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

Author: johnthagen

.changeset/add_metapdm_option_for_generating_pep621_pdm_metadata.md

@@ -27,7 +27,7 @@ jobs:
         shell: bash
 
       - name: Cache dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: .venv
           key: ${{ runner.os }}-${{ steps.get_python_version.outputs.python_version }}-dependencies-${{ hashFiles('**/pdm.lock') }}
@@ -67,7 +67,7 @@ jobs:
         if: matrix.os == 'ubuntu-latest'
 
       - name: Store coverage report
-        uses: actions/upload-artifact@v4.1.0
+        uses: actions/upload-artifact@v4.3.0
         if: matrix.os == 'ubuntu-latest'
         with:
           name: coverage-${{ matrix.python }}
@@ -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.1.0
+        uses: actions/upload-artifact@v4.3.0
         with:
           name: html-report
           path: htmlcov
@@ -138,7 +138,7 @@ jobs:
         id: get_python_version
         run: echo "python_version=$(python --version)" >> $GITHUB_OUTPUT
       - name: Cache dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: .venv
           key: ${{ runner.os }}-${{ steps.get_python_version.outputs.python_version }}-dependencies-${{ hashFiles('**/pdm.lock') }}
@@ -149,13 +149,8 @@ jobs:
           pip install pdm
           python -m venv .venv
           pdm install
-      - name: Regenerate Integration Client
-        run: |
-          pdm run openapi-python-client update --url http://localhost:3000/openapi.json --config integration-tests-config.yaml --meta pdm
-      - name: Check for any file changes
-        run: python .github/check_for_changes.py
       - name: Cache Generated Client Dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: integration-tests/.venv
           key: ${{ runner.os }}-${{ steps.get_python_version.outputs.python_version }}-integration-dependencies-${{ hashFiles('**/pdm.lock') }}

.changeset/add_original_openapi_data_attribute_to_response_object.md

