Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 9d9b6c0

Browse filesBrowse files
tseavertseaver
authored
Appease current pylint opinions: (googleapis#3692)
- Document missing ':raises:', ':rtype:', and ':returns:'. - Use ':raises <exception_type>:'. - Add pro-forma docstrings to namespace package initializers. - Avoid using 'len(seq) == 0' (or '!=') for boolean tests. pylint still complains about import cycles: ************* Module google.cloud.spanner.streamed R: 1, 0: Cyclic import (google.cloud.spanner -> google.cloud.spanner.client -> google.cloud.spanner.instance -> google.cloud.spanner.database) (cyclic-import) R: 1, 0: Cyclic import (google.cloud.spanner -> google.cloud.spanner.client) (cyclic-import)
1 parent a1269a6 commit 9d9b6c0
Copy full SHA for 9d9b6c0

10 files changed

+86-28Lines changed: 86 additions & 28 deletions

File tree

Expand file treeCollapse file tree
Open diff view settings
Filter options
Expand file treeCollapse file tree
Open diff view settings
Collapse file

‎spanner/google/__init__.py‎

Copy file name to clipboardExpand all lines: spanner/google/__init__.py
+2Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15+
"""Google namespace package."""
16+
1517
try:
1618
import pkg_resources
1719
pkg_resources.declare_namespace(__name__)
Collapse file

‎spanner/google/cloud/__init__.py‎

Copy file name to clipboardExpand all lines: spanner/google/cloud/__init__.py
+2Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15+
"""Google Cloud namespace package."""
16+
1517
try:
1618
import pkg_resources
1719
pkg_resources.declare_namespace(__name__)
Collapse file

‎spanner/google/cloud/spanner/_helpers.py‎

Copy file name to clipboardExpand all lines: spanner/google/cloud/spanner/_helpers.py
+7-4Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ class TimestampWithNanoseconds(datetime.datetime):
3838
"""
3939
__slots__ = ('_nanosecond',)
4040

41+
# pylint: disable=arguments-differ
4142
def __new__(cls, *args, **kw):
4243
nanos = kw.pop('nanosecond', 0)
4344
if nanos > 0:
@@ -48,6 +49,7 @@ def __new__(cls, *args, **kw):
4849
inst = datetime.datetime.__new__(cls, *args, **kw)
4950
inst._nanosecond = nanos or 0
5051
return inst
52+
# pylint: disable=arguments-differ
5153

5254
@property
5355
def nanosecond(self):
@@ -74,6 +76,7 @@ def from_rfc3339(cls, stamp):
7476
7577
:rtype: :class:`TimestampWithNanoseconds`
7678
:returns: an instance matching the timestamp string
79+
:raises ValueError: if ``stamp`` does not match the expected format
7780
"""
7881
with_nanos = _RFC3339_NANOS.match(stamp)
7982
if with_nanos is None:
@@ -110,7 +113,7 @@ def _try_to_coerce_bytes(bytestring):
110113
'base64-encoded bytes.')
111114

112115

113-
# pylint: disable=too-many-return-statements
116+
# pylint: disable=too-many-return-statements,too-many-branches
114117
def _make_value_pb(value):
115118
"""Helper for :func:`_make_list_value_pbs`.
116119
@@ -119,7 +122,7 @@ def _make_value_pb(value):
119122
120123
:rtype: :class:`~google.protobuf.struct_pb2.Value`
121124
:returns: value protobufs
122-
:raises: :exc:`ValueError` if value is not of a known scalar type.
125+
:raises ValueError: if value is not of a known scalar type.
123126
"""
124127
if value is None:
125128
return Value(null_value='NULL_VALUE')
@@ -150,7 +153,7 @@ def _make_value_pb(value):
150153
if isinstance(value, six.text_type):
151154
return Value(string_value=value)
152155
raise ValueError("Unknown type: %s" % (value,))
153-
# pylint: enable=too-many-return-statements
156+
# pylint: enable=too-many-return-statements,too-many-branches
154157

155158

