Merge branch 'main' into avoid-duplicating-enum-property-names-1167

Author: dbanty

.changeset/properly_rebuild_pydantic_models_if_necessary.md

@@ -0,0 +1,10 @@
+---
+default: patch
+---
+
+# Fix compatibility with Pydantic 2.10+
+
+#1176 by @Viicos
+
+Set `defer_build` to models that we know will fail to build, and call `model_rebuild`
+in the `__init__.py` file.

.github/workflows/checks.yml

@@ -11,7 +11,7 @@ jobs:
   test:
     strategy:
       matrix:
-        python: [ "3.8", "3.9", "3.10", "3.11", "3.12", "3.13" ]
+        python: [ "3.9", "3.10", "3.11", "3.12", "3.13" ]
         os: [ ubuntu-latest, macos-latest, windows-latest ]
     runs-on: ${{ matrix.os }}
     steps:
@@ -51,27 +51,62 @@ jobs:
       - name: Run pytest without coverage
         if: matrix.os != 'ubuntu-latest'
         run: pdm test
-        env:
-          TASKIPY: true
 
       - name: Run pytest with coverage
         if: matrix.os == 'ubuntu-latest'
         run: pdm test_with_coverage
-        env:
-          TASKIPY: true
-      
+
       - run: mv .coverage .coverage.${{ matrix.python }}
         if: matrix.os == 'ubuntu-latest'
 
       - name: Store coverage report
-        uses: actions/upload-artifact@v4.4.3
+        uses: actions/upload-artifact@v4.5.0
         if: matrix.os == 'ubuntu-latest'
         with:
           name: coverage-${{ matrix.python }}
           path: .coverage.${{ matrix.python }}
           if-no-files-found: error
           include-hidden-files: true
 
+  test_min_deps:
+    strategy:
+      matrix:
+        os: [ ubuntu-latest, macos-latest, windows-latest ]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/[email protected]
+      - name: Set up Python
+        uses: actions/[email protected]
+        with:
+          python-version: "3.9"
+
+      - name: Get Python Version
+        id: get_python_version
+        run: echo "python_version=$(python --version)" >> $GITHUB_OUTPUT
+        shell: bash
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: .venv
+          key: ${{ runner.os }}-${{ steps.get_python_version.outputs.python_version }}-min-dependencies-${{ hashFiles('**/pdm.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ steps.get_python_version.outputs.python_version }}-min-dependencies
+      - name: Install PDM
+        run: pip install pdm
+
+      - name: Install minimum dependencies
+        run: pdm install -L pdm.minimal.lock
+
+      - name: Run mypy
+        run: pdm mypy --show-error-codes
+
+      - name: Lint
+        run: pdm run ruff check .
+
+      - name: Run unit tests only  # snapshots are expected to fail
+        run: pdm unit_test
+
   coverage:
     name: Combine & check coverage
     needs: test
@@ -107,7 +142,7 @@ jobs:
           .venv/bin/python -m coverage report --fail-under=100          
 
       - name: Upload HTML report if check failed.
-        uses: actions/upload-artifact@v4.4.3
+        uses: actions/upload-artifact@v4.5.0
         with:
           name: html-report
           path: htmlcov
@@ -131,7 +166,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.3
         with:
             attestations: true

CHANGELOG.md

@@ -13,6 +13,31 @@ 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.22.0 (2024-11-23)
+
+### Breaking Changes
+
+#### 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.
+
+#### `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_`.
+
+### Features
+
+- Support Ruff 0.8 (#1169)
+
+## 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/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",
     }