Release 0.1.20 (#97)

- Fix the bug that can occur when a reflection server doesn't serve a
dependency
- Fix tests to allow for testing and usage of Protobuf 5
- Add nox to the testing tool for local testing of multiple Python and
protobuf verisons
- Update documentation to reflect support plans
- Clean up action flows for testing

Author: ViridianForge

.github/workflows/test.yaml

@@ -7,11 +7,30 @@ on:
       - master
 
 jobs:
+  run_checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.8
+      - name: Install dependencies
+        run: |
+          pip install -r requirements-lint.txt
+      - name: Lint and check formatting with ruff
+        run: |
+          ruff check src/ --statistics --config ruff.toml
+          ruff format src/ --check --config ruff.toml
+      - name: Typecheck with mypy
+        run: |
+          mypy src/grpc_requests/*.py
   run_tests:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ '3.8', '3.9', '3.10', '3.11', '3.12' ]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        protobuf-version: ["4.25.4", "5.27.3"]
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
@@ -21,15 +40,9 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements-dev.txt
           pip install -e .
-      - name: Lint and check formatting with ruff
-        run: |
-          ruff check src/grpc_requests/*.py src/tests/*.py --statistics --config ruff.toml
-          ruff format src/grpc_requests/*.py src/tests/*.py --check --config ruff.toml
-      - name: Typecheck with mypy
-        run: |
-          mypy src/grpc_requests/*.py
+          pip install -r requirements-test.txt
+          pip install protobuf==${{ matrix.protobuf-version }}
       - name: Test with pytest
         run: |
           pytest --cov-report=xml --cov=src/grpc_requests

CHANGELOG.md

@@ -5,48 +5,72 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.20](https://github.com/grpc-requests/grpc_requests/releases/tag/v0.1.20) - 2024-08-15
+
+### Added
+
+- Noxfile for testing combinations of supported versions Python and protobuf
+- Specifications around support targets for Python and protobuf for the library
+
+### Fixed
+
+- Fixed a bug wherein attempting to retrieve a dependency of a FileDescriptor could
+  result thrown an exception if the dependency was not being served via reflection by
+  the server.
+
+## [0.1.19](https://github.com/grpc-requests/grpc_requests/releases/tag/v0.1.19) - 2024-07-18
+
+### Added
+
+- Tools for developers to measure complexity of the code base
+- Integrations with mypy
+
+### Removed
+
+Support for Python 3.7
+
 ## [0.1.18](https://github.com/wesky93/grpc_requests/releases/tag/v0.1.18) - 2024-05-18
 
-## Added
+### Added
 
 - Support for lazy loading of services in async clients
 
 ## [0.1.17](https://github.com/wesky93/grpc_requests/releases/tag/v0.1.17) - 2024-04-22
 
-## Added
+### Added
 
 - Support for custom message parsing in both async and sync clients
 
-## Removed
+### Removed
 
 - Removed singular FileDescriptor getter methods and Method specific field descriptor
   methods as laid out previously.
 
 ## [0.1.16](https://github.com/wesky93/grpc_requests/releases/tag/v0.1.16) - 2024-03-03
 
-## Added
+### Added
 
 - Additional usage examples
 
-## Fixed
+### Fixed
 
 - Put deprecation warnings in the correct place for old get_descriptor methods, so they do not warn at all times.
 
 ## [0.1.15](https://github.com/wesky93/grpc_requests/releases/tag/v0.1.15) - 2024-02-17
 
-## Added
+### Added
 
 - Add methods to return FileDescriptors and their transistive dependencies as requested by either a name or symbol
 - Add option to skip automatic checking of method availability
 
-## Deprecated
+### Deprecated
 
 - Due to the possibility of transient dependencies being missed, or other name or symbol collisions, methods to access singular FileDescriptors are deprecated and will be removed in version 0.1.17
 - The method to retrieve fields of a method's descriptor input type alone will be removed in version 0.1.17
 
 ## [0.1.14](https://github.com/wesky93/grpc_requests/releases/tag/v0.1.14) - 2024-01-06
 
-## Added
+### Added
 
 - MethodMetaData accessible to clients
 - MethodDescriptors accessible via MethodMetaData
@@ -55,49 +79,47 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [0.1.13](https://github.com/wesky93/grpc_requests/releases/tag/v0.1.13) - 2023-12-03
 
-## Added
+### Added
 
 - Added channel interceptors for standard and async clients
 
-## Fixed
+### Fixed
 
 - Refactored how methods and services are added to description pool to better avoid cases where FileDescriptors may be added twice.
 
 ## [0.1.12](https://github.com/wesky93/grpc_requests/releases/tag/v0.1.12) - 2023-11-26
 
-## Added
+### Added
 
 - Method to print out a generic descriptor added to utils collection
 - Helper methods to print out a method's request and responses in a human readable format
 
-## Changed
+### Changed
 
 - Documentation revamped
 - Version checks to avoid using deprecated methods added to async client
 
-## Fixed
+### Fixed
 
 - Include `requirements.txt` in build manifest
 
-## Deprecated
+### Deprecated
 
 - Method to retrieve fields for the descriptor of a method's input type.
 
-## Added
-
 ## [0.1.11](https://github.com/wesky93/grpc_requests/releases/tag/v0.1.11) - 2023-10-05
 
-## Added
+### Added
 
 - Method to retrieve fields for the descriptor of a method's input type.
 
-## Changes
+### Changes
 
 - Updates to minimum versons of requirements to address vulnerabilities
 
 ## [0.1.10](https://github.com/wesky93/grpc_requests/releases/tag/v0.1.10) - 2023-03-07
 
-## Fixed
+### Fixed
 
 - Corrected pin of `protobuf` version in `requirements.txt`
 

README.md

@@ -1,5 +1,6 @@
 # grpc_requests
 
+[![Nox](https://img.shields.io/badge/%F0%9F%A6%8A-Nox-D85E00.svg)](https://github.com/wntrblm/nox)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
 [![PyPI](https://img.shields.io/pypi/v/grpc-requests?style=flat-square)](https://pypi.org/project/grpc-requests)
@@ -19,7 +20,7 @@ from grpc_requests import Client
 client = Client.get_by_endpoint("localhost:50051")
 assert client.service_names == ["helloworld.Greeter"]
 
-request_data = {"name": "sinsky"} 
+request_data = {"name": "sinsky"}
 say_hello_response = client.request("helloworld.Greeter", "SayHello", request_data)
 assert say_hello_response ==  {"message":"Hello sinsky!"}
 ```
@@ -60,15 +61,28 @@ usage scenarioes, and the [unit tests](./src/tests/) are also a useful reference
 
 Contributions from the community are welcomed and greatly appreciated.
 
-Before opening a PR, [tests.sh](./tests.sh) can be used to ensure the contribution passes
-linting and unit test checks. You can also run [complexity.sh](./complexity.sh) to use
+Before opening a PR, running `python -m nox` can be used to ensure the contribution passes
+linting and unit test checks for all supported versions of Python and protobuf.
+You can also run [complexity.sh](./complexity.sh) to use
 [radon](https://pypi.org/project/radon/) to look at the cyclomatic complexity,
 maintainability index, and Halstead effort and difficulty of files.
 
 PRs should be targeted to merge with the `develop` branch. When opening a PR,
 please assign it to a maintainer for review. The maintainers will take it from
 there.
 
+## Compatibility
+
+`grpc_requests` currently does its best to support versions of Python and
+protobuf that are within their support lifetimes. You may find that other versions
+of dependencies work with the library, but this should be treated as a happy accident.
+
+For Python, we target versions that are in the security and bugfix phases.
+For protobuf, we target versions that in their public support phase.
+
+[Python's support matrix](https://devguide.python.org/versions/)
+[Protobuf's support matrix](https://protobuf.dev/support/version-support/#python)
+
 ## Questions, Comments, Issues?
 
 For questions, please start a conversation on the [discussions page](https://github.com/wesky93/grpc_requests/discussions)!

noxfile.py

@@ -0,0 +1,23 @@
+import nox
+
+@nox.session
+@nox.parametrize(
+    "python,protobuf",
+    [
+        (python, protobuf)
+        for python in ["3.8","3.9","3.10","3.11","3.12"]
+        for protobuf in ["4.25.4","5.27.3"]
+    ]
+)
+def test(session, protobuf):
+    session.install("-e",".")
+    session.install("-r", "requirements-test.txt")
+    session.install(f"protobuf=={protobuf}")
+    session.run("pytest")
+
+@nox.session
+def lint(session):
+    session.install("-r", "requirements-lint.txt")
+    session.run("ruff", "check", "src/", "--statistics", "--config", "ruff.toml")
+    session.run("ruff", "format", "src/", "--config", "ruff.toml")
+    session.run("mypy", "src/grpc_requests/")

requirements-dev.txt

@@ -12,4 +12,5 @@ grpcio-tools>=1.60.1
 grpc-stubs >= 1.53.0
 types-protobuf>=5.26.0
 radon>=6.0.1
-mypy>=1.10.0
+mypy>=1.10.0
+nox>=2024.4.15

requirements-lint.txt

@@ -0,0 +1,4 @@
+grpc-stubs >= 1.53.0
+mypy>=1.10.0
+ruff>=0.1.7
+types-protobuf>=5.26.0

requirements-test.txt

@@ -0,0 +1,8 @@
+grpcio >= 1.60.1
+grpcio-reflection >= 1.60.1
+google-api-core>=2.11.1
+cryptography>=41.0.7
+pytest-cov>=4.0.0
+pytest-asyncio>=0.15.1
+aiounittest>=1.4.2
+grpc-interceptor>=0.15.4

requirements.txt

@@ -1,5 +1,5 @@
 grpcio >= 1.60.1
 grpcio-reflection >= 1.60.1
-protobuf>=3.20.3,<5.0.0dev
+protobuf>=3.20.3
 google-api-core>=2.11.1
-cryptography>=41.0.7
+cryptography>=41.0.7

ruff.toml

@@ -1,5 +1,8 @@
-# Continue supporting python 3.7
-target-version = "py37"
+target-version = "py38"
+
+# Exclude compiled Protobuf files
+exclude = ["**/*_pb2.py", "**/*_pb2_grpc.py", "**/*_pb2.pyi", "**/*_pb2_grpc.pyi"]
+
 
 [lint]
 # Bugbear Rules
@@ -14,6 +17,3 @@ unfixable = ["B"]
 [lint.per-file-ignores]
 "__init__.py" = ["E402"]
 "**/{tests,docs,tools}/*" = ["E402"]
-
-
-

src/examples/client_tester_client.py

@@ -9,41 +9,41 @@
 running.
 """
 
-host = 'localhost'
-port = '50051'
+host = "localhost"
+port = "50051"
 endpoint = f"{host}:{port}"
 
 client = Client.get_by_endpoint(endpoint)
 
-service = 'client_tester.ClientTester'
+service = "client_tester.ClientTester"
 
 # Unary-Unary Example
 
-unary_unary_method = 'TestUnaryUnary'
+unary_unary_method = "TestUnaryUnary"
 unary_unary_request = {}
 
 response = client.unary_unary(service, unary_unary_method, unary_unary_request)
 print(response)
 
 # Unary-Stream Example
 
-unary_stream_method = 'TestUnaryStream'
+unary_stream_method = "TestUnaryStream"
 unary_stream_request = {}
 
 responses = client.unary_stream(service, unary_stream_method, unary_stream_request)
 print(responses)
 
 # Stream-Unary Example
 
-stream_unary_method = 'TestStreamUnary'
+stream_unary_method = "TestStreamUnary"
 stream_unary_request = [{}, {}, {}]
 
 response = client.stream_unary(service, stream_unary_method, stream_unary_request)
 print(response)
 
 # Stream-Stream Example
 
-stream_stream_method = 'TestStreamStream'
+stream_stream_method = "TestStreamStream"
 stream_stream_request = [{}, {}, {}]
 
 responses = client.stream_stream(service, stream_stream_method, stream_stream_request)