google-cloud-pubsub 2.35.0__tar.gz → 2.37.0__tar.gz

{google_cloud_pubsub-2.35.0/google_cloud_pubsub.egg-info → google_cloud_pubsub-2.37.0}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: google-cloud-pubsub
-Version: 2.35.0
+Version: 2.37.0
 Summary: Google Cloud Pub/Sub API client library
-Home-page: https://github.com/googleapis/python-pubsub
+Home-page: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-pubsub
 Author: Google LLC
 Author-email: googleapis-packages@google.com
 License: Apache 2.0
@@ -22,15 +22,13 @@ Classifier: Operating System :: OS Independent
 Classifier: Topic :: Internet
 Requires-Python: >=3.9
 License-File: LICENSE
+Requires-Dist: google-api-core[grpc]<3.0.0,>=2.11.0
+Requires-Dist: google-auth!=2.24.0,!=2.25.0,<3.0.0,>=2.14.1
 Requires-Dist: grpcio<2.0.0,>=1.51.3; python_version < "3.14"
-Requires-Dist: grpcio<2.0.0,>=1.75.1; python_version >= "3.14"
-Requires-Dist: google-auth<3.0.0,>=2.14.1
-Requires-Dist: google-api-core[grpc]!=2.0.*,!=2.1.*,!=2.10.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,<3.0.0,>=1.34.0
-Requires-Dist: proto-plus<2.0.0,>=1.22.0
-Requires-Dist: proto-plus<2.0.0,>=1.22.2; python_version >= "3.11"
+Requires-Dist: proto-plus<2.0.0,>=1.22.3
 Requires-Dist: proto-plus<2.0.0,>=1.25.0; python_version >= "3.13"
-Requires-Dist: protobuf!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5,<7.0.0,>=3.20.2
-Requires-Dist: grpc-google-iam-v1<1.0.0,>=0.12.4
+Requires-Dist: protobuf<8.0.0,>=4.25.8
+Requires-Dist: grpc-google-iam-v1<1.0.0,>=0.14.0
 Requires-Dist: grpcio-status>=1.33.2
 Requires-Dist: opentelemetry-api>=1.27.0
 Requires-Dist: opentelemetry-sdk>=1.27.0
@@ -49,12 +47,12 @@ Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
 
-Python Client for Google Cloud Pub / Sub
-========================================
+Python Client for Google Cloud Pub/Sub
+======================================
 
-|GA| |pypi| |versions|
+|stable| |pypi| |versions|
 
-`Google Cloud Pub / Sub`_ is a fully-managed real-time messaging service that
+'Google Cloud Pub/Sub:' is a fully-managed real-time messaging service that
 allows you to send and receive messages between independent applications. You
 can leverage Cloud Pub/Sub’s flexibility to decouple systems and components
 hosted on Google Cloud Platform or elsewhere on the Internet. By building on
@@ -67,18 +65,18 @@ can subscribe to that topic to receive the messages. By decoupling senders and
 receivers, Google Cloud Pub/Sub allows developers to communicate between
 independently written applications.
 
-- `Product Documentation`_
 - `Client Library Documentation`_
+- `Product Documentation`_
 
-.. |GA| image:: https://img.shields.io/badge/support-GA-gold.svg
-   :target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#general-availability
+.. |stable| image:: https://img.shields.io/badge/support-stable-gold.svg
+   :target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels
 .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-pubsub.svg
    :target: https://pypi.org/project/google-cloud-pubsub/
 .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-pubsub.svg
    :target: https://pypi.org/project/google-cloud-pubsub/
-.. _Google Cloud Pub / Sub: https://cloud.google.com/pubsub/
-.. _Product Documentation: https://cloud.google.com/pubsub/docs
-.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/pubsub/latest/summary_overview
+.. _Google Cloud Pub/Sub: https://cloud.google.com/pubsub/docs/
+.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/pubsub/latest
+.. _Product Documentation:  https://cloud.google.com/pubsub/docs/
 
 Quick Start
 -----------
@@ -87,50 +85,64 @@ In order to use this library, you first need to go through the following steps:
 
 1. `Select or create a Cloud Platform project.`_
 2. `Enable billing for your project.`_
