Merge branch 'upstream-main' into live-generated-code-tests

Author: eli-bl

.changeset/drop_support_for_python_38.md

@@ -0,0 +1,8 @@
+---
+default: major
+---
+
+# Drop support for Python 3.8
+
+Python 3.8 is no longer supported. "New" 3.9 syntax, like generics on builtin collections, is used both in the generator 
+and the generated code.

.changeset/type_is_now_a_reserved_field_name.md

@@ -0,0 +1,8 @@
+---
+default: major
+---
+
+# `type` is now a reserved field name
+
+Because `type` is used in type annotations now, it is no longer a valid field name. Fields which were previously named 
+`type` will be renamed to `type_`.

.github/workflows/checks.yml

@@ -131,7 +131,7 @@ jobs:
       - name: Set up Python
         uses: actions/[email protected]
         with:
-          python-version: "3.8"
+          python-version: "3.9"
       - name: Get Python Version
         id: get_python_version
         run: echo "python_version=$(python --version)" >> $GITHUB_OUTPUT

.github/workflows/release.yml

@@ -18,6 +18,6 @@ jobs:
       - name: Build
         run: hatchling build
       - name: Push to PyPI
-        uses: pypa/gh-action-pypi-publish@v1.10.3
+        uses: pypa/gh-action-pypi-publish@v1.12.2
         with:
             attestations: true

CHANGELOG.md

