Skip to content

feat: provide and use Python version support check #832

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 58 commits into from
Oct 24, 2025
+915 −2
Merged

feat: provide and use Python version support check #832

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
58 commits
Select commit Hold shift + click to select a range
6316d70
feat: provide Python run-time version support
vchudnov-g Jul 29, 2025
a136ad7
feat: apply Python version suport warnings to api_core
vchudnov-g Jul 29, 2025
45cd647
feat: add deprecation check for the protobuf package
vchudnov-g Jul 30, 2025
25225fa
format files
vchudnov-g Jul 30, 2025
1d567c0
fix lint warning
vchudnov-g Jul 30, 2025
f1dbbb4
add docstring to `warn_deprecation_for_versions_less_than`
vchudnov-g Jul 30, 2025
e3fd56f
Add/fix docstrings
vchudnov-g Jul 30, 2025
8b1dfb1
fix typo
vchudnov-g Jul 31, 2025
4b9208e
add test for _python_package_support.py
vchudnov-g Jul 31, 2025
5cf8652
add constants for various buffer periods
vchudnov-g Jul 31, 2025
7d8b1c7
Update warning code to only require import package names
vchudnov-g Jul 31, 2025
cda8e27
Fix messaegs and test
vchudnov-g Jul 31, 2025
db92fac
Add TODO: provide the functionality in previous versions of api_core
vchudnov-g Jul 31, 2025
118a7c8
Fix mypy failures
vchudnov-g Aug 12, 2025
f1c46aa
Try to remove a round-off error causing a test mock failure
vchudnov-g Aug 12, 2025
474ec0d
Remove more potential test failures/warnings
vchudnov-g Aug 12, 2025
2083b49
Format
vchudnov-g Aug 12, 2025
4ea124e
Try making the specified_timeout a float
vchudnov-g Aug 12, 2025
c5949c4
fix: tweak message parameter names
vchudnov-g Sep 3, 2025
6fc1473
fix: add PYTHON_VERSION_STATUS_UNSPECIFIED enum value
vchudnov-g Sep 3, 2025
8829e20
docs: tweak TODOs
vchudnov-g Sep 3, 2025
bdb6260
fix test to match code changes
vchudnov-g Sep 3, 2025
7896664
fix: restore asyncio designator for async tests
vchudnov-g Sep 4, 2025
54a5611
Remove some workarounds trying to fix presubmit errors (since fixed)
vchudnov-g Sep 5, 2025
2e2990b
Additional test tweaks to prevent non-significant failures
vchudnov-g Sep 5, 2025
35a2074
chore: fix test that was waiting before initiating operation
vchudnov-g Sep 5, 2025
cd64832
fix: skip coverage checks for code specific to Pyton 3.7
vchudnov-g Sep 5, 2025
e36414a
chore: try to address coverage failures
vchudnov-g Sep 8, 2025
b6245ca
chore: try to address more coverage failures
vchudnov-g Sep 8, 2025
3a897ba
chore: fix comments and exported function
vchudnov-g Sep 9, 2025
814ea63
fix lint
vchudnov-g Sep 9, 2025
8dee04b
chore: fix unit test
vchudnov-g Sep 9, 2025
95f4777
chore: lint
vchudnov-g Sep 9, 2025
a34ec15
Use warnings module instead of logging module
vchudnov-g Sep 10, 2025
a04e2e6
fix: print the current package versions correctly
vchudnov-g Sep 15, 2025
8b3f337
wip: before gemini doc fixes
vchudnov-g Sep 15, 2025
29896cf
fix: return tuple of version tuple and version string, fix tests
vchudnov-g Sep 16, 2025
d421f98
lint
vchudnov-g Sep 22, 2025
ac76f7a
feat: add grace period for 3.9; tweak warning
vchudnov-g Oct 1, 2025
e093a96
lint
vchudnov-g Oct 1, 2025
187f848
allow providing a recommended version
vchudnov-g Oct 1, 2025
b575a16
refactor: used namedtuple
vchudnov-g Oct 13, 2025
ecb7211
refactor: s/"--"/UNKNOWN_VERSION_STRING/ in code, not test
vchudnov-g Oct 13, 2025
3c587cf
refactor s/next_supported_version/minimum_fully_supported_version/
vchudnov-g Oct 13, 2025
fbe0f0b
refactor: s/dependent_/consumer_/
vchudnov-g Oct 13, 2025
28b0b32
refactor: add _PACKAGE_DEPENDENCY_WARNINGS
vchudnov-g Oct 13, 2025
21c9aec
refactor: reorder and comment on _init__ statements for clarity
vchudnov-g Oct 13, 2025
e24c13d
fix: exapnd VersionInfo with version field; clarify fake dates
vchudnov-g Oct 13, 2025
dbc3a26
doc: document PythonVersionSupportStatus
vchudnov-g Oct 13, 2025
d472bae
refactor: make fake past and future versions into constants
vchudnov-g Oct 14, 2025
0550f83
refactor: reword default string for min_python
vchudnov-g Oct 14, 2025
491b695
fix: fix populating PYTHON_VERSION_INFO
vchudnov-g Oct 14, 2025
6338389
fix: type hints
vchudnov-g Oct 14, 2025
05bcf6f
feat: allow check_dependency_versions() to take any number of Depende…
vchudnov-g Oct 17, 2025
fc224b7
add unit test to satisfy coverage requirement
vchudnov-g Oct 17, 2025
a6c40ce
fix lint
vchudnov-g Oct 17, 2025
d0414b2
fix lint
vchudnov-g Oct 17, 2025
835df53
test: add test for _flatten_message
vchudnov-g Oct 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix lint
  • Loading branch information
