Skip to content

Commit ec781b6

Browse files
committed
Remove None from param types and add (Optional).
This runs a script to remove None from the types for parameters, and added (Optional) to the description. Does not pass lint due to some too-long lines. I will clean those up manually. See: googleapis#2580 (review)
1 parent bf0c541 commit ec781b6

File tree

34 files changed

+275
-274
lines changed

34 files changed

+275
-274
lines changed

bigquery/google/cloud/bigquery/dataset.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -216,8 +216,8 @@ def default_table_expiration_ms(self):
216216
def default_table_expiration_ms(self, value):
217217
"""Update default expiration time for tables in the dataset.
218218
219-
:type value: int, or ``NoneType``
220-
:param value: new default time, in milliseconds
219+
:type value: int
220+
:param value: (Optional) new default time, in milliseconds
221221
222222
:raises: ValueError for invalid value types.
223223
"""
@@ -238,8 +238,8 @@ def description(self):
238238
def description(self, value):
239239
"""Update description of the dataset.
240240
241-
:type value: str, or ``NoneType``
242-
:param value: new description
241+
:type value: str
242+
:param value: (Optional) new description
243243
244244
:raises: ValueError for invalid value types.
245245
"""
@@ -260,8 +260,8 @@ def friendly_name(self):
260260
def friendly_name(self, value):
261261
"""Update title of the dataset.
262262
263-
:type value: str, or ``NoneType``
264-
:param value: new title
263+
:type value: str
264+
:param value: (Optional) new title
265265
266266
:raises: ValueError for invalid value types.
267267
"""
@@ -282,8 +282,8 @@ def location(self):
282282
def location(self, value):
283283
"""Update location in which the dataset is hosted.
284284
285-
:type value: str, or ``NoneType``
286-
:param value: new location
285+
:type value: str
286+
:param value: (Optional) new location
287287
288288
:raises: ValueError for invalid value types.
289289
"""

