Merge branch 'main' into raise-on-error-code

Author: dbanty

.github/renovate.json

@@ -2,5 +2,6 @@
   "extends": [
     "config:base",
     ":semanticCommitTypeAll(chore)"
-  ]
+  ],
+  "rangeStrategy": "widen"
 }

.github/workflows/checks.yml

@@ -10,13 +10,13 @@ jobs:
   test:
     strategy:
       matrix:
-        python: [ "3.7", "3.8", "3.9", "3.10" ]
+        python: [ "3.7", "3.8", "3.9", "3.10", "3.11" ]
         os: [ ubuntu-latest, macos-latest, windows-latest ]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python }}
 
@@ -67,7 +67,7 @@ jobs:
         shell: bash
         run: poetry run coverage xml
 
-      - uses: codecov/codecov-action@v2
+      - uses: codecov/codecov-action@v3
         with:
           files: ./coverage.xml
 
@@ -82,7 +82,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4
         with:
           python-version: "3.10"
       - name: Get Python Version

.github/workflows/codeql-analysis.yml

@@ -29,10 +29,10 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       # Override language selection by uncommenting this and choosing your languages
       with:
         languages: python
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2

.github/workflows/pythonpublish.yml

@@ -0,0 +1,20 @@
+name: Release Dry Run
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.PAT }}
+      - name: Install Knope
+        uses: knope-dev/action@v1
+        with:
+          version: 0.6.2
+      - run: knope release --dry-run

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

@@ -0,0 +1,31 @@
+name: Release
+
+on: workflow_dispatch
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.PAT }}
+      - name: Import GPG key
+        uses: crazy-max/ghaction-import-gpg@v5
+        with:
+          gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
+          git_user_signingkey: true
+          git_commit_gpgsign: true
+          git_push_gpgsign: false
+      - name: Install Knope
+        uses: knope-dev/action@v1
+        with:
+          version: 0.6.2
+      - name: Bump Version & Create GitHub Release
+        run: knope release
+        env:
+          GITHUB_TOKEN: ${{ secrets.PAT }}
+      - name: Install Poetry
+        run: pip install --upgrade poetry
+      - name: Push to PyPI
+        run: poetry publish --build -u __token__ -p ${{ secrets.PYPI_TOKEN }}

.github/workflows/release.yml