-3. `Enable the Google Cloud Pub / Sub API.`_
-4. `Setup Authentication.`_
+3. `Enable the Google Cloud Pub/Sub.`_
+4. `Set up Authentication.`_
 
 .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
 .. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
-.. _Enable the Google Cloud Pub / Sub API.:  https://cloud.google.com/pubsub
-.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
+.. _Enable the Google Cloud Pub/Sub.:  https://cloud.google.com/pubsub/docs/
+.. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
 
 Installation
 ~~~~~~~~~~~~
 
-Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
-create isolated Python environments. The basic problem it addresses is one of
-dependencies and versions, and indirectly permissions.
+Install this library in a virtual environment using `venv`_. `venv`_ is a tool that
+creates isolated Python environments. These isolated environments can have separate
+versions of Python packages, which allows you to isolate one project's dependencies
+from the dependencies of other projects.
 
-With `virtualenv`_, it's possible to install this library without needing system
+With `venv`_, it's possible to install this library without needing system
 install permissions, and without clashing with the installed system
 dependencies.
 
-.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
+.. _`venv`: https://docs.python.org/3/library/venv.html
+
+
+Code samples and snippets
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Code samples and snippets live in the `samples/`_ folder.
+
+.. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-pubsub/samples
 
 
 Supported Python Versions
 ^^^^^^^^^^^^^^^^^^^^^^^^^
-Python >= 3.9
+Our client libraries are compatible with all current `active`_ and `maintenance`_ versions of
+Python.
 
-Deprecated Python Versions
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-Python < 3.9
+Python >= 3.9, including 3.14
+
+.. _active: https://devguide.python.org/devcycle/#in-development-main-branch
+.. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches
 
-The last version of this library compatible with Python 3.7 and 3.8 is google-cloud-pubsub==2.34.0.
+Unsupported Python Versions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Python <= 3.8
 
-The last version of this library compatible with Python 2.7 is google-cloud-pubsub==1.7.0.
+If you are using an `end-of-life`_
+version of Python, we recommend that you update as soon as possible to an actively supported version.
 
+.. _end-of-life: https://devguide.python.org/devcycle/#end-of-life-branches
 
 Mac/Linux
 ^^^^^^^^^
 
 .. code-block:: console
 
-    pip install virtualenv
-    virtualenv <your-env>
+    python3 -m venv <your-env>
     source <your-env>/bin/activate
-    <your-env>/bin/pip install google-cloud-pubsub
+    pip install google-cloud-pubsub
 
 
 Windows
@@ -138,11 +150,9 @@ Windows
 
 .. code-block:: console
 
-    pip install virtualenv
-    virtualenv <your-env>
-    <your-env>\Scripts\activate
-    <your-env>\Scripts\pip.exe install google-cloud-pubsub
-
+    py -m venv <your-env>
+    .\<your-env>\Scripts\activate
+    pip install google-cloud-pubsub
 
 Example Usage
 ~~~~~~~~~~~~~
@@ -281,3 +291,105 @@ License
 Apache 2.0 - See `the LICENSE`_ for more information.
 
 .. _the LICENSE: https://github.com/googleapis/google-cloud-python/blob/main/LICENSE