@vchudnov-g
vchudnov-g committed Oct 23, 2025
commit 814ea634f1b92ee7bcebf528ebd6771222f698e9
4 changes: 3 additions & 1 deletion google/api_core/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,6 @@
check_dependency_versions = _python_package_support.check_dependency_versions
check_dependency_versions("google.api_core")
Copy link
Contributor

@daniel-sanche daniel-sanche Oct 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: can this be re-arranged with comments?

# expose dependency checks for external callers
check_python_version = _python_version_support.check_python_version
check_dependency_versions = _python_package_support.check_dependency_versions
warn_deprecation_for_versions_less_than = (
    _python_package_support.warn_deprecation_for_versions_less_than
)

# perform version checks against api_core, and emit warnings if needed
check_python_version(package="google.api_core")
check_dependency_versions("google.api_core")

Copy link
Contributor

@daniel-sanche daniel-sanche Oct 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And maybe the check methods themselves should be renamed to make it clear that they emit a warning. If I saw it imported in an external package, that part might not be clear from the name. But maybe I'm overthinking it

Copy link
Contributor Author

@vchudnov-g vchudnov-g Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did the rearrangement.

I'm not convinced about the renaming. I think "check" conveys the intent more than simply "warn", and "check _and_warn" is too verbose without a lot of benefit. Open to counterarguments..


warn_deprecation_for_versions_less_than = _python_package_support.warn_deprecation_for_versions_less_than
warn_deprecation_for_versions_less_than = (
_python_package_support.warn_deprecation_for_versions_less_than
)
Copy link
Contributor

@daniel-sanche daniel-sanche Oct 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are both check_dependency_versions and warn_deprecation_for_versions_less_than meant to be used externally? I'm just seeing check_dependency_versions in the generator PR

Copy link
Contributor Author

@vchudnov-g vchudnov-g Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. check_dependency_versions calls warn_deprecation_for_versions_less_than, so for package deprecation warnings that apply to anything used by api_core as well as its dependents, such as the GAPICs, calling the former is sufficient. At the moment, the only such package is protobuf.
  2. Modules can import and use warn_deprecation_for_versions_less_than directly for packages that they themselves want to issue deprecation warnings for, but which are not used by api_core itself. We are not configuring any right now.

For those two reasons,

  • the generator PR is not using warn_deprecation_for_versions_less_than at the moment, and
  • warn_deprecation_for_versions_less_than does not have an underscore prefix.

I think this design makes sense, but please do check my thinking (and my explanation).

Copy link
Contributor

@daniel-sanche daniel-sanche Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I think that makes sense, just wanted to make sure I understood the intention

7 changes: 5 additions & 2 deletions tests/unit/test_python_version_support.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,8 +163,11 @@ def test_override_gapic_end_only():
{version_tuple: overridden_info},
):
result_before_boundary = check_python_version(
today=custom_gapic_end + datetime.timedelta(days=-1))
assert result_before_boundary == PythonVersionStatus.PYTHON_VERSION_DEPRECATED
today=custom_gapic_end + datetime.timedelta(days=-1)
)
assert (
result_before_boundary == PythonVersionStatus.PYTHON_VERSION_DEPRECATED
)

result_at_boundary = check_python_version(today=custom_gapic_end)
assert result_at_boundary == PythonVersionStatus.PYTHON_VERSION_EOL
Expand Down