Skip to content

Commit fe03a00

Browse files
hebaalazzehhebaalazzeh
committed
refactor(generator): update templates and goldens to use client_utils instead of client_cert and config_helpers
1 parent 2d03894 commit fe03a00

13 files changed

Lines changed: 52 additions & 65 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: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,7 @@ from google.api_core import exceptions as core_exceptions
3030
from google.api_core import extended_operation
3131
{% endif %}
3232
from google.api_core import gapic_v1
33-
from google.api_core.gapic_v1 import client_cert
34-
from google.api_core.gapic_v1 import config_helpers
33+
from google.api_core.gapic_v1 import client_utils
3534
from google.api_core import retry as retries
3635
from google.auth import credentials as ga_credentials # type: ignore
3736
from google.auth.transport import mtls # type: ignore
@@ -193,7 +192,7 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
193192
@staticmethod
194193
def _use_client_cert_effective() -> bool:
195194
"""Returns whether client certificate should be used for mTLS."""
196-
return client_cert.use_client_cert_effective()
195+
return client_utils.use_client_cert_effective()
197196

198197
@classmethod
199198
def from_service_account_info(cls, info: dict, *args, **kwargs):
@@ -335,15 +334,15 @@ class {{ service.client_name }}(metaclass={{ service.client_name }}Meta):
335334
@staticmethod
336335
def _read_environment_variables() -> Tuple[bool, str, Optional[str]]:
337336
"""Returns the environment variables used by the client."""
338-
return config_helpers.read_environment_variables()
337+
return client_utils.read_environment_variables()
339338

340339
@staticmethod
341340
def _get_client_cert_source(
342341
provided_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]],
343342
use_cert_flag: bool,
344343
) -> Optional[Callable[[], Tuple[bytes, bytes]]]:
345344
"""Return the client cert source to be used by the client."""
346-
return client_cert.get_client_cert_source(provided_cert_source, use_cert_flag)
345+
return client_utils.get_client_cert_source(provided_cert_source, use_cert_flag)
347346

348347
@staticmethod
349348
def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint) -> str:

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@
2727
from google.api_core import client_options as client_options_lib
2828
from google.api_core import exceptions as core_exceptions
2929
from google.api_core import gapic_v1
30-
from google.api_core.gapic_v1 import client_cert
31-
from google.api_core.gapic_v1 import config_helpers
30+
from google.api_core.gapic_v1 import client_utils
3231
from google.api_core import retry as retries
3332
from google.auth import credentials as ga_credentials # type: ignore
3433
from google.auth.transport import mtls # type: ignore
@@ -148,7 +147,7 @@ def _get_default_mtls_endpoint(api_endpoint) -> Optional[str]:
148147
@staticmethod
149148
def _use_client_cert_effective() -> bool:
150149
"""Returns whether client certificate should be used for mTLS."""
151-
return client_cert.use_client_cert_effective()
150+
return client_utils.use_client_cert_effective()
152151

153152
@classmethod
154153
def from_service_account_info(cls, info: dict, *args, **kwargs):
@@ -393,15 +392,15 @@ def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_optio
393392
@staticmethod
394393
def _read_environment_variables() -> Tuple[bool, str, Optional[str]]:
395394
"""Returns the environment variables used by the client."""
396-
return config_helpers.read_environment_variables()
395+
return client_utils.read_environment_variables()
397396

398397
@staticmethod
399398
def _get_client_cert_source(
400399
provided_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]],
401400
use_cert_flag: bool,
402401
) -> Optional[Callable[[], Tuple[bytes, bytes]]]:
403402
"""Return the client cert source to be used by the client."""
404-
return client_cert.get_client_cert_source(provided_cert_source, use_cert_flag)
403+
return client_utils.get_client_cert_source(provided_cert_source, use_cert_flag)
405404

406405
@staticmethod
407406
def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint) -> str:

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@
2727
from google.api_core import client_options as client_options_lib
2828
from google.api_core import exceptions as core_exceptions
2929
from google.api_core import gapic_v1
30-
from google.api_core.gapic_v1 import client_cert
31-
from google.api_core.gapic_v1 import config_helpers
30+
from google.api_core.gapic_v1 import client_utils
3231
from google.api_core import retry as retries
3332
from google.auth import credentials as ga_credentials # type: ignore
3433
from google.auth.transport import mtls # type: ignore
@@ -151,7 +150,7 @@ def _get_default_mtls_endpoint(api_endpoint) -> Optional[str]:
151150
@staticmethod
152151
def _use_client_cert_effective() -> bool:
153152
"""Returns whether client certificate should be used for mTLS."""
154-
return client_cert.use_client_cert_effective()
153+
return client_utils.use_client_cert_effective()
155154

