google-maps-routeoptimization 0.4.0__tar.gz → 0.5.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/MANIFEST.in +1 -1
  2. {google_maps_routeoptimization-0.4.0/google_maps_routeoptimization.egg-info → google_maps_routeoptimization-0.5.1}/PKG-INFO +22 -20
  3. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/README.rst +14 -11
  4. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization/__init__.py +1 -1
  5. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization/gapic_version.py +2 -2
  6. google_maps_routeoptimization-0.5.1/google/maps/routeoptimization_v1/__init__.py +113 -0
  7. google_maps_routeoptimization-0.5.1/google/maps/routeoptimization_v1/_compat.py +262 -0
  8. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/gapic_version.py +2 -2
  9. {google_maps_routeoptimization-0.4.0/tests/unit → google_maps_routeoptimization-0.5.1/google/maps/routeoptimization_v1/services}/__init__.py +1 -1
  10. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/services/route_optimization/__init__.py +1 -1
  11. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/services/route_optimization/async_client.py +8 -10
  12. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/services/route_optimization/client.py +25 -164
  13. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/services/route_optimization/transports/__init__.py +1 -1
  14. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/services/route_optimization/transports/base.py +2 -4
  15. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/services/route_optimization/transports/grpc.py +1 -1
  16. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/services/route_optimization/transports/grpc_asyncio.py +1 -1
  17. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/services/route_optimization/transports/rest.py +48 -59
  18. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/services/route_optimization/transports/rest_base.py +1 -174
  19. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/types/__init__.py +1 -1
  20. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/types/route_optimization_service.py +4 -3
  21. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1/google_maps_routeoptimization.egg-info}/PKG-INFO +22 -20
  22. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/google_maps_routeoptimization.egg-info/SOURCES.txt +2 -0
  23. google_maps_routeoptimization-0.5.1/google_maps_routeoptimization.egg-info/requires.txt +8 -0
  24. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/setup.py +12 -10
  25. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/tests/__init__.py +1 -1
  26. {google_maps_routeoptimization-0.4.0/tests/unit/gapic → google_maps_routeoptimization-0.5.1/tests/unit}/__init__.py +1 -1
  27. {google_maps_routeoptimization-0.4.0/google/maps/routeoptimization_v1/services → google_maps_routeoptimization-0.5.1/tests/unit/gapic}/__init__.py +1 -1
  28. google_maps_routeoptimization-0.5.1/tests/unit/gapic/routeoptimization_v1/__init__.py +15 -0
  29. google_maps_routeoptimization-0.5.1/tests/unit/gapic/routeoptimization_v1/test_compat.py +429 -0
  30. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/tests/unit/gapic/routeoptimization_v1/test_route_optimization.py +140 -465
  31. google_maps_routeoptimization-0.4.0/google/maps/routeoptimization_v1/__init__.py +0 -202
  32. google_maps_routeoptimization-0.4.0/google_maps_routeoptimization.egg-info/requires.txt +0 -11
  33. google_maps_routeoptimization-0.4.0/tests/unit/gapic/routeoptimization_v1/__init__.py +0 -15
  34. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/LICENSE +0 -0
  35. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization/py.typed +0 -0
  36. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/gapic_metadata.json +0 -0
  37. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/py.typed +0 -0
  38. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/google_maps_routeoptimization.egg-info/dependency_links.txt +0 -0
  39. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/google_maps_routeoptimization.egg-info/not-zip-safe +0 -0
  40. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/google_maps_routeoptimization.egg-info/top_level.txt +0 -0
  41. {google_maps_routeoptimization-0.4.0 → google_maps_routeoptimization-0.5.1}/setup.cfg +0 -0
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2025 Google LLC
2
+ # Copyright 2026 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -1,34 +1,33 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: google-maps-routeoptimization
3
- Version: 0.4.0
3
+ Version: 0.5.1
4
4
  Summary: Google Maps Routeoptimization API client library
5
5
  Home-page: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-maps-routeoptimization
6
6
  Author: Google LLC
7
7
  Author-email: googleapis-packages@google.com
