Skip to content

Commit 32303a0

Browse files
hebaalazzehhebaalazzeh
committed
refactor(generator): update templates and goldens to use public gapic_v1 helpers
Update the client.py.j2 template to import and call public client_cert, config_helpers, method_helpers, and routing modules in google-api-core gapic_v1. Regenerates all integration golden files accordingly.
1 parent 60d3ccb commit 32303a0

13 files changed

Lines changed: 121 additions & 121 deletions

File tree

  • packages/gapic-generator
    • gapic/templates/%namespace/%name_%version/%sub/services/%service
    • tests/integration/goldens
      • asset/google/cloud/asset_v1/services/asset_service
      • credentials/google/iam/credentials_v1/services/iam_credentials
      • eventarc/google/cloud/eventarc_v1/services/eventarc
      • logging_internal/google/cloud/logging_v2/services
      • logging/google/cloud/logging_v2/services
      • redis_selective/google/cloud/redis_v1/services/cloud_redis
      • redis/google/cloud/redis_v1/services/cloud_redis
      • storagebatchoperations/google/cloud/storagebatchoperations_v1/services/storage_batch_operations

‎packages/gapic-generator/gapic/templates/%namespace/%name_%version/%sub/services/%service/client.py.j2‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import os
2525
import re
2626
from typing import Dict, Callable, Mapping, MutableMapping, MutableSequence, Optional, {% if service.any_server_streaming %}Iterable, {% endif %}{% if service.any_client_streaming %}Iterator, {% endif %}Sequence, Tuple, Type, Union, cast
2727
{% if ns.has_auto_populated %}
28-
from google.api_core.gapic_v1 import _method_helpers
28+
from google.api_core.gapic_v1 import method_helpers
2929
{% endif %}
3030
import warnings
3131

@@ -38,9 +38,9 @@ from google.api_core import exceptions as core_exceptions
3838
from google.api_core import extended_operation
3939
{% endif %}
4040
from google.api_core import gapic_v1
41-
from google.api_core.gapic_v1 import _client_cert
42-
from google.api_core.gapic_v1 import _config_helpers
43-
from google.api_core.gapic_v1 import _routing
41+
from google.api_core.gapic_v1 import client_cert
42+
from google.api_core.gapic_v1 import config_helpers
43+
from google.api_core.gapic_v1 import routing
4444
from google.api_core import retry as retries
4545
from google.auth import credentials as ga_credentials # type: ignore
4646
from google.auth.transport import mtls # type: ignore
@@ -165,7 +165,7 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
165165
Returns:
166166
Optional[str]: converted mTLS api endpoint.
167167
"""
168-
return _routing.get_default_mtls_endpoint(api_endpoint)
168+
return routing.get_default_mtls_endpoint(api_endpoint)
169169

170170
# Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead.
171171
DEFAULT_ENDPOINT = {% if service.host %}"{{ service.host }}"{% else %}None{% endif %}
@@ -191,7 +191,7 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
191191
ValueError: (If using a version of google-auth without should_use_client_cert and
192192
GOOGLE_API_USE_CLIENT_CERTIFICATE is set to an unexpected value.)
193193
"""
194-
return _client_cert.use_client_cert_effective()
194+
return client_cert.use_client_cert_effective()
195195

196196
@classmethod
197197
def from_service_account_info(cls, info: dict, *args, **kwargs):
@@ -344,7 +344,7 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
344344
google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT
345345
is not any of ["auto", "never", "always"].
346346
"""
347-
return _config_helpers.read_environment_variables()
347+
return config_helpers.read_environment_variables()
348348

349349
@staticmethod
350350
def _get_client_cert_source(provided_cert_source, use_cert_flag):
@@ -357,7 +357,7 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
357357
Returns:
358358
bytes or None: The client cert source to be used by the client.
359359
"""
360-
return _client_cert.get_client_cert_source(provided_cert_source, use_cert_flag)
360+
return client_cert.get_client_cert_source(provided_cert_source, use_cert_flag)
361361