156155
@classmethod
157156
def from_service_account_info(cls, info: dict, *args, **kwargs):
@@ -330,15 +329,15 @@ def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_optio
330329
@staticmethod
331330
def _read_environment_variables() -> Tuple[bool, str, Optional[str]]:
332331
"""Returns the environment variables used by the client."""
333-
return config_helpers.read_environment_variables()
332+
return client_utils.read_environment_variables()
334333

335334
@staticmethod
336335
def _get_client_cert_source(
337336
provided_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]],
338337
use_cert_flag: bool,
339338
) -> Optional[Callable[[], Tuple[bytes, bytes]]]:
340339
"""Return the client cert source to be used by the client."""
341-
return client_cert.get_client_cert_source(provided_cert_source, use_cert_flag)
340+
return client_utils.get_client_cert_source(provided_cert_source, use_cert_flag)
342341

343342
@staticmethod
344343
def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint) -> str:

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@
2727
from google.api_core import client_options as client_options_lib
2828
from google.api_core import exceptions as core_exceptions
2929
from google.api_core import gapic_v1
30-
from google.api_core.gapic_v1 import client_cert
31-
from google.api_core.gapic_v1 import config_helpers
30+
from google.api_core.gapic_v1 import client_utils
3231
from google.api_core import retry as retries
3332
from google.auth import credentials as ga_credentials # type: ignore
3433
from google.auth.transport import mtls # type: ignore
@@ -169,7 +168,7 @@ def _get_default_mtls_endpoint(api_endpoint) -> Optional[str]:
169168
@staticmethod
170169
def _use_client_cert_effective() -> bool:
171170
"""Returns whether client certificate should be used for mTLS."""
172-
return client_cert.use_client_cert_effective()
171+
return client_utils.use_client_cert_effective()
173172

174173
@classmethod
175174
def from_service_account_info(cls, info: dict, *args, **kwargs):
@@ -513,15 +512,15 @@ def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_optio
513512
@staticmethod
514513
def _read_environment_variables() -> Tuple[bool, str, Optional[str]]:
515514
"""Returns the environment variables used by the client."""
516-
return config_helpers.read_environment_variables()
515+
return client_utils.read_environment_variables()
517516

518517
@staticmethod
519518
def _get_client_cert_source(
520519
provided_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]],
521520
use_cert_flag: bool,
522521
) -> Optional[Callable[[], Tuple[bytes, bytes]]]:
523522
"""Return the client cert source to be used by the client."""
524-
return client_cert.get_client_cert_source(provided_cert_source, use_cert_flag)
523+
return client_utils.get_client_cert_source(provided_cert_source, use_cert_flag)
525524

526525
@staticmethod
527526
def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint) -> str:

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@
2727
from google.api_core import client_options as client_options_lib
2828
from google.api_core import exceptions as core_exceptions
2929
from google.api_core import gapic_v1
30-
from google.api_core.gapic_v1 import client_cert
31-
from google.api_core.gapic_v1 import config_helpers
30+
from google.api_core.gapic_v1 import client_utils
3231
from google.api_core import retry as retries
3332
from google.auth import credentials as ga_credentials # type: ignore
3433
from google.auth.transport import mtls # type: ignore
@@ -144,7 +143,7 @@ def _get_default_mtls_endpoint(api_endpoint) -> Optional[str]:
144143
@staticmethod
145144
def _use_client_cert_effective() -> bool:
146145
"""Returns whether client certificate should be used for mTLS."""
147-
return client_cert.use_client_cert_effective()
146+
return client_utils.use_client_cert_effective()
148147

149148
@classmethod
150149
def from_service_account_info(cls, info: dict, *args, **kwargs):
@@ -389,15 +388,15 @@ def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_optio
389388
@staticmethod
390389
def _read_environment_variables() -> Tuple[bool, str, Optional[str]]:
391390
"""Returns the environment variables used by the client."""
392-
return config_helpers.read_environment_variables()
391+
return client_utils.read_environment_variables()
393392

394393
@staticmethod
395394
def _get_client_cert_source(
396395
provided_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]],
397396
use_cert_flag: bool,
398397
) -> Optional[Callable[[], Tuple[bytes, bytes]]]:
399398
"""Return the client cert source to be used by the client."""
400-
return client_cert.get_client_cert_source(provided_cert_source, use_cert_flag)
399+
return client_utils.get_client_cert_source(provided_cert_source, use_cert_flag)
401400