8
- License: Apache 2.0
8
+ License: Apache-2.0
9
9
  Platform: Posix; MacOS X; Windows
10
10
  Classifier: Development Status :: 4 - Beta
11
11
  Classifier: Intended Audience :: Developers
12
12
  Classifier: License :: OSI Approved :: Apache Software License
13
13
  Classifier: Programming Language :: Python
14
14
  Classifier: Programming Language :: Python :: 3
15
- Classifier: Programming Language :: Python :: 3.9
16
15
  Classifier: Programming Language :: Python :: 3.10
17
16
  Classifier: Programming Language :: Python :: 3.11
18
17
  Classifier: Programming Language :: Python :: 3.12
19
18
  Classifier: Programming Language :: Python :: 3.13
20
19
  Classifier: Programming Language :: Python :: 3.14
20
+ Classifier: Programming Language :: Python :: 3.15
21
21
  Classifier: Operating System :: OS Independent
22
22
  Classifier: Topic :: Internet
23
- Requires-Python: >=3.9
23
+ Requires-Python: >=3.10
24
24
  License-File: LICENSE
25
- Requires-Dist: google-api-core[grpc]<3.0.0,>=2.11.0
25
+ Requires-Dist: google-api-core[grpc]<3.0.0,>=2.28.0
26
26
  Requires-Dist: google-auth!=2.24.0,!=2.25.0,<3.0.0,>=2.14.1
27
- Requires-Dist: grpcio<2.0.0,>=1.33.2
27
+ Requires-Dist: grpcio<2.0.0,>=1.59.0
28
28
  Requires-Dist: grpcio<2.0.0,>=1.75.1; python_version >= "3.14"
29
- Requires-Dist: proto-plus<2.0.0,>=1.22.3
30
- Requires-Dist: proto-plus<2.0.0,>=1.25.0; python_version >= "3.13"
31
- Requires-Dist: protobuf<8.0.0,>=4.25.8
29
+ Requires-Dist: proto-plus<2.0.0,>=1.26.1
30
+ Requires-Dist: protobuf<8.0.0,>=6.33.5
32
31
  Dynamic: author
33
32
  Dynamic: author-email
34
33
  Dynamic: classifier
@@ -41,12 +40,14 @@ Dynamic: requires-dist
41
40
  Dynamic: requires-python
42
41
  Dynamic: summary
43
42
 
44
- Python Client for Route Optimization API
45
- ========================================
43
+ Python Client for Route Optimization
44
+ ====================================
46
45
 
47
46
  |preview| |pypi| |versions|
48
47
 
49
- `Route Optimization API`_: The Route Optimization API assigns tasks and routes to a vehicle fleet, optimizing against the objectives and constraints that you supply for your transportation goals.
48
+ `Route Optimization`_: The Route Optimization API assigns tasks and routes to a vehicle fleet,
49
+ optimizing against the objectives and constraints that you supply for your
50
+ transportation goals.
50
51
 
51
52
  - `Client Library Documentation`_
52
53
  - `Product Documentation`_
@@ -57,7 +58,7 @@ Python Client for Route Optimization API
57
58
  :target: https://pypi.org/project/google-maps-routeoptimization/
58
59
  .. |versions| image:: https://img.shields.io/pypi/pyversions/google-maps-routeoptimization.svg
59
60
  :target: https://pypi.org/project/google-maps-routeoptimization/
60
- .. _Route Optimization API: https://developers.google.com/maps/documentation/route-optimization
61
+ .. _Route Optimization: https://developers.google.com/maps/documentation/route-optimization
61
62
  .. _Client Library Documentation: https://googleapis.dev/python/google-maps-routeoptimization/latest
62
63
  .. _Product Documentation: https://developers.google.com/maps/documentation/route-optimization
63
64
 
@@ -68,12 +69,12 @@ In order to use this library, you first need to go through the following steps:
68
69
 
69
70
  1. `Select or create a Cloud Platform project.`_
70
71
  2. `Enable billing for your project.`_
71
- 3. `Enable the Route Optimization API.`_
72
+ 3. `Enable the Route Optimization.`_
72
73
  4. `Set up Authentication.`_
