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

dhermes · web-flow · commit 7b81eb486839 · 2016-10-21T14:40:34.000-07:00
Remove None &amp; NoneType from parameter types in docstrings.
diff --git a/packages/google-cloud-pubsub/google/cloud/pubsub/_gax.py b/packages/google-cloud-pubsub/google/cloud/pubsub/_gax.py
@@ -269,14 +269,15 @@ def subscription_create(self, subscription_path, topic_path,
                            subscribed, in format
                            ``projects/<PROJECT>/topics/<TOPIC_NAME>``.
 
-        :type ack_deadline: int, or ``NoneType``
-        :param ack_deadline: the deadline (in seconds) by which messages pulled
-                             from the back-end must be acknowledged.
+        :type ack_deadline: int
+        :param ack_deadline:
+            (Optional) the deadline (in seconds) by which messages pulled from
+            the back-end must be acknowledged.
 
-        :type push_endpoint: str, or ``NoneType``
-        :param push_endpoint: URL to which messages will be pushed by the
-                              back-end.  If not set, the application must pull
-                              messages.
+        :type push_endpoint: str
+        :param push_endpoint:
+            (Optional) URL to which messages will be pushed by the back-end.
+            If not set, the application must pull messages.
 
         :rtype: dict
         :returns: ``Subscription`` resource returned from the API.
@@ -351,10 +352,10 @@ def subscription_modify_push_config(self, subscription_path,
             the fully-qualified path of the new subscription, in format
             ``projects/<PROJECT>/subscriptions/<SUB_NAME>``.
 
-        :type push_endpoint: str, or ``NoneType``
-        :param push_endpoint: URL to which messages will be pushed by the
-                              back-end.  If not set, the application must pull
-                              messages.
+        :type push_endpoint: str
+        :param push_endpoint:
+            (Optional) URL to which messages will be pushed by the back-end.
+            If not set, the application must pull messages.
         """
         push_config = PushConfig(push_endpoint=push_endpoint)
         try:
diff --git a/packages/google-cloud-pubsub/google/cloud/pubsub/connection.py b/packages/google-cloud-pubsub/google/cloud/pubsub/connection.py
@@ -309,14 +309,15 @@ def subscription_create(self, subscription_path, topic_path,
                            subscribed, in format
                            ``projects/<PROJECT>/topics/<TOPIC_NAME>``.
 
-        :type ack_deadline: int, or ``NoneType``
-        :param ack_deadline: the deadline (in seconds) by which messages pulled
-                            from the back-end must be acknowledged.
+        :type ack_deadline: int
+        :param ack_deadline:
+            (Optional) the deadline (in seconds) by which messages pulled from
+            the back-end must be acknowledged.
 
-        :type push_endpoint: str, or ``NoneType``
-        :param push_endpoint: URL to which messages will be pushed by the
-                              back-end.  If not set, the application must pull
-                              messages.
+        :type push_endpoint: str
+        :param push_endpoint:
+            (Optional) URL to which messages will be pushed by the back-end.
+            If not set, the application must pull messages.
 
         :rtype: dict
         :returns: ``Subscription`` resource returned from the API.
@@ -378,10 +379,10 @@ def subscription_modify_push_config(self, subscription_path,
             the fully-qualified path of the new subscription, in format
             ``projects/<PROJECT>/subscriptions/<SUB_NAME>``.
 
-        :type push_endpoint: str, or ``NoneType``
-        :param push_endpoint: URL to which messages will be pushed by the
-                              back-end.  If not set, the application must pull
-                              messages.
+        :type push_endpoint: str
+        :param push_endpoint:
+            (Optional) URL to which messages will be pushed by the back-end.
+            If not set, the application must pull messages.
         """
         conn = self._connection
         path = '/%s:modifyPushConfig' % (subscription_path,)
diff --git a/packages/google-cloud-pubsub/google/cloud/pubsub/message.py b/packages/google-cloud-pubsub/google/cloud/pubsub/message.py
@@ -32,9 +32,9 @@ class Message(object):
     :type message_id: str
     :param message_id: An ID assigned to the message by the API.
 
-    :type attributes: dict or None
-    :param attributes: Extra metadata associated by the publisher with the
-                       message.
+    :type attributes: dict
+    :param attributes:
+        (Optional) Extra metadata associated by the publisher with the message.
     """
     _service_timestamp = None
 
@@ -80,8 +80,8 @@ def service_timestamp(self):
     def from_api_repr(cls, api_repr):
         """Factory:  construct message from API representation.
 
-        :type api_repr: dict or None
-        :param api_repr: The API representation of the message
+        :type api_repr: dict
+        :param api_repr: (Optional) The API representation of the message
 
         :rtype: :class:`Message`
         :returns: The message created from the response.
diff --git a/packages/google-cloud-pubsub/google/cloud/pubsub/subscription.py b/packages/google-cloud-pubsub/google/cloud/pubsub/subscription.py
@@ -29,22 +29,24 @@ class Subscription(object):
     :type name: str
     :param name: the name of the subscription.
 
-    :type topic: :class:`google.cloud.pubsub.topic.Topic` or ``NoneType``
-    :param topic: the topic to which the subscription belongs;  if ``None``,
-                  the subscription's topic has been deleted.
+    :type topic: :class:`google.cloud.pubsub.topic.Topic`
+    :param topic:
+        (Optional) the topic to which the subscription belongs;  if ``None``,
+        the subscription's topic has been deleted.
 
     :type ack_deadline: int
     :param ack_deadline: the deadline (in seconds) by which messages pulled
                          from the back-end must be acknowledged.
 
     :type push_endpoint: str
-    :param push_endpoint: URL to which messages will be pushed by the back-end.
-                          If not set, the application must pull messages.
-
-    :type client: :class:`~google.cloud.pubsub.client.Client` or
-                  ``NoneType``
-    :param client: the client to use.  If not passed, falls back to the
-                   ``client`` stored on the topic.
+    :param push_endpoint:
+        (Optional) URL to which messages will be pushed by the back-end.  If
+        not set, the application must pull messages.
+
+    :type client: :class:`~google.cloud.pubsub.client.Client`
+    :param client:
+        (Optional) The client to use.  If not passed, falls back to the
+        ``client`` stored on the topic.
     """
 
     _DELETED_TOPIC_PATH = '_deleted-topic_'
@@ -81,9 +83,10 @@ def from_api_repr(cls, resource, client, topics=None):
         :param client: Client which holds credentials and project
                        configuration for a topic.
 
-        :type topics: dict or None
-        :param topics: A mapping of topic names -> topics.  If not passed,
-                       the subscription will have a newly-created topic.
+        :type topics: dict
+        :param topics:
+            (Optional) A mapping of topic names -> topics.  If not passed, the
+            subscription will have a newly-created topic.
 
         :rtype: :class:`google.cloud.pubsub.subscription.Subscription`
         :returns: Subscription parsed from ``resource``.