156159
def _make_list_value_pb(values):
@@ -189,7 +192,7 @@ def _parse_value_pb(value_pb, field_type):
189192
190193
:rtype: varies on field_type
191194
:returns: value extracted from value_pb
192-
:raises: ValueError if uknown type is passed
195+
:raises ValueError: if unknown type is passed
193196
"""
194197
if value_pb.HasField('null_value'):
195198
return None
Collapse file

‎spanner/google/cloud/spanner/database.py‎

Copy file name to clipboardExpand all lines: spanner/google/cloud/spanner/database.py
+24-3Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,9 +99,8 @@ def from_pb(cls, database_pb, instance, pool=None):
9999
100100
:rtype: :class:`Database`
101101
:returns: The database parsed from the protobuf response.
102-
:raises:
103-
:class:`ValueError <exceptions.ValueError>` if the instance
104-
name does not match the expected format
102+
:raises ValueError:
103+
if the instance name does not match the expected format
105104
or if the parsed project ID does not match the project ID
106105
on the instance's client, or if the parsed instance ID does
107106
not match the instance's ID.
@@ -175,6 +174,13 @@ def create(self):
175174
176175
See
177176
https://cloud.google.com/spanner/reference/rpc/google.spanner.admin.database.v1#google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase
177+
178+
:rtype: :class:`~google.cloud.future.operation.Operation`
179+
:returns: a future used to poll the status of the create request
180+
:raises Conflict: if the database already exists
181+
:raises NotFound: if the instance owning the database does not exist
182+
:raises GaxError:
183+
for errors other than ``ALREADY_EXISTS`` returned from the call
178184
"""
179185
api = self._instance._client.database_admin_api
180186
options = _options_with_prefix(self.name)
@@ -205,6 +211,11 @@ def exists(self):
205211
206212
See
207213
https://cloud.google.com/spanner/reference/rpc/google.spanner.admin.database.v1#google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDDL
214+
215+
:rtype: bool
216+
:returns: True if the database exists, else false.
217+
:raises GaxError:
218+
for errors other than ``NOT_FOUND`` returned from the call
208219
"""
209220
api = self._instance._client.database_admin_api
210221
options = _options_with_prefix(self.name)
@@ -224,6 +235,10 @@ def reload(self):
224235
225236
See
226237
https://cloud.google.com/spanner/reference/rpc/google.spanner.admin.database.v1#google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDDL
238+
239+
:raises NotFound: if the database does not exist
240+
:raises GaxError:
241+
for errors other than ``NOT_FOUND`` returned from the call
227242
"""
228243
api = self._instance._client.database_admin_api
229244
options = _options_with_prefix(self.name)
@@ -246,6 +261,9 @@ def update_ddl(self, ddl_statements):
246261
247262
:rtype: :class:`google.cloud.future.operation.Operation`
248263
:returns: an operation instance
264+
:raises NotFound: if the database does not exist
265+
:raises GaxError:
266+
for errors other than ``NOT_FOUND`` returned from the call
249267
"""
250268
client = self._instance._client
251269
api = client.database_admin_api
@@ -474,6 +492,9 @@ def _check_ddl_statements(value):
474492
475493
:rtype: tuple
476494
:returns: tuple of validated DDL statement strings.
495+
:raises ValueError:
496+
if elements in ``value`` are not strings, or if ``value`` contains
497+
a ``CREATE DATABASE`` statement.
477498
"""
478499
if not all(isinstance(line, six.string_types) for line in value):
479500
raise ValueError("Pass a list of strings")
Collapse file

‎spanner/google/cloud/spanner/instance.py‎