402401
@staticmethod
403402
def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint) -> str:

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@
2727
from google.api_core import client_options as client_options_lib
2828
from google.api_core import exceptions as core_exceptions
2929
from google.api_core import gapic_v1
30-
from google.api_core.gapic_v1 import client_cert
31-
from google.api_core.gapic_v1 import config_helpers
30+
from google.api_core.gapic_v1 import client_utils
3231
from google.api_core import retry as retries
3332
from google.auth import credentials as ga_credentials # type: ignore
3433
from google.auth.transport import mtls # type: ignore
@@ -141,7 +140,7 @@ def _get_default_mtls_endpoint(api_endpoint) -> Optional[str]:
141140
@staticmethod
142141
def _use_client_cert_effective() -> bool:
143142
"""Returns whether client certificate should be used for mTLS."""
144-
return client_cert.use_client_cert_effective()
143+
return client_utils.use_client_cert_effective()
145144

146145
@classmethod
147146
def from_service_account_info(cls, info: dict, *args, **kwargs):
@@ -320,15 +319,15 @@ def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_optio
320319
@staticmethod
321320
def _read_environment_variables() -> Tuple[bool, str, Optional[str]]:
322321
"""Returns the environment variables used by the client."""
323-
return config_helpers.read_environment_variables()
322+
return client_utils.read_environment_variables()
324323

325324
@staticmethod
326325
def _get_client_cert_source(
327326
provided_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]],
328327
use_cert_flag: bool,
329328
) -> Optional[Callable[[], Tuple[bytes, bytes]]]:
330329
"""Return the client cert source to be used by the client."""
331-
return client_cert.get_client_cert_source(provided_cert_source, use_cert_flag)
330+
return client_utils.get_client_cert_source(provided_cert_source, use_cert_flag)
332331

333332
@staticmethod
334333
def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint) -> str:

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@
2727
from google.api_core import client_options as client_options_lib
2828
from google.api_core import exceptions as core_exceptions
2929
from google.api_core import gapic_v1
30-
from google.api_core.gapic_v1 import client_cert
31-
from google.api_core.gapic_v1 import config_helpers
30+
from google.api_core.gapic_v1 import client_utils
3231
from google.api_core import retry as retries
3332
from google.auth import credentials as ga_credentials # type: ignore
3433
from google.auth.transport import mtls # type: ignore
@@ -142,7 +141,7 @@ def _get_default_mtls_endpoint(api_endpoint) -> Optional[str]:
142141
@staticmethod
143142
def _use_client_cert_effective() -> bool:
144143
"""Returns whether client certificate should be used for mTLS."""
145-
return client_cert.use_client_cert_effective()
144+
return client_utils.use_client_cert_effective()
146145

147146
@classmethod
148147
def from_service_account_info(cls, info: dict, *args, **kwargs):
@@ -321,15 +320,15 @@ def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_optio
321320
@staticmethod
322321
def _read_environment_variables() -> Tuple[bool, str, Optional[str]]:
323322
"""Returns the environment variables used by the client."""
324-
return config_helpers.read_environment_variables()
323+
return client_utils.read_environment_variables()
325324

326325
@staticmethod
327326
def _get_client_cert_source(
328327
provided_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]],
329328
use_cert_flag: bool,
330329
) -> Optional[Callable[[], Tuple[bytes, bytes]]]:
331330
"""Return the client cert source to be used by the client."""
332-
return client_cert.get_client_cert_source(provided_cert_source, use_cert_flag)
331+
return client_utils.get_client_cert_source(provided_cert_source, use_cert_flag)
333332

334333
@staticmethod
335334
def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint) -> str:

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@
2727
from google.api_core import client_options as client_options_lib
2828
from google.api_core import exceptions as core_exceptions
2929
from google.api_core import gapic_v1
30-
from google.api_core.gapic_v1 import client_cert
31-
from google.api_core.gapic_v1 import config_helpers
30+
from google.api_core.gapic_v1 import client_utils
3231
from google.api_core import retry as retries
3332
from google.auth import credentials as ga_credentials # type: ignore
3433
from google.auth.transport import mtls # type: ignore
@@ -144,7 +143,7 @@ def _get_default_mtls_endpoint(api_endpoint) -> Optional[str]:
144143
@staticmethod
145144
def _use_client_cert_effective() -> bool:
146145
"""Returns whether client certificate should be used for mTLS."""
147-
return client_cert.use_client_cert_effective()
146+
return client_utils.use_client_cert_effective()
148147