+
+Next Steps
+~~~~~~~~~~
+
+-  Read the `Client Library Documentation`_ for Google Cloud Pub/Sub
+   to see other available methods on the client.
+-  Read the `Google Cloud Pub/Sub Product documentation`_ to learn
+   more about the product and see How-to Guides.
+-  View this `README`_ to see the full list of Cloud
+   APIs that we cover.
+
+.. _Google Cloud Pub/Sub Product documentation:  https://cloud.google.com/pubsub/docs/
+.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst
+
+Logging
+-------
+
+This library uses the standard Python :code:`logging` functionality to log some RPC events that could be of interest for debugging and monitoring purposes.
+Note the following:
+
+#. Logs may contain sensitive information. Take care to **restrict access to the logs** if they are saved, whether it be on local storage or on Google Cloud Logging.
+#. Google may refine the occurrence, level, and content of various log messages in this library without flagging such changes as breaking. **Do not depend on immutability of the logging events**.
+#. By default, the logging events from this library are not handled. You must **explicitly configure log handling** using one of the mechanisms below.
+
+Simple, environment-based configuration
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To enable logging for this library without any changes in your code, set the :code:`GOOGLE_SDK_PYTHON_LOGGING_SCOPE` environment variable to a valid Google
+logging scope. This configures handling of logging events (at level :code:`logging.DEBUG` or higher) from this library in a default manner, emitting the logged
+messages in a structured format. It does not currently allow customizing the logging levels captured nor the handlers, formatters, etc. used for any logging
+event.
+
+A logging scope is a period-separated namespace that begins with :code:`google`, identifying the Python module or package to log.
+
+- Valid logging scopes: :code:`google`, :code:`google.cloud.asset.v1`, :code:`google.api`, :code:`google.auth`, etc.
+- Invalid logging scopes: :code:`foo`, :code:`123`, etc.
+
+**NOTE**: If the logging scope is invalid, the library does not set up any logging handlers.
+
+Environment-Based Examples
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+- Enabling the default handler for all Google-based loggers
+
+.. code-block:: console
+
+    export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google
+
+- Enabling the default handler for a specific Google module (for a client library called :code:`library_v1`):
+
+.. code-block:: console
+
+    export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google.cloud.library_v1
+
+
+Advanced, code-based configuration
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can also configure a valid logging scope using Python's standard `logging` mechanism.
+
+Code-Based Examples
+^^^^^^^^^^^^^^^^^^^
+
+- Configuring a handler for all Google-based loggers
+
+.. code-block:: python
+
+    import logging
+    
+    from google.cloud import library_v1
+    
+    base_logger = logging.getLogger("google")
+    base_logger.addHandler(logging.StreamHandler())
+    base_logger.setLevel(logging.DEBUG)
+
+- Configuring a handler for a specific Google module (for a client library called :code:`library_v1`):
+
+.. code-block:: python
+
+    import logging
+    
+    from google.cloud import library_v1
+    
+    base_logger = logging.getLogger("google.cloud.library_v1")
+    base_logger.addHandler(logging.StreamHandler())
+    base_logger.setLevel(logging.DEBUG)
+
+Logging details
+~~~~~~~~~~~~~~~
+
+#. Regardless of which of the mechanisms above you use to configure logging for this library, by default logging events are not propagated up to the root
+   logger from the `google`-level logger. If you need the events to be propagated to the root logger, you must explicitly set
+   :code:`logging.getLogger("google").propagate = True` in your code.
+#. You can mix the different logging configurations above for different Google modules. For example, you may want use a code-based logging configuration for
+   one library, but decide you need to also set up environment-based logging configuration for another library.
+
+   #. If you attempt to use both code-based and environment-based configuration for the same module, the environment-based configuration will be ineffectual
+      if the code -based configuration gets applied first.
+
+#. The Google-specific logging configurations (default handlers for environment-based configuration; not propagating logging events to the root logger) get
+   executed the first time *any* client library is instantiated in your application, and only if the affected loggers have not been previously configured.
+   (This is the reason for 2.i. above.)

google_cloud_pubsub-2.37.0/README.rst