bigquery/google/cloud/bigquery/query.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -345,17 +345,17 @@ def fetch_data(self, max_results=None, page_token=None, start_index=None,
345345
See:
346346
https://cloud.google.com/bigquery/docs/reference/v2/jobs/getQueryResults
347347
348-
:type max_results: int or ``NoneType``
349-
:param max_results: maximum number of rows to return.
348+
:type max_results: int
349+
:param max_results: (Optional) maximum number of rows to return.
350350
351-
:type page_token: str or ``NoneType``
352-
:param page_token: token representing a cursor into the table's rows.
351+
:type page_token: str
352+
:param page_token: (Optional) token representing a cursor into the table's rows.
353353
354-
:type start_index: int or ``NoneType``
355-
:param start_index: zero-based index of starting row
354+
:type start_index: int
355+
:param start_index: (Optional) zero-based index of starting row
356356
357-
:type timeout_ms: int or ``NoneType``
358-
:param timeout_ms: timeout, in milliseconds, to wait for query to
357+
:type timeout_ms: int
358+
:param timeout_ms: (Optional) timeout, in milliseconds, to wait for query to
359359
complete
360360
361361
:type client: :class:`~google.cloud.bigquery.client.Client` or

bigquery/google/cloud/bigquery/table.py

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -264,8 +264,8 @@ def description(self):
264264
def description(self, value):
265265
"""Update description of the table.
266266
267-
:type value: str, or ``NoneType``
268-
:param value: new description
267+
:type value: str
268+
:param value: (Optional) new description
269269
270270
:raises: ValueError for invalid value types.
271271
"""
@@ -289,8 +289,8 @@ def expires(self):
289289
def expires(self, value):
290290
"""Update datetime at which the table will be removed.
291291
292-
:type value: ``datetime.datetime``, or ``NoneType``
293-
:param value: the new expiration time, or None
292+
:type value: ``datetime.datetime``
293+
:param value: (Optional) the new expiration time, or None
294294
"""
295295
if not isinstance(value, datetime.datetime) and value is not None:
296296
raise ValueError("Pass a datetime, or None")
@@ -309,8 +309,8 @@ def friendly_name(self):
309309
def friendly_name(self, value):
310310
"""Update title of the table.
311311
312-
:type value: str, or ``NoneType``
313-
:param value: new title
312+
:type value: str
313+
:param value: (Optional) new title
314314
315315
:raises: ValueError for invalid value types.
316316
"""
@@ -331,8 +331,8 @@ def location(self):
331331
def location(self, value):
332332
"""Update location in which the table is hosted.
333333
334-
:type value: str, or ``NoneType``
335-
:param value: new location
334+
:type value: str
335+
:param value: (Optional) new location
336336
337337
:raises: ValueError for invalid value types.
338338
"""
@@ -554,17 +554,17 @@ def patch(self,
554554
:param client: the client to use. If not passed, falls back to the
555555
``client`` stored on the current dataset.
556556
557-
:type friendly_name: str or ``NoneType``
558-
:param friendly_name: point in time at which the table expires.
557+
:type friendly_name: str
558+
:param friendly_name: (Optional) point in time at which the table expires.
559559
560-
:type description: str or ``NoneType``
561-
:param description: point in time at which the table expires.
560+
:type description: str
561+
:param description: (Optional) point in time at which the table expires.
562562
563-
:type location: str or ``NoneType``
564-
:param location: point in time at which the table expires.
563+
:type location: str
564+
:param location: (Optional) point in time at which the table expires.
565565
566-
:type expires: :class:`datetime.datetime` or ``NoneType``
567-
:param expires: point in time at which the table expires.
566+
:type expires: :class:`datetime.datetime`
567+
:param expires: (Optional) point in time at which the table expires.
568568
569569
:type view_query: str
570570
:param view_query: SQL query defining the table as a view
@@ -654,11 +654,12 @@ def fetch_data(self, max_results=None, page_token=None, client=None):
654654
incomplete. To ensure that the local copy of the schema is
655655
up-to-date, call the table's ``reload`` method.
656656
657-
:type max_results: int or ``NoneType``
658-
:param max_results: maximum number of rows to return.
657+
:type max_results: int
658+
:param max_results: (Optional) maximum number of rows to return.
659659
660-
:type page_token: str or ``NoneType``
661-
:param page_token: token representing a cursor into the table's rows.
660+
:type page_token: str
661+
:param page_token:
662+
(Optional) token representing a cursor into the table's rows.
662663
663664
:type client: :class:`~google.cloud.bigquery.client.Client` or
664665
``NoneType``
@@ -714,18 +715,18 @@ def insert_data(self,
714715
:param row_ids: Unique ids, one per row being inserted. If not
715716
passed, no de-duplication occurs.
716717
717-
:type skip_invalid_rows: bool or ``NoneType``
718-
:param skip_invalid_rows: skip rows w/ invalid data?
718+
:type skip_invalid_rows: bool
719+
:param skip_invalid_rows: (Optional) skip rows w/ invalid data?
719720
720-
:type ignore_unknown_values: bool or ``NoneType``
721-
:param ignore_unknown_values: ignore columns beyond schema?
722-
723-
:type template_suffix: str or ``NoneType``
724-
:param template_suffix: treat ``name`` as a template table and provide
725-
a suffix. BigQuery will create the table
726-
``<name> + <template_suffix>`` based on the
727-
schema of the template table. See:
728-
https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables
721+
:type ignore_unknown_values: bool
722+
:param ignore_unknown_values: (Optional) ignore columns beyond schema?
723+
724+
:type template_suffix: str
725+
:param template_suffix:
726+
(Optional) treat ``name`` as a template table and provide a suffix.
727+
BigQuery will create the table ``<name> + <template_suffix>`` based
728+
on the schema of the template table. See:
729+
https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables
729730
730731
:type client: :class:`~google.cloud.bigquery.client.Client` or
731732
``NoneType``

core/google/cloud/_helpers.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -366,8 +366,8 @@ def _microseconds_from_datetime(value):
366366
def _millis_from_datetime(value):
367367
"""Convert non-none datetime to timestamp, assuming UTC.
368368
369-
:type value: :class:`datetime.datetime`, or None
370-
:param value: the timestamp
369+
:type value: :class:`datetime.datetime`
370+
:param value: (Optional) the timestamp
371371
372372
:rtype: int, or ``NoneType``
373373
:returns: the timestamp, in milliseconds, or None
@@ -554,8 +554,8 @@ def _name_from_project_path(path, project, template):
554554
:type path: str
555555
:param path: URI path containing the name.
556556
557-
:type project: str or NoneType
558-
:param project: The project associated with the request. It is
557+
:type project: str
558+
:param project: (Optional) The project associated with the request. It is
559559
included for validation purposes. If passed as None,
560560
disables validation.
561561

core/google/cloud/connection.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -214,8 +214,8 @@ def _make_request(self, method, url, data=None, content_type=None,
214214
:type headers: dict
215215
:param headers: A dictionary of HTTP headers to send with the request.
216216
217-
:type target_object: object or :class:`NoneType`
218-
:param target_object: Argument to be used by library callers.
217+
:type target_object: object
218+
:param target_object: (Optional) Argument to be used by library callers.
219219
This can allow custom behavior, for example, to
220220
defer an HTTP request and complete initialization
221221
of the object at a later time.
@@ -261,8 +261,8 @@ def _do_request(self, method, url, headers, data,
261261
:type data: str
262262
:param data: The data to send as the body of the request.
263263
264-
:type target_object: object or :class:`NoneType`
265-
:param target_object: Unused ``target_object`` here but may be used
264+
:type target_object: object
265+
:param target_object: (Optional) Unused ``target_object`` here but may be used
266266
by a superclass.
267267
268268
:rtype: tuple of ``response`` (a dictionary of sorts)
@@ -323,8 +323,8 @@ def api_request(self, method, path, query_params=None,
323323
response as JSON and raise an exception if
324324
that cannot be done. Default is True.
325325
326-
:type _target_object: :class:`object` or :class:`NoneType`
327-
:param _target_object: Protected argument to be used by library
326+
:type _target_object: :class:`object`
327+
:param _target_object: (Optional) Protected argument to be used by library
328328
callers. This can allow custom behavior, for
329329
example, to defer an HTTP request and complete
330330
initialization of the object at a later time.

core/google/cloud/streaming/buffered_stream.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ def _bytes_remaining(self):
8181
def read(self, size=None):
8282
"""Read bytes from the buffer.
8383
84-
:type size: int or None
85-
:param size: How many bytes to read (defaults to all remaining bytes).
84+
:type size: int
85+
:param size: (Optional) How many bytes to read (defaults to all remaining bytes).
8686
8787
:rtype: str
8888
:returns: The data read from the stream.

core/google/cloud/streaming/http_wrapper.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@ def _httplib2_debug_level(http_request, level, http=None):
8080
:type level: int
8181
:param level: the debuglevel for logging.
8282
83-
:type http: :class:`httplib2.Http`, or ``None``
84-
:param http: the instance on whose connections to set the debuglevel.
83+
:type http: :class:`httplib2.Http`
84+
:param http: (Optional) the instance on whose connections to set the debuglevel.
8585
"""
8686
if http_request.loggable_body is None:
8787
yield
@@ -115,8 +115,8 @@ class Request(object):
115115
:type http_method: str
116116
:param http_method: the HTTP method to use for the request
117117
118-
:type headers: mapping or None
119-
:param headers: headers to be sent with the request
118+
:type headers: mapping
119+
:param headers: (Optional) headers to be sent with the request
120120
121121
:type body: str
122122
:param body: body to be sent with the request

core/google/cloud/streaming/stream_slice.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,8 @@ def read(self, size=None):
6565
slice indicates we should still be able to read more bytes, we
6666
raise :exc:`IncompleteRead`.
6767
68-
:type size: int or None
69-
:param size: If provided, read no more than size bytes from the stream.
68+
:type size: int
69+
:param size: (Optional) If provided, read no more than size bytes from the stream.
7070
7171
:rtype: bytes
7272
:returns: bytes read from this slice.

core/google/cloud/streaming/transfer.py

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -280,8 +280,8 @@ def from_stream(cls, stream, auto_transfer=True, total_size=None, **kwds):
280280
:type stream: writable file-like object
281281
:param stream: the target file
282282
283-
:type total_size: int or None
284-
:param total_size: total size of the file to be downloaded
283+
:type total_size: int
284+
:param total_size: (Optional) total size of the file to be downloaded
285285
286286
:type auto_transfer: bool
287287
:param auto_transfer: should the transfer be started immediately
@@ -457,8 +457,8 @@ def _compute_end_byte(self, start, end=None, use_chunks=True):
457457
:type start: int
458458
:param start: start byte of the range.
459459
460-
:type end: int or None
461-
:param end: suggested last byte of the range.
460+
:type end: int
461+
:param end: (Optional) suggested last byte of the range.
462462
463463
:type use_chunks: bool
464464
:param use_chunks: If False, ignore :attr:`chunksize`.
@@ -493,8 +493,8 @@ def _get_chunk(self, start, end):
493493
:type start: int
494494
:param start: start byte of the range.
495495
496-
:type end: int or None
497-
:param end: end byte of the range.
496+
:type end: int
497+
:param end: (Optional) end byte of the range.
498498
499499
:rtype: :class:`google.cloud.streaming.http_wrapper.Response`
500500
:returns: response from the chunk request.
@@ -555,8 +555,8 @@ def get_range(self, start, end=None, use_chunks=True):
555555
:type start: int
556556
:param start: Where to start fetching bytes. (See above.)
557557
558-
:type end: int or ``None``
559-
:param end: Where to stop fetching bytes. (See above.)
558+
:type end: int
559+
:param end: (Optional) Where to stop fetching bytes. (See above.)
560560
561561
:type use_chunks: bool
562562
:param use_chunks: If False, ignore :attr:`chunksize`
@@ -625,8 +625,8 @@ class Upload(_Transfer):
625625
:type mime_type: str:
626626
:param mime_type: MIME type of the upload.
627627
628-
:type total_size: int or None
629-
:param total_size: Total upload size for the stream.
628+
:type total_size: int
629+
:param total_size: (Optional) Total upload size for the stream.
630630
631631
:type http: :class:`httplib2.Http` (or workalike)
632632
:param http: Http instance used to perform requests.
@@ -669,8 +669,8 @@ def from_file(cls, filename, mime_type=None, auto_transfer=True, **kwds):
669669
:type mime_type: str
670670
:param mime_type: MIMEtype of the file being uploaded
671671
672-
:type auto_transfer: bool or None
673-
:param auto_transfer: should the transfer be started immediately
672+
:type auto_transfer: bool
673+
:param auto_transfer: (Optional) should the transfer be started immediately
674674
675675
:type kwds: dict
676676
:param kwds: keyword arguments: passed
@@ -700,11 +700,11 @@ def from_stream(cls, stream, mime_type,
700700
:type mime_type: str
701701
:param mime_type: MIMEtype of the file being uploaded
702702
703-
:type total_size: int or None
704-
:param total_size: Size of the file being uploaded
703+
:type total_size: int
704+
:param total_size: (Optional) Size of the file being uploaded
705705
706-
:type auto_transfer: bool or None
707-
:param auto_transfer: should the transfer be started immediately
706+
:type auto_transfer: bool
707+
:param auto_transfer: (Optional) should the transfer be started immediately
708708
709709
:type kwds: dict
710710
:param kwds: keyword arguments: passed
@@ -784,8 +784,8 @@ def total_size(self):
784784
def total_size(self, value):
785785
"""Update total size of the stream to be uploaded.
786786
787-
:type value: int or None
788-
:param value: the size
787+
:type value: int
788+
:param value: (Optional) the size
789789
"""
790790
self._ensure_uninitialized()
791791
self._total_size = value
@@ -1048,8 +1048,8 @@ def _validate_chunksize(self, chunksize=None):
10481048
10491049
Helper for :meth:`stream_file`.
10501050
1051-
:type chunksize: int or None
1052-
:param chunksize: the chunk size to be tested.
1051+
:type chunksize: int
1052+
:param chunksize: (Optional) the chunk size to be tested.
10531053
10541054
:raises: :exc:`ValueError` if ``chunksize`` is not a multiple
10551055
of the server-specified granulariy.

0 commit comments

Comments
 (0)