From 32bc302cabe988ebe7b1ce8fe186dacf9a096e5a Mon Sep 17 00:00:00 2001 From: dpcollins-google <40498610+dpcollins-google@users.noreply.github.com> Date: Mon, 26 Oct 2020 15:31:08 -0400 Subject: [PATCH] docs: add documentation that Publisher and Subscriber must be used in a `with` block (#55) --- google/cloud/pubsublite/cloudpubsub/publisher.py | 4 ++++ google/cloud/pubsublite/cloudpubsub/subscriber.py | 2 ++ 2 files changed, 6 insertions(+) diff --git a/google/cloud/pubsublite/cloudpubsub/publisher.py b/google/cloud/pubsublite/cloudpubsub/publisher.py index f0b83df1..7824de51 100644 --- a/google/cloud/pubsublite/cloudpubsub/publisher.py +++ b/google/cloud/pubsublite/cloudpubsub/publisher.py @@ -7,6 +7,8 @@ class AsyncPublisher(AsyncContextManager): """ An AsyncPublisher publishes messages similar to Google Pub/Sub, but must be used in an async context. Any publish failures are permanent. + + Must be used in an `async with` block or have __aenter__() awaited before use. """ @abstractmethod @@ -32,6 +34,8 @@ async def publish( class Publisher(ContextManager): """ A Publisher publishes messages similar to Google Pub/Sub. Any publish failures are permanent. + + Must be used in a `with` block or have __enter__() called before use. """ @abstractmethod diff --git a/google/cloud/pubsublite/cloudpubsub/subscriber.py b/google/cloud/pubsublite/cloudpubsub/subscriber.py index 3ba66e44..1015f70b 100644 --- a/google/cloud/pubsublite/cloudpubsub/subscriber.py +++ b/google/cloud/pubsublite/cloudpubsub/subscriber.py @@ -7,6 +7,8 @@ class AsyncSubscriber(AsyncContextManager): """ A Cloud Pub/Sub asynchronous subscriber. + + Must be used in an `async with` block or have __aenter__() awaited before use. """ @abstractmethod