Copy file name to clipboardExpand all lines: spanner/google/cloud/spanner/instance.py
+17-5Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -109,11 +109,10 @@ def from_pb(cls, instance_pb, client):
109109
110110
:rtype: :class:`Instance`
111111
:returns: The instance parsed from the protobuf response.
112-
:raises: :class:`ValueError <exceptions.ValueError>` if the instance
113-
name does not match
114-
``projects/{project}/instances/{instance_id}``
115-
or if the parsed project ID does not match the project ID
116-
on the client.
112+
:raises ValueError:
113+
if the instance name does not match
114+
``projects/{project}/instances/{instance_id}`` or if the parsed
115+
project ID does not match the project ID on the client.
117116
"""
118117
match = _INSTANCE_NAME_RE.match(instance_pb.name)
119118
if match is None:
@@ -201,6 +200,9 @@ def create(self):
201200
202201
:rtype: :class:`google.cloud.future.operation.Operation`
203202
:returns: an operation instance
203+
:raises Conflict: if the instance already exists
204+
:raises GaxError:
205+
for errors other than ``ALREADY_EXISTS`` returned from the call
204206
"""
205207
api = self._client.instance_admin_api
206208
instance_pb = admin_v1_pb2.Instance(
@@ -230,6 +232,11 @@ def exists(self):
230232
231233
See
232234
https://cloud.google.com/spanner/reference/rpc/google.spanner.admin.instance.v1#google.spanner.admin.instance.v1.InstanceAdmin.GetInstanceConfig
235+
236+
:rtype: bool
237+
:returns: True if the instance exists, else false
238+
:raises GaxError:
239+
for errors other than ``NOT_FOUND`` returned from the call
233240
"""
234241
api = self._client.instance_admin_api
235242
options = _options_with_prefix(self.name)
@@ -248,6 +255,9 @@ def reload(self):
248255
249256
See
250257
https://cloud.google.com/spanner/reference/rpc/google.spanner.admin.instance.v1#google.spanner.admin.instance.v1.InstanceAdmin.GetInstanceConfig
258+
259+
:raises NotFound: if the instance does not exist
260+
:raises GaxError: for other errors returned from the call
251261
"""
252262
api = self._client.instance_admin_api
253263
options = _options_with_prefix(self.name)
@@ -281,6 +291,8 @@ def update(self):
281291
282292
:rtype: :class:`google.cloud.future.operation.Operation`
283293
:returns: an operation instance
294+
:raises NotFound: if the instance does not exist
295+
:raises GaxError: for other errors returned from the call
284296
"""
285297
api = self._client.instance_admin_api
286298
instance_pb = admin_v1_pb2.Instance(
Collapse file

‎spanner/google/cloud/spanner/pool.py‎

Copy file name to clipboardExpand all lines: spanner/google/cloud/spanner/pool.py
+8Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ def bind(self, database):
3939
4040
Concrete implementations of this method may pre-fill the pool
4141
using the database.
42+
43+
:raises NotImplementedError: abstract method
4244
"""
4345
raise NotImplementedError()
4446

@@ -48,6 +50,8 @@ def get(self):
4850
Concrete implementations of this method are allowed to raise an
4951
error to signal that the pool is exhausted, or to block until a
5052
session is available.
53+
54+
:raises NotImplementedError: abstract method
5155
"""
5256
raise NotImplementedError()
5357

@@ -60,6 +64,8 @@ def put(self, session):
6064
Concrete implementations of this method are allowed to raise an
6165
error to signal that the pool is full, or to block until it is
6266
not full.
67+
68+
:raises NotImplementedError: abstract method
6369
"""
6470
raise NotImplementedError()
6571

@@ -69,6 +75,8 @@ def clear(self):
6975
Concrete implementations of this method are allowed to raise an
7076
error to signal that the pool is full, or to block until it is
7177
not full.
78+
79+
:raises NotImplementedError: abstract method
7280
"""
7381
raise NotImplementedError()
7482

Collapse file

‎spanner/google/cloud/spanner/session.py‎

Copy file name to clipboardExpand all lines: spanner/google/cloud/spanner/session.py
+12-4Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ def name(self):
7878
7979
:rtype: str
8080
:returns: The session name.
81+
:raises ValueError: if session is not yet created
8182
"""
8283
if self._session_id is None:
8384
raise ValueError('No session ID set by back-end')
@@ -106,6 +107,8 @@ def exists(self):
106107
107108
:rtype: bool
108109
:returns: True if the session exists on the back-end, else False.
110+
:raises GaxError:
111+
for errors other than ``NOT_FOUND`` returned from the call
109112
"""
110113
if self._session_id is None:
111114
return False
@@ -126,7 +129,10 @@ def delete(self):
126129
See
127130
https://cloud.google.com/spanner/reference/rpc/google.spanner.v1#google.spanner.v1.Spanner.GetSession
128131
129-
:raises: :exc:`ValueError` if :attr:`session_id` is not already set.
132+
:raises ValueError: if :attr:`session_id` is not already set.
133+
:raises NotFound: if the session does not exist
134+
:raises GaxError:
135+
for errors other than ``NOT_FOUND`` returned from the call
130136
"""
131137
if self._session_id is None:
132138
raise ValueError('Session ID not set by back-end')
@@ -151,7 +157,7 @@ def snapshot(self, **kw):
151157
152158
:rtype: :class:`~google.cloud.spanner.snapshot.Snapshot`
153159
:returns: a snapshot bound to this session
154-
:raises: :exc:`ValueError` if the session has not yet been created.
160+
:raises ValueError: if the session has not yet been created.
155161
"""
156162
if self._session_id is None:
157163
raise ValueError("Session has not been created.")
@@ -223,7 +229,7 @@ def batch(self):
223229
224230
:rtype: :class:`~google.cloud.spanner.batch.Batch`
225231
:returns: a batch bound to this session
226-
:raises: :exc:`ValueError` if the session has not yet been created.
232+
:raises ValueError: if the session has not yet been created.
227233
"""
228234
if self._session_id is None:
229235
raise ValueError("Session has not been created.")
@@ -235,7 +241,7 @@ def transaction(self):
235241
236242
:rtype: :class:`~google.cloud.spanner.transaction.Transaction`
237243
:returns: a transaction bound to this session
238-
:raises: :exc:`ValueError` if the session has not yet been created.
244+
:raises ValueError: if the session has not yet been created.
239245
"""
240246
if self._session_id is None:
241247
raise ValueError("Session has not been created.")
@@ -264,6 +270,8 @@ def run_in_transaction(self, func, *args, **kw):
264270
265271
:rtype: :class:`datetime.datetime`
266272
:returns: timestamp of committed transaction
273+
:raises Exception:
274+
reraises any non-ABORT execptions raised by ``func``.
267275
"""
268276
deadline = time.time() + kw.pop(
269277
'timeout_secs', DEFAULT_RETRY_TIMEOUT_SECS)
Collapse file

‎spanner/google/cloud/spanner/snapshot.py‎

Copy file name to clipboardExpand all lines: spanner/google/cloud/spanner/snapshot.py
+9-7Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,9 @@ def read(self, table, columns, keyset, index='', limit=0,
7474
7575
:rtype: :class:`~google.cloud.spanner.streamed.StreamedResultSet`
7676
:returns: a result set instance which can be used to consume rows.
77-
:raises: ValueError for reuse of single-use snapshots, or if a
78-
transaction ID is pending for multiple-use snapshots.
77+
:raises ValueError:
78+
for reuse of single-use snapshots, or if a transaction ID is
79+
already pending for multiple-use snapshots.
7980
"""
8081
if self._read_request_count > 0:
8182
if not self._multi_use:
@@ -126,8 +127,9 @@ def execute_sql(self, sql, params=None, param_types=None, query_mode=None,
126127
127128
:rtype: :class:`~google.cloud.spanner.streamed.StreamedResultSet`
128129
:returns: a result set instance which can be used to consume rows.
129-
:raises: ValueError for reuse of single-use snapshots, or if a
130-
transaction ID is pending for multiple-use snapshots.
130+
:raises ValueError:
131+
for reuse of single-use snapshots, or if a transaction ID is
132+
already pending for multiple-use snapshots.
131133
"""
132134
if self._read_request_count > 0:
133135
if not self._multi_use:
@@ -248,12 +250,12 @@ def _make_txn_selector(self):
248250
return TransactionSelector(single_use=options)
249251

250252
def begin(self):
251-
"""Begin a transaction on the database.
253+
"""Begin a read-only transaction on the database.
252254
253255
:rtype: bytes
254256
:returns: the ID for the newly-begun transaction.
255-
:raises: ValueError if the transaction is already begun, committed,
256-
or rolled back.
257+
:raises ValueError:
258+
if the transaction is already begun, committed, or rolled back.
257259
"""
258260
if not self._multi_use:
259261
raise ValueError("Cannot call 'begin' single-use snapshots")
Collapse file

‎spanner/google/cloud/spanner/streamed.py‎

Copy file name to clipboardExpand all lines: spanner/google/cloud/spanner/streamed.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ def consume_all(self):
163163
def __iter__(self):
164164
iter_rows, self._rows[:] = self._rows[:], ()
165165
while True:
166-
if len(iter_rows) == 0:
166+
if not iter_rows:
167167
self.consume_next() # raises StopIteration
168168
iter_rows, self._rows[:] = self._rows[:], ()
169169
while iter_rows:
Collapse file

‎spanner/google/cloud/spanner/transaction.py‎

Copy file name to clipboardExpand all lines: spanner/google/cloud/spanner/transaction.py
+4-4Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ def begin(self):
6060
6161
:rtype: bytes
6262
:returns: the ID for the newly-begun transaction.
63-
:raises: ValueError if the transaction is already begun, committed,
64-
or rolled back.
63+
:raises ValueError:
64+
if the transaction is already begun, committed, or rolled back.
6565
"""
6666
if self._transaction_id is not None:
6767
raise ValueError("Transaction already begun")
@@ -97,11 +97,11 @@ def commit(self):
9797
9898
:rtype: datetime
9999
:returns: timestamp of the committed changes.
100-
:raises: :exc:`ValueError` if there are no mutations to commit.
100+
:raises ValueError: if there are no mutations to commit.
101101
"""
102102
self._check_state()
103103

104-
if len(self._mutations) == 0:
104+
if not self._mutations:
105105
raise ValueError("No mutations to commit")
106106

107107
database = self._session._database

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.