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()
 

end_to_end_tests/golden-record/my_test_api_client/api/naming/post_naming_property_conflict_with_import.py

@@ -16,8 +16,6 @@ def _get_kwargs(
     *,
     json_body: PostNamingPropertyConflictWithImportJsonBody,
 ) -> Dict[str, Any]:
-    pass
-
     json_json_body = json_body.to_dict()
 
     return {

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

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

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

@@ -13,8 +13,6 @@ def _get_kwargs(
     *,
     param_query: str = "overridden_in_GET",
 ) -> Dict[str, Any]:
-    pass
-
     params: Dict[str, Any] = {}
     params["param"] = param_query
 

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

@@ -14,8 +14,6 @@ def _get_kwargs(
     param1: str,
     param3: int,
 ) -> Dict[str, Any]:
-    pass
-
     return {
         "method": "get",
         "url": "/multiple-path-parameters/{param4}/something/{param2}/{param1}/{param3}".format(

end_to_end_tests/golden-record/my_test_api_client/api/responses/post_responses_unions_simple_before_complex.py

@@ -12,8 +12,6 @@
 
 
 def _get_kwargs() -> Dict[str, Any]:
-    pass
-
     return {
         "method": "post",
         "url": "/responses/unions/simple_before_complex",

end_to_end_tests/golden-record/my_test_api_client/api/tag1/get_tag_with_number.py

@@ -9,8 +9,6 @@
 
 
 def _get_kwargs() -> Dict[str, Any]:
-    pass
-
     return {
         "method": "get",
         "url": "/tag_with_number",

end_to_end_tests/golden-record/my_test_api_client/api/tests/callback_test.py

@@ -14,8 +14,6 @@ def _get_kwargs(
     *,
     json_body: AModel,
 ) -> Dict[str, Any]:
-    pass
-
     json_json_body = json_body.to_dict()
 
     return {

end_to_end_tests/golden-record/my_test_api_client/api/tests/defaults_tests_defaults_post.py

@@ -27,8 +27,6 @@ def _get_kwargs(
     model_prop: "ModelWithUnionProperty",
     required_model_prop: "ModelWithUnionProperty",
 ) -> Dict[str, Any]:
-    pass
-
     params: Dict[str, Any] = {}
     params["string_prop"] = string_prop
 

end_to_end_tests/golden-record/my_test_api_client/api/tests/description_with_backslash.py

@@ -9,8 +9,6 @@
 
 
 def _get_kwargs() -> Dict[str, Any]:
-    pass
-
     return {
         "method": "get",
         "url": "/tests/description-with-backslash",

end_to_end_tests/golden-record/my_test_api_client/api/tests/get_basic_list_of_booleans.py

@@ -9,8 +9,6 @@
 
 
 def _get_kwargs() -> Dict[str, Any]:
-    pass
-
     return {
         "method": "get",
         "url": "/tests/basic_lists/booleans",

end_to_end_tests/golden-record/my_test_api_client/api/tests/get_basic_list_of_floats.py

@@ -9,8 +9,6 @@
 
 
 def _get_kwargs() -> Dict[str, Any]:
-    pass
-
     return {
         "method": "get",
         "url": "/tests/basic_lists/floats",

end_to_end_tests/golden-record/my_test_api_client/api/tests/get_basic_list_of_integers.py

@@ -9,8 +9,6 @@
 
 
 def _get_kwargs() -> Dict[str, Any]:
-    pass
-
     return {
         "method": "get",
         "url": "/tests/basic_lists/integers",

end_to_end_tests/golden-record/my_test_api_client/api/tests/get_basic_list_of_strings.py

@@ -9,8 +9,6 @@
 
 
 def _get_kwargs() -> Dict[str, Any]:
-    pass
-
     return {
         "method": "get",
         "url": "/tests/basic_lists/strings",

end_to_end_tests/golden-record/my_test_api_client/api/tests/get_user_list.py

@@ -20,8 +20,6 @@ def _get_kwargs(
     an_enum_value_with_only_null: List[None],
     some_date: Union[datetime.date, datetime.datetime],
 ) -> Dict[str, Any]:
-    pass
-
     params: Dict[str, Any] = {}
     json_an_enum_value = []
     for an_enum_value_item_data in an_enum_value:

end_to_end_tests/golden-record/my_test_api_client/api/tests/int_enum_tests_int_enum_post.py

@@ -14,8 +14,6 @@ def _get_kwargs(
     *,
     int_enum: AnIntEnum,
 ) -> Dict[str, Any]:
-    pass
-
     params: Dict[str, Any] = {}
     json_int_enum = int_enum.value
 

end_to_end_tests/golden-record/my_test_api_client/api/tests/json_body_tests_json_body_post.py

@@ -14,8 +14,6 @@ def _get_kwargs(
     *,
     json_body: AModel,
 ) -> Dict[str, Any]:
-    pass
-
     json_json_body = json_body.to_dict()
 
     return {

end_to_end_tests/golden-record/my_test_api_client/api/tests/no_response_tests_no_response_get.py

@@ -9,8 +9,6 @@
 
 
 def _get_kwargs() -> Dict[str, Any]:
-    pass
-
     return {
         "method": "get",
         "url": "/tests/no_response",

end_to_end_tests/golden-record/my_test_api_client/api/tests/octet_stream_tests_octet_stream_get.py

@@ -10,8 +10,6 @@
 
 
 def _get_kwargs() -> Dict[str, Any]:
-    pass
-
     return {
         "method": "get",
         "url": "/tests/octet_stream",

end_to_end_tests/golden-record/my_test_api_client/api/tests/post_form_data.py

@@ -12,8 +12,6 @@
 def _get_kwargs(
     form_data: AFormData,
 ) -> Dict[str, Any]:
-    pass
-
     return {
         "method": "post",
         "url": "/tests/post_form_data",

end_to_end_tests/golden-record/my_test_api_client/api/tests/post_form_data_inline.py

@@ -12,8 +12,6 @@
 def _get_kwargs(
     form_data: PostFormDataInlineData,
 ) -> Dict[str, Any]:
-    pass
-
     return {
         "method": "post",
         "url": "/tests/post_form_data_inline",

end_to_end_tests/golden-record/my_test_api_client/api/tests/post_tests_json_body_string.py

@@ -13,8 +13,6 @@ def _get_kwargs(
     *,
     json_body: str,
 ) -> Dict[str, Any]:
-    pass
-
     json_json_body = json_body
 
     return {

end_to_end_tests/golden-record/my_test_api_client/api/tests/test_inline_objects.py

@@ -14,8 +14,6 @@ def _get_kwargs(
     *,
     json_body: TestInlineObjectsJsonBody,
 ) -> Dict[str, Any]:
-    pass
-
     json_json_body = json_body.to_dict()
 
     return {

end_to_end_tests/golden-record/my_test_api_client/api/tests/unsupported_content_tests_unsupported_content_get.py

@@ -9,8 +9,6 @@
 
 
 def _get_kwargs() -> Dict[str, Any]:
-    pass
-
     return {
         "method": "get",
         "url": "/tests/unsupported_content",

end_to_end_tests/golden-record/my_test_api_client/api/tests/upload_file_tests_upload_post.py

@@ -14,8 +14,6 @@ def _get_kwargs(
     *,
     multipart_data: BodyUploadFileTestsUploadPost,
 ) -> Dict[str, Any]:
-    pass
-
     multipart_multipart_data = multipart_data.to_multipart()
 
     return {

end_to_end_tests/golden-record/my_test_api_client/api/tests/upload_multiple_files_tests_upload_post.py

@@ -13,8 +13,6 @@ def _get_kwargs(
     *,
     multipart_data: List[File],
 ) -> Dict[str, Any]:
-    pass
-
     multipart_multipart_data = []
     for multipart_data_item_data in multipart_data:
         multipart_data_item = multipart_data_item_data.to_tuple()

end_to_end_tests/golden-record/my_test_api_client/api/true_/false_.py

@@ -12,8 +12,6 @@ def _get_kwargs(
     *,
     import_: str,
 ) -> Dict[str, Any]:
-    pass
-
     params: Dict[str, Any] = {}
     params["import"] = import_
 

end_to_end_tests/golden-record/my_test_api_client/models/an_array_with_a_circular_ref_in_items_object_additional_properties_a_item.py

@@ -21,8 +21,6 @@ class AnArrayWithACircularRefInItemsObjectAdditionalPropertiesAItem:
     ] = _attrs_field(init=False, factory=dict)
 
     def to_dict(self) -> Dict[str, Any]:
-        pass
-
         field_dict: Dict[str, Any] = {}
         for prop_name, prop in self.additional_properties.items():
             field_dict[prop_name] = []

end_to_end_tests/golden-record/my_test_api_client/models/an_array_with_a_circular_ref_in_items_object_additional_properties_b_item.py

@@ -21,8 +21,6 @@ class AnArrayWithACircularRefInItemsObjectAdditionalPropertiesBItem:
     ] = _attrs_field(init=False, factory=dict)
 
     def to_dict(self) -> Dict[str, Any]:
-        pass
-
         field_dict: Dict[str, Any] = {}
         for prop_name, prop in self.additional_properties.items():
             field_dict[prop_name] = []

end_to_end_tests/golden-record/my_test_api_client/models/model_with_circular_ref_in_additional_properties_a.py

@@ -19,8 +19,6 @@ class ModelWithCircularRefInAdditionalPropertiesA:
     )
 
     def to_dict(self) -> Dict[str, Any]:
-        pass
-
         field_dict: Dict[str, Any] = {}
         for prop_name, prop in self.additional_properties.items():
             field_dict[prop_name] = prop.to_dict()

end_to_end_tests/golden-record/my_test_api_client/models/model_with_circular_ref_in_additional_properties_b.py

@@ -19,8 +19,6 @@ class ModelWithCircularRefInAdditionalPropertiesB:
     )
 
     def to_dict(self) -> Dict[str, Any]:
-        pass
-
         field_dict: Dict[str, Any] = {}
         for prop_name, prop in self.additional_properties.items():
             field_dict[prop_name] = prop.to_dict()