Adopt ruff formatter instead of black (ready for review) (#1051)

Author: Luca-Blight

.github/workflows/ci.yml

@@ -315,7 +315,7 @@ jobs:
           version: '3.1.32'
           actions-cache-folder: emsdk-cache
 
-      - run: pip install 'maturin>=1,<2' 'black>=22.3.0,<23' typing_extensions
+      - run: pip install 'maturin>=1,<2' 'ruff==0.1.3' typing_extensions
 
       - name: build wheels
         run: make build-wasm
@@ -442,7 +442,7 @@ jobs:
           python-version: '3.11'
           architecture: ${{ matrix.python-architecture || 'x64' }}
 
-      - run: pip install -U twine 'black>=22.3.0,<23' typing_extensions
+      - run: pip install -U twine 'ruff==0.1.3' typing_extensions
 
       # generate self-schema now, so we don't have to do so inside docker in maturin build
       - run: python generate_self_schema.py
@@ -501,7 +501,7 @@ jobs:
         with:
           components: llvm-tools
 
-      - run: pip install -U 'black>=22.3.0,<23' typing_extensions
+      - run: pip install -U 'ruff==0.1.3' typing_extensions
 
       # generate self-schema now, so we don't have to do so inside docker in maturin build
       - run: python generate_self_schema.py

Makefile

@@ -1,6 +1,6 @@
 .DEFAULT_GOAL := all
-black = black python/pydantic_core tests generate_self_schema.py wasm-preview/run_tests.py
-ruff = ruff python/pydantic_core tests generate_self_schema.py wasm-preview/run_tests.py
+sources = python/pydantic_core tests generate_self_schema.py wasm-preview/run_tests.py 
+
 mypy-stubtest = python -m mypy.stubtest pydantic_core._pydantic_core --allowlist .mypy-stubtest-allowlist
 
 # using pip install cargo (via maturin via pip) doesn't get the tty handle
@@ -90,14 +90,14 @@ build-wasm:
 
 .PHONY: format
 format:
-	$(black)
-	$(ruff) --fix --exit-zero
+	ruff --fix $(sources) 
+	ruff format $(sources) 
 	cargo fmt
 
 .PHONY: lint-python
 lint-python:
-	$(ruff)
-	$(black) --check --diff
+	ruff $(sources) 
+	ruff format --check $(sources) 
 	$(mypy-stubtest)
 	griffe dump -f -d google -LWARNING -o/dev/null python/pydantic_core
 

pyproject.toml

@@ -57,13 +57,15 @@ features = ["pyo3/extension-module"]
 line-length = 120
 extend-select = ['Q', 'RUF100', 'C90', 'I']
 extend-ignore = [
-    'E501',  # ignore line too long and let black handle it
     'E721',  # using type() instead of isinstance() - we use this in tests
 ]
 flake8-quotes = {inline-quotes = 'single', multiline-quotes = 'double'}
 mccabe = { max-complexity = 13 }
 isort = { known-first-party = ['pydantic_core', 'tests'] }
 
+[tool.ruff.format]
+quote-style = 'single'
+
 [tool.pytest.ini_options]
 testpaths = 'tests'
 log_format = '%(name)s %(levelname)s: %(message)s'
@@ -97,13 +99,6 @@ exclude_lines = [
     '@overload',
 ]
 
-[tool.black]
-color = true
-line-length = 120
-target-version = ['py37', 'py38', 'py39', 'py310']
-skip-string-normalization = true
-skip-magic-trailing-comma = true
-
 # configuring https://github.com/pydantic/hooky
 [tool.hooky]
 assignees = ['samuelcolvin', 'adriangb', 'dmontagu', 'davidhewitt', 'lig']

python/pydantic_core/_pydantic_core.pyi

@@ -847,7 +847,6 @@ def list_all_errors() -> list[ErrorTypeInfo]:
     Returns:
         A list of `ErrorTypeInfo` typed dicts.
     """
-
 @final
 class TzInfo(datetime.tzinfo):
     def tzname(self, _dt: datetime.datetime | None) -> str | None: ...

tests/requirements-linting.txt

@@ -1,5 +1,4 @@
-black==23.10.1
-griffe==0.36.9
-pyright==1.1.334
+griffe==0.36.7
+pyright==1.1.332
 ruff==0.1.3
 mypy==1.6.1

tests/serializers/test_functions.py

@@ -228,7 +228,7 @@ def append_args(value, info):
         'exclude_defaults=False, exclude_none=False, round_trip=False)'
     )
     assert s.to_json(123) == (
-        b'"123 info=SerializationInfo(include=None, exclude=None, mode=\'json\', by_alias=True, exclude_unset=False, '
+        b"\"123 info=SerializationInfo(include=None, exclude=None, mode='json', by_alias=True, exclude_unset=False, "
         b'exclude_defaults=False, exclude_none=False, round_trip=False)"'
     )
 

tests/test_errors.py

@@ -1050,9 +1050,9 @@ def test_loc_with_dots(pydantic_version):
     ]
     # insert_assert(str(exc_info.value))
     assert str(exc_info.value) == (
-        "1 validation error for typed-dict\n"
-        "`foo.bar`.0\n"
-        "  Input should be a valid integer, unable to parse string as an integer "
+        '1 validation error for typed-dict\n'
+        '`foo.bar`.0\n'
+        '  Input should be a valid integer, unable to parse string as an integer '
         "[type=int_parsing, input_value='x', input_type=str]\n"
         f'    For further information visit https://errors.pydantic.dev/{pydantic_version}/v/int_parsing'
     )

tests/validators/test_arguments.py

@@ -1009,11 +1009,11 @@ def test_error_display(pydantic_version):
     ]
     # insert_assert(str(exc_info.value))
     assert str(exc_info.value) == (
-        "1 validation error for arguments\n"
-        "b\n"
-        "  Missing required argument [type=missing_argument, "
+        '1 validation error for arguments\n'
+        'b\n'
+        '  Missing required argument [type=missing_argument, '
         "input_value=ArgsKwargs((), {'a': 1}), input_type=ArgsKwargs]\n"
-        f"    For further information visit https://errors.pydantic.dev/{pydantic_version}/v/missing_argument"
+        f'    For further information visit https://errors.pydantic.dev/{pydantic_version}/v/missing_argument'
     )
     # insert_assert(exc_info.value.json(include_url=False))
     assert exc_info.value.json(include_url=False) == (

tests/validators/test_bool.py

@@ -63,7 +63,7 @@ def test_bool_error(pydantic_version):
         '1 validation error for bool\n'
         '  Input should be a valid boolean, '
         "unable to interpret input [type=bool_parsing, input_value='wrong', input_type=str]\n"
-        f"    For further information visit https://errors.pydantic.dev/{pydantic_version}/v/bool_parsing"
+        f'    For further information visit https://errors.pydantic.dev/{pydantic_version}/v/bool_parsing'
     )
     assert exc_info.value.errors(include_url=False) == [
         {

tests/validators/test_int.py

@@ -357,10 +357,10 @@ def test_too_long(pydantic_version):
     ]
     # insert_assert(repr(exc_info.value))
     assert repr(exc_info.value) == (
-        "1 validation error for int\n"
-        "  Unable to parse input string as an integer, exceeded maximum size "
+        '1 validation error for int\n'
+        '  Unable to parse input string as an integer, exceeded maximum size '
         "[type=int_parsing_size, input_value='111111111111111111111111...11111111111111111111111', input_type=str]\n"
-        f"    For further information visit https://errors.pydantic.dev/{pydantic_version}/v/int_parsing_size"
+        f'    For further information visit https://errors.pydantic.dev/{pydantic_version}/v/int_parsing_size'
     )