fix: add support for protobuf 5.x #644
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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 | ||
|
|
@@ -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() | ||
|
|
||
|
|
@@ -72,17 +76,46 @@ def blacken(session): | |
| session.run("black", *BLACK_EXCLUDES, *BLACK_PATHS) | ||
|
|
||
|
|
||
| def install_prerelease_dependencies(session, constraints_path): | ||
|
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 (It might be easier to talk synchronously about this.) There was a problem hiding this comment. There is a difference in that we don't allow transitive dependencies in the |
||
| 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", | ||
|
|
@@ -92,10 +125,41 @@ 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" | ||
|
There was a problem hiding this comment. I'm confused: in line 206, where we call 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 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 Lines 99 to 100 in 7fbce0d |
||
| ) | ||
| # This *must* be the last install command to get the package from source. | ||
| session.install("-e", ".", "--no-deps") | ||
| else: | ||
| if install_grpc: | ||
| session.install( | ||
| "-e", | ||
| ".[grpc]", | ||
| "-c", | ||
| f"{constraints_dir}/constraints-{session.python}.txt", | ||
| ) | ||
| else: | ||
| session.install( | ||
| "-e", ".", "-c", f"{constraints_dir}/constraints-{session.python}.txt" | ||
| ) | ||
parthea marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| # 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", | ||
|
|
@@ -130,15 +194,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[-1]) | ||
| def unit_prerelease(session): | ||
|
There was a problem hiding this comment. So this tests running against the pre-release versions of the dependencies, right? And we only bother to do this with the latest Python run-time. A comment might be helpful. Also, my personal preference would to rename this (and similar code elsewhere) as |
||
| """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" | ||
| ) | ||
|
|
@@ -150,7 +225,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) | ||
|
|
@@ -164,10 +239,10 @@ def lint_setup_py(session): | |
| session.run("python", "setup.py", "check", "--restructuredtext", "--strict") | ||
|
|
||
|
|
||
| @nox.session(python=DEFAULT_PYTHON_VERSION) | ||
|
There was a problem hiding this comment. Just to clarify, do we want to run this against all versions? There was a problem hiding this comment. We normally only run it on 1 version but we can expand it if there is value |
||
| def pytype(session): | ||
| """Run type-checking.""" | ||
| session.install(".[grpc]", "pytype") | ||
| session.run("pytype") | ||
|
|
||
|
|
||
|
|
@@ -178,9 +253,7 @@ def mypy(session): | |
| session.install( | ||
| "types-setuptools", | ||
| "types-requests", | ||
| "types-protobuf", | ||
| "types-mock", | ||
| "types-dataclasses", | ||
| ) | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -30,7 +30,7 @@ | |
| release_status = "Development Status :: 5 - Production/Stable" | ||
| dependencies = [ | ||
| "googleapis-common-protos >= 1.56.2, < 2.0.dev0", | ||
| "protobuf>=3.19.5,<6.0.0.dev0,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", | ||
| "proto-plus >= 1.22.3, <2.0.0dev", | ||
| "google-auth >= 2.14.1, < 3.0.dev0", | ||
| "requests >= 2.18.0, < 3.0.0.dev0", | ||
|
|
||
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.
I think this more succinct code should work (I haven't tested it) and would be easier to maintain.
Ref: https://docs.github.com/en/actions/using-jobs/using-a-matrix-for-your-jobs#expanding-or-adding-matrix-configurations
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.
This comment is obsolete with the changes in e1efa83