Merge branch 'main' into fix-multipart-body-file-array

Author: dbanty

.changeset/const_values_are_now_validated_at_runtime.md

@@ -0,0 +1,10 @@
+---
+default: major
+---
+
+# `const` values in responses are now validated at runtime
+
+Prior to this version, `const` values returned from servers were assumed to always be correct. Now, if a server returns 
+an unexpected value, the client will raise a `ValueError`. This should enable better usage with `oneOf`.
+
+PR #1024. Thanks @peter-greenatlas!

.changeset/switch_yaml_parsing_to_12.md

@@ -0,0 +1,11 @@
+---
+default: major
+---
+
+# Switch YAML parsing to 1.2
+
+This change switches the YAML parsing library to `ruamel.yaml` which follows the YAML 1.2 specification. 
+[There are breaking changes](https://yaml.readthedocs.io/en/latest/pyyaml/#defaulting-to-yaml-12-support) from YAML 1.1 to 1.2,
+though they will not affect most use cases.
+
+PR #1042 fixes #1041. Thanks @rtaycher!

.github/workflows/checks.yml

@@ -15,9 +15,9 @@ jobs:
         os: [ ubuntu-latest, macos-latest, windows-latest ]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v4.1.1
+      - uses: actions/checkout@v4.1.6
       - name: Set up Python
-        uses: actions/setup-python@v5.0.0
+        uses: actions/setup-python@v5.1.0
         with:
           python-version: ${{ matrix.python }}
 
@@ -67,7 +67,7 @@ jobs:
         if: matrix.os == 'ubuntu-latest'
 
       - name: Store coverage report
-        uses: actions/upload-artifact@v4.3.1
+        uses: actions/upload-artifact@v4.3.3
         if: matrix.os == 'ubuntu-latest'
         with:
           name: coverage-${{ matrix.python }}
@@ -79,12 +79,12 @@ jobs:
     needs: test
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4.1.1
+      - uses: actions/checkout@v4.1.6
       - uses: actions/setup-python@v5
         with:
           python-version: "3.12"
       - name: Download coverage reports
-        uses: actions/download-artifact@v4.1.2
+        uses: actions/download-artifact@v4.1.7
         with:
           merge-multiple: true
 
@@ -109,7 +109,7 @@ jobs:
           .venv/bin/python -m coverage report --fail-under=100          
 
       - name: Upload HTML report if check failed.
-        uses: actions/upload-artifact@v4.3.1
+        uses: actions/upload-artifact@v4.3.3
         with:
           name: html-report
           path: htmlcov
@@ -129,9 +129,9 @@ jobs:
         ports:
           - "3000:3000"
     steps:
-      - uses: actions/checkout@v4.1.1
+      - uses: actions/checkout@v4.1.6
       - name: Set up Python
-        uses: actions/setup-python@v5.0.0
+        uses: actions/setup-python@v5.1.0
         with:
           python-version: "3.8"
       - name: Get Python Version

.github/workflows/preview_release_pr.yml

@@ -7,17 +7,17 @@ jobs:
     if: "!contains(github.event.head_commit.message, 'chore: prepare release')" # Skip merges from releases
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4.1.1
+      - uses: actions/checkout@v4.1.6
         with:
           fetch-depth: 0
           token: ${{ secrets.PAT }}
       - name: Configure Git
         run: |
           git config --global user.name GitHub Actions
           git config user.email github-actions@github.com
-      - uses: knope-dev/action@v2.0.0
+      - uses: knope-dev/action@v2.1.0
         with:
-          version: 0.14.0
+          version: 0.16.2
       - run: knope prepare-release --verbose
         env:
           GITHUB_TOKEN: ${{ secrets.PAT }}

.github/workflows/release-dry-run.yml

@@ -6,12 +6,12 @@ jobs:
   release:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4.1.1
+      - uses: actions/checkout@v4.1.6
         with:
           fetch-depth: 0
           token: ${{ secrets.GITHUB_TOKEN }}
       - name: Install Knope
-        uses: knope-dev/action@v2.0.0
+        uses: knope-dev/action@v2.1.0
         with:
-          version: 0.14.0
+          version: 0.16.2
       - run: knope prepare-release --dry-run

.github/workflows/release.yml

@@ -12,20 +12,20 @@ jobs:
     permissions:
       id-token: write
     steps:
-      - uses: actions/checkout@v4.1.1
+      - uses: actions/checkout@v4.1.6
         with:
           fetch-depth: 0
           token: ${{ secrets.PAT }}
       - name: Install Knope
-        uses: knope-dev/action@v2.0.0
+        uses: knope-dev/action@v2.1.0
         with:
-          version: 0.14.0
+          version: 0.16.2
       - name: Install Hatchling
         run: pip install --upgrade hatchling
       - name: Build
         run: hatchling build
       - name: Push to PyPI
-        uses: pypa/gh-action-pypi-publish@v1.8.11
+        uses: pypa/gh-action-pypi-publish@v1.8.14
       - name: Create GitHub Release
         run: knope release
         env:

.gitignore

@@ -4,6 +4,7 @@ build/
 dist/
 *.egg-info/
 .pytest_cache/
+.ruff_cache
 
 # macOS
 .DS_Store

CHANGELOG.md

@@ -13,6 +13,62 @@ 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.19.1 (2024-03-27)
+
+### Features
+
+#### Add config option to override content types
+
+You can now define a `content_type_overrides` field in your `config.yml`:
+
+```yaml
+content_type_overrides:
+  application/zip: application/octet-stream
+```
+
+This allows `openapi-python-client` to generate code for content types it doesn't recognize.
+
+PR #1010 closes #810. Thanks @gaarutyunov!
+
+### Fixes
+
+#### Add aliases to `Client` for pyright
+
+This should resolve incompatibilities between the generated `Client` class and the pyright type checker.
+
+PR #1009 closes #909. Thanks @patrick91!
+
+## 0.19.0 (2024-03-06)
+
+### Breaking Changes
+
+#### Update PDM metadata syntax
+
+Metadata generated for PDM will now use the new `distribution = true` syntax instead of `package-type = "library"`. 
+New packages generated with `--meta pdm` will require PDM `2.12.0` or later to build. 
+
+### Features
+
+#### Add response content to `UnexpectedStatus` exception
+
+The error message for `UnexpectedStatus` exceptions will now include the UTF-8 decoded (ignoring errors) body of the response.
+
+PR #989 implements #840. Thanks @harabat!
+
+### Fixes
+
+#### Allow hyphens in path parameters
+
+Before now, path parameters which were invalid Python identifiers were not allowed, and would fail generation with an
+"Incorrect path templating" error. In particular, this meant that path parameters with hyphens were not allowed.
+This has now been fixed!
+
+PR #986 fixed issue #976. Thanks @harabat!
+
+> [!WARNING]
+> This change may break custom templates, see [this diff](https://github.com/openapi-generators/openapi-python-client/pull/986/files#diff-0de8437b26075d8fe8454cf47d8d95d4835c7f827fa87328e03f690412be803e)
+> if you have trouble upgrading.
+
 ## 0.18.0 (2024-02-22)
 
 ### Breaking Changes

README.md

@@ -156,6 +156,16 @@ If this option results in conflicts, you will need to manually override class na
 
 By default, the timeout for retrieving the schema file via HTTP is 5 seconds. In case there is an error when retrieving the schema, you might try and increase this setting to a higher value.
 
+### content_type_overrides
+
+Normally, `openapi-python-client` will skip any bodies or responses that it doesn't recognize the content type for.
+This config tells the generator to treat a given content type like another.
+
+```yaml
+content_type_overrides:
+  application/zip: application/octet-stream
+```
+
 [changelog.md]: CHANGELOG.md
 [poetry]: https://python-poetry.org/
 [PDM]: https://pdm-project.org/latest/

end_to_end_tests/baseline_openapi_3.0.json

@@ -1508,6 +1508,27 @@
         }
       }
     },
