feat: gapic centralization into api core by hebaalazzeh · Pull Request #17628 · googleapis/google-cloud-python

hebaalazzeh · 2026-07-06T06:29:35Z

Update and Release google-api-core

This PR introduces centralized helper functions into google.api_core.gapic_v1. The goal of this centralization is to reduce package size, improve maintainability, and boost import performance of generated GAPIC clients by moving redundant, service-agnostic boilerplate logic into google-api-core.

Key Changes

Centralized GAPIC Helpers: Extracted logic previously repeated across generated clients into focused, domain-specific modules within google.api_core.gapic_v1:
- _routing.py (get_default_mtls_endpoint, get_api_endpoint, get_universe_domain)
- _client_cert.py (use_client_cert_effective, get_client_cert_source)
- _config_helpers.py (read_environment_variables)
- _method_helpers.py (setup_request_id)
Public Method Exposure: Removed the _ prefix from these functions so they can be securely imported and utilized by external generated clients.
Backward Compatibility: Added internal aliases (e.g., _use_client_cert_effective = use_client_cert_effective) to prevent breaking changes for existing GAPIC clients (over 2,400+ repos) that have not yet been regenerated.
Comprehensive Test Coverage: Added exhaustive unit tests for all helper functions in dedicated, domain-specific test files (test_routing.py, test_client_cert.py, test_config_helpers.py, test_method_helpers.py).
CI Environment Hardening:
- Handled grpc optional dependencies gracefully to ensure tests pass in install_grpc=False environments.
- Ensured older versions of google-auth (e.g. <=2.14.1) pass in the CI test matrix by safely validating should_use_client_cert availability.

Next Steps (Phase 2)

Once this PR is merged and a new minor version of google-api-core (e.g. 2.18.0) is released, we can update the GAPIC generator to utilize these centralized helpers and stop emitting the redundant logic.

Note

Full details and baseline metrics are available in the attached Design Document.

… clients

gemini-code-assist

Code Review

This pull request introduces a new client_helpers module in google-api-core containing helper functions for GAPIC client initialization, and adds global lazy imports control (__lazy_modules__) to google-cloud-compute. The review feedback suggests optimizing performance by compiling the mTLS endpoint regular expression at the module level rather than inside the function. Additionally, it recommends correcting the type annotations in get_api_endpoint to use Optional[Any] for client_cert_source and Optional[str] for the return type.

…rs.py Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

hebaalazzeh · 2026-07-06T21:40:30Z

/gemini

…al client_helpers methods

Splits the monolithic client_helpers.py into routing.py, client_cert.py, config_helpers.py, and method_helpers.py to improve readability and maintainability. Updates gapic_v1 exports and test imports accordingly.

…ication PR

ohmayr · 2026-07-10T21:53:05Z