@@ -0,0 +1,346 @@
+Python Client for Google Cloud Pub/Sub
+======================================
+
+|stable| |pypi| |versions|
+
+'Google Cloud Pub/Sub:' is a fully-managed real-time messaging service that
+allows you to send and receive messages between independent applications. You
+can leverage Cloud Pub/Sub’s flexibility to decouple systems and components
+hosted on Google Cloud Platform or elsewhere on the Internet. By building on
+the same technology Google uses, Cloud Pub / Sub is designed to provide “at
+least once” delivery at low latency with on-demand scalability to 1 million
+messages per second (and beyond).
+
+Publisher applications can send messages to a ``topic`` and other applications
+can subscribe to that topic to receive the messages. By decoupling senders and
+receivers, Google Cloud Pub/Sub allows developers to communicate between
+independently written applications.
+
+- `Client Library Documentation`_
+- `Product Documentation`_
+
+.. |stable| image:: https://img.shields.io/badge/support-stable-gold.svg
+   :target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels
+.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-pubsub.svg
+   :target: https://pypi.org/project/google-cloud-pubsub/
+.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-pubsub.svg
+   :target: https://pypi.org/project/google-cloud-pubsub/
+.. _Google Cloud Pub/Sub: https://cloud.google.com/pubsub/docs/
+.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/pubsub/latest
+.. _Product Documentation:  https://cloud.google.com/pubsub/docs/
+
+Quick Start
+-----------
+
+In order to use this library, you first need to go through the following steps:
+
+1. `Select or create a Cloud Platform project.`_
+2. `Enable billing for your project.`_
+3. `Enable the Google Cloud Pub/Sub.`_
+4. `Set up Authentication.`_
+
+.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
+.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
+.. _Enable the Google Cloud Pub/Sub.:  https://cloud.google.com/pubsub/docs/
+.. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
+
+Installation
+~~~~~~~~~~~~
+
+Install this library in a virtual environment using `venv`_. `venv`_ is a tool that
+creates isolated Python environments. These isolated environments can have separate
+versions of Python packages, which allows you to isolate one project's dependencies
+from the dependencies of other projects.
+
+With `venv`_, it's possible to install this library without needing system
+install permissions, and without clashing with the installed system
+dependencies.
+
+.. _`venv`: https://docs.python.org/3/library/venv.html
+
+
+Code samples and snippets
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Code samples and snippets live in the `samples/`_ folder.
+
+.. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-pubsub/samples
+
+
+Supported Python Versions
+^^^^^^^^^^^^^^^^^^^^^^^^^
+Our client libraries are compatible with all current `active`_ and `maintenance`_ versions of
+Python.
+
+Python >= 3.9, including 3.14
+
+.. _active: https://devguide.python.org/devcycle/#in-development-main-branch
+.. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches
+
+Unsupported Python Versions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Python <= 3.8
+
+If you are using an `end-of-life`_
+version of Python, we recommend that you update as soon as possible to an actively supported version.
+
+.. _end-of-life: https://devguide.python.org/devcycle/#end-of-life-branches
+
+Mac/Linux
+^^^^^^^^^
+
+.. code-block:: console
+
+    python3 -m venv <your-env>
+    source <your-env>/bin/activate
+    pip install google-cloud-pubsub
+
+
+Windows
+^^^^^^^
+
+.. code-block:: console
+
+    py -m venv <your-env>
+    .\<your-env>\Scripts\activate
+    pip install google-cloud-pubsub
+
+Example Usage
+~~~~~~~~~~~~~
+
+Publishing
+^^^^^^^^^^
+
+To publish data to Cloud Pub/Sub you must create a topic, and then publish
+messages to it
+
+.. code-block:: python
+
+    import os
+    from google.cloud import pubsub_v1
+
+    publisher = pubsub_v1.PublisherClient()
+    topic_name = 'projects/{project_id}/topics/{topic}'.format(
+        project_id=os.getenv('GOOGLE_CLOUD_PROJECT'),
+        topic='MY_TOPIC_NAME',  # Set this to something appropriate.
+    )
+    publisher.create_topic(name=topic_name)
+    future = publisher.publish(topic_name, b'My first message!', spam='eggs')
+    future.result()
+
+To learn more, consult the `publishing documentation`_.
+
+.. _publishing documentation: https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.publisher.client.Client
+
+
+Subscribing
+^^^^^^^^^^^
+
+To subscribe to data in Cloud Pub/Sub, you create a subscription based on
+the topic, and subscribe to that, passing a callback function.
+
+.. code-block:: python
+
+    import os
+    from google.cloud import pubsub_v1
+
+    topic_name = 'projects/{project_id}/topics/{topic}'.format(
+        project_id=os.getenv('GOOGLE_CLOUD_PROJECT'),
+        topic='MY_TOPIC_NAME',  # Set this to something appropriate.
+    )
+
+    subscription_name = 'projects/{project_id}/subscriptions/{sub}'.format(
+        project_id=os.getenv('GOOGLE_CLOUD_PROJECT'),
+        sub='MY_SUBSCRIPTION_NAME',  # Set this to something appropriate.
+    )
+
+    def callback(message):
+        print(message.data)
+        message.ack()
+
+    with pubsub_v1.SubscriberClient() as subscriber:
+        subscriber.create_subscription(
+            name=subscription_name, topic=topic_name)
+        future = subscriber.subscribe(subscription_name, callback)
+
+The future returned by the call to ``subscriber.subscribe`` can be used to
+block the current thread until a given condition obtains:
+
+.. code-block:: python
+
+    try:
+        future.result()
+    except KeyboardInterrupt:
+        future.cancel()
+
+It is also possible to pull messages in a synchronous (blocking) fashion. To
+learn more about subscribing, consult the `subscriber documentation`_.
+
+.. _subscriber documentation: https://cloud.google.com/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.subscriber.client.Client
+
+
+Authentication
+^^^^^^^^^^^^^^
+
+It is possible to specify the authentication method to use with the Pub/Sub
+clients. This can be done by providing an explicit `Credentials`_ instance. Support
+for various authentication methods is available from the `google-auth`_ library.
+
+For example, to use JSON Web Tokens, provide a `google.auth.jwt.Credentials`_ instance:
+
+.. code-block:: python
+
+    import json
+    from google.auth import jwt
+
+    service_account_info = json.load(open("service-account-info.json"))
+    audience = "https://pubsub.googleapis.com/google.pubsub.v1.Subscriber"
+
+    credentials = jwt.Credentials.from_service_account_info(
+        service_account_info, audience=audience
+    )
+
+    subscriber = pubsub_v1.SubscriberClient(credentials=credentials)
+
+    # The same for the publisher, except that the "audience" claim needs to be adjusted
+    publisher_audience = "https://pubsub.googleapis.com/google.pubsub.v1.Publisher"
+    credentials_pub = credentials.with_claims(audience=publisher_audience)
+    publisher = pubsub_v1.PublisherClient(credentials=credentials_pub)
+
+.. _Credentials: https://google-auth.readthedocs.io/en/latest/reference/google.auth.credentials.html#google.auth.credentials.Credentials
+.. _google-auth: https://google-auth.readthedocs.io/en/latest/index.html
+.. _google.auth.jwt.Credentials: https://google-auth.readthedocs.io/en/latest/reference/google.auth.jwt.html#google.auth.jwt.Credentials
+
+
+Versioning
+----------
+
+This library follows `Semantic Versioning`_.
+
+It is currently in major version one (1.y.z), which means that the public API should be considered stable.
+
+.. _Semantic Versioning: http://semver.org/
+
+Contributing
+------------
+
+Contributions to this library are always welcome and highly encouraged.
+
+See the `CONTRIBUTING doc`_ for more information on how to get started.
+
+.. _CONTRIBUTING doc: https://github.com/googleapis/google-cloud-python/blob/main/CONTRIBUTING.rst
+
+Community
+---------
+
+The best place to ask questions is via Stackoverflow: https://stackoverflow.com/questions/tagged/google-cloud-pubsub
+
+
+License
+-------
+
+Apache 2.0 - See `the LICENSE`_ for more information.
+
+.. _the LICENSE: https://github.com/googleapis/google-cloud-python/blob/main/LICENSE
+
+Next Steps
+~~~~~~~~~~
+
+-  Read the `Client Library Documentation`_ for Google Cloud Pub/Sub
+   to see other available methods on the client.
+-  Read the `Google Cloud Pub/Sub Product documentation`_ to learn
+   more about the product and see How-to Guides.
+-  View this `README`_ to see the full list of Cloud
+   APIs that we cover.
+
+.. _Google Cloud Pub/Sub Product documentation:  https://cloud.google.com/pubsub/docs/
+.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst
+
+Logging
+-------
+
+This library uses the standard Python :code:`logging` functionality to log some RPC events that could be of interest for debugging and monitoring purposes.
+Note the following:
+
+#. Logs may contain sensitive information. Take care to **restrict access to the logs** if they are saved, whether it be on local storage or on Google Cloud Logging.
+#. Google may refine the occurrence, level, and content of various log messages in this library without flagging such changes as breaking. **Do not depend on immutability of the logging events**.
+#. By default, the logging events from this library are not handled. You must **explicitly configure log handling** using one of the mechanisms below.
+
+Simple, environment-based configuration
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To enable logging for this library without any changes in your code, set the :code:`GOOGLE_SDK_PYTHON_LOGGING_SCOPE` environment variable to a valid Google
+logging scope. This configures handling of logging events (at level :code:`logging.DEBUG` or higher) from this library in a default manner, emitting the logged
+messages in a structured format. It does not currently allow customizing the logging levels captured nor the handlers, formatters, etc. used for any logging
+event.
+
+A logging scope is a period-separated namespace that begins with :code:`google`, identifying the Python module or package to log.
+
+- Valid logging scopes: :code:`google`, :code:`google.cloud.asset.v1`, :code:`google.api`, :code:`google.auth`, etc.
+- Invalid logging scopes: :code:`foo`, :code:`123`, etc.
+
+**NOTE**: If the logging scope is invalid, the library does not set up any logging handlers.
+
+Environment-Based Examples
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+- Enabling the default handler for all Google-based loggers
+
+.. code-block:: console
+
+    export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google
+
+- Enabling the default handler for a specific Google module (for a client library called :code:`library_v1`):
+
+.. code-block:: console
+
+    export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google.cloud.library_v1
+
+
+Advanced, code-based configuration
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can also configure a valid logging scope using Python's standard `logging` mechanism.
+
+Code-Based Examples
+^^^^^^^^^^^^^^^^^^^
+
+- Configuring a handler for all Google-based loggers
+
+.. code-block:: python
+
+    import logging
+    
+    from google.cloud import library_v1
+    
+    base_logger = logging.getLogger("google")
+    base_logger.addHandler(logging.StreamHandler())
+    base_logger.setLevel(logging.DEBUG)
+
+- Configuring a handler for a specific Google module (for a client library called :code:`library_v1`):
+
+.. code-block:: python
+
+    import logging
+    
+    from google.cloud import library_v1
+    
+    base_logger = logging.getLogger("google.cloud.library_v1")
+    base_logger.addHandler(logging.StreamHandler())
+    base_logger.setLevel(logging.DEBUG)
+
+Logging details
+~~~~~~~~~~~~~~~
+
+#. Regardless of which of the mechanisms above you use to configure logging for this library, by default logging events are not propagated up to the root
+   logger from the `google`-level logger. If you need the events to be propagated to the root logger, you must explicitly set
+   :code:`logging.getLogger("google").propagate = True` in your code.
+#. You can mix the different logging configurations above for different Google modules. For example, you may want use a code-based logging configuration for
+   one library, but decide you need to also set up environment-based logging configuration for another library.
+
+   #. If you attempt to use both code-based and environment-based configuration for the same module, the environment-based configuration will be ineffectual
+      if the code -based configuration gets applied first.
+
+#. The Google-specific logging configurations (default handlers for environment-based configuration; not propagating logging events to the root logger) get
+   executed the first time *any* client library is instantiated in your application, and only if the affected loggers have not been previously configured.
+   (This is the reason for 2.i. above.)