+    "/naming/{hyphen-in-path}": {
+      "get": {
+        "tags": ["naming"],
+        "operationId": "hyphen_in_path",
+        "parameters": [
+          {
+            "name": "hyphen-in-path",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful response"
+          }
+        }
+      }
+    },
     "/parameter-references/{path_param}": {
       "get": {
         "tags": [
@@ -1608,6 +1629,36 @@
           }
         }
       }
+    },
+    "/config/content-type-override": {
+      "post": {
+        "tags": [
+          "config"
+        ],
+        "summary": "Content Type Override",
+        "operationId": "content_type_override",
+        "requestBody": {
+          "content": {
+            "openapi/python/client": {
+              "schema": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "openapi/python/client": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {

end_to_end_tests/baseline_openapi_3.1.yaml

@@ -1502,6 +1502,27 @@ info:
       }
     }
   },
+  "/naming/{hyphen-in-path}": {
+    "get": {
+      "tags": [ "naming" ],
+      "operationId": "hyphen_in_path",
+      "parameters": [
+        {
+          "name": "hyphen-in-path",
+          "in": "path",
+          "required": true,
+          "schema": {
+            "type": "string"
+          }
+        }
+      ],
+      "responses": {
+        "200": {
+          "description": "Successful response"
+        }
+      }
+    }
+  },
   "/parameter-references/{path_param}": {
     "get": {
       "tags": [
@@ -1602,6 +1623,36 @@ info:
         }
       }
     }
+  },
+  "/config/content-type-override": {
+    "post": {
+      "tags": [
+        "config"
+      ],
+      "summary": "Content Type Override",
+      "operationId": "content_type_override",
+      "requestBody": {
+        "content": {
+          "openapi/python/client": {
+            "schema": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "responses": {
+        "200": {
+          "description": "Successful Response",
+          "content": {
+            "openapi/python/client": {
+              "schema": {
+                "type": "string"
+              }
+            }
+          }
+        }
+      }
+    }
   }
 }
 "components": {

end_to_end_tests/config.yml

@@ -9,3 +9,5 @@ class_overrides:
     class_name: AnEnumValue
     module_name: an_enum_value
 field_prefix: attr_
+content_type_overrides:
+   openapi/python/client: application/json

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

@@ -1,8 +1,9 @@
-""" Contains methods for accessing the API """
+"""Contains methods for accessing the API"""
 
 from typing import Type
 
 from .bodies import BodiesEndpoints
+from .config import ConfigEndpoints
 from .default import DefaultEndpoints
 from .defaults import DefaultsEndpoints
 from .enums import EnumsEndpoints
@@ -64,3 +65,7 @@ def naming(cls) -> Type[NamingEndpoints]:
     @classmethod
     def parameter_references(cls) -> Type[ParameterReferencesEndpoints]:
         return ParameterReferencesEndpoints
+
+    @classmethod
+    def config(cls) -> Type[ConfigEndpoints]:
+        return ConfigEndpoints

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

@@ -1,4 +1,4 @@
-""" Contains methods for accessing the API Endpoints """
+"""Contains methods for accessing the API Endpoints"""
 
 import types