73
74
 
74
75
  .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
75
76
  .. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
76
- .. _Enable the Route Optimization API.: https://developers.google.com/maps/documentation/route-optimization
77
+ .. _Enable the Route Optimization.: https://developers.google.com/maps/documentation/route-optimization
77
78
  .. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
78
79
 
79
80
  Installation
@@ -104,14 +105,15 @@ Supported Python Versions
104
105
  Our client libraries are compatible with all current `active`_ and `maintenance`_ versions of
105
106
  Python.
106
107
 
107
- Python >= 3.9, including 3.14
108
+ Python >= 3.10, including 3.14
108
109
 
109
110
  .. _active: https://devguide.python.org/devcycle/#in-development-main-branch
110
111
  .. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches
111
112
 
112
113
  Unsupported Python Versions
113
114
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^
114
- Python <= 3.8
115
+ Python <= 3.9
116
+
115
117
 
116
118
  If you are using an `end-of-life`_
117
119
  version of Python, we recommend that you update as soon as possible to an actively supported version.
@@ -140,14 +142,14 @@ Windows
140
142
  Next Steps
141
143
  ~~~~~~~~~~
142
144
 
143
- - Read the `Client Library Documentation`_ for Route Optimization API
145
+ - Read the `Client Library Documentation`_ for Route Optimization
144
146
  to see other available methods on the client.
145
- - Read the `Route Optimization API Product documentation`_ to learn
147
+ - Read the `Route Optimization Product documentation`_ to learn
146
148
  more about the product and see How-to Guides.
147
149
  - View this `README`_ to see the full list of Cloud
148
150
  APIs that we cover.
149
151
 
150
- .. _Route Optimization API Product documentation: https://developers.google.com/maps/documentation/route-optimization
152
+ .. _Route Optimization Product documentation: https://developers.google.com/maps/documentation/route-optimization
151
153
  .. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst
152
154
 
153
155
  Logging
@@ -1,9 +1,11 @@
1
- Python Client for Route Optimization API
2
- ========================================
1
+ Python Client for Route Optimization
2
+ ====================================
3
3
 
4
4
  |preview| |pypi| |versions|
5
5
 
6
- `Route Optimization API`_: The Route Optimization API assigns tasks and routes to a vehicle fleet, optimizing against the objectives and constraints that you supply for your transportation goals.
6
+ `Route Optimization`_: The Route Optimization API assigns tasks and routes to a vehicle fleet,
7
+ optimizing against the objectives and constraints that you supply for your
8
+ transportation goals.
7
9
 
8
10
  - `Client Library Documentation`_
9
11
  - `Product Documentation`_
@@ -14,7 +16,7 @@ Python Client for Route Optimization API
14
16
  :target: https://pypi.org/project/google-maps-routeoptimization/
15
17
  .. |versions| image:: https://img.shields.io/pypi/pyversions/google-maps-routeoptimization.svg
16
18
  :target: https://pypi.org/project/google-maps-routeoptimization/
17
- .. _Route Optimization API: https://developers.google.com/maps/documentation/route-optimization
19
+ .. _Route Optimization: https://developers.google.com/maps/documentation/route-optimization
18
20
  .. _Client Library Documentation: https://googleapis.dev/python/google-maps-routeoptimization/latest
19
21
  .. _Product Documentation: https://developers.google.com/maps/documentation/route-optimization
20
22
 
@@ -25,12 +27,12 @@ In order to use this library, you first need to go through the following steps:
25
27
 
26
28
  1. `Select or create a Cloud Platform project.`_
27
29
  2. `Enable billing for your project.`_
28
- 3. `Enable the Route Optimization API.`_
30
+ 3. `Enable the Route Optimization.`_
29
31
  4. `Set up Authentication.`_
30
32
 
31
33
  .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
32
34
  .. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
33
- .. _Enable the Route Optimization API.: https://developers.google.com/maps/documentation/route-optimization
35
+ .. _Enable the Route Optimization.: https://developers.google.com/maps/documentation/route-optimization
34
36
  .. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
35
37
 
36
38
  Installation
