fix: add support for protobuf 5.x #644
Filter by extension
Only manifest files
Viewed files
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| Expand Up | @@ -15,7 +15,9 @@ | |
| from __future__ import absolute_import | ||
| import os | ||
| import pathlib | ||
| import re | ||
| import shutil | ||
| import unittest | ||
|
|
||
| # https://github.com/google/importlab/issues/25 | ||
| import nox # pytype: disable=import-error | ||
| Expand All | @@ -26,6 +28,8 @@ | |
| # Black and flake8 clash on the syntax for ignoring flake8's F401 in this file. | ||
| BLACK_EXCLUDES = ["--exclude", "^/google/api_core/operations_v1/__init__.py"] | ||
|
|
||
| PYTHON_VERSIONS = ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"] | ||
|
|
||
| DEFAULT_PYTHON_VERSION = "3.10" | ||
| CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() | ||
|
|
||
| Expand Down Expand Up | @@ -72,17 +76,46 @@ def blacken(session): | |
| session.run("black", *BLACK_EXCLUDES, *BLACK_PATHS) | ||
|
|
||
|
|
||
| def install_prerelease_dependencies(session, constraints_path): | ||
|
Comment thread
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment. Sorry, I have gaps in my mental model for testing prerelease; This installs our dependencies at pre-release versions, right? Is the only difference, then, the use of --pre below? If it's the same set of dependencies, it seems it would be clearer to have them loaded in the same place for pre-release and stable versions, and add the extra install parameters conditionally on each thing we install. (It might be easier to talk synchronously about this.)
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
Author
There was a problem hiding this comment. There is a difference in that we don't allow transitive dependencies in the install_prerelease_dependencies session as we want to ensure that we're installing the pre-release version of each dependency. In the non-prerelease session, we are installing transitive dependencies.
Sorry, something went wrong. |
||
| with open(constraints_path, encoding="utf-8") as constraints_file: | ||
| constraints_text = constraints_file.read() | ||
| # Ignore leading whitespace and comment lines. | ||
| constraints_deps = [ | ||
| match.group(1) | ||
| for match in re.finditer( | ||
| r"^\s*(\S+)(?===\S+)", constraints_text, flags=re.MULTILINE | ||
| ) | ||
| ] | ||
| session.install(*constraints_deps) | ||
| prerel_deps = [ | ||
| "google-auth", | ||
| "googleapis-common-protos", | ||
| "grpcio", | ||
| "grpcio-status", | ||
| "proto-plus", | ||
| "protobuf", | ||
| ] | ||
|
|
||
| for dep in prerel_deps: | ||
| session.install("--pre", "--no-deps", "--upgrade", dep) | ||
|
|
||
| # Remaining dependencies | ||
| other_deps = [ | ||
| "requests", | ||
| ] | ||
| session.install(*other_deps) | ||
|
|
||
|
|
||
| def default(session, install_grpc=True, prerelease=False): | ||
| """Default unit test session. | ||
|
|
||
| This is intended to be run **without** an interpreter set, so | ||
| that the current ``python`` (on the ``PATH``) or the version of | ||
| Python corresponding to the ``nox`` binary the ``PATH`` can | ||
| run the tests. | ||
| """ | ||
| if prerelease and not install_grpc: | ||
| unittest.skip("The pre-release session cannot be run without grpc") | ||
|
|
||
| session.install( | ||
| "dataclasses", | ||
| Expand All | @@ -92,10 +125,36 @@ def default(session, install_grpc=True): | |
| "pytest-xdist", | ||
| ) | ||
|
|
||
| constraints_dir = str(CURRENT_DIRECTORY / "testing") | ||
|
|
||
| if prerelease: | ||
| install_prerelease_dependencies( | ||
| session, f"{constraints_dir}/constraints-{PYTHON_VERSIONS[0]}.txt" | ||
|
Comment thread
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment. I'm confused: in line 206, where we call default(..., prerelease=True), the decorator constrains python=PYTHON_VERSIONS[-1]. But here we are referencing the constraints for PYTHON_VERSIONS[0]. Could you clarify?
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
Author
There was a problem hiding this comment. As per the comment in below, the constraints file for the lowest supported python version contains a list of all of the dependencies of the library. The function install_prerelease_dependencies will extract the dependencies from the file. python-api-core/testing/constraints-3.7.txt Lines 1 to 7 in 126b5c7 Lines 79 to 88 in 7fbce0d Once we have a list of dependencies, we will install them independently with the --pre and --no-deps option. `--upgrade is also added to ensure that we get the latest pre-release. Lines 99 to 100 in 7fbce0d
Sorry, something went wrong. |
||
| ) | ||
| # This *must* be the last install command to get the package from source. | ||
| session.install("-e", ".", "--no-deps") | ||
| else: | ||
| session.install( | ||
| "-e", | ||
| ".[grpc]" if install_grpc else ".", | ||
| "-c", | ||
| f"{constraints_dir}/constraints-{session.python}.txt", | ||
| ) | ||
|
|
||
| # Print out package versions of dependencies | ||
| session.run( | ||
| "python", "-c", "import google.protobuf; print(google.protobuf.__version__)" | ||
| ) | ||
| # Support for proto.version was added in v1.23.0 | ||
| # https://github.com/googleapis/proto-plus-python/releases/tag/v1.23.0 | ||
| session.run( | ||
| "python", | ||
| "-c", | ||
| """import proto; hasattr(proto, "version") and print(proto.version.__version__)""", | ||
| ) | ||
| if install_grpc: | ||
| session.run("python", "-c", "import grpc; print(grpc.__version__)") | ||
| session.run("python", "-c", "import google.auth; print(google.auth.__version__)") | ||
|
|
||
| pytest_args = [ | ||
| "python", | ||
| Expand Down Expand Up | @@ -130,15 +189,26 @@ def default(session, install_grpc=True): | |
| session.run(*pytest_args) | ||
|
|
||
|
|
||
| @nox.session(python=PYTHON_VERSIONS) | ||
| def unit(session): | ||
| """Run the unit test suite.""" | ||
| default(session) | ||
|
|
||
|
|
||
| @nox.session(python=PYTHON_VERSIONS) | ||
| def unit_with_prerelease_deps(session): | ||
| """Run the unit test suite.""" | ||
| default(session, prerelease=True) | ||
|
|
||
|
|
||
| @nox.session(python=PYTHON_VERSIONS) | ||
| def unit_grpc_gcp(session): | ||
| """ | ||
| Run the unit test suite with grpcio-gcp installed. | ||
| `grpcio-gcp` doesn't support protobuf 4+. | ||
| Remove extra `grpcgcp` when protobuf 3.x is dropped. | ||
| https://github.com/googleapis/python-api-core/issues/594 | ||
| """ | ||
| constraints_path = str( | ||
| CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt" | ||
| ) | ||
| Expand All | @@ -150,7 +220,7 @@ def unit_grpc_gcp(session): | |
| default(session) | ||
|
|
||
|
|
||
| @nox.session(python=PYTHON_VERSIONS) | ||
| def unit_wo_grpc(session): | ||
| """Run the unit test suite w/o grpcio installed""" | ||
| default(session, install_grpc=False) | ||
| Expand All | @@ -164,10 +234,10 @@ def lint_setup_py(session): | |
| session.run("python", "setup.py", "check", "--restructuredtext", "--strict") | ||
|
|
||
|
|
||
| @nox.session(python=DEFAULT_PYTHON_VERSION) | ||
|
Comment thread
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment. Just to clarify, do we want to run this against all versions?
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
Author
There was a problem hiding this comment. We normally only run it on 1 version but we can expand it if there is value
Sorry, something went wrong. |
||
| def pytype(session): | ||
| """Run type-checking.""" | ||
| session.install(".[grpc]", "pytype") | ||
| session.run("pytype") | ||
|
|
||
|
|
||
| Expand All | @@ -178,9 +248,7 @@ def mypy(session): | |
| session.install( | ||
| "types-setuptools", | ||
| "types-requests", | ||
| "types-protobuf", | ||
| "types-mock", | ||
| "types-dataclasses", | ||
| ) | ||
| Expand Down | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low QualityWhy is this file changed?
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low QualityI ran black on all of the files and this file was formatted
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.