@@ -13,6 +13,80 @@ 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.12.2
+
+### Fixes
+
+- Support Python 3.11.0 (#701)
+
+## 0.12.1
+
+### Fixes
+
+- Version bump due to PyPI error
+
+## 0.12.0
+
+### Breaking Changes
+
+- Change the `Response.status_code` type to the `HTTPStatus` enum [#665]
+
+### Features
+
+- Add `endpoint_collections_by_tag` and `openapi` to the templating globals [#689]. Thanks @paulo-raca!
+- Support for recursive and circular references using lazy imports [#670, #338, #466]. Thanks @maz808 & @mtovt!
+- Include `__all__` in generated `__init__.py` files [#676, #631, #540, #675]. Thanks @EltonChou!
+
+### Fixes
+
+- If data.type is None but has data.properties, assume type is object [#691, #674]. Thanks @ahuang11!
+
+## 0.11.6
+
+### Features
+
+- improve the error message when parsing a response fails [#659]. Thanks @supermihi!
+- Authorization header can now be customized in AuthenticatedClient [#660]. Thanks @supermihi!
+- Support inlined form data schema in requestBody [#656, #662]. Thanks @supermihi!
+- Allow enums in headers [#663, #667]. Thanks @supermihi!
+
+### Fixes
+
+- Exception when parsing documents which contain callbacks [#661]. Thanks @dachucky!
+
+## 0.11.5
+
+### Features
+
+- support `#/components/parameters` references [#288, #615, #653]. Thanks @jsanchez7SC!
+
+### Fixes
+
+- Keep trailing newlines in generated files [#646, #654]. Thanks @eliask!
+
+## 0.11.4
+
+### Fixes
+
+- Invalid code generation with some `oneOf` and `anyOf` combinations [#603, #642]. Thanks @jselig-rigetti!
+- Allow relative references in all URLs [#630]. Thanks @jtv8!
+
+## 0.11.3
+
+### Fixes
+
+- Allow tokenUrl to be relative [#618]. Thanks @Fokko!
+
+## 0.11.2
+
+### Features
+
+- Allow httpx 0.23.x (#617)
+
+### Fixes
+
+- typos in generated README (#586). Thanks @adelevie!
+
 ## 0.11.1
 
 ### Features

CHANGELOG.md

@@ -9,7 +9,7 @@
 ## Setting up a Dev Environment
 
 1. Make sure you have [Poetry](https://python-poetry.org/) installed and up to date.
-2. Make sure you have a supported Python version (e.g. 3.8) installed and accessible to Poetry (e.g. with [pyenv](https://github.com/pyenv/pyenv).
+2. Make sure you have a supported Python version (e.g. 3.8) installed and accessible to Poetry (e.g. with [pyenv](https://github.com/pyenv/pyenv)).
 3. Use `poetry install` in the project directory to create a virtual environment with the relevant dependencies.
 4. Enter a `poetry shell` to make running commands easier.
 
@@ -32,7 +32,7 @@
 
 ## Creating a Pull Request
 
-Once you've written the code and run the checks, the next step is to create a pull request against the `main` branch of this repository. This repository uses [conventional commits] squashed on each PR, then uses [Dobby] to auto-generate CHANGELOG.md entries for release. So the title of your PR should be in the format of a conventional commit written in plain english as it will end up in the CHANGELOG. Some example PR titles:
+Once you've written the code and run the checks, the next step is to create a pull request against the `main` branch of this repository. This repository uses [conventional commits] squashed on each PR, then uses [Knope] to auto-generate CHANGELOG.md entries for release. So the title of your PR should be in the format of a conventional commit written in plain english as it will end up in the CHANGELOG. Some example PR titles:
 
 - feat: Support for `allOf` in OpenAPI documents (closes #123).
 - refactor!: Removed support for Python 3.5
@@ -45,4 +45,4 @@ Once your PR is created, a series of automated checks should run. If any of them
 As soon as possible, your PR will be reviewed. If there are any changes requested there will likely be a bit of back and forth. Once this process is done, your changes will be merged into main and included in the next release. If you need your changes available on PyPI by a certain time, please mention it in the PR, and we'll do our best to accommodate.
 
 [Conventional Commits]: https://www.conventionalcommits.org/en/v1.0.0/
-[Dobby]: https://triaxtec.github.io/dobby/introduction.html
+[Knope]: https://knope-dev.github.io/knope/

CONTRIBUTING.md

@@ -157,5 +157,13 @@ post_hooks:
    - "black ."
 ```
 
+### use_path_prefixes_for_title_model_names
+
+By default, `openapi-python-client` generates class names which include the full path to the schema, including any parent-types. This can result in very long class names like `MyRouteSomeClassAnotherClassResponse`—which is very unique and unlikely to cause conflicts with future API additions, but also super verbose.
+
+If you are carefully curating your `title` properties already to ensure no duplicate class names, you can turn off this prefixing feature by setting `use_path_prefixes_for_title_model_names` to `false` in your config file. This will use the `title` property of any object that has it set _without_ prefixing.
+
+If this option results in conflicts, you will need to manually override class names instead via the `class_overrides` option.
+
 [changelog.md]: CHANGELOG.md
 [poetry]: https://python-poetry.org/

README.md

@@ -4,7 +4,9 @@
 
 from .default import DefaultEndpoints
 from .location import LocationEndpoints
+from .parameter_references import ParameterReferencesEndpoints
 from .parameters import ParametersEndpoints
+from .responses import ResponsesEndpoints
 from .tag1 import Tag1Endpoints
 from .tests import TestsEndpoints
 from .true_ import True_Endpoints
@@ -15,6 +17,10 @@ class MyTestApiClientApi:
     def tests(cls) -> Type[TestsEndpoints]:
         return TestsEndpoints
 
+    @classmethod
+    def responses(cls) -> Type[ResponsesEndpoints]:
+        return ResponsesEndpoints
+
     @classmethod
     def default(cls) -> Type[DefaultEndpoints]:
         return DefaultEndpoints
@@ -34,3 +40,7 @@ def location(cls) -> Type[LocationEndpoints]:
     @classmethod
     def true_(cls) -> Type[True_Endpoints]:
         return True_Endpoints
+
+    @classmethod
+    def parameter_references(cls) -> Type[ParameterReferencesEndpoints]:
+        return ParameterReferencesEndpoints

dobby.toml

@@ -0,0 +1,14 @@
+""" Contains methods for accessing the API Endpoints """
+
+import types
+
+from . import get_parameter_references_path_param
+
+
+class ParameterReferencesEndpoints:
+    @classmethod
+    def get_parameter_references_path_param(cls) -> types.ModuleType:
+        """
+        Test different types of parameter references
+        """
+        return get_parameter_references_path_param

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

@@ -0,0 +1,14 @@
+""" Contains methods for accessing the API Endpoints """
+
+import types
+
+from . import post_responses_unions_simple_before_complex
+
+
+class ResponsesEndpoints:
+    @classmethod
+    def post_responses_unions_simple_before_complex(cls) -> types.ModuleType:
+        """
+        Regression test for #603
+        """
+        return post_responses_unions_simple_before_complex

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

@@ -3,6 +3,7 @@
 import types
 
 from . import (
+    callback_test,
     defaults_tests_defaults_post,
     get_basic_list_of_booleans,
     get_basic_list_of_floats,
@@ -14,6 +15,7 @@
     no_response_tests_no_response_get,
     octet_stream_tests_octet_stream_get,
     post_form_data,
+    post_form_data_inline,
     post_tests_json_body_string,
     test_inline_objects,
     token_with_cookie_auth_token_with_cookie_get,
@@ -66,6 +68,13 @@ def post_form_data(cls) -> types.ModuleType:
         """
         return post_form_data
 
+    @classmethod
+    def post_form_data_inline(cls) -> types.ModuleType:
+        """
+        Post form data (inline schema)
+        """
+        return post_form_data_inline
+
     @classmethod
     def upload_file_tests_upload_post(cls) -> types.ModuleType:
         """
@@ -142,3 +151,10 @@ def token_with_cookie_auth_token_with_cookie_get(cls) -> types.ModuleType:
         Test optional cookie parameters
         """
         return token_with_cookie_auth_token_with_cookie_get
+
+    @classmethod
+    def callback_test(cls) -> types.ModuleType:
+        """
+        Try sending a request related to a callback
+        """
+        return callback_test

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

@@ -20,4 +20,4 @@ dmypy.json
 .idea/
 
 /coverage.xml
-/.coverage
+/.coverage

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

@@ -84,4 +84,4 @@ If you want to install this client into another project without publishing it (e
 1. If that project **is using Poetry**, you can simply do `poetry add <path-to-this-client>` from that project
 1. If that project is not using Poetry:
     1. Build a wheel with `poetry build -f wheel`
-    1. Install that wheel from the other project `pip install <path-to-wheel>`
+    1. Install that wheel from the other project `pip install <path-to-wheel>`

end_to_end_tests/golden-record/.gitignore

@@ -1,2 +1,7 @@
 """ A client library for accessing My Test API """
 from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)