Switch to Ruff & Test Python 3.12 (#870)

* ci: Use Checkout releases instead of shas

* ci: Test Python 3.12

* ci: Fix Knope dry-run

* Switch to Ruff

* test: Ignore `.ruff_cache` in golden records

---------

Co-authored-by: Dylan Anthony <dbanty@users.noreply.github.com>

Author: dbanty

.changeset/remove_useless_pass_statements_from_generated_code.md

@@ -0,0 +1,5 @@
+---
+default: patch
+---
+
+#### Remove useless `pass` statements from generated code

.changeset/use_ruff_instead_of_isort_autoflake_at_runtime.md

@@ -0,0 +1,7 @@
+---
+default: major
+---
+
+#### Use Ruff instead of isort + autoflake at runtime
+
+`isort` and `autoflake` are no longer runtime dependencies, so if you have them set in custom `post_hooks` in a config file, you'll need to make sure they're being installed manually. [`ruff`](https://docs.astral.sh/ruff) is now installed and used by default instead.

.github/check_for_changes.py

@@ -1,10 +1,11 @@
 import subprocess
+import sys
 
 output = subprocess.run(["git", "status", "--porcelain"], capture_output=True, check=True).stdout
 
 if output == b"":
     # No changes
-    exit(0)
+    sys.exit(0)
 
 print(output)
-exit(1)
+sys.exit(1)

.github/workflows/checks.yml

@@ -11,7 +11,7 @@ jobs:
   test:
     strategy:
       matrix:
-        python: [ "3.8", "3.9", "3.10", "3.11" ]
+        python: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
         os: [ ubuntu-latest, macos-latest, windows-latest ]
     runs-on: ${{ matrix.os }}
     steps:
@@ -48,17 +48,14 @@ jobs:
       - name: Run Black
         run: poetry run black . --check
 
-      - name: Run isort
-        run: poetry run isort . --check
-
       - name: Run safety
         run: poetry export -f requirements.txt | poetry run safety check --bare --stdin
 
       - name: Run mypy
         run: poetry run mypy --show-error-codes openapi_python_client
 
-      - name: Run pylint
-        run: poetry run pylint openapi_python_client
+      - name: Run Ruff
+        run: poetry run ruff check .
 
       - name: Run pytest
         run: poetry run pytest --cov=openapi_python_client --cov-report=term-missing tests end_to_end_tests/test_end_to_end.py --basetemp=tests/tmp
@@ -106,7 +103,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.10"
+          python-version: "3.8"
       - name: Get Python Version
         id: get_python_version
         run: echo "python_version=$(python --version)" >> $GITHUB_OUTPUT

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

@@ -14,4 +14,4 @@ jobs:
         uses: knope-dev/action@v2.0.0
         with:
           version: 0.12.0
-      - run: knope release --dry-run
+      - run: knope prepare-release --dry-run

README.md

@@ -27,7 +27,7 @@ This tool focuses on creating the best developer experience for Python developer
 
 I recommend you install with [pipx](https://pipxproject.github.io/pipx/) so you don't conflict with any other packages you might have: `pipx install openapi-python-client --include-deps`.
 
-> Note the `--include-deps` option which will also make `black`, `isort`, and `autoflake` available in your path so that `openapi-python-client` can use them to clean up the generated code.
+> Note the `--include-deps` option which will also make `black` and `ruff` available in your path so that `openapi-python-client` can use them to clean up the generated code.
 
 **If you use `pipx run` then the post-generation hooks will not be available unless you install them manually.**
 
@@ -151,8 +151,7 @@ In the config file, there's an easy way to tell `openapi-python-client` to run a
 
 ```yaml
 post_hooks:
-   - "autoflake -i -r --remove-all-unused-imports --remove-unused-variables --ignore-init-module-imports ."
-   - "isort ."
+   - "ruff check . --fix"
    - "black ."
 ```
 

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

@@ -12,8 +12,6 @@ def _get_kwargs(
     *,
     common: Union[Unset, None, str] = UNSET,
 ) -> Dict[str, Any]:
-    pass
-
     params: Dict[str, Any] = {}
     params["common"] = common
 

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

@@ -12,8 +12,6 @@ def _get_kwargs(
     *,
     common: Union[Unset, None, str] = UNSET,
 ) -> Dict[str, Any]:
-    pass
-
     params: Dict[str, Any] = {}
     params["common"] = common
 

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

@@ -13,8 +13,6 @@ def _get_kwargs(
     client_query: str,
     url_query: str,
 ) -> Dict[str, Any]:
-    pass
-
     params: Dict[str, Any] = {}
     params["client"] = client_query
 

end_to_end_tests/golden-record/my_test_api_client/api/location/get_location_query_optionality.py

@@ -16,8 +16,6 @@ def _get_kwargs(
     null_not_required: Union[Unset, None, datetime.datetime] = UNSET,
     not_null_not_required: Union[Unset, None, datetime.datetime] = UNSET,
 ) -> Dict[str, Any]:
-    pass
-
     params: Dict[str, Any] = {}
     json_not_null_required = not_null_required.isoformat()