149148
@classmethod
150149
def from_service_account_info(cls, info: dict, *args, **kwargs):
@@ -389,15 +388,15 @@ def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_optio
389388
@staticmethod
390389
def _read_environment_variables() -> Tuple[bool, str, Optional[str]]:
391390
"""Returns the environment variables used by the client."""
392-
return config_helpers.read_environment_variables()
391+
return client_utils.read_environment_variables()
393392

394393
@staticmethod
395394
def _get_client_cert_source(
396395
provided_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]],
397396
use_cert_flag: bool,
398397
) -> Optional[Callable[[], Tuple[bytes, bytes]]]:
399398
"""Return the client cert source to be used by the client."""
400-
return client_cert.get_client_cert_source(provided_cert_source, use_cert_flag)
399+
return client_utils.get_client_cert_source(provided_cert_source, use_cert_flag)
401400

402401
@staticmethod
403402
def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint) -> str:

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@
2727
from google.api_core import client_options as client_options_lib
2828
from google.api_core import exceptions as core_exceptions
2929
from google.api_core import gapic_v1
30-
from google.api_core.gapic_v1 import client_cert
31-
from google.api_core.gapic_v1 import config_helpers
30+
from google.api_core.gapic_v1 import client_utils
3231
from google.api_core import retry as retries
3332
from google.auth import credentials as ga_credentials # type: ignore
3433
from google.auth.transport import mtls # type: ignore
@@ -141,7 +140,7 @@ def _get_default_mtls_endpoint(api_endpoint) -> Optional[str]:
141140
@staticmethod
142141
def _use_client_cert_effective() -> bool:
143142
"""Returns whether client certificate should be used for mTLS."""
144-
return client_cert.use_client_cert_effective()
143+
return client_utils.use_client_cert_effective()
145144

146145
@classmethod
147146
def from_service_account_info(cls, info: dict, *args, **kwargs):
@@ -320,15 +319,15 @@ def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_optio
320319
@staticmethod
321320
def _read_environment_variables() -> Tuple[bool, str, Optional[str]]:
322321
"""Returns the environment variables used by the client."""
323-
return config_helpers.read_environment_variables()
322+
return client_utils.read_environment_variables()
324323

325324
@staticmethod
326325
def _get_client_cert_source(
327326
provided_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]],
328327
use_cert_flag: bool,
329328
) -> Optional[Callable[[], Tuple[bytes, bytes]]]:
330329
"""Return the client cert source to be used by the client."""
331-
return client_cert.get_client_cert_source(provided_cert_source, use_cert_flag)
330+
return client_utils.get_client_cert_source(provided_cert_source, use_cert_flag)
332331

333332
@staticmethod
334333
def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint) -> str:

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@
2727
from google.api_core import client_options as client_options_lib
2828
from google.api_core import exceptions as core_exceptions
2929
from google.api_core import gapic_v1
30-
from google.api_core.gapic_v1 import client_cert
31-
from google.api_core.gapic_v1 import config_helpers
30+
from google.api_core.gapic_v1 import client_utils
3231
from google.api_core import retry as retries
3332
from google.auth import credentials as ga_credentials # type: ignore
3433
from google.auth.transport import mtls # type: ignore
@@ -142,7 +141,7 @@ def _get_default_mtls_endpoint(api_endpoint) -> Optional[str]:
142141
@staticmethod
143142
def _use_client_cert_effective() -> bool:
144143
"""Returns whether client certificate should be used for mTLS."""
145-
return client_cert.use_client_cert_effective()
144+
return client_utils.use_client_cert_effective()
146145

147146
@classmethod
148147
def from_service_account_info(cls, info: dict, *args, **kwargs):
@@ -321,15 +320,15 @@ def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_optio
321320
@staticmethod
322321
def _read_environment_variables() -> Tuple[bool, str, Optional[str]]:
323322
"""Returns the environment variables used by the client."""
324-
return config_helpers.read_environment_variables()
323+
return client_utils.read_environment_variables()
325324

326325
@staticmethod
327326
def _get_client_cert_source(
328327
provided_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]],
329328
use_cert_flag: bool,
330329
) -> Optional[Callable[[], Tuple[bytes, bytes]]]:
331330
"""Return the client cert source to be used by the client."""
332-
return client_cert.get_client_cert_source(provided_cert_source, use_cert_flag)
331+
return client_utils.get_client_cert_source(provided_cert_source, use_cert_flag)
333332

334333
@staticmethod
335334
def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint) -> str:

0 commit comments

Comments
 (0)