@@ -61,14 +63,15 @@ Supported Python Versions
61
63
  Our client libraries are compatible with all current `active`_ and `maintenance`_ versions of
62
64
  Python.
63
65
 
64
- Python >= 3.9, including 3.14
66
+ Python >= 3.10, including 3.14
65
67
 
66
68
  .. _active: https://devguide.python.org/devcycle/#in-development-main-branch
67
69
  .. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches
68
70
 
69
71
  Unsupported Python Versions
70
72
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^
71
- Python <= 3.8
73
+ Python <= 3.9
74
+
72
75
 
73
76
  If you are using an `end-of-life`_
74
77
  version of Python, we recommend that you update as soon as possible to an actively supported version.
@@ -97,14 +100,14 @@ Windows
97
100
  Next Steps
98
101
  ~~~~~~~~~~
99
102
 
100
- - Read the `Client Library Documentation`_ for Route Optimization API
103
+ - Read the `Client Library Documentation`_ for Route Optimization
101
104
  to see other available methods on the client.
102
- - Read the `Route Optimization API Product documentation`_ to learn
105
+ - Read the `Route Optimization Product documentation`_ to learn
103
106
  more about the product and see How-to Guides.
104
107
  - View this `README`_ to see the full list of Cloud
105
108
  APIs that we cover.
106
109
 
107
- .. _Route Optimization API Product documentation: https://developers.google.com/maps/documentation/route-optimization
110
+ .. _Route Optimization Product documentation: https://developers.google.com/maps/documentation/route-optimization
108
111
  .. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst
109
112
 
110
113
  Logging
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2025 Google LLC
2
+ # Copyright 2026 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2025 Google LLC
2
+ # Copyright 2026 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -13,4 +13,4 @@
13
13
  # See the License for the specific language governing permissions and
14
14
  # limitations under the License.
15
15
  #