{google_cloud_pubsub-2.35.0 → google_cloud_pubsub-2.37.0}/google/cloud/pubsub/__init__.py

@@ -17,11 +17,12 @@
 
 from __future__ import absolute_import
 
-from google.cloud.pubsub_v1 import PublisherClient
-from google.cloud.pubsub_v1 import SubscriberClient
-from google.cloud.pubsub_v1 import SchemaServiceClient
-from google.cloud.pubsub_v1 import types
-
+from google.cloud.pubsub_v1 import (
+    PublisherClient,
+    SchemaServiceClient,
+    SubscriberClient,
+    types,
+)
 
 __all__ = (
     "types",

{google_cloud_pubsub-2.35.0 → google_cloud_pubsub-2.37.0}/google/cloud/pubsub_v1/__init__.py

@@ -14,9 +14,7 @@
 
 from __future__ import absolute_import
 
-from google.cloud.pubsub_v1 import types
-from google.cloud.pubsub_v1 import publisher
-from google.cloud.pubsub_v1 import subscriber
+from google.cloud.pubsub_v1 import publisher, subscriber, types
 from google.pubsub_v1.services import schema_service
 
 

{google_cloud_pubsub-2.35.0 → google_cloud_pubsub-2.37.0}/google/cloud/pubsub_v1/exceptions.py

@@ -16,5 +16,4 @@ from __future__ import absolute_import
 
 from concurrent.futures import TimeoutError
 
-
 __all__ = ("TimeoutError",)

{google_cloud_pubsub-2.35.0 → google_cloud_pubsub-2.37.0}/google/cloud/pubsub_v1/open_telemetry/context_propagation.py

@@ -12,9 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import Optional, List
+from typing import List, Optional
 
-from opentelemetry.propagators.textmap import Setter, Getter
+from opentelemetry.propagators.textmap import Getter, Setter
 
 from google.pubsub_v1 import PubsubMessage