google-maps-routeoptimization 0.1.7__tar.gz → 0.1.9__tar.gz

{google_maps_routeoptimization-0.1.7/google_maps_routeoptimization.egg-info → google_maps_routeoptimization-0.1.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: google-maps-routeoptimization
-Version: 0.1.7
+Version: 0.1.9
 Summary: Google Maps Routeoptimization API client library
 Home-page: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-maps-routeoptimization
 Author: Google LLC
@@ -23,11 +23,11 @@ Classifier: Operating System :: OS Independent
 Classifier: Topic :: Internet
 Requires-Python: >=3.7
 License-File: LICENSE
-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.0dev,>=1.34.1
-Requires-Dist: google-auth!=2.24.0,!=2.25.0,<3.0.0dev,>=2.14.1
-Requires-Dist: proto-plus<2.0.0dev,>=1.22.3
-Requires-Dist: proto-plus<2.0.0dev,>=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,<6.0.0dev,>=3.20.2
+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.1
+Requires-Dist: google-auth!=2.24.0,!=2.25.0,<3.0.0,>=2.14.1
+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
 
 Python Client for Route Optimization API
 ========================================
@@ -57,12 +57,12 @@ 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 Route Optimization API.`_
-4. `Setup Authentication.`_
+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 Route Optimization API.:  https://developers.google.com/maps/documentation/route-optimization
-.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
+.. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
 
 Installation
 ~~~~~~~~~~~~
@@ -137,3 +137,92 @@ Next Steps
 
 .. _Route Optimization API Product documentation:  https://developers.google.com/maps/documentation/route-optimization
 .. _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.translate_v3 import translate
+    
+    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.translate_v3 import translate
+    
+    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_maps_routeoptimization-0.1.9/README.rst

@@ -0,0 +1,197 @@
+Python Client for Route Optimization API
+========================================
+
+|preview| |pypi| |versions|
+
+`Route Optimization API`_: he Route Optimization API assigns tasks and routes to a vehicle fleet, optimizing against the objectives and constraints that you supply for your transportation goals.
+
+- `Client Library Documentation`_
+- `Product Documentation`_
+
+.. |preview| image:: https://img.shields.io/badge/support-preview-orange.svg
+   :target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels
+.. |pypi| image:: https://img.shields.io/pypi/v/google-maps-routeoptimization.svg
+   :target: https://pypi.org/project/google-maps-routeoptimization/
+.. |versions| image:: https://img.shields.io/pypi/pyversions/google-maps-routeoptimization.svg
+   :target: https://pypi.org/project/google-maps-routeoptimization/
+.. _Route Optimization API: https://developers.google.com/maps/documentation/route-optimization
+.. _Client Library Documentation: https://googleapis.dev/python/google-maps-routeoptimization/latest
+.. _Product Documentation:  https://developers.google.com/maps/documentation/route-optimization
+
+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 Route Optimization API.`_
+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 Route Optimization API.:  https://developers.google.com/maps/documentation/route-optimization
+.. _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-maps-routeoptimization/samples
+
+
+Supported Python Versions
+^^^^^^^^^^^^^^^^^^^^^^^^^
+Our client libraries are compatible with all current `active`_ and `maintenance`_ versions of
+Python.
+
+Python >= 3.7
+
+.. _active: https://devguide.python.org/devcycle/#in-development-main-branch
+.. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches
+
+Unsupported Python Versions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Python <= 3.6
+
+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-maps-routeoptimization
+
+
+Windows
+^^^^^^^
+
+.. code-block:: console
+
+    py -m venv <your-env>
+    .\<your-env>\Scripts\activate
+    pip install google-maps-routeoptimization
+
+Next Steps
+~~~~~~~~~~
+
+-  Read the `Client Library Documentation`_ for Route Optimization API
+   to see other available methods on the client.
+-  Read the `Route Optimization API 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.
+
+.. _Route Optimization API Product documentation:  https://developers.google.com/maps/documentation/route-optimization
+.. _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.translate_v3 import translate
+    
+    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.translate_v3 import translate
+    
+    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_maps_routeoptimization-0.1.7 → google_maps_routeoptimization-0.1.9}/google/maps/routeoptimization/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.1.7"  # {x-release-please-version}
+__version__ = "0.1.9"  # {x-release-please-version}

{google_maps_routeoptimization-0.1.7 → google_maps_routeoptimization-0.1.9}/google/maps/routeoptimization_v1/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.1.7"  # {x-release-please-version}
+__version__ = "0.1.9"  # {x-release-please-version}

{google_maps_routeoptimization-0.1.7 → google_maps_routeoptimization-0.1.9}/google/maps/routeoptimization_v1/services/route_optimization/client.py

@@ -14,6 +14,8 @@
 # limitations under the License.
 #
 from collections import OrderedDict
+from http import HTTPStatus
+import json
 import logging as std_logging
 import os
 import re
@@ -488,6 +490,33 @@ class RouteOptimizationClient(metaclass=RouteOptimizationClientMeta):
         # NOTE (b/349488459): universe validation is disabled until further notice.
         return True
 
+    def _add_cred_info_for_auth_errors(
+        self, error: core_exceptions.GoogleAPICallError
+    ) -> None:
+        """Adds credential info string to error details for 401/403/404 errors.
+
+        Args:
+            error (google.api_core.exceptions.GoogleAPICallError): The error to add the cred info.
+        """
+        if error.code not in [
+            HTTPStatus.UNAUTHORIZED,
+            HTTPStatus.FORBIDDEN,
+            HTTPStatus.NOT_FOUND,
+        ]:
+            return
+
+        cred = self._transport._credentials
+
+        # get_cred_info is only available in google-auth>=2.35.0
+        if not hasattr(cred, "get_cred_info"):
+            return
+
+        # ignore the type check since pypy test fails when get_cred_info
+        # is not available
+        cred_info = cred.get_cred_info()  # type: ignore
+        if cred_info and hasattr(error._details, "append"):
+            error._details.append(json.dumps(cred_info))
+
     @property
     def api_endpoint(self):
         """Return the API endpoint used by the client instance.
@@ -991,16 +1020,20 @@ class RouteOptimizationClient(metaclass=RouteOptimizationClientMeta):
         # Validate the universe domain.
         self._validate_universe_domain()
 
-        # Send the request.
-        response = rpc(
-            request,
-            retry=retry,
-            timeout=timeout,
-            metadata=metadata,
-        )
+        try:
+            # Send the request.
+            response = rpc(
+                request,
+                retry=retry,
+                timeout=timeout,
+                metadata=metadata,
+            )
 
-        # Done; return the response.
-        return response
+            # Done; return the response.
+            return response
+        except core_exceptions.GoogleAPICallError as e:
+            self._add_cred_info_for_auth_errors(e)
+            raise e
 
 
 DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(

{google_maps_routeoptimization-0.1.7 → google_maps_routeoptimization-0.1.9}/google/maps/routeoptimization_v1/services/route_optimization/transports/rest.py

@@ -111,12 +111,35 @@ class RouteOptimizationRestInterceptor:
     ) -> operations_pb2.Operation:
         """Post-rpc interceptor for batch_optimize_tours
 
-        Override in a subclass to manipulate the response
+        DEPRECATED. Please use the `post_batch_optimize_tours_with_metadata`
+        interceptor instead.
+
+        Override in a subclass to read or manipulate the response
         after it is returned by the RouteOptimization server but before
-        it is returned to user code.
+        it is returned to user code. This `post_batch_optimize_tours` interceptor runs
+        before the `post_batch_optimize_tours_with_metadata` interceptor.
         """
         return response
 
+    def post_batch_optimize_tours_with_metadata(
+        self,
+        response: operations_pb2.Operation,
+        metadata: Sequence[Tuple[str, Union[str, bytes]]],
+    ) -> Tuple[operations_pb2.Operation, Sequence[Tuple[str, Union[str, bytes]]]]:
+        """Post-rpc interceptor for batch_optimize_tours
+
+        Override in a subclass to read or manipulate the response or metadata after it
+        is returned by the RouteOptimization server but before it is returned to user code.
+
+        We recommend only using this `post_batch_optimize_tours_with_metadata`
+        interceptor in new development instead of the `post_batch_optimize_tours` interceptor.
+        When both interceptors are used, this `post_batch_optimize_tours_with_metadata` interceptor runs after the
+        `post_batch_optimize_tours` interceptor. The (possibly modified) response returned by
+        `post_batch_optimize_tours` will be passed to
+        `post_batch_optimize_tours_with_metadata`.
+        """
+        return response, metadata
+
     def pre_optimize_tours(
         self,
         request: route_optimization_service.OptimizeToursRequest,
@@ -137,12 +160,38 @@ class RouteOptimizationRestInterceptor:
     ) -> route_optimization_service.OptimizeToursResponse:
         """Post-rpc interceptor for optimize_tours
 
-        Override in a subclass to manipulate the response
+        DEPRECATED. Please use the `post_optimize_tours_with_metadata`
+        interceptor instead.
+
+        Override in a subclass to read or manipulate the response
         after it is returned by the RouteOptimization server but before
-        it is returned to user code.
+        it is returned to user code. This `post_optimize_tours` interceptor runs
+        before the `post_optimize_tours_with_metadata` interceptor.
         """
         return response
 
+    def post_optimize_tours_with_metadata(
+        self,
+        response: route_optimization_service.OptimizeToursResponse,
+        metadata: Sequence[Tuple[str, Union[str, bytes]]],
+    ) -> Tuple[
+        route_optimization_service.OptimizeToursResponse,
+        Sequence[Tuple[str, Union[str, bytes]]],
+    ]:
+        """Post-rpc interceptor for optimize_tours
+
+        Override in a subclass to read or manipulate the response or metadata after it
+        is returned by the RouteOptimization server but before it is returned to user code.
+
+        We recommend only using this `post_optimize_tours_with_metadata`
+        interceptor in new development instead of the `post_optimize_tours` interceptor.
+        When both interceptors are used, this `post_optimize_tours_with_metadata` interceptor runs after the
+        `post_optimize_tours` interceptor. The (possibly modified) response returned by
+        `post_optimize_tours` will be passed to
+        `post_optimize_tours_with_metadata`.
+        """
+        return response, metadata
+
     def pre_get_operation(
         self,
         request: operations_pb2.GetOperationRequest,
@@ -445,6 +494,10 @@ class RouteOptimizationRestTransport(_BaseRouteOptimizationRestTransport):
             json_format.Parse(response.content, resp, ignore_unknown_fields=True)
 
             resp = self._interceptor.post_batch_optimize_tours(resp)
+            response_metadata = [(k, str(v)) for k, v in response.headers.items()]
+            resp, _ = self._interceptor.post_batch_optimize_tours_with_metadata(
+                resp, response_metadata
+            )
             if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(
                 logging.DEBUG
             ):  # pragma: NO COVER
@@ -600,6 +653,10 @@ class RouteOptimizationRestTransport(_BaseRouteOptimizationRestTransport):
             json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True)
 
             resp = self._interceptor.post_optimize_tours(resp)
+            response_metadata = [(k, str(v)) for k, v in response.headers.items()]
+            resp, _ = self._interceptor.post_optimize_tours_with_metadata(
+                resp, response_metadata
+            )
             if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(
                 logging.DEBUG
             ):  # pragma: NO COVER

{google_maps_routeoptimization-0.1.7 → google_maps_routeoptimization-0.1.9/google_maps_routeoptimization.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: google-maps-routeoptimization
-Version: 0.1.7
+Version: 0.1.9
 Summary: Google Maps Routeoptimization API client library
 Home-page: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-maps-routeoptimization
 Author: Google LLC
@@ -23,11 +23,11 @@ Classifier: Operating System :: OS Independent
 Classifier: Topic :: Internet
 Requires-Python: >=3.7
 License-File: LICENSE
-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.0dev,>=1.34.1
-Requires-Dist: google-auth!=2.24.0,!=2.25.0,<3.0.0dev,>=2.14.1
-Requires-Dist: proto-plus<2.0.0dev,>=1.22.3
-Requires-Dist: proto-plus<2.0.0dev,>=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,<6.0.0dev,>=3.20.2
+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.1
+Requires-Dist: google-auth!=2.24.0,!=2.25.0,<3.0.0,>=2.14.1
+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
 
 Python Client for Route Optimization API
 ========================================
@@ -57,12 +57,12 @@ 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 Route Optimization API.`_
-4. `Setup Authentication.`_
+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 Route Optimization API.:  https://developers.google.com/maps/documentation/route-optimization
-.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
+.. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
 
 Installation
 ~~~~~~~~~~~~
@@ -137,3 +137,92 @@ Next Steps
 
 .. _Route Optimization API Product documentation:  https://developers.google.com/maps/documentation/route-optimization
 .. _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.translate_v3 import translate
+    
+    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.translate_v3 import translate
+    
+    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_maps_routeoptimization-0.1.9/google_maps_routeoptimization.egg-info/requires.txt

@@ -0,0 +1,7 @@
+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.1
+google-auth!=2.24.0,!=2.25.0,<3.0.0,>=2.14.1
+proto-plus<2.0.0,>=1.22.3
+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
+
+[:python_version >= "3.13"]
+proto-plus<2.0.0,>=1.25.0

{google_maps_routeoptimization-0.1.7 → google_maps_routeoptimization-0.1.9}/setup.py

@@ -41,13 +41,13 @@ else:
     release_status = "Development Status :: 5 - Production/Stable"
 
 dependencies = [
-    "google-api-core[grpc] >= 1.34.1, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*",
+    "google-api-core[grpc] >= 1.34.1, <3.0.0,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*",
     # Exclude incompatible versions of `google-auth`
     # See https://github.com/googleapis/google-cloud-python/issues/12364
-    "google-auth >= 2.14.1, <3.0.0dev,!=2.24.0,!=2.25.0",
-    "proto-plus >= 1.22.3, <2.0.0dev",
-    "proto-plus >= 1.25.0, <2.0.0dev; python_version >= '3.13'",
-    "protobuf>=3.20.2,<6.0.0dev,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5",
+    "google-auth >= 2.14.1, <3.0.0,!=2.24.0,!=2.25.0",
+    "proto-plus >= 1.22.3, <2.0.0",
+    "proto-plus >= 1.25.0, <2.0.0; python_version >= '3.13'",
+    "protobuf>=3.20.2,<7.0.0,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5",
 ]
 extras = {}
 url = "https://github.com/googleapis/google-cloud-python/tree/main/packages/google-maps-routeoptimization"

{google_maps_routeoptimization-0.1.7 → google_maps_routeoptimization-0.1.9}/tests/unit/gapic/routeoptimization_v1/test_route_optimization.py

@@ -72,6 +72,13 @@ from google.maps.routeoptimization_v1.services.route_optimization import (
 )
 from google.maps.routeoptimization_v1.types import route_optimization_service
 
+CRED_INFO_JSON = {
+    "credential_source": "/path/to/file",
+    "credential_type": "service account credentials",
+    "principal": "service-account@example.com",
+}
+CRED_INFO_STRING = json.dumps(CRED_INFO_JSON)
+
 
 async def mock_async_gen(data, chunk_size=1):
     for i in range(0, len(data)):  # pragma: NO COVER
@@ -339,6 +346,49 @@ def test__get_universe_domain():
     assert str(excinfo.value) == "Universe Domain cannot be an empty string."
 
 
+@pytest.mark.parametrize(
+    "error_code,cred_info_json,show_cred_info",
+    [
+        (401, CRED_INFO_JSON, True),
+        (403, CRED_INFO_JSON, True),
+        (404, CRED_INFO_JSON, True),
+        (500, CRED_INFO_JSON, False),
+        (401, None, False),
+        (403, None, False),
+        (404, None, False),
+        (500, None, False),
+    ],
+)
+def test__add_cred_info_for_auth_errors(error_code, cred_info_json, show_cred_info):
+    cred = mock.Mock(["get_cred_info"])
+    cred.get_cred_info = mock.Mock(return_value=cred_info_json)
+    client = RouteOptimizationClient(credentials=cred)
+    client._transport._credentials = cred
+
+    error = core_exceptions.GoogleAPICallError("message", details=["foo"])
+    error.code = error_code
+
+    client._add_cred_info_for_auth_errors(error)
+    if show_cred_info:
+        assert error.details == ["foo", CRED_INFO_STRING]
+    else:
+        assert error.details == ["foo"]
+
+
+@pytest.mark.parametrize("error_code", [401, 403, 404, 500])
+def test__add_cred_info_for_auth_errors_no_get_cred_info(error_code):
+    cred = mock.Mock([])
+    assert not hasattr(cred, "get_cred_info")
+    client = RouteOptimizationClient(credentials=cred)
+    client._transport._credentials = cred
+
+    error = core_exceptions.GoogleAPICallError("message", details=[])
+    error.code = error_code
+
+    client._add_cred_info_for_auth_errors(error)
+    assert error.details == []
+
+
 @pytest.mark.parametrize(
     "client_class,transport_name",
     [
@@ -2178,10 +2228,13 @@ def test_optimize_tours_rest_interceptors(null_interceptor):
     ) as transcode, mock.patch.object(
         transports.RouteOptimizationRestInterceptor, "post_optimize_tours"
     ) as post, mock.patch.object(
+        transports.RouteOptimizationRestInterceptor, "post_optimize_tours_with_metadata"
+    ) as post_with_metadata, mock.patch.object(
         transports.RouteOptimizationRestInterceptor, "pre_optimize_tours"
     ) as pre:
         pre.assert_not_called()
         post.assert_not_called()
+        post_with_metadata.assert_not_called()
         pb_message = route_optimization_service.OptimizeToursRequest.pb(
             route_optimization_service.OptimizeToursRequest()
         )
@@ -2207,6 +2260,10 @@ def test_optimize_tours_rest_interceptors(null_interceptor):
         ]
         pre.return_value = request, metadata
         post.return_value = route_optimization_service.OptimizeToursResponse()
+        post_with_metadata.return_value = (
+            route_optimization_service.OptimizeToursResponse(),
+            metadata,
+        )
 
         client.optimize_tours(
             request,
@@ -2218,6 +2275,7 @@ def test_optimize_tours_rest_interceptors(null_interceptor):
 
         pre.assert_called_once()
         post.assert_called_once()
+        post_with_metadata.assert_called_once()
 
 
 def test_batch_optimize_tours_rest_bad_request(
@@ -2298,10 +2356,14 @@ def test_batch_optimize_tours_rest_interceptors(null_interceptor):
     ), mock.patch.object(
         transports.RouteOptimizationRestInterceptor, "post_batch_optimize_tours"
     ) as post, mock.patch.object(
+        transports.RouteOptimizationRestInterceptor,
+        "post_batch_optimize_tours_with_metadata",
+    ) as post_with_metadata, mock.patch.object(
         transports.RouteOptimizationRestInterceptor, "pre_batch_optimize_tours"
     ) as pre:
         pre.assert_not_called()
         post.assert_not_called()
+        post_with_metadata.assert_not_called()
         pb_message = route_optimization_service.BatchOptimizeToursRequest.pb(
             route_optimization_service.BatchOptimizeToursRequest()
         )
@@ -2325,6 +2387,7 @@ def test_batch_optimize_tours_rest_interceptors(null_interceptor):
         ]
         pre.return_value = request, metadata
         post.return_value = operations_pb2.Operation()
+        post_with_metadata.return_value = operations_pb2.Operation(), metadata
 
         client.batch_optimize_tours(
             request,
@@ -2336,6 +2399,7 @@ def test_batch_optimize_tours_rest_interceptors(null_interceptor):
 
         pre.assert_called_once()
         post.assert_called_once()
+        post_with_metadata.assert_called_once()
 
 
 def test_get_operation_rest_bad_request(

google_maps_routeoptimization-0.1.7/README.rst

@@ -1,108 +0,0 @@
-Python Client for Route Optimization API
-========================================
-
-|preview| |pypi| |versions|
-
-`Route Optimization API`_: he Route Optimization API assigns tasks and routes to a vehicle fleet, optimizing against the objectives and constraints that you supply for your transportation goals.
-
-- `Client Library Documentation`_
-- `Product Documentation`_
-
-.. |preview| image:: https://img.shields.io/badge/support-preview-orange.svg
-   :target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels
-.. |pypi| image:: https://img.shields.io/pypi/v/google-maps-routeoptimization.svg
-   :target: https://pypi.org/project/google-maps-routeoptimization/
-.. |versions| image:: https://img.shields.io/pypi/pyversions/google-maps-routeoptimization.svg
-   :target: https://pypi.org/project/google-maps-routeoptimization/
-.. _Route Optimization API: https://developers.google.com/maps/documentation/route-optimization
-.. _Client Library Documentation: https://googleapis.dev/python/google-maps-routeoptimization/latest
-.. _Product Documentation:  https://developers.google.com/maps/documentation/route-optimization
-
-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 Route Optimization API.`_
-4. `Setup 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 Route Optimization API.:  https://developers.google.com/maps/documentation/route-optimization
-.. _Setup 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-maps-routeoptimization/samples
-
-
-Supported Python Versions
-^^^^^^^^^^^^^^^^^^^^^^^^^
-Our client libraries are compatible with all current `active`_ and `maintenance`_ versions of
-Python.
-
-Python >= 3.7
-
-.. _active: https://devguide.python.org/devcycle/#in-development-main-branch
-.. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches
-
-Unsupported Python Versions
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Python <= 3.6
-
-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-maps-routeoptimization
-
-
-Windows
-^^^^^^^
-
-.. code-block:: console
-
-    py -m venv <your-env>
-    .\<your-env>\Scripts\activate
-    pip install google-maps-routeoptimization
-
-Next Steps
-~~~~~~~~~~
-
--  Read the `Client Library Documentation`_ for Route Optimization API
-   to see other available methods on the client.
--  Read the `Route Optimization API 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.
-
-.. _Route Optimization API Product documentation:  https://developers.google.com/maps/documentation/route-optimization
-.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst

google_maps_routeoptimization-0.1.7/google_maps_routeoptimization.egg-info/requires.txt

@@ -1,7 +0,0 @@
-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.0dev,>=1.34.1
-google-auth!=2.24.0,!=2.25.0,<3.0.0dev,>=2.14.1
-proto-plus<2.0.0dev,>=1.22.3
-protobuf!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5,<6.0.0dev,>=3.20.2
-
-[:python_version >= "3.13"]
-proto-plus<2.0.0dev,>=1.25.0