@@ -13,6 +13,13 @@ Programmatic usage of this project (e.g., importing it as a Python module) and t
 
 The 0.x prefix used in versions for this project is to indicate that breaking changes are expected frequently (several times a year). Breaking changes will increment the minor number, all other changes will increment the patch number. You can track the progress toward 1.0 [here](https://github.com/openapi-generators/openapi-python-client/projects/2).
 
+## 0.21.7 (2024-10-28)
+
+### Fixes
+
+- allow required fields list to be specified as empty (#651) (#1149)
+- import cast for required const properties, since it's used in the template (#1153)
+
 ## 0.21.6 (2024-10-20)
 
 ### Features

CONTRIBUTING.md

@@ -41,7 +41,7 @@ To request a feature:
 ### Setting up a Dev Environment
 
 1. Make sure you have [PDM](https://pdm-project.org) installed and up to date.
-2. Make sure you have a supported Python version (e.g. 3.8) installed.
+2. Make sure you have a supported Python version (e.g. 3.13) installed.
 3. Use `pdm install` in the project directory to create a virtual environment with the relevant dependencies.
 
 ### Writing tests

end_to_end_tests/custom-templates-golden-record/my_test_api_client/api/__init__.py

@@ -1,7 +1,5 @@
 """Contains methods for accessing the API"""
 
-from typing import Type
-
 from .bodies import BodiesEndpoints
 from .config import ConfigEndpoints
 from .default import DefaultEndpoints
@@ -19,53 +17,53 @@
 
 class MyTestApiClientApi:
     @classmethod
-    def bodies(cls) -> Type[BodiesEndpoints]:
+    def bodies(cls) -> type[BodiesEndpoints]:
         return BodiesEndpoints
 
     @classmethod
-    def tests(cls) -> Type[TestsEndpoints]:
+    def tests(cls) -> type[TestsEndpoints]:
         return TestsEndpoints
 
     @classmethod
-    def defaults(cls) -> Type[DefaultsEndpoints]:
+    def defaults(cls) -> type[DefaultsEndpoints]:
         return DefaultsEndpoints
 
     @classmethod
-    def enums(cls) -> Type[EnumsEndpoints]:
+    def enums(cls) -> type[EnumsEndpoints]:
         return EnumsEndpoints
 
     @classmethod
-    def responses(cls) -> Type[ResponsesEndpoints]:
+    def responses(cls) -> type[ResponsesEndpoints]:
         return ResponsesEndpoints
 
     @classmethod
-    def default(cls) -> Type[DefaultEndpoints]:
+    def default(cls) -> type[DefaultEndpoints]:
         return DefaultEndpoints
 
     @classmethod
-    def parameters(cls) -> Type[ParametersEndpoints]:
+    def parameters(cls) -> type[ParametersEndpoints]:
         return ParametersEndpoints
 
     @classmethod
-    def tag1(cls) -> Type[Tag1Endpoints]:
+    def tag1(cls) -> type[Tag1Endpoints]:
         return Tag1Endpoints
 
     @classmethod
-    def location(cls) -> Type[LocationEndpoints]:
+    def location(cls) -> type[LocationEndpoints]:
         return LocationEndpoints
 
     @classmethod
-    def true_(cls) -> Type[True_Endpoints]:
+    def true_(cls) -> type[True_Endpoints]:
         return True_Endpoints
 
     @classmethod
-    def naming(cls) -> Type[NamingEndpoints]:
+    def naming(cls) -> type[NamingEndpoints]:
         return NamingEndpoints
 
     @classmethod
-    def parameter_references(cls) -> Type[ParameterReferencesEndpoints]:
+    def parameter_references(cls) -> type[ParameterReferencesEndpoints]:
         return ParameterReferencesEndpoints
 
     @classmethod
-    def config(cls) -> Type[ConfigEndpoints]:
+    def config(cls) -> type[ConfigEndpoints]:
         return ConfigEndpoints

end_to_end_tests/generated_client.py

@@ -5,7 +5,7 @@
 from pathlib import Path
 import sys
 import tempfile
-from typing import Any, List, Optional, Set
+from typing import Any, Optional
 
 from attrs import define
 import pytest
@@ -28,7 +28,7 @@ class GeneratedClientContext:
     generator_result: Result
     base_module: str
     monkeypatch: pytest.MonkeyPatch
-    old_modules: Optional[Set[str]] = None
+    old_modules: Optional[set[str]] = None
 
     def __enter__(self) -> "GeneratedClientContext":
         self.monkeypatch.syspath_prepend(self.output_path)
@@ -59,7 +59,7 @@ def import_symbol(self, module_path: str, name: str) -> Any:
 
 def _run_command(
     command: str,
-    extra_args: Optional[List[str]] = None,
+    extra_args: Optional[list[str]] = None,
     openapi_document: Optional[str] = None,
     url: Optional[str] = None,
     config_path: Optional[Path] = None,
@@ -85,7 +85,7 @@ def _run_command(
 
 def generate_client(
     openapi_document: str,
-    extra_args: List[str] = [],
+    extra_args: list[str] = [],
     output_path: str = "my-test-api-client",
     base_module: str = "my_test_api_client",
     specify_output_path_explicitly: bool = True,
@@ -112,7 +112,7 @@ def generate_client(
 
 def generate_client_from_inline_spec(
     openapi_spec: str,
-    extra_args: List[str] = [],
+    extra_args: list[str] = [],
     config: str = "",
     filename_suffix: Optional[str] = None,
     base_module: str = "testapi_client",

end_to_end_tests/golden-record/my_test_api_client/api/bodies/json_like.py

@@ -1,5 +1,5 @@
 from http import HTTPStatus
-from typing import Any, Dict, Optional, Union
+from typing import Any, Optional, Union
 
 import httpx
 
@@ -12,10 +12,10 @@
 def _get_kwargs(
     *,
     body: JsonLikeBody,
-) -> Dict[str, Any]:
-    headers: Dict[str, Any] = {}
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
 
-    _kwargs: Dict[str, Any] = {
+    _kwargs: dict[str, Any] = {
         "method": "post",
         "url": "/bodies/json-like",
     }

end_to_end_tests/golden-record/my_test_api_client/api/bodies/post_bodies_multiple.py

@@ -1,5 +1,5 @@
 from http import HTTPStatus
-from typing import Any, Dict, Optional, Union
+from typing import Any, Optional, Union
 
 import httpx
 
@@ -19,10 +19,10 @@ def _get_kwargs(
         PostBodiesMultipleDataBody,
         PostBodiesMultipleFilesBody,
     ],
-) -> Dict[str, Any]:
-    headers: Dict[str, Any] = {}
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
 
-    _kwargs: Dict[str, Any] = {
+    _kwargs: dict[str, Any] = {
         "method": "post",
         "url": "/bodies/multiple",
     }

end_to_end_tests/golden-record/my_test_api_client/api/bodies/refs.py

@@ -1,5 +1,5 @@
 from http import HTTPStatus
-from typing import Any, Dict, Optional, Union
+from typing import Any, Optional, Union
 
 import httpx
 
@@ -12,10 +12,10 @@
 def _get_kwargs(
     *,
     body: AModel,
-) -> Dict[str, Any]:
-    headers: Dict[str, Any] = {}
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
 
-    _kwargs: Dict[str, Any] = {
+    _kwargs: dict[str, Any] = {
         "method": "post",
         "url": "/bodies/refs",
     }

end_to_end_tests/golden-record/my_test_api_client/api/config/content_type_override.py

@@ -1,5 +1,5 @@
 from http import HTTPStatus
-from typing import Any, Dict, Optional, Union, cast
+from typing import Any, Optional, Union, cast
 
 import httpx
 
@@ -11,10 +11,10 @@
 def _get_kwargs(
     *,
     body: str,
-) -> Dict[str, Any]:
-    headers: Dict[str, Any] = {}
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
 
-    _kwargs: Dict[str, Any] = {
+    _kwargs: dict[str, Any] = {
         "method": "post",
         "url": "/config/content-type-override",
     }

end_to_end_tests/golden-record/my_test_api_client/api/default/get_common_parameters.py

@@ -1,5 +1,5 @@
 from http import HTTPStatus
-from typing import Any, Dict, Optional, Union
+from typing import Any, Optional, Union
 
 import httpx
 
@@ -11,14 +11,14 @@
 def _get_kwargs(
     *,
     common: Union[Unset, str] = UNSET,
-) -> Dict[str, Any]:
-    params: Dict[str, Any] = {}
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
 
     params["common"] = common
 
     params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
 
-    _kwargs: Dict[str, Any] = {
+    _kwargs: dict[str, Any] = {
         "method": "get",
         "url": "/common_parameters",
         "params": params,

end_to_end_tests/golden-record/my_test_api_client/api/default/get_models_allof.py

@@ -1,5 +1,5 @@
 from http import HTTPStatus
-from typing import Any, Dict, Optional, Union
+from typing import Any, Optional, Union
 
 import httpx
 
@@ -9,8 +9,8 @@
 from ...types import Response
 
 
-def _get_kwargs() -> Dict[str, Any]:
-    _kwargs: Dict[str, Any] = {
+def _get_kwargs() -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
         "method": "get",
         "url": "/models/allof",
     }

end_to_end_tests/golden-record/my_test_api_client/api/default/get_models_oneof_with_required_const.py

@@ -1,5 +1,5 @@
 from http import HTTPStatus
-from typing import Any, Dict, Optional, Union
+from typing import Any, Optional, Union
 
 import httpx
 
@@ -14,8 +14,8 @@
 from ...types import Response
 
 
-def _get_kwargs() -> Dict[str, Any]:
-    _kwargs: Dict[str, Any] = {
+def _get_kwargs() -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
         "method": "get",
         "url": "/models/oneof-with-required-const",
     }

end_to_end_tests/golden-record/my_test_api_client/api/default/post_common_parameters.py

@@ -1,5 +1,5 @@
 from http import HTTPStatus
-from typing import Any, Dict, Optional, Union
+from typing import Any, Optional, Union
 
 import httpx
 
@@ -11,14 +11,14 @@
 def _get_kwargs(
     *,
     common: Union[Unset, str] = UNSET,
-) -> Dict[str, Any]:
-    params: Dict[str, Any] = {}
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
 
     params["common"] = common
 
     params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
 
-    _kwargs: Dict[str, Any] = {
+    _kwargs: dict[str, Any] = {
         "method": "post",
         "url": "/common_parameters",
         "params": params,

end_to_end_tests/golden-record/my_test_api_client/api/default/reserved_parameters.py

@@ -1,5 +1,5 @@
 from http import HTTPStatus
-from typing import Any, Dict, Optional, Union
+from typing import Any, Optional, Union
 
 import httpx
 
@@ -12,16 +12,16 @@ def _get_kwargs(
     *,
     client_query: str,
     url_query: str,
-) -> Dict[str, Any]:
-    params: Dict[str, Any] = {}
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
 
     params["client"] = client_query
 
     params["url"] = url_query
 
     params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
 
-    _kwargs: Dict[str, Any] = {
+    _kwargs: dict[str, Any] = {
         "method": "get",
         "url": "/naming/reserved-parameters",
         "params": params,