16
- __version__ = "0.4.0" # {x-release-please-version}
16
+ __version__ = "0.5.1" # {x-release-please-version}
@@ -0,0 +1,113 @@
1
+ # -*- coding: utf-8 -*-
2
+ # Copyright 2026 Google LLC
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
15
+ #
16
+ import google.api_core as api_core
17
+
18
+ from google.maps.routeoptimization_v1 import gapic_version as package_version
19
+
20
+ __version__ = package_version.__version__
21
+
22
+ # PEP 0810: Explicit Lazy Imports
23
+ # Python 3.15+ natively intercepts and defers these imports.
24
+ # Developers can disable this behavior and force eager imports.
25
+ # For more information, see:
26
+ # https://docs.python.org/3.15/library/sys.html#sys.set_lazy_imports_filter
27
+ # Older Python versions safely ignore this variable.
28
+ __lazy_modules__ = {
29
+ "google.maps.routeoptimization_v1.services.route_optimization",
30
+ "google.maps.routeoptimization_v1.types.route_optimization_service",
31
+ }
32
+
33
+
34
+ from .services.route_optimization import (
35
+ RouteOptimizationAsyncClient,
36
+ RouteOptimizationClient,
37
+ )
38
+ from .types.route_optimization_service import (
39
+ AggregatedMetrics,
40
+ BatchOptimizeToursMetadata,
41
+ BatchOptimizeToursRequest,
42
+ BatchOptimizeToursResponse,
43
+ BreakRule,
44
+ DataFormat,
45
+ DistanceLimit,
46
+ GcsDestination,
47
+ GcsSource,
48
+ InjectedSolutionConstraint,
49
+ InputConfig,
50
+ Location,
51
+ OptimizeToursLongRunningMetadata,
52
+ OptimizeToursRequest,
53
+ OptimizeToursResponse,
54
+ OptimizeToursUriMetadata,
55
+ OptimizeToursUriRequest,
56
+ OptimizeToursUriResponse,
57
+ OptimizeToursValidationError,
58
+ OutputConfig,
59
+ RouteModifiers,
60
+ Shipment,
61
+ ShipmentModel,
62
+ ShipmentRoute,
63
+ ShipmentTypeIncompatibility,
64
+ ShipmentTypeRequirement,
65
+ SkippedShipment,
66
+ TimeWindow,
67
+ TransitionAttributes,
68
+ Uri,
69
+ Vehicle,
70
+ VehicleFullness,
71
+ Waypoint,
72
+ )
73
+
74
+ __all__ = (
75
+ "RouteOptimizationAsyncClient",
76
+ "AggregatedMetrics",
77
+ "BatchOptimizeToursMetadata",
78
+ "BatchOptimizeToursRequest",
79
+ "BatchOptimizeToursResponse",
80
+ "BreakRule",
81
+ "DataFormat",
82
+ "DistanceLimit",
83
+ "GcsDestination",
84
+ "GcsSource",
85
+ "InjectedSolutionConstraint",
86
+ "InputConfig",
87
+ "Location",
88
+ "OptimizeToursLongRunningMetadata",
89
+ "OptimizeToursRequest",
90
+ "OptimizeToursResponse",
91
+ "OptimizeToursUriMetadata",
92
+ "OptimizeToursUriRequest",
93
+ "OptimizeToursUriResponse",
94
+ "OptimizeToursValidationError",
95
+ "OutputConfig",
96
+ "RouteModifiers",
97
+ "RouteOptimizationClient",
98
+ "Shipment",
99
+ "ShipmentModel",
100
+ "ShipmentRoute",
101
+ "ShipmentTypeIncompatibility",
102
+ "ShipmentTypeRequirement",
103
+ "SkippedShipment",
104
+ "TimeWindow",
105
+ "TransitionAttributes",
106
+ "Uri",
107
+ "Vehicle",
108
+ "VehicleFullness",
109
+ "Waypoint",
110
+ )
111
+
112
+ api_core.check_python_version("google.maps.routeoptimization_v1")
113
+ api_core.check_dependency_versions("google.maps.routeoptimization_v1")
@@ -0,0 +1,262 @@
1
+ # -*- coding: utf-8 -*-
2
+ # Copyright 2026 Google LLC
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
15
+ #
16
+ """A compatibility module for older versions of google-api-core."""
17
+
18
+ import json
19
+ import os
20
+ from typing import Any, Dict, List, Optional, Tuple
21
+ from urllib.parse import urlparse, urlunparse
22
+
23
+ from google.api_core import path_template
24
+ from google.api_core.universe import EmptyUniverseError
25
+ from google.auth.exceptions import MutualTLSChannelError
26
+ from google.protobuf import json_format
27
+
28
+ try:
29
+ # note: `#type: ignore` is added because the return type for `should_use_client_cert`
30
+ # is different than that of the fallback implementation below. This will be removed once
31
+ # we bump the minimum supported version of google-auth.
32
+ from google.auth.transport.mtls import should_use_client_cert # type: ignore
33
+ except ImportError: # pragma: NO COVER
34
+
35
+ def should_use_client_cert():
36
+ """Returns whether client certificate should be used for mTLS."""
37
+ use_client_cert = os.getenv(
38
+ "GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"
39
+ ).lower()
40
+ if use_client_cert not in ("true", "false"):
41
+ raise ValueError(
42
+ "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be"
43
+ " either `true` or `false`"
44
+ )
45
+ return use_client_cert == "true"
46
+
47
+
48
+ def read_environment_variables():
49
+ """Returns the environment variables used by the client.
50
+
51
+ Returns:
52
+ Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE,
53
+ GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables.
54
+
55
+ Raises:
56
+ ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not
57
+ any of ["true", "false"].
58
+ google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT
59
+ is not any of ["auto", "never", "always"].
60
+ """
61
+ use_client_cert = should_use_client_cert()
62
+ use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower()
63
+ universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN")
64
+ if use_mtls_endpoint not in ("auto", "never", "always"):
65
+ raise MutualTLSChannelError(
66
+ "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`,"
67
+ " `auto` or `always`"
68
+ )
69
+ return use_client_cert, use_mtls_endpoint, universe_domain_env
70
+
71
+
72
+ DEFAULT_UNIVERSE = "googleapis.com"
73
+
74
+ try:
75
+ from google.api_core.universe import get_default_mtls_endpoint
76
+ except ImportError: # pragma: NO COVER
77
+
78
+ def get_default_mtls_endpoint(api_endpoint: Optional[str]) -> Optional[str]:
79
+ """Converts api endpoint to mTLS endpoint.
80
+
81
+ Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to
82
+ "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively.
83
+ Other URLs (including those that do not match these domain suffixes or
84
+ already contain '.mtls.') are passed through as-is.
85
+
86
+ Args:
87
+ api_endpoint (Optional[str]): the api endpoint to convert.
88
+
89
+ Returns:
90
+ Optional[str]: converted mTLS api endpoint.
91
+ """
92
+ if not api_endpoint or ".mtls." in api_endpoint.lower():
93
+ return api_endpoint
94
+
95
+ has_scheme = "://" in api_endpoint
96
+ if not has_scheme:
97
+ parsed = urlparse("//" + api_endpoint)
98
+ else:
99
+ parsed = urlparse(api_endpoint)
100
+
101
+ host = parsed.hostname
102
+ if not host:
103
+ return api_endpoint
104
+
105
+ port = f":{parsed.port}" if parsed.port else ""
106
+
107
+ lowered_host = host.lower()
108
+ suffix_sandbox = ".sandbox.googleapis.com"
109
+ suffix_google = ".googleapis.com"
110
+ if lowered_host.endswith(suffix_sandbox):
111
+ new_host = host[: -len(suffix_sandbox)] + ".mtls.sandbox.googleapis.com"
112
+ elif lowered_host.endswith(suffix_google):
113
+ new_host = host[: -len(suffix_google)] + ".mtls.googleapis.com"
114
+ else:
115
+ return api_endpoint
116
+
117
+ netloc = new_host + port
118
+ new_parsed = parsed._replace(netloc=netloc)
119
+
120
+ if not has_scheme:
121
+ return urlunparse(new_parsed)[2:]
122
+ else:
123
+ return urlunparse(new_parsed)
124
+
125
+
126
+ try:
127
+ from google.api_core.universe import get_api_endpoint
128
+ except ImportError: # pragma: NO COVER
129
+
130
+ def get_api_endpoint(
131
+ api_override: Optional[str],
132
+ universe_domain: str,
133
+ default_universe: str,
134
+ default_mtls_endpoint: Optional[str],
135
+ default_endpoint_template: str,
136
+ use_mtls: bool,
137
+ ) -> str:
138
+ """Return the API endpoint used by the client.
139
+
140
+ Args:
141
+ api_override (Optional[str]): The API endpoint override. If specified,
142
+ this is always returned.
143
+ universe_domain (str): The universe domain used by the client.
144
+ default_universe (str): The default universe domain.
145
+ default_mtls_endpoint (Optional[str]): The default mTLS endpoint.
146
+ default_endpoint_template (str): The default endpoint template containing
147
+ a placeholder `{UNIVERSE_DOMAIN}`.
148
+ use_mtls (bool): Whether to use the mTLS endpoint.
149
+
150
+ Returns:
151
+ str: The API endpoint to be used by the client.
152
+
153
+ Raises:
154
+ google.auth.exceptions.MutualTLSChannelError: If mTLS is requested but
155
+ not supported in the configured universe domain.
156
+ ValueError: If mTLS is requested but no mTLS endpoint is available.
157
+ """
158
+ if api_override is not None:
159
+ return api_override
160
+
161
+ if use_mtls:
162
+ if universe_domain.lower() != default_universe.lower():
163
+ raise MutualTLSChannelError(
164
+ f"mTLS is not supported in any universe other than {default_universe}."
165
+ )
166
+ if not default_mtls_endpoint:
167
+ raise ValueError("mTLS endpoint is not available.")
168
+ return default_mtls_endpoint
169
+ else:
170
+ return default_endpoint_template.format(UNIVERSE_DOMAIN=universe_domain)
171
+
172
+
173
+ try:
174
+ from google.api_core.universe import get_universe_domain
175
+ except ImportError: # pragma: NO COVER
176
+
177
+ def get_universe_domain(
178
+ *potential_universes: Optional[str],
179
+ default_universe: str,
180
+ ) -> str:
181
+ """Return the universe domain used by the client.
182
+
183
+ Args:
184
+ *potential_universes (Optional[str]): Potential universe domains in order of preference.
185
+ default_universe (str): The default universe domain.
186
+
187
+ Returns:
188
+ str: The universe domain to be used by the client.
189
+
190
+ Raises:
191
+ EmptyUniverseError: If the resolved universe domain is an empty string.
192
+ """
193
+ resolved = next(
194
+ (x.strip() for x in potential_universes if x is not None),
195
+ default_universe,
196
+ )
197
+
198
+ if not resolved:
199
+ raise EmptyUniverseError()
200
+ return resolved
201
+
202
+
203
+ try:
204
+ from google.api_core.rest_helpers import transcode_request # type: ignore
205
+ except ImportError: # pragma: NO COVER
206
+
207
+ def transcode_request(
208
+ http_options: List[Dict[str, str]],
209
+ request: Any,
210
+ required_fields_default_values: Optional[Dict[str, Any]] = None,
211
+ rest_numeric_enums: bool = False,
212
+ ) -> Tuple[Dict[str, Any], Optional[str], Dict[str, Any]]:
213
+ """Transcodes a request into HTTP method, URI, body, and query parameters.
214
+
215
+ Args:
216
+ http_options (List[Dict[str, str]]): List of HTTP transcoding rules.
217
+ request (Any): The protobuf or proto-plus request message.
218
+ required_fields_default_values (Optional[Dict[str, Any]]): Dictionary
219
+ of required fields default values to merge into query parameters if missing.
220
+ rest_numeric_enums (bool): Whether to encode enums as integers.
221
+
222
+ Returns:
223
+ Tuple[Dict[str, Any], Optional[str], Dict[str, Any]]: A tuple containing:
224
+ - The raw transcoded request dictionary (containing keys like 'uri', 'method').
225
+ - The serialized request body JSON string, or None if no body.
226
+ - The query parameters dictionary.
227
+ """
228
+ if request is None:
229
+ raise TypeError("request cannot be None")
230
+
231
+ # Convert proto-plus message to its underlying protobuf message if needed
232
+ pb_request = getattr(request, "_pb", request)
233
+
234
+ transcoded_request = path_template.transcode(http_options, pb_request)
235
+
236
+ body_json = None
237
+ if transcoded_request.get("body") is not None:
238
+ body_json = json_format.MessageToJson(
239
+ transcoded_request["body"],
240
+ use_integers_for_enums=rest_numeric_enums,
241
+ )
242
+
243
+ query_params_json = {}
244
+ if transcoded_request.get("query_params") is not None:
245
+ query_params_json = json.loads(
246
+ json_format.MessageToJson(
247
+ transcoded_request["query_params"],
248
+ use_integers_for_enums=rest_numeric_enums,
249
+ )
250
+ )
251
+
252
+ # If required_fields_default_values is provided, we merge default values for missing
253
+ # required fields into the query parameters.
254
+ if required_fields_default_values:
255
+ for k, v in required_fields_default_values.items():
256
+ if k not in query_params_json:
257
+ query_params_json[k] = v
258
+
259
+ if rest_numeric_enums:
260
+ query_params_json["$alt"] = "json;enum-encoding=int"
261
+
262
+ return transcoded_request, body_json, query_params_json
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2025 Google LLC
2
+ # Copyright 2026 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -13,4 +13,4 @@
13
13
  # See the License for the specific language governing permissions and
14
14
  # limitations under the License.
15
15
  #
16
- __version__ = "0.4.0" # {x-release-please-version}
16
+ __version__ = "0.5.1" # {x-release-please-version}
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2025 Google LLC
2
+ # Copyright 2026 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  # -*- coding: utf-8 -*-
2
- # Copyright 2025 Google LLC
2
+ # Copyright 2026 Google LLC
3
3
  #
4
4
  # Licensed under the Apache License, Version 2.0 (the "License");
5
5
  # you may not use this file except in compliance with the License.