+from google.api_core.gapic_v1 import (
+    _client_cert,
+    _config_helpers,
+    _method_helpers,
+    _routing,


Exporting private module names ("_client_cert", "_config_helpers", "_method_helpers", "_routing") in __all__ is unconventional for top-level public API design.

ohmayr · 2026-07-10T21:55:35Z

+    use_client_cert = use_client_cert_effective()
+    use_mtls_endpoint = os.getenv(
+        "GOOGLE_API_USE_MTLS_ENDPOINT", "auto"
+    ).lower()  # noqa: E501


nit: can we remove # noqa: E501 from here and other places?

ohmayr · 2026-07-10T21:57:09Z

+try:
+    import grpc  # noqa: F401
+except ImportError:
+    pytest.skip("No GRPC", allow_module_level=True)


why are we skipping tests if grpc is not installed? Don't these functions work for REST too?

ohmayr · 2026-07-10T21:58:32Z

+# Backward compatibility aliases for private methods
+# Previously, gapic-generator-python generated clients used these methods
+_use_client_cert_effective = use_client_cert_effective
+_get_client_cert_source = get_client_cert_source


Can you explain or provide the use case of these lines? How does they help?

ohmayr · 2026-07-10T22:03:12Z

+
+
+def get_client_cert_source(
+    provided_cert_source: Optional[Any], use_cert_flag: bool


iss this docstring correct? Can we confirm against google-auth?

ohmayr · 2026-07-10T22:10:35Z

Could we open a draft PR for gapic-generator with the template updates, temporarily pointing its test google-api-core dependency to this git branch?

Running the gapic-generator-python CI (showcase and unit tests) on that draft PR will give us end-to-end verification that this branch integrates cleanly with generated code before we merge.

hebaalazzeh added 3 commits June 30, 2026 06:42

feat: apply PEP 0810 lazy imports to google-cloud-compute

aedbee9

fix: remove python version guard for PEP 810 lazy imports

4b3ba9d

feat: centralize service-agnostic boilerplate into api_core for GAPIC…

c60e977

… clients

gemini-code-assist Bot reviewed Jul 6, 2026

View reviewed changes

hebaalazzeh and others added 6 commits July 5, 2026 23:33

Update packages/google-api-core/google/api_core/gapic_v1/client_helpe…

4463094

…rs.py Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

refactor: optimize regex and update type hints in client_helpers

4d9bea2

style: run black formatter on client_helpers.py

54cf6a0

fix: address lint and mypy issues in api_core and kms

69260e5

fix: address black formatting issue in client_helpers.py

46e0797

fix: add underscore prefix to internal helpers in client_helpers.py

a4513c4

hebaalazzeh self-assigned this Jul 6, 2026

test: add unit tests for gapic client_helpers

ad1c01f

hebaalazzeh force-pushed the feat/gapic-centralization-api-core branch from 5e1eb20 to ad1c01f Compare July 6, 2026 21:21

hebaalazzeh added 10 commits July 6, 2026 21:49

chore: revert experimental kms validation changes

1456ead

fix: resolve flake8 line length issues in tests

0ffcdd3

chore: revert experimental PEP 0810 lazy loading in compute

2168bc0

feat: centralize additional client helpers to api_core

5abeb85

test: mock missing google-auth mtls attributes

09243e9

style: remove manual 79-char line breaks to satisfy black

be2b472

refactor: remove underscore prefix from gapic client helpers

d386dfe

fix: linting issues and add backward compatibility aliases for intern…

72d6561

…al client_helpers methods

fix: skip test_client_helpers in non-grpc environments

6a44282

fix: mock patch missing attribute in old google-auth versions

2353e82

hebaalazzeh force-pushed the feat/gapic-centralization-api-core branch from c27695d to 2353e82 Compare July 7, 2026 20:56

hebaalazzeh marked this pull request as ready for review July 7, 2026 21:01

hebaalazzeh requested a review from a team as a code owner July 7, 2026 21:01

hebaalazzeh force-pushed the feat/gapic-centralization-api-core branch 3 times, most recently from 1d7b5c2 to 3f02e35 Compare July 9, 2026 20:02

hebaalazzeh force-pushed the feat/gapic-centralization-api-core branch from 3f02e35 to 3c40eed Compare July 9, 2026 20:10

feat: split client_helpers into domain-specific modules

7208833

Splits the monolithic client_helpers.py into routing.py, client_cert.py, config_helpers.py, and method_helpers.py to improve readability and maintainability. Updates gapic_v1 exports and test imports accordingly.

hebaalazzeh force-pushed the feat/gapic-centralization-api-core branch from 3c40eed to 7208833 Compare July 9, 2026 20:42

chore: fix lint and formatting

65861d9

hebaalazzeh requested review from a team as code owners July 10, 2026 01:37

hebaalazzeh requested review from tswast and removed request for a team and tswast July 10, 2026 01:37

chore: revert accidental formatting and generated files to fix dedupl…

17acb05

…ication PR

hebaalazzeh requested a review from a team July 10, 2026 09:09

test: split test_client_helpers.py into domain-specific test files

3e9393a

ohmayr reviewed Jul 10, 2026

View reviewed changes

fix: address reviewer comments on api-core

1888b2e

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: gapic centralization into api core#17628

feat: gapic centralization into api core#17628
hebaalazzeh wants to merge 25 commits into
mainfrom
feat/gapic-centralization-api-core

hebaalazzeh commented Jul 6, 2026 •

edited

Loading

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hebaalazzeh commented Jul 6, 2026

Uh oh!

ohmayr Jul 10, 2026

Uh oh!

ohmayr Jul 10, 2026

Uh oh!

ohmayr Jul 10, 2026

Uh oh!

ohmayr Jul 10, 2026

Uh oh!

ohmayr Jul 10, 2026

Uh oh!

ohmayr commented Jul 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants



		def get_client_cert_source(
		provided_cert_source: Optional[Any], use_cert_flag: bool

Uh oh!

Conversation

hebaalazzeh commented Jul 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Update and Release google-api-core

Key Changes

Next Steps (Phase 2)

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hebaalazzeh commented Jul 6, 2026

Uh oh!

ohmayr Jul 10, 2026

Choose a reason for hiding this comment

Uh oh!

ohmayr Jul 10, 2026

Choose a reason for hiding this comment

Uh oh!

ohmayr Jul 10, 2026

Choose a reason for hiding this comment

Uh oh!

ohmayr Jul 10, 2026

Choose a reason for hiding this comment

Uh oh!

ohmayr Jul 10, 2026

Choose a reason for hiding this comment

Uh oh!

ohmayr commented Jul 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

hebaalazzeh commented Jul 6, 2026 •

edited

Loading