362362
@staticmethod
363363
def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint) -> str:
@@ -376,7 +376,7 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
376376
"""
377377
return cast(
378378
str,
379-
_routing.get_api_endpoint(
379+
routing.get_api_endpoint(
380380
api_override,
381381
client_cert_source,
382382
universe_domain,
@@ -401,7 +401,7 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
401401
Raises:
402402
ValueError: If the universe domain is an empty string.
403403
"""
404-
return _routing.get_universe_domain(
404+
return routing.get_universe_domain(
405405
client_universe_domain,
406406
universe_domain_env,
407407
{{ service.client_name }}._DEFAULT_UNIVERSE,
@@ -430,7 +430,7 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
430430
field_name (str): The name of the field to populate.
431431
is_proto3_optional (bool): Whether the field is proto3 optional.
432432
"""
433-
_method_helpers.setup_request_id(request, field_name, is_proto3_optional)
433+
method_helpers.setup_request_id(request, field_name, is_proto3_optional)
434434
{% endif %}
435435

436436
def _add_cred_info_for_auth_errors(

‎packages/gapic-generator/tests/integration/goldens/asset/google/cloud/asset_v1/services/asset_service/client.py‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@
2828
from google.api_core import client_options as client_options_lib
2929
from google.api_core import exceptions as core_exceptions
3030
from google.api_core import gapic_v1
31-
from google.api_core.gapic_v1 import _client_cert
32-
from google.api_core.gapic_v1 import _config_helpers
33-
from google.api_core.gapic_v1 import _routing
31+
from google.api_core.gapic_v1 import client_cert
32+
from google.api_core.gapic_v1 import config_helpers
33+
from google.api_core.gapic_v1 import routing
3434
from google.api_core import retry as retries
3535
from google.auth import credentials as ga_credentials # type: ignore
3636
from google.auth.transport import mtls # type: ignore
@@ -115,7 +115,7 @@ def _get_default_mtls_endpoint(api_endpoint) -> Optional[str]:
115115
Returns:
116116
Optional[str]: converted mTLS api endpoint.
117117
"""
118-
return _routing.get_default_mtls_endpoint(api_endpoint)
118+
return routing.get_default_mtls_endpoint(api_endpoint)
119119

120120
# Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead.
121121
DEFAULT_ENDPOINT = "cloudasset.googleapis.com"
@@ -139,7 +139,7 @@ def _use_client_cert_effective():
139139
ValueError: (If using a version of google-auth without should_use_client_cert and
140140
GOOGLE_API_USE_CLIENT_CERTIFICATE is set to an unexpected value.)
141141
"""
142-
return _client_cert.use_client_cert_effective()
142+
return client_cert.use_client_cert_effective()
143143

144144
@classmethod
145145
def from_service_account_info(cls, info: dict, *args, **kwargs):
@@ -395,7 +395,7 @@ def _read_environment_variables():
395395
google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT
396396
is not any of ["auto", "never", "always"].
397397
"""
398-
return _config_helpers.read_environment_variables()
398+
return config_helpers.read_environment_variables()
399399

400400
@staticmethod
401401
def _get_client_cert_source(provided_cert_source, use_cert_flag):
@@ -408,7 +408,7 @@ def _get_client_cert_source(provided_cert_source, use_cert_flag):
408408
Returns:
409409
bytes or None: The client cert source to be used by the client.
410410
"""
411-
return _client_cert.get_client_cert_source(provided_cert_source, use_cert_flag)
411+
return client_cert.get_client_cert_source(provided_cert_source, use_cert_flag)
412412

413413
@staticmethod
414414
def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint) -> str:
@@ -427,7 +427,7 @@ def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtl
427427
"""
428428
return cast(
429429
str,
430-
_routing.get_api_endpoint(
430+
routing.get_api_endpoint(
431431
api_override,
432432
client_cert_source,
433433
universe_domain,
@@ -452,7 +452,7 @@ def _get_universe_domain(client_universe_domain: Optional[str], universe_domain_
452452
Raises:
453453
ValueError: If the universe domain is an empty string.
454454
"""
455-
return _routing.get_universe_domain(
455+
return routing.get_universe_domain(
456456
client_universe_domain,
457457
universe_domain_env,
458458
AssetServiceClient._DEFAULT_UNIVERSE,

‎packages/gapic-generator/tests/integration/goldens/credentials/google/iam/credentials_v1/services/iam_credentials/client.py‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@
2828
from google.api_core import client_options as client_options_lib
2929
from google.api_core import exceptions as core_exceptions
3030
from google.api_core import gapic_v1
31-
from google.api_core.gapic_v1 import _client_cert
32-
from google.api_core.gapic_v1 import _config_helpers
33-
from google.api_core.gapic_v1 import _routing
31+
from google.api_core.gapic_v1 import client_cert
32+
from google.api_core.gapic_v1 import config_helpers
33+
from google.api_core.gapic_v1 import routing
3434
from google.api_core import retry as retries
3535
from google.auth import credentials as ga_credentials # type: ignore
3636
from google.auth.transport import mtls # type: ignore
@@ -118,7 +118,7 @@ def _get_default_mtls_endpoint(api_endpoint) -> Optional[str]:
118118
Returns:
119119
Optional[str]: converted mTLS api endpoint.
120120
"""
121-
return _routing.get_default_mtls_endpoint(api_endpoint)
121+
return routing.get_default_mtls_endpoint(api_endpoint)
122122

123123
# Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead.
124124
DEFAULT_ENDPOINT = "iamcredentials.googleapis.com"
@@ -142,7 +142,7 @@ def _use_client_cert_effective():
142142
ValueError: (If using a version of google-auth without should_use_client_cert and
143143
GOOGLE_API_USE_CLIENT_CERTIFICATE is set to an unexpected value.)
144144
"""
145-
return _client_cert.use_client_cert_effective()
145+
return client_cert.use_client_cert_effective()
146146

147147
@classmethod
148148
def from_service_account_info(cls, info: dict, *args, **kwargs):
@@ -332,7 +332,7 @@ def _read_environment_variables():
332332
google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT
333333
is not any of ["auto", "never", "always"].
334334
"""
335-
return _config_helpers.read_environment_variables()
335+
return config_helpers.read_environment_variables()
336336

337337
@staticmethod
338338
def _get_client_cert_source(provided_cert_source, use_cert_flag):
@@ -345,7 +345,7 @@ def _get_client_cert_source(provided_cert_source, use_cert_flag):
345345
Returns:
346346
bytes or None: The client cert source to be used by the client.
347347
"""
348-
return _client_cert.get_client_cert_source(provided_cert_source, use_cert_flag)
348+
return client_cert.get_client_cert_source(provided_cert_source, use_cert_flag)
349349

350350
@staticmethod
351351
def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint) -> str:
@@ -364,7 +364,7 @@ def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtl
364364
"""
365365
return cast(
366366
str,
367-
_routing.get_api_endpoint(
367+
routing.get_api_endpoint(
368368
api_override,
369369
client_cert_source,
370370
universe_domain,
@@ -389,7 +389,7 @@ def _get_universe_domain(client_universe_domain: Optional[str], universe_domain_
389389
Raises:
390390
ValueError: If the universe domain is an empty string.
391391
"""
392-
return _routing.get_universe_domain(
392+
return routing.get_universe_domain(
393393
client_universe_domain,
394394
universe_domain_env,
395395
IAMCredentialsClient._DEFAULT_UNIVERSE,

‎packages/gapic-generator/tests/integration/goldens/eventarc/google/cloud/eventarc_v1/services/eventarc/client.py‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@
2828
from google.api_core import client_options as client_options_lib
2929
from google.api_core import exceptions as core_exceptions
3030
from google.api_core import gapic_v1
31-
from google.api_core.gapic_v1 import _client_cert
32-
from google.api_core.gapic_v1 import _config_helpers
33-
from google.api_core.gapic_v1 import _routing
31+
from google.api_core.gapic_v1 import client_cert
32+
from google.api_core.gapic_v1 import config_helpers
33+
from google.api_core.gapic_v1 import routing
3434
from google.api_core import retry as retries
3535
from google.auth import credentials as ga_credentials # type: ignore
3636
from google.auth.transport import mtls # type: ignore
@@ -136,7 +136,7 @@ def _get_default_mtls_endpoint(api_endpoint) -> Optional[str]:
136136
Returns:
137137
Optional[str]: converted mTLS api endpoint.
138138
"""
139-
return _routing.get_default_mtls_endpoint(api_endpoint)
139+
return routing.get_default_mtls_endpoint(api_endpoint)
140140

141141
# Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead.
142142
DEFAULT_ENDPOINT = "eventarc.googleapis.com"
@@ -160,7 +160,7 @@ def _use_client_cert_effective():
160160
ValueError: (If using a version of google-auth without should_use_client_cert and
161161
GOOGLE_API_USE_CLIENT_CERTIFICATE is set to an unexpected value.)
162162
"""
163-
return _client_cert.use_client_cert_effective()
163+
return client_cert.use_client_cert_effective()
164164

165165
@classmethod
166166
def from_service_account_info(cls, info: dict, *args, **kwargs):
@@ -515,7 +515,7 @@ def _read_environment_variables():
515515
google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT
516516
is not any of ["auto", "never", "always"].
517517
"""
518-
return _config_helpers.read_environment_variables()
518+
return config_helpers.read_environment_variables()
519519

520520
@staticmethod
521521
def _get_client_cert_source(provided_cert_source, use_cert_flag):
@@ -528,7 +528,7 @@ def _get_client_cert_source(provided_cert_source, use_cert_flag):
528528
Returns:
529529
bytes or None: The client cert source to be used by the client.
530530
"""
531-
return _client_cert.get_client_cert_source(provided_cert_source, use_cert_flag)
531+
return client_cert.get_client_cert_source(provided_cert_source, use_cert_flag)
532532

533533
@staticmethod
534534
def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint) -> str:
@@ -547,7 +547,7 @@ def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtl
547547
"""
548548
return cast(
549549
str,
550-
_routing.get_api_endpoint(
550+
routing.get_api_endpoint(
551551
api_override,
552552
client_cert_source,
553553
universe_domain,
@@ -572,7 +572,7 @@ def _get_universe_domain(client_universe_domain: Optional[str], universe_domain_
572572
Raises:
573573
ValueError: If the universe domain is an empty string.
574574
"""
575-
return _routing.get_universe_domain(
575+
return routing.get_universe_domain(
576576
client_universe_domain,
577577
universe_domain_env,
578578
EventarcClient._DEFAULT_UNIVERSE,

‎packages/gapic-generator/tests/integration/goldens/logging/google/cloud/logging_v2/services/config_service_v2/client.py‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@
2828
from google.api_core import client_options as client_options_lib
2929
from google.api_core import exceptions as core_exceptions
3030
from google.api_core import gapic_v1
31-
from google.api_core.gapic_v1 import _client_cert
32-
from google.api_core.gapic_v1 import _config_helpers
33-
from google.api_core.gapic_v1 import _routing
31+
from google.api_core.gapic_v1 import client_cert
32+
from google.api_core.gapic_v1 import config_helpers
33+
from google.api_core.gapic_v1 import routing
3434
from google.api_core import retry as retries
3535
from google.auth import credentials as ga_credentials # type: ignore
3636
from google.auth.transport import mtls # type: ignore
@@ -111,7 +111,7 @@ def _get_default_mtls_endpoint(api_endpoint) -> Optional[str]:
111111
Returns:
112112
Optional[str]: converted mTLS api endpoint.
113113
"""
114-
return _routing.get_default_mtls_endpoint(api_endpoint)
114+
return routing.get_default_mtls_endpoint(api_endpoint)
115115

116116
# Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead.
117117
DEFAULT_ENDPOINT = "logging.googleapis.com"
@@ -135,7 +135,7 @@ def _use_client_cert_effective():
135135
ValueError: (If using a version of google-auth without should_use_client_cert and
136136
GOOGLE_API_USE_CLIENT_CERTIFICATE is set to an unexpected value.)
137137
"""
138-
return _client_cert.use_client_cert_effective()
138+
return client_cert.use_client_cert_effective()
139139

140140
@classmethod
141141
def from_service_account_info(cls, info: dict, *args, **kwargs):
@@ -391,7 +391,7 @@ def _read_environment_variables():
391391
google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT
392392
is not any of ["auto", "never", "always"].
393393
"""
394-
return _config_helpers.read_environment_variables()
394+
return config_helpers.read_environment_variables()
395395

396396
@staticmethod
397397
def _get_client_cert_source(provided_cert_source, use_cert_flag):
@@ -404,7 +404,7 @@ def _get_client_cert_source(provided_cert_source, use_cert_flag):
404404
Returns:
405405
bytes or None: The client cert source to be used by the client.
406406
"""
407-
return _client_cert.get_client_cert_source(provided_cert_source, use_cert_flag)
407+
return client_cert.get_client_cert_source(provided_cert_source, use_cert_flag)
408408

409409
@staticmethod
410410
def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint) -> str:
@@ -423,7 +423,7 @@ def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtl
423423
"""
424424
return cast(
425425
str,
426-
_routing.get_api_endpoint(
426+
routing.get_api_endpoint(
427427
api_override,
428428
client_cert_source,
429429
universe_domain,
@@ -448,7 +448,7 @@ def _get_universe_domain(client_universe_domain: Optional[str], universe_domain_
448448
Raises:
449449
ValueError: If the universe domain is an empty string.
450450
"""
451-
return _routing.get_universe_domain(
451+
return routing.get_universe_domain(
452452
client_universe_domain,
453453
universe_domain_env,
454454
ConfigServiceV2Client._DEFAULT_UNIVERSE,

0 commit comments

Comments
 (0)