Merge pull request #18 from OpenPaymentNetwork/main

Fix typing compatibility for Python 3.9

Author: mike-oakley

openapi_pydantic/compat.py

@@ -1,6 +1,6 @@
 """Compatibility layer to make this package usable with Pydantic 1 or 2"""
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Optional
 
 from pydantic.version import VERSION as PYDANTIC_VERSION
 
@@ -30,7 +30,7 @@
 
     def ConfigDict(
         extra: Literal["allow", "ignore", "forbid"] = "allow",
-        json_schema_extra: dict[str, Any] | None = None,
+        json_schema_extra: Optional[dict[str, Any]] = None,
         populate_by_name: bool = True,
     ) -> PydanticConfigDict:
         """Stub for pydantic.ConfigDict in Pydantic 2"""
@@ -53,7 +53,7 @@ def models_json_schema(
         *,
         by_alias: bool = True,
         ref_template: str = "#/$defs/{model}",
-        schema_generator: type | None = None,
+        schema_generator: Optional[type] = None,
     ) -> tuple[dict, dict[str, Any]]:
         """Stub for pydantic.json_schema.models_json_schema in Pydantic 2"""
         ...

openapi_pydantic/v3/v3_0_3/schema.py

@@ -602,9 +602,9 @@ class Config:
     def schema_validate(
         obj: Any,
         *,
-        strict: bool | None = None,
-        from_attributes: bool | None = None,
-        context: dict[str, Any] | None = None
+        strict: Optional[bool] = None,
+        from_attributes: Optional[bool] = None,
+        context: Optional[dict[str, Any]] = None
     ) -> Schema:
         ...
 

openapi_pydantic/v3/v3_0_3/util.py

@@ -1,5 +1,16 @@
 import logging
-from typing import TYPE_CHECKING, Any, Generic, List, Optional, Set, Type, TypeVar, cast
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Generic,
+    List,
+    Optional,
+    Set,
+    Type,
+    TypeVar,
+    Union,
+    cast,
+)
 
 from pydantic import BaseModel
 
@@ -143,7 +154,7 @@ def construct_open_api_with_schema_class(
 
 def _validate_schemas(
     schema_definitions: dict[str, Any]
-) -> dict[str, Reference | Schema]:
+) -> dict[str, Union[Reference, Schema]]:
     """Convert JSON Schema definitions to parsed OpenAPI objects"""
     # Note: if an error occurs in schema_validate(), it may indicate that
     # the generated JSON schemas are not compatible with the version

openapi_pydantic/v3/v3_1_0/schema.py

@@ -959,9 +959,9 @@ class Config:
     def schema_validate(
         obj: Any,
         *,
-        strict: bool | None = None,
-        from_attributes: bool | None = None,
-        context: dict[str, Any] | None = None
+        strict: Optional[bool] = None,
+        from_attributes: Optional[bool] = None,
+        context: Optional[dict[str, Any]] = None
     ) -> Schema:
         ...
 

tests/util/test_optional_and_computed.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 import pytest
 
 from openapi_pydantic import (
@@ -69,7 +71,7 @@ class ConfigDictExt(ConfigDict, total=False):
 
     class SampleModel(BaseModel):
         req: bool
-        opt: bool | None = None
+        opt: Optional[bool] = None
 
         @computed_field  # type: ignore
         @property

tests/v3_0_3/test_optional_and_computed.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 import pytest
 
 from openapi_pydantic.compat import PYDANTIC_V2, JsonSchemaMode
@@ -72,7 +74,7 @@ class ConfigDictExt(ConfigDict, total=False):
 
     class SampleModel(BaseModel):
         req: bool
-        opt: bool | None = None
+        opt: Optional[bool] = None
 
         @computed_field  # type: ignore
         @property

tox.ini

@@ -1,42 +1,27 @@
 [tox]
 min_version = 4.0
-env_list = format, test_pydantic1, type_pydantic1, test_pydantic2, type_pydantic2, lint, py{3.9,3.10,3.11}
+env_list = format, lint, py{39,310,311}-pydantic{1,2}-{test,type}
 
 [gh-actions]
 python =
     3.9: py39
     3.10: py310
-    3.11: py311, test_pydantic1, type_pydantic1, test_pydantic2, type_pydantic2, format, lint
+    3.11: format, lint, py311
 
-[testenv:test_pydantic1]
+[testenv]
 labels = core
 allowlist_externals = poetry
+# The "pydanticX:", "test:", and "type:" prefixes are Tox factor-conditional settings.
+# https://tox.wiki/en/3.4.0/config.html?highlight=conditional#factors-and-factor-conditional-settings
+# Note that "poetry add" changes pyproject.toml, but at least we
+# change it back when the tests finish.
 commands_pre =
-  poetry install --only main --only test --no-root --all-extras
-  poetry add pydantic^1
-commands = poetry run pytest -vv tests
-
-[testenv:type_pydantic1]
-allowlist_externals = poetry
-commands_pre =
-  poetry install --no-root --all-extras
-  poetry add pydantic^1
-commands = poetry run mypy openapi_pydantic tests
-
-[testenv:test_pydantic2]
-labels = core
-allowlist_externals = poetry
-commands_pre =
-  poetry install --only main --only test --no-root --all-extras
-  poetry add 'pydantic>=1.8'
-commands = poetry run pytest -vv tests
-
-[testenv:type_pydantic2]
-allowlist_externals = poetry
-commands_pre =
+  pydantic1: poetry add --lock pydantic<2
+  pydantic2: poetry add --lock pydantic>=1.8
   poetry install --no-root --all-extras
-  poetry add 'pydantic>=1.8'
-commands = poetry run mypy openapi_pydantic tests
+commands =
+  test: poetry run pytest -vv tests
+  type: poetry run mypy openapi_pydantic tests
 
 [testenv:format]
 allowlist_externals = poetry