Skip to content

Commit 72d6561

Browse files
committed
fix: linting issues and add backward compatibility aliases for internal client_helpers methods
1 parent d386dfe commit 72d6561

2 files changed

Lines changed: 21 additions & 12 deletions

File tree

packages/google-api-core/google/api_core/gapic_v1/client_helpers.py

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ def get_api_endpoint(
128128
else:
129129
return default_endpoint_template.format(
130130
UNIVERSE_DOMAIN=universe_domain
131-
)
131+
) # noqa: E501
132132

133133

134134
def read_environment_variables() -> Tuple[bool, str, Optional[str]]:
@@ -149,7 +149,7 @@ def read_environment_variables() -> Tuple[bool, str, Optional[str]]:
149149
use_client_cert = use_client_cert_effective()
150150
use_mtls_endpoint = os.getenv(
151151
"GOOGLE_API_USE_MTLS_ENDPOINT", "auto"
152-
).lower()
152+
).lower() # noqa: E501
153153
universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN")
154154
if use_mtls_endpoint not in ("auto", "never", "always"):
155155
raise MutualTLSChannelError(
@@ -216,7 +216,7 @@ def get_universe_domain(
216216

217217
def setup_request_id(
218218
request: Any, field_name: str, is_proto3_optional: bool
219-
) -> None:
219+
) -> None: # noqa: E501
220220
"""Populate a UUID4 field in the request if it is not already set.
221221
222222
Args:
@@ -245,3 +245,13 @@ def setup_request_id(
245245
else:
246246
if not getattr(request, field_name):
247247
setattr(request, field_name, str(uuid.uuid4()))
248+
249+
250+
# Backward compatibility aliases for private methods
251+
# Previously, gapic-generator-python generated clients used these methods
252+
_use_client_cert_effective = use_client_cert_effective
253+
_get_default_mtls_endpoint = get_default_mtls_endpoint
254+
_read_environment_variables = read_environment_variables
255+
_get_client_cert_source = get_client_cert_source
256+
_get_universe_domain = get_universe_domain
257+
_setup_request_id = setup_request_id

packages/google-api-core/tests/unit/gapic/test_client_helpers.py

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ def test_get_api_endpoint_mtls_universe_mismatch():
153153

154154
@mock.patch(
155155
"google.api_core.gapic_v1.client_helpers.use_client_cert_effective"
156-
)
156+
) # noqa: E501
157157
@mock.patch.dict(os.environ, clear=True)
158158
def test_read_environment_variables(mock_effective):
159159
mock_effective.return_value = True
@@ -177,10 +177,10 @@ def test_read_environment_variables_invalid_mtls():
177177

178178
@mock.patch(
179179
"google.auth.transport.mtls.has_default_client_cert_source", create=True
180-
)
180+
) # noqa: E501
181181
@mock.patch(
182182
"google.auth.transport.mtls.default_client_cert_source", create=True
183-
)
183+
) # noqa: E501
184184
def test_get_client_cert_source(mock_default, mock_has_default):
185185
mock_default.return_value = b"default_cert"
186186
mock_has_default.return_value = True
@@ -190,9 +190,8 @@ def test_get_client_cert_source(mock_default, mock_has_default):
190190

191191
# When provided_cert_source is given, return provided
192192
assert (
193-
client_helpers.get_client_cert_source(b"provided", True)
194-
== b"provided"
195-
)
193+
client_helpers.get_client_cert_source(b"provided", True) == b"provided"
194+
) # noqa: E501
196195

197196
# When no provided cert but default is available
198197
assert client_helpers.get_client_cert_source(None, True) == b"default_cert"
@@ -203,20 +202,20 @@ def test_get_universe_domain():
203202
assert (
204203
client_helpers.get_universe_domain(
205204
"client.com", "env.com", "default.com"
206-
)
205+
) # noqa: E501
207206
== "client.com"
208207
)
209208

210209
# env takes precedence over default
211210
assert (
212211
client_helpers.get_universe_domain(None, "env.com", "default.com")
213-
== "env.com"
212+
== "env.com" # noqa: E501
214213
)
215214

216215
# fallback to default
217216
assert (
218217
client_helpers.get_universe_domain(None, None, "default.com")
219-
== "default.com"
218+
== "default.com" # noqa: E501
220219
)
221220

222221

0 commit comments

Comments
 (0)