@@ -13,6 +13,42 @@ 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.17.2 (2024-01-15)
+
+### Features
+
+#### Add `--meta=pdm` option for generating PEP621 + PDM metadata
+
+The default metadata is still `--meta=poetry`, which generates a `pyproject.toml` file with Poetry-specific metadata.
+This change adds the `--meta=pdm` option which includes [PDM](https://pdm-project.org/latest/)-specific metadata, but also 
+standard [PEP621](https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#writing-pyproject-toml)
+metadata. This may be useful as a starting point for other dependency managers & build tools (like Hatch).
+
+#### Add original OpenAPI `data` attribute to `Response` object
+
+PR #767
+
+In custom templates, you can now access a `response.data` attribute that contains the original OpenAPI definition of the
+response (Response Object or Reference Object).
+
+#### Include the `UP` rule for generated Ruff config
+
+This enables [pyupgrade-like improvements](https://docs.astral.sh/ruff/rules/#pyupgrade-up) which should replace some 
+`.format()` calls with f-strings.
+
+### Fixes
+
+#### Fix Ruff formatting for `--meta=none`
+
+PR #940 fixes issue #939. Thanks @satwell!
+
+Due to the lack of `pyproject.toml`, Ruff was not getting configured properly when `--meta=none`.
+As a result, it didn't clean up common generation issues like duplicate imports, which would then cause errors from 
+linters.
+
+This is now fixed by changing the default `post_hook` to `ruff check . --fix --extend-select=I` when `--meta=none`.
+Using `generate --meta=none` should now be almost identical to the code generated by `update`.
+
 ## 0.17.1 (2024-01-04)
 
 ### Features

.github/check_for_changes.py

@@ -0,0 +1,2 @@
+post_hooks:
+  - echo "this should fail" && exit 1

.github/workflows/checks.yml

@@ -34,9 +34,7 @@ def _get_kwargs(
 
     _kwargs: Dict[str, Any] = {
         "method": "get",
-        "url": "/parameter-references/{path_param}".format(
-            path_param=path_param,
-        ),
+        "url": f"/parameter-references/{path_param}",
         "params": params,
         "cookies": cookies,
     }

CHANGELOG.md

@@ -21,9 +21,7 @@ def _get_kwargs(
 
     _kwargs: Dict[str, Any] = {
         "method": "delete",
-        "url": "/common_parameters_overriding/{param}".format(
-            param=param_path,
-        ),
+        "url": f"/common_parameters_overriding/{param_path}",
         "params": params,
     }
 

end_to_end_tests/custom_post_hooks.config.yml

@@ -21,9 +21,7 @@ def _get_kwargs(
 
     _kwargs: Dict[str, Any] = {
         "method": "get",
-        "url": "/common_parameters_overriding/{param}".format(
-            param=param_path,
-        ),
+        "url": f"/common_parameters_overriding/{param_path}",
         "params": params,
     }
 

end_to_end_tests/golden-record/my_test_api_client/api/parameter_references/get_parameter_references_path_param.py

@@ -31,9 +31,7 @@ def _get_kwargs(
 
     _kwargs: Dict[str, Any] = {
         "method": "get",
-        "url": "/same-name-multiple-locations/{param}".format(
-            param=param_path,
-        ),
+        "url": f"/same-name-multiple-locations/{param_path}",
         "params": params,
         "cookies": cookies,
     }

end_to_end_tests/golden-record/my_test_api_client/api/parameters/delete_common_parameters_overriding_param.py

@@ -16,12 +16,7 @@ def _get_kwargs(
 ) -> Dict[str, Any]:
     _kwargs: Dict[str, Any] = {
         "method": "get",
-        "url": "/multiple-path-parameters/{param4}/something/{param2}/{param1}/{param3}".format(
-            param4=param4,
-            param2=param2,
-            param1=param1,
-            param3=param3,
-        ),
+        "url": f"/multiple-path-parameters/{param4}/something/{param2}/{param1}/{param3}",
     }
 
     return _kwargs

end_to_end_tests/golden-record/my_test_api_client/api/parameters/get_common_parameters_overriding_param.py

@@ -21,5 +21,5 @@ requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.ruff]
-select = ["F", "I"]
+select = ["F", "I", "UP"]
 line-length = 120

end_to_end_tests/golden-record/my_test_api_client/api/parameters/get_same_name_multiple_locations_param.py

@@ -19,5 +19,5 @@ requires = ["pdm-backend"]
 build-backend = "pdm.backend"
 
 [tool.ruff]
-select = ["F", "I"]
+select = ["F", "I", "UP"]
 line-length = 120

end_to_end_tests/golden-record/my_test_api_client/api/parameters/multiple_path_parameters.py

@@ -21,5 +21,5 @@ requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.ruff]
-select = ["F", "I"]
+select = ["F", "I", "UP"]
 line-length = 120

end_to_end_tests/golden-record/pyproject.toml

@@ -79,12 +79,11 @@ def regen_custom_template_golden_record():
     gr_path = Path(__file__).parent / "golden-record"
     tpl_gr_path = Path(__file__).parent / "custom-templates-golden-record"
 
-    output_path = Path(tempfile.mkdtemp())
+    output_path = Path.cwd() / "my-test-api-client"
     config_path = Path(__file__).parent / "config.yml"
 
     shutil.rmtree(tpl_gr_path, ignore_errors=True)
 
-    os.chdir(str(output_path.absolute()))
     result = runner.invoke(
         app,
         [
@@ -96,9 +95,8 @@ def regen_custom_template_golden_record():
     )
 
     if result.stdout:
-        generated_output_path = output_path / "my-test-api-client"
-        for f in generated_output_path.glob("**/*"):  # nb: works for Windows and Unix
-            relative_to_generated = f.relative_to(generated_output_path)
+        for f in output_path.glob("**/*"):  # nb: works for Windows and Unix
+            relative_to_generated = f.relative_to(output_path)
             gr_file = gr_path / relative_to_generated
             if not gr_file.exists():
                 print(f"{gr_file} does not exist, ignoring")

end_to_end_tests/metadata_snapshots/pdm.pyproject.toml

@@ -21,5 +21,5 @@ requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.ruff]
-select = ["F", "I"]
+select = ["F", "I", "UP"]
 line-length = 120

end_to_end_tests/metadata_snapshots/poetry.pyproject.toml

@@ -28,9 +28,7 @@ def _get_kwargs(
 
     _kwargs: Dict[str, Any] = {
         "method": "post",
-        "url": "/const/{path}".format(
-            path=path,
-        ),
+        "url": f"/const/{path}",
         "params": params,
     }