google-maps-routeoptimization 0.5.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.
- {google_maps_routeoptimization-0.5.0/google_maps_routeoptimization.egg-info → google_maps_routeoptimization-0.5.1}/PKG-INFO +5 -5
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization/gapic_version.py +1 -1
- google_maps_routeoptimization-0.5.1/google/maps/routeoptimization_v1/__init__.py +113 -0
- google_maps_routeoptimization-0.5.1/google/maps/routeoptimization_v1/_compat.py +262 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/gapic_version.py +1 -1
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/services/route_optimization/async_client.py +1 -3
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/services/route_optimization/client.py +24 -163
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/services/route_optimization/transports/base.py +1 -3
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/services/route_optimization/transports/rest.py +47 -58
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/services/route_optimization/transports/rest_base.py +0 -173
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1/google_maps_routeoptimization.egg-info}/PKG-INFO +5 -5
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/google_maps_routeoptimization.egg-info/SOURCES.txt +2 -0
- google_maps_routeoptimization-0.5.1/google_maps_routeoptimization.egg-info/requires.txt +8 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/setup.py +8 -5
- google_maps_routeoptimization-0.5.1/tests/unit/gapic/routeoptimization_v1/test_compat.py +429 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/tests/unit/gapic/routeoptimization_v1/test_route_optimization.py +62 -389
- google_maps_routeoptimization-0.5.0/google/maps/routeoptimization_v1/__init__.py +0 -185
- google_maps_routeoptimization-0.5.0/google_maps_routeoptimization.egg-info/requires.txt +0 -11
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/LICENSE +0 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/MANIFEST.in +0 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/README.rst +0 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization/__init__.py +0 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization/py.typed +0 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/gapic_metadata.json +0 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/py.typed +0 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/services/__init__.py +0 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/services/route_optimization/__init__.py +0 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/services/route_optimization/transports/__init__.py +0 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/services/route_optimization/transports/grpc.py +0 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/services/route_optimization/transports/grpc_asyncio.py +0 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/types/__init__.py +0 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/google/maps/routeoptimization_v1/types/route_optimization_service.py +0 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/google_maps_routeoptimization.egg-info/dependency_links.txt +0 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/google_maps_routeoptimization.egg-info/not-zip-safe +0 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/google_maps_routeoptimization.egg-info/top_level.txt +0 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/setup.cfg +0 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/tests/__init__.py +0 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/tests/unit/__init__.py +0 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/tests/unit/gapic/__init__.py +0 -0
- {google_maps_routeoptimization-0.5.0 → google_maps_routeoptimization-0.5.1}/tests/unit/gapic/routeoptimization_v1/__init__.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: google-maps-routeoptimization
|
|
3
|
-
Version: 0.5.
|
|
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
|
|
@@ -17,17 +17,17 @@ Classifier: Programming Language :: Python :: 3.11
|
|
|
17
17
|
Classifier: Programming Language :: Python :: 3.12
|
|
18
18
|
Classifier: Programming Language :: Python :: 3.13
|
|
19
19
|
Classifier: Programming Language :: Python :: 3.14
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.15
|
|
20
21
|
Classifier: Operating System :: OS Independent
|
|
21
22
|
Classifier: Topic :: Internet
|
|
22
23
|
Requires-Python: >=3.10
|
|
23
24
|
License-File: LICENSE
|
|
24
|
-
Requires-Dist: google-api-core[grpc]<3.0.0,>=2.
|
|
25
|
+
Requires-Dist: google-api-core[grpc]<3.0.0,>=2.28.0
|
|
25
26
|
Requires-Dist: google-auth!=2.24.0,!=2.25.0,<3.0.0,>=2.14.1
|
|
26
27
|
Requires-Dist: grpcio<2.0.0,>=1.59.0
|
|
27
28
|
Requires-Dist: grpcio<2.0.0,>=1.75.1; python_version >= "3.14"
|
|
28
|
-
Requires-Dist: proto-plus<2.0.0,>=1.
|
|
29
|
-
Requires-Dist:
|
|
30
|
-
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
|
|
31
31
|
Dynamic: author
|
|
32
32
|
Dynamic: author-email
|
|
33
33
|
Dynamic: classifier
|
|
@@ -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
|
|
@@ -892,9 +892,7 @@ class RouteOptimizationAsyncClient:
|
|
|
892
892
|
DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
|
|
893
893
|
gapic_version=package_version.__version__
|
|
894
894
|
)
|
|
895
|
-
|
|
896
|
-
if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
|
|
897
|
-
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
|
|
895
|
+
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
|
|
898
896
|
|
|
899
897
|
|
|
900
898
|
__all__ = ("RouteOptimizationAsyncClient",)
|
|
@@ -46,6 +46,13 @@ from google.auth.transport.grpc import SslCredentials # type: ignore
|
|
|
46
46
|
from google.oauth2 import service_account # type: ignore
|
|
47
47
|
|
|
48
48
|
from google.maps.routeoptimization_v1 import gapic_version as package_version
|
|
49
|
+
from google.maps.routeoptimization_v1._compat import (
|
|
50
|
+
get_api_endpoint,
|
|
51
|
+
get_default_mtls_endpoint,
|
|
52
|
+
get_universe_domain,
|
|
53
|
+
read_environment_variables,
|
|
54
|
+
should_use_client_cert,
|
|
55
|
+
)
|
|
49
56
|
|
|
50
57
|
try:
|
|
51
58
|
OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None]
|
|
@@ -133,77 +140,13 @@ class RouteOptimizationClient(metaclass=RouteOptimizationClientMeta):
|
|
|
133
140
|
- at least one of latitude and longitude must be non-zero.
|
|
134
141
|
"""
|
|
135
142
|
|
|
136
|
-
@staticmethod
|
|
137
|
-
def _get_default_mtls_endpoint(api_endpoint) -> Optional[str]:
|
|
138
|
-
"""Converts api endpoint to mTLS endpoint.
|
|
139
|
-
|
|
140
|
-
Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to
|
|
141
|
-
"*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively.
|
|
142
|
-
Args:
|
|
143
|
-
api_endpoint (Optional[str]): the api endpoint to convert.
|
|
144
|
-
Returns:
|
|
145
|
-
Optional[str]: converted mTLS api endpoint.
|
|
146
|
-
"""
|
|
147
|
-
if not api_endpoint:
|
|
148
|
-
return api_endpoint
|
|
149
|
-
|
|
150
|
-
mtls_endpoint_re = re.compile(
|
|
151
|
-
r"(?P<name>[^.]+)(?P<mtls>\.mtls)?(?P<sandbox>\.sandbox)?(?P<googledomain>\.googleapis\.com)?"
|
|
152
|
-
)
|
|
153
|
-
|
|
154
|
-
m = mtls_endpoint_re.match(api_endpoint)
|
|
155
|
-
if m is None:
|
|
156
|
-
# Could not parse api_endpoint; return as-is.
|
|
157
|
-
return api_endpoint
|
|
158
|
-
|
|
159
|
-
name, mtls, sandbox, googledomain = m.groups()
|
|
160
|
-
if mtls or not googledomain:
|
|
161
|
-
return api_endpoint
|
|
162
|
-
|
|
163
|
-
if sandbox:
|
|
164
|
-
return api_endpoint.replace(
|
|
165
|
-
"sandbox.googleapis.com", "mtls.sandbox.googleapis.com"
|
|
166
|
-
)
|
|
167
|
-
|
|
168
|
-
return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com")
|
|
169
|
-
|
|
170
143
|
# Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead.
|
|
171
144
|
DEFAULT_ENDPOINT = "routeoptimization.googleapis.com"
|
|
172
|
-
DEFAULT_MTLS_ENDPOINT =
|
|
173
|
-
DEFAULT_ENDPOINT
|
|
174
|
-
)
|
|
145
|
+
DEFAULT_MTLS_ENDPOINT = get_default_mtls_endpoint(DEFAULT_ENDPOINT)
|
|
175
146
|
|
|
176
147
|
_DEFAULT_ENDPOINT_TEMPLATE = "routeoptimization.{UNIVERSE_DOMAIN}"
|
|
177
148
|
_DEFAULT_UNIVERSE = "googleapis.com"
|
|
178
149
|
|
|
179
|
-
@staticmethod
|
|
180
|
-
def _use_client_cert_effective():
|
|
181
|
-
"""Returns whether client certificate should be used for mTLS if the
|
|
182
|
-
google-auth version supports should_use_client_cert automatic mTLS enablement.
|
|
183
|
-
|
|
184
|
-
Alternatively, read from the GOOGLE_API_USE_CLIENT_CERTIFICATE env var.
|
|
185
|
-
|
|
186
|
-
Returns:
|
|
187
|
-
bool: whether client certificate should be used for mTLS
|
|
188
|
-
Raises:
|
|
189
|
-
ValueError: (If using a version of google-auth without should_use_client_cert and
|
|
190
|
-
GOOGLE_API_USE_CLIENT_CERTIFICATE is set to an unexpected value.)
|
|
191
|
-
"""
|
|
192
|
-
# check if google-auth version supports should_use_client_cert for automatic mTLS enablement
|
|
193
|
-
if hasattr(mtls, "should_use_client_cert"): # pragma: NO COVER
|
|
194
|
-
return mtls.should_use_client_cert()
|
|
195
|
-
else: # pragma: NO COVER
|
|
196
|
-
# if unsupported, fallback to reading from env var
|
|
197
|
-
use_client_cert_str = os.getenv(
|
|
198
|
-
"GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"
|
|
199
|
-
).lower()
|
|
200
|
-
if use_client_cert_str not in ("true", "false"):
|
|
201
|
-
raise ValueError(
|
|
202
|
-
"Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be"
|
|
203
|
-
" either `true` or `false`"
|
|
204
|
-
)
|
|
205
|
-
return use_client_cert_str == "true"
|
|
206
|
-
|
|
207
150
|
@classmethod
|
|
208
151
|
def from_service_account_info(cls, info: dict, *args, **kwargs):
|
|
209
152
|
"""Creates an instance of this client using the provided credentials
|
|
@@ -369,7 +312,7 @@ class RouteOptimizationClient(metaclass=RouteOptimizationClientMeta):
|
|
|
369
312
|
)
|
|
370
313
|
if client_options is None:
|
|
371
314
|
client_options = client_options_lib.ClientOptions()
|
|
372
|
-
use_client_cert =
|
|
315
|
+
use_client_cert = should_use_client_cert()
|
|
373
316
|
use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto")
|
|
374
317
|
if use_mtls_endpoint not in ("auto", "never", "always"):
|
|
375
318
|
raise MutualTLSChannelError(
|
|
@@ -390,35 +333,12 @@ class RouteOptimizationClient(metaclass=RouteOptimizationClientMeta):
|
|
|
390
333
|
elif use_mtls_endpoint == "always" or (
|
|
391
334
|
use_mtls_endpoint == "auto" and client_cert_source
|
|
392
335
|
):
|
|
393
|
-
api_endpoint = cls.DEFAULT_MTLS_ENDPOINT
|
|
336
|
+
api_endpoint = cls.DEFAULT_MTLS_ENDPOINT # type: ignore
|
|
394
337
|
else:
|
|
395
338
|
api_endpoint = cls.DEFAULT_ENDPOINT
|
|
396
339
|
|
|
397
340
|
return api_endpoint, client_cert_source
|
|
398
341
|
|
|
399
|
-
@staticmethod
|
|
400
|
-
def _read_environment_variables():
|
|
401
|
-
"""Returns the environment variables used by the client.
|
|
402
|
-
|
|
403
|
-
Returns:
|
|
404
|
-
Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE,
|
|
405
|
-
GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables.
|
|
406
|
-
|
|
407
|
-
Raises:
|
|
408
|
-
ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not
|
|
409
|
-
any of ["true", "false"].
|
|
410
|
-
google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT
|
|
411
|
-
is not any of ["auto", "never", "always"].
|
|
412
|
-
"""
|
|
413
|
-
use_client_cert = RouteOptimizationClient._use_client_cert_effective()
|
|
414
|
-
use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower()
|
|
415
|
-
universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN")
|
|
416
|
-
if use_mtls_endpoint not in ("auto", "never", "always"):
|
|
417
|
-
raise MutualTLSChannelError(
|
|
418
|
-
"Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`"
|
|
419
|
-
)
|
|
420
|
-
return use_client_cert, use_mtls_endpoint, universe_domain_env
|
|
421
|
-
|
|
422
342
|
@staticmethod
|
|
423
343
|
def _get_client_cert_source(provided_cert_source, use_cert_flag):
|
|
424
344
|
"""Return the client cert source to be used by the client.
|
|
@@ -438,65 +358,6 @@ class RouteOptimizationClient(metaclass=RouteOptimizationClientMeta):
|
|
|
438
358
|
client_cert_source = mtls.default_client_cert_source()
|
|
439
359
|
return client_cert_source
|
|
440
360
|
|
|
441
|
-
@staticmethod
|
|
442
|
-
def _get_api_endpoint(
|
|
443
|
-
api_override, client_cert_source, universe_domain, use_mtls_endpoint
|
|
444
|
-
) -> str:
|
|
445
|
-
"""Return the API endpoint used by the client.
|
|
446
|
-
|
|
447
|
-
Args:
|
|
448
|
-
api_override (str): The API endpoint override. If specified, this is always
|
|
449
|
-
the return value of this function and the other arguments are not used.
|
|
450
|
-
client_cert_source (bytes): The client certificate source used by the client.
|
|
451
|
-
universe_domain (str): The universe domain used by the client.
|
|
452
|
-
use_mtls_endpoint (str): How to use the mTLS endpoint, which depends also on the other parameters.
|
|
453
|
-
Possible values are "always", "auto", or "never".
|
|
454
|
-
|
|
455
|
-
Returns:
|
|
456
|
-
str: The API endpoint to be used by the client.
|
|
457
|
-
"""
|
|
458
|
-
if api_override is not None:
|
|
459
|
-
api_endpoint = api_override
|
|
460
|
-
elif use_mtls_endpoint == "always" or (
|
|
461
|
-
use_mtls_endpoint == "auto" and client_cert_source
|
|
462
|
-
):
|
|
463
|
-
_default_universe = RouteOptimizationClient._DEFAULT_UNIVERSE
|
|
464
|
-
if universe_domain != _default_universe:
|
|
465
|
-
raise MutualTLSChannelError(
|
|
466
|
-
f"mTLS is not supported in any universe other than {_default_universe}."
|
|
467
|
-
)
|
|
468
|
-
api_endpoint = RouteOptimizationClient.DEFAULT_MTLS_ENDPOINT
|
|
469
|
-
else:
|
|
470
|
-
api_endpoint = RouteOptimizationClient._DEFAULT_ENDPOINT_TEMPLATE.format(
|
|
471
|
-
UNIVERSE_DOMAIN=universe_domain
|
|
472
|
-
)
|
|
473
|
-
return api_endpoint
|
|
474
|
-
|
|
475
|
-
@staticmethod
|
|
476
|
-
def _get_universe_domain(
|
|
477
|
-
client_universe_domain: Optional[str], universe_domain_env: Optional[str]
|
|
478
|
-
) -> str:
|
|
479
|
-
"""Return the universe domain used by the client.
|
|
480
|
-
|
|
481
|
-
Args:
|
|
482
|
-
client_universe_domain (Optional[str]): The universe domain configured via the client options.
|
|
483
|
-
universe_domain_env (Optional[str]): The universe domain configured via the "GOOGLE_CLOUD_UNIVERSE_DOMAIN" environment variable.
|
|
484
|
-
|
|
485
|
-
Returns:
|
|
486
|
-
str: The universe domain to be used by the client.
|
|
487
|
-
|
|
488
|
-
Raises:
|
|
489
|
-
ValueError: If the universe domain is an empty string.
|
|
490
|
-
"""
|
|
491
|
-
universe_domain = RouteOptimizationClient._DEFAULT_UNIVERSE
|
|
492
|
-
if client_universe_domain is not None:
|
|
493
|
-
universe_domain = client_universe_domain
|
|
494
|
-
elif universe_domain_env is not None:
|
|
495
|
-
universe_domain = universe_domain_env
|
|
496
|
-
if len(universe_domain.strip()) == 0:
|
|
497
|
-
raise ValueError("Universe Domain cannot be an empty string.")
|
|
498
|
-
return universe_domain
|
|
499
|
-
|
|
500
361
|
def _validate_universe_domain(self):
|
|
501
362
|
"""Validates client's and credentials' universe domains are consistent.
|
|
502
363
|
|
|
@@ -630,13 +491,15 @@ class RouteOptimizationClient(metaclass=RouteOptimizationClientMeta):
|
|
|
630
491
|
universe_domain_opt = getattr(self._client_options, "universe_domain", None)
|
|
631
492
|
|
|
632
493
|
self._use_client_cert, self._use_mtls_endpoint, self._universe_domain_env = (
|
|
633
|
-
|
|
494
|
+
read_environment_variables()
|
|
634
495
|
)
|
|
635
496
|
self._client_cert_source = RouteOptimizationClient._get_client_cert_source(
|
|
636
497
|
self._client_options.client_cert_source, self._use_client_cert
|
|
637
498
|
)
|
|
638
|
-
self._universe_domain =
|
|
639
|
-
universe_domain_opt,
|
|
499
|
+
self._universe_domain = get_universe_domain(
|
|
500
|
+
universe_domain_opt,
|
|
501
|
+
self._universe_domain_env,
|
|
502
|
+
default_universe=RouteOptimizationClient._DEFAULT_UNIVERSE,
|
|
640
503
|
)
|
|
641
504
|
self._api_endpoint: str = "" # updated below, depending on `transport`
|
|
642
505
|
|
|
@@ -671,14 +534,14 @@ class RouteOptimizationClient(metaclass=RouteOptimizationClientMeta):
|
|
|
671
534
|
self._transport = cast(RouteOptimizationTransport, transport)
|
|
672
535
|
self._api_endpoint = self._transport.host
|
|
673
536
|
|
|
674
|
-
self._api_endpoint = (
|
|
675
|
-
self.
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
)
|
|
537
|
+
self._api_endpoint = self._api_endpoint or get_api_endpoint(
|
|
538
|
+
api_override=self._client_options.api_endpoint,
|
|
539
|
+
universe_domain=self._universe_domain,
|
|
540
|
+
default_universe=RouteOptimizationClient._DEFAULT_UNIVERSE,
|
|
541
|
+
default_mtls_endpoint=RouteOptimizationClient.DEFAULT_MTLS_ENDPOINT,
|
|
542
|
+
default_endpoint_template=RouteOptimizationClient._DEFAULT_ENDPOINT_TEMPLATE,
|
|
543
|
+
use_mtls=self._use_mtls_endpoint == "always"
|
|
544
|
+
or (self._use_mtls_endpoint == "auto" and self._client_cert_source),
|
|
682
545
|
)
|
|
683
546
|
|
|
684
547
|
if not transport_provided:
|
|
@@ -1312,8 +1175,6 @@ class RouteOptimizationClient(metaclass=RouteOptimizationClientMeta):
|
|
|
1312
1175
|
DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
|
|
1313
1176
|
gapic_version=package_version.__version__
|
|
1314
1177
|
)
|
|
1315
|
-
|
|
1316
|
-
if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
|
|
1317
|
-
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
|
|
1178
|
+
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
|
|
1318
1179
|
|
|
1319
1180
|
__all__ = ("RouteOptimizationClient",)
|