Pubsub: Separate subscriber and publish future documentation.

pubsub/google/cloud/pubsub_v1/futures.py

@@ -87,18 +87,12 @@ def done(self):
         return self._exception != self._SENTINEL or self._result != self._SENTINEL
 
     def result(self, timeout=None):
-        """Return the message ID, or raise an exception.
-
-        This blocks until the message has successfully been published, and
-        returns the message ID.
+        """Resolve the future and return a value where appropriate.
 
         Args:
             timeout (Union[int, float]): The number of seconds before this call
                 times out and raises TimeoutError.
 
-        Returns:
-            str: The message ID.
-
         Raises:
             ~.pubsub_v1.TimeoutError: If the request times out.
             Exception: For undefined exceptions in the underlying
@@ -115,9 +109,6 @@ def result(self, timeout=None):
     def exception(self, timeout=None):
         """Return the exception raised by the call, if any.
 
-        This blocks until the message has successfully been published, and
-        returns the exception. If the call succeeded, return None.
-
         Args:
             timeout (Union[int, float]): The number of seconds before this call
                 times out and raises TimeoutError.
@@ -139,15 +130,21 @@ def exception(self, timeout=None):
         # Okay, this batch had an error; this should return it.
         return self._exception
 
-    def add_done_callback(self, fn):
+    def add_done_callback(self, callback):
         """Attach the provided callable to the future.
 
         The provided function is called, with this future as its only argument,
         when the future finishes running.
+
+        Args:
+            callback (Callable): The function to call.
+
+        Returns:
+            None
         """
         if self.done():
-            return fn(self)
-        self._callbacks.append(fn)
+            return callback(self)
+        self._callbacks.append(callback)
 
     def set_result(self, result):
         """Set the result of the future to the provided result.

pubsub/google/cloud/pubsub_v1/publisher/futures.py

@@ -36,13 +36,28 @@ class Future(futures.Future):
             :class:`threading.Event` will be created and used.
     """
 
-    # The publishing-side subclass does not need any special behavior
-    # at this time.
-    #
-    # However, there is still a subclass so that if someone attempts
-    # isinstance checks against a publisher-returned or subscriber-returned
-    # future, trying either one against the other returns False.
-    pass
-
-
-__all__ = ("Future",)
+    def result(self, timeout=None):
+        """Return the message ID or raise an exception.
+
+        This blocks until the message has been published successfully and
+        returns the message ID unless an exception is raised.
+
+        Args:
+            timeout (Union[int, float]): The number of seconds before this call
+                times out and raises TimeoutError.
+
+        Returns:
+            str: The message ID.
+
+        Raises:
+            ~.pubsub_v1.TimeoutError: If the request times out.
+            Exception: For undefined exceptions in the underlying
+                call execution.
+        """
+        # Attempt to get the exception if there is one.
+        # If there is not one, then we know everything worked, and we can
+        # return an appropriate value.
+        err = self.exception(timeout=timeout)
+        if err is None:
+            return self._result
+        raise err

pubsub/google/cloud/pubsub_v1/subscriber/futures.py

@@ -46,5 +46,8 @@ def cancel(self):
         return self._manager.close()
 
     def cancelled(self):
-        """bool: True if the subscription has been cancelled."""
+        """
+        returns:
+            bool: ``True`` if the subscription has been cancelled.
+        """
         return self._cancelled