Merge branch 'main' into openapi-3.1

dbanty · dbanty · commit ed8f1e4294f8 · 2023-11-03T15:15:36.000-06:00
diff --git a/.changeset/switch_from_black_to_ruff_for_formatting.md b/.changeset/switch_from_black_to_ruff_for_formatting.md
@@ -0,0 +1,7 @@
+---
+default: major
+---
+
+# Switch from Black to Ruff for formatting
+
+`black` is no longer a runtime dependency, 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.
diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
@@ -45,16 +45,16 @@ jobs:
       - name: Install Dependencies
         run: poetry install
 
-      - name: Run Black
-        run: poetry run black . --check
+      - name: Check formatting
+        run: poetry run ruff format . --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 Ruff
+      - name: Lint
         run: poetry run ruff check .
 
       - name: Run pytest
diff --git a/README.md b/README.md
@@ -2,7 +2,6 @@
 [![codecov](https://codecov.io/gh/openapi-generators/openapi-python-client/branch/main/graph/badge.svg)](https://codecov.io/gh/triaxtec/openapi-python-client)
 [![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)
 [![Generic badge](https://img.shields.io/badge/type_checked-mypy-informational.svg)](https://mypy.readthedocs.io/en/stable/introduction.html)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
 [![PyPI version shields.io](https://img.shields.io/pypi/v/openapi-python-client.svg)](https://pypi.python.org/pypi/openapi-python-client/)
 [![Downloads](https://static.pepy.tech/personalized-badge/openapi-python-client?period=total&units=international_system&left_color=blue&right_color=green&left_text=Downloads)](https://pepy.tech/project/openapi-python-client)
 
@@ -156,7 +155,7 @@ In the config file, there's an easy way to tell `openapi-python-client` to run a
 ```yaml
 post_hooks:
    - "ruff check . --fix"
-   - "black ."
+   - "ruff format ."
 ```
 
 ### use_path_prefixes_for_title_model_names
diff --git a/end_to_end_tests/golden-record/my_test_api_client/models/a_model.py b/end_to_end_tests/golden-record/my_test_api_client/models/a_model.py
@@ -442,7 +442,7 @@ def _parse_not_required_one_of_models(data: object) -> Union["FreeFormModel", "M
         not_required_one_of_models = _parse_not_required_one_of_models(d.pop("not_required_one_of_models", UNSET))
 
         def _parse_not_required_nullable_one_of_models(
-            data: object,
+            data: object
         ) -> Union["FreeFormModel", "ModelWithUnionProperty", None, Unset, str]:
             if data is None:
                 return data
diff --git a/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 b/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
@@ -27,9 +27,7 @@ def to_dict(self) -> Dict[str, Any]:
             for (
                 componentsschemas_an_array_with_a_circular_ref_in_items_object_additional_properties_b_item_data
             ) in prop:
-                componentsschemas_an_array_with_a_circular_ref_in_items_object_additional_properties_b_item = (
-                    componentsschemas_an_array_with_a_circular_ref_in_items_object_additional_properties_b_item_data.to_dict()
-                )
+                componentsschemas_an_array_with_a_circular_ref_in_items_object_additional_properties_b_item = componentsschemas_an_array_with_a_circular_ref_in_items_object_additional_properties_b_item_data.to_dict()
 
                 field_dict[prop_name].append(
                     componentsschemas_an_array_with_a_circular_ref_in_items_object_additional_properties_b_item
diff --git a/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 b/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
@@ -27,9 +27,7 @@ def to_dict(self) -> Dict[str, Any]:
             for (
                 componentsschemas_an_array_with_a_circular_ref_in_items_object_additional_properties_a_item_data
             ) in prop:
-                componentsschemas_an_array_with_a_circular_ref_in_items_object_additional_properties_a_item = (
-                    componentsschemas_an_array_with_a_circular_ref_in_items_object_additional_properties_a_item_data.to_dict()
-                )
+                componentsschemas_an_array_with_a_circular_ref_in_items_object_additional_properties_a_item = componentsschemas_an_array_with_a_circular_ref_in_items_object_additional_properties_a_item_data.to_dict()
 
                 field_dict[prop_name].append(
                     componentsschemas_an_array_with_a_circular_ref_in_items_object_additional_properties_a_item
diff --git a/end_to_end_tests/golden-record/my_test_api_client/models/an_array_with_a_recursive_ref_in_items_object_additional_properties_item.py b/end_to_end_tests/golden-record/my_test_api_client/models/an_array_with_a_recursive_ref_in_items_object_additional_properties_item.py
@@ -19,9 +19,7 @@ def to_dict(self) -> Dict[str, Any]:
         for prop_name, prop in self.additional_properties.items():
             field_dict[prop_name] = []
             for componentsschemas_an_array_with_a_recursive_ref_in_items_object_additional_properties_item_data in prop:
-                componentsschemas_an_array_with_a_recursive_ref_in_items_object_additional_properties_item = (
-                    componentsschemas_an_array_with_a_recursive_ref_in_items_object_additional_properties_item_data.to_dict()
-                )
+                componentsschemas_an_array_with_a_recursive_ref_in_items_object_additional_properties_item = componentsschemas_an_array_with_a_recursive_ref_in_items_object_additional_properties_item_data.to_dict()
 
                 field_dict[prop_name].append(
                     componentsschemas_an_array_with_a_recursive_ref_in_items_object_additional_properties_item
diff --git a/end_to_end_tests/golden-record/my_test_api_client/models/model_with_any_json_properties.py b/end_to_end_tests/golden-record/my_test_api_client/models/model_with_any_json_properties.py
@@ -53,7 +53,7 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
         for prop_name, prop_dict in d.items():
 
             def _parse_additional_property(
-                data: object,
+                data: object
             ) -> Union["ModelWithAnyJsonPropertiesAdditionalPropertyType0", List[str], bool, float, int, str]:
                 try:
                     if not isinstance(data, dict):
diff --git a/end_to_end_tests/golden-record/my_test_api_client/models/model_with_union_property_inlined.py b/end_to_end_tests/golden-record/my_test_api_client/models/model_with_union_property_inlined.py
@@ -53,7 +53,7 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
         d = src_dict.copy()
 
         def _parse_fruit(
-            data: object,
+            data: object
         ) -> Union["ModelWithUnionPropertyInlinedFruitType0", "ModelWithUnionPropertyInlinedFruitType1", Unset]:
             if isinstance(data, Unset):
                 return data
diff --git a/end_to_end_tests/golden-record/pyproject.toml b/end_to_end_tests/golden-record/pyproject.toml
@@ -21,19 +21,6 @@ python-dateutil = "^2.8.0"
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
 
-[tool.black]
-line-length = 120
-target_version = ['py38', 'py39', 'py310', 'py311']
-exclude = '''
-(
-  /(
-    | \.git
-    | \.venv
-    | \.mypy_cache
-  )/
-)
-'''
-
 [tool.ruff]
 select = ["F", "I"]
 line-length = 120
diff --git a/integration-tests/poetry.lock b/integration-tests/poetry.lock
diff --git a/integration-tests/pyproject.toml b/integration-tests/pyproject.toml
@@ -26,19 +26,6 @@ pytest-asyncio = "^0.21.0"
 requires = ["poetry>=1.0"]
 build-backend = "poetry.masonry.api"
 
-[tool.black]
-line-length = 120
-target_version = ['py38', 'py39', 'py310', 'py311']
-exclude = '''
-(
-  /(
-    | \.git
-    | \.venv
-    | \.mypy_cache
-  )/
-)
-'''
-
 [tool.ruff]
 select = ["F", "I"]
 line-length = 120
diff --git a/openapi_python_client/config.py b/openapi_python_client/config.py
@@ -30,7 +30,7 @@ class Config(BaseModel):
     use_path_prefixes_for_title_model_names: bool = True
     post_hooks: List[str] = [
         "ruff check --fix .",
-        "black .",
+        "ruff format .",
     ]
     field_prefix: str = "field_"
     http_timeout: int = 5
diff --git a/openapi_python_client/templates/pyproject_no_poetry.toml.jinja b/openapi_python_client/templates/pyproject_no_poetry.toml.jinja
@@ -1,16 +1,3 @@
-[tool.black]
-line-length = 120
-target_version = ['py38', 'py39', 'py310', 'py311']
-exclude = '''
-(
-  /(
-    | \.git
-    | \.venv
-    | \.mypy_cache
-  )/
-)
-'''
-
 [tool.ruff]
 select = ["F", "I"]
 line-length = 120
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ class Config(BaseModel):`
`30`	`30`	`use_path_prefixes_for_title_model_names: bool = True`
`31`	`31`	`post_hooks: List[str] = [`
`32`	`32`	`"ruff check --fix .",`
`33`		`- "black .",`
	`33`	`+ "ruff format .",`
`34`	`34`	`]`
`35`	`35`	`field_prefix: str = "field_"`
`36`	`36`	`http_timeout: int = 5`