Merge pull request #2584 from tswast/nonetype-to-optional

Remove None & NoneType from parameter types in docstrings.

Author: dhermes

packages/google-cloud-storage/google/cloud/storage/acl.py

@@ -419,10 +419,10 @@ def _save(self, acl, predefined, client):
         :param acl: The ACL object to save.  If left blank, this will save
                     current entries.
 
-        :type predefined: str or None
-        :param predefined: An identifier for a predefined ACL.  Must be one
-                           of the keys in :attr:`PREDEFINED_JSON_ACLS`
-                           If passed, `acl` must be None.
+        :type predefined: str
+        :param predefined:
+            (Optional) An identifier for a predefined ACL.  Must be one of the
+            keys in :attr:`PREDEFINED_JSON_ACLS` If passed, `acl` must be None.
 
         :type client: :class:`~google.cloud.storage.client.Client` or
                       ``NoneType``

packages/google-cloud-storage/google/cloud/storage/batch.py

@@ -44,8 +44,8 @@ class MIMEApplicationHTTP(MIMEApplication):
     :type headers:  dict
     :param headers: HTTP headers
 
-    :type body: str or None
-    :param body: HTTP payload
+    :type body: str
+    :param body: (Optional) HTTP payload
 
     """
     def __init__(self, method, uri, headers, body):
@@ -154,11 +154,11 @@ def _do_request(self, method, url, headers, data, target_object):
         :type data: str
         :param data: The data to send as the body of the request.
 
-        :type target_object: object or :class:`NoneType`
-        :param target_object: This allows us to enable custom behavior in our
-                              batch connection. Here we defer an HTTP request
-                              and complete initialization of the object at a
-                              later time.
+        :type target_object: object
+        :param target_object:
+            (Optional) This allows us to enable custom behavior in our batch
+            connection. Here we defer an HTTP request and complete
+            initialization of the object at a later time.
 
         :rtype: tuple of ``response`` (a dictionary of sorts)
                 and ``content`` (a string).

packages/google-cloud-storage/google/cloud/storage/blob.py

@@ -94,8 +94,8 @@ def chunk_size(self):
     def chunk_size(self, value):
         """Set the blob's default chunk size.
 
-        :type value: int or ``NoneType``
-        :param value: The current blob's chunk size, if it is set.
+        :type value: int
+        :param value: (Optional) The current blob's chunk size, if it is set.
 
         :raises: :class:`ValueError` if ``value`` is not ``None`` and is not a
                  multiple of 256 KB.
@@ -450,7 +450,7 @@ def upload_from_file(self, file_obj, rewind=False, size=None,
                      :func:`os.fstat`. (If the file handle is not from the
                      filesystem this won't be possible.)
 
-        :type content_type: str or ``NoneType``
+        :type content_type: str
         :param content_type: Optional type of content being uploaded.
 
         :type num_retries: int
@@ -567,7 +567,7 @@ def upload_from_filename(self, filename, content_type=None, client=None):
         :type filename: str
         :param filename: The path to the file.
 
-        :type content_type: str or ``NoneType``
+        :type content_type: str
         :param content_type: Optional type of content being uploaded.
 
         :type client: :class:`~google.cloud.storage.client.Client` or
@@ -861,8 +861,8 @@ def metadata(self, value):
 
         See: https://cloud.google.com/storage/docs/json_api/v1/objects
 
-        :type value: dict or ``NoneType``
-        :param value: The blob metadata to set.
+        :type value: dict
+        :param value: (Optional) The blob metadata to set.
         """
         self._patch_property('metadata', value)
 

packages/google-cloud-storage/google/cloud/storage/client.py

@@ -227,28 +227,29 @@ def list_buckets(self, max_results=None, page_token=None, prefix=None,
 
         This implements "storage.buckets.list".
 
-        :type max_results: int or ``NoneType``
+        :type max_results: int
         :param max_results: Optional. Maximum number of buckets to return.
 
-        :type page_token: str or ``NoneType``
+        :type page_token: str
         :param page_token: Optional. Opaque marker for the next "page" of
                            buckets. If not passed, will return the first page
                            of buckets.
 
-        :type prefix: str or ``NoneType``
+        :type prefix: str
         :param prefix: Optional. Filter results to buckets whose names begin
                        with this prefix.
 
-        :type projection: str or ``NoneType``
-        :param projection: If used, must be 'full' or 'noAcl'. Defaults to
-                           'noAcl'. Specifies the set of properties to return.
-
-        :type fields: str or ``NoneType``
-        :param fields: Selector specifying which fields to include in a
-                       partial response. Must be a list of fields. For example
-                       to get a partial response with just the next page token
-                       and the language of each bucket returned:
-                       'items/id,nextPageToken'
+        :type projection: str
+        :param projection:
+            (Optional) Specifies the set of properties to return. If used, must
+            be 'full' or 'noAcl'. Defaults to 'noAcl'.
+
+        :type fields: str
+        :param fields:
+            (Optional) Selector specifying which fields to include in a partial
+            response. Must be a list of fields. For example to get a partial
+            response with just the next page token and the language of each
+            bucket returned: 'items/id,nextPageToken'
 
         :rtype: :class:`~google.cloud.iterator.Iterator`
         :returns: Iterator of all :class:`~google.cloud.storage.bucket.Bucket`