Adopting ruff formatter (#7930)

Co-authored-by: sydney-runkle <sydneymarierunkle@gmail.com>

Makefile

@@ -25,13 +25,13 @@ rebuild-lockfiles: .pdm
 
 .PHONY: format  ## Auto-format python source files
 format: .pdm
-	pdm run black $(sources)
 	pdm run ruff --fix $(sources)
+	pdm run ruff format $(sources)
 
 .PHONY: lint  ## Lint python source files
 lint: .pdm
 	pdm run ruff $(sources)
-	pdm run black $(sources) --check --diff
+	pdm run ruff format --check $(sources)
 
 .PHONY: codespell  ## Use Codespell to do spellchecking
 codespell: .pre-commit

docs/contributing.md

@@ -90,8 +90,8 @@ Run tests and linting locally to make sure everything is working as expected.
 ```bash
 # Run automated code formatting and linting
 make format
-# Pydantic uses black and ruff
-# (https://github.com/ambv/black, https://github.com/charliermarsh/ruff)
+# Pydantic uses ruff, an awesome Python linter written in rust
+# https://github.com/astral-sh/ruff
 
 # Run tests and linting
 make

pydantic/_internal/_model_construction.py

@@ -367,8 +367,8 @@ def inspect_namespace(  # noqa C901
                 )
             else:
                 raise PydanticUserError(
-                    f"A non-annotated attribute was detected: `{var_name} = {value!r}`. All model fields require a "
-                    f"type annotation; if `{var_name}` is not meant to be a field, you may be able to resolve this "
+                    f'A non-annotated attribute was detected: `{var_name} = {value!r}`. All model fields require a '
+                    f'type annotation; if `{var_name}` is not meant to be a field, you may be able to resolve this '
                     f"error by annotating it as a `ClassVar` or updating `model_config['ignored_types']`.",
                     code='model-field-missing-annotation',
                 )

pydantic/color.py

@@ -55,13 +55,13 @@ def __getitem__(self, item: Any) -> Any:
 r_hex_short = r'\s*(?:#|0x)?([0-9a-f])([0-9a-f])([0-9a-f])([0-9a-f])?\s*'
 r_hex_long = r'\s*(?:#|0x)?([0-9a-f]{2})([0-9a-f]{2})([0-9a-f]{2})([0-9a-f]{2})?\s*'
 # CSS3 RGB examples: rgb(0, 0, 0), rgba(0, 0, 0, 0.5), rgba(0, 0, 0, 50%)
-r_rgb = fr'\s*rgba?\(\s*{_r_255}{_r_comma}{_r_255}{_r_comma}{_r_255}(?:{_r_comma}{_r_alpha})?\s*\)\s*'
+r_rgb = rf'\s*rgba?\(\s*{_r_255}{_r_comma}{_r_255}{_r_comma}{_r_255}(?:{_r_comma}{_r_alpha})?\s*\)\s*'
 # CSS3 HSL examples: hsl(270, 60%, 50%), hsla(270, 60%, 50%, 0.5), hsla(270, 60%, 50%, 50%)
-r_hsl = fr'\s*hsla?\(\s*{_r_h}{_r_comma}{_r_sl}{_r_comma}{_r_sl}(?:{_r_comma}{_r_alpha})?\s*\)\s*'
+r_hsl = rf'\s*hsla?\(\s*{_r_h}{_r_comma}{_r_sl}{_r_comma}{_r_sl}(?:{_r_comma}{_r_alpha})?\s*\)\s*'
 # CSS4 RGB examples: rgb(0 0 0), rgb(0 0 0 / 0.5), rgb(0 0 0 / 50%), rgba(0 0 0 / 50%)
-r_rgb_v4_style = fr'\s*rgba?\(\s*{_r_255}\s+{_r_255}\s+{_r_255}(?:\s*/\s*{_r_alpha})?\s*\)\s*'
+r_rgb_v4_style = rf'\s*rgba?\(\s*{_r_255}\s+{_r_255}\s+{_r_255}(?:\s*/\s*{_r_alpha})?\s*\)\s*'
 # CSS4 HSL examples: hsl(270 60% 50%), hsl(270 60% 50% / 0.5), hsl(270 60% 50% / 50%), hsla(270 60% 50% / 50%)
-r_hsl_v4_style = fr'\s*hsla?\(\s*{_r_h}\s+{_r_sl}\s+{_r_sl}(?:\s*/\s*{_r_alpha})?\s*\)\s*'
+r_hsl_v4_style = rf'\s*hsla?\(\s*{_r_h}\s+{_r_sl}\s+{_r_sl}(?:\s*/\s*{_r_alpha})?\s*\)\s*'
 
 # colors where the two hex characters are the same, if all colors match this the short version of hex colors can be used
 repeat_colors = {int(c * 2, 16) for c in '0123456789abcdef'}

pydantic/deprecated/class_validators.py

@@ -114,13 +114,13 @@ def validator(
     fields = tuple((__field, *fields))
     if isinstance(fields[0], FunctionType):
         raise PydanticUserError(
-            "`@validator` should be used with fields and keyword arguments, not bare. "
+            '`@validator` should be used with fields and keyword arguments, not bare. '
             "E.g. usage should be `@validator('<field_name>', ...)`",
             code='validator-no-fields',
         )
     elif not all(isinstance(field, str) for field in fields):
         raise PydanticUserError(
-            "`@validator` fields should be passed as separate string args. "
+            '`@validator` fields should be passed as separate string args. '
             "E.g. usage should be `@validator('<field_name_1>', '<field_name_2>', ...)`",
             code='validator-invalid-fields',
         )
@@ -162,7 +162,10 @@ def root_validator(
     # which means you need to specify `skip_on_failure=True`
     skip_on_failure: Literal[True],
     allow_reuse: bool = ...,
-) -> Callable[[_V1RootValidatorFunctionType], _V1RootValidatorFunctionType,]:
+) -> Callable[
+    [_V1RootValidatorFunctionType],
+    _V1RootValidatorFunctionType,
+]:
     ...
 
 
@@ -173,7 +176,10 @@ def root_validator(
     # `skip_on_failure`, in fact it is not allowed as an argument!
     pre: Literal[True],
     allow_reuse: bool = ...,
-) -> Callable[[_V1RootValidatorFunctionType], _V1RootValidatorFunctionType,]:
+) -> Callable[
+    [_V1RootValidatorFunctionType],
+    _V1RootValidatorFunctionType,
+]:
     ...
 
 
@@ -185,7 +191,10 @@ def root_validator(
     pre: Literal[False],
     skip_on_failure: Literal[True],
     allow_reuse: bool = ...,
-) -> Callable[[_V1RootValidatorFunctionType], _V1RootValidatorFunctionType,]:
+) -> Callable[
+    [_V1RootValidatorFunctionType],
+    _V1RootValidatorFunctionType,
+]:
     ...
 
 

pydantic/main.py

@@ -1110,7 +1110,7 @@ def parse_file(  # noqa: D102
 
     @classmethod
     @typing_extensions.deprecated(
-        "The `from_orm` method is deprecated; set "
+        'The `from_orm` method is deprecated; set '
         "`model_config['from_attributes']=True` and use `model_validate` instead.",
         category=PydanticDeprecatedSince20,
     )

pydantic/networks.py

@@ -636,7 +636,7 @@ def _validate(cls, __input_value: NetworkType) -> IPv4Network | IPv6Network:
 
 def _build_pretty_email_regex() -> re.Pattern[str]:
     name_chars = r'[\w!#$%&\'*+\-/=?^_`{|}~]'
-    unquoted_name_group = fr'((?:{name_chars}+\s+)*{name_chars}+)'
+    unquoted_name_group = rf'((?:{name_chars}+\s+)*{name_chars}+)'
     quoted_name_group = r'"((?:[^"]|\")+)"'
     email_group = r'<\s*(.+)\s*>'
     return re.compile(rf'\s*(?:{unquoted_name_group}|{quoted_name_group})?\s*{email_group}\s*')

pyproject.toml

@@ -84,14 +84,12 @@ docs = [
     "pyupgrade",
     "mike @ git+https://github.com/jimporter/mike.git",
     "mkdocs-embed-external-markdown>=2.3.0",
-    "black>=23.3.0",
     "pytest-examples>=0.0.10",
     "pydantic-settings>=2.0b1",
     "pydantic-extra-types @ git+https://github.com/pydantic/pydantic-extra-types.git@main"
 ]
 linting = [
-    "black",
-    "ruff",
+    "ruff==0.1.3",
     "mypy~=1.1.1",
 ]
 testing = [
@@ -176,8 +174,7 @@ unconfirmed_label = 'pending'
 [tool.ruff]
 line-length = 120
 extend-select = ['Q', 'RUF100', 'C90', 'UP', 'I', 'D', 'T']
-# E501 is handled by black
-extend-ignore = ['D105', 'D107', 'D205', 'D415', 'E501']
+extend-ignore = ['D105', 'D107', 'D205', 'D415']
 flake8-quotes = {inline-quotes = 'single', multiline-quotes = 'double'}
 mccabe = { max-complexity = 14 }
 isort = { known-first-party = ['pydantic', 'tests'] }
@@ -190,6 +187,9 @@ extend-exclude = ['pydantic/v1', 'tests/mypy/outputs']
 "tests/benchmarks/test_fastapi_startup_generics.py" = ['UP006', 'UP007']
 "tests/benchmarks/test_fastapi_startup_simple.py" = ['UP006', 'UP007']
 
+[tool.ruff.format]
+quote-style = 'single'
+
 [tool.ruff.pydocstyle]
 convention = "google"
 
@@ -228,19 +228,6 @@ source = [
     'D:\a\pydantic\pydantic\pydantic',
 ]
 
-[tool.black]
-color = true
-line-length = 120
-target-version = ['py310']
-skip-string-normalization = true
-exclude = '''
-(
-  /(
-    pydantic/v1
-    | tests/mypy/outputs
-  )/
-)
-'''
 
 [tool.pyright]
 include = ['pydantic']

tests/check_usage_docs.py

@@ -10,7 +10,7 @@
 version_file = PYDANTIC_DIR / 'version.py'
 
 
-version = re.search(br"VERSION = '(.*)'", version_file.read_bytes()).group(1)
+version = re.search(rb"VERSION = '(.*)'", version_file.read_bytes()).group(1)
 version_major_minor = b'.'.join(version.split(b'.')[:2])
 expected_base = b'https://docs.pydantic.dev/' + version_major_minor + b'/'
 
@@ -30,7 +30,7 @@ def sub(m: re.Match) -> bytes:
         else:
             return m.group(0)
 
-    b = re.sub(br'(""" *usage.docs: *)(https://.+?/.+?/)', sub, b, flags=re.I)
+    b = re.sub(rb'(""" *usage.docs: *)(https://.+?/.+?/)', sub, b, flags=re.I)
     if changed:
         error_count += changed
         path.write_bytes(b)

tests/test_discriminated_union.py

@@ -361,7 +361,7 @@ class Top(BaseModel):
             'ctx': {'discriminator': "'m'", 'expected_tags': '1, 2', 'tag': '3'},
             'input': {'m': 3},
             'loc': ('sub',),
-            'msg': "Input tag '3' found using 'm' does not match any of the expected " "tags: 1, 2",
+            'msg': "Input tag '3' found using 'm' does not match any of the expected " 'tags: 1, 2',
             'type': 'union_tag_invalid',
         }
     ]
@@ -911,7 +911,7 @@ def test_wrap_function_schema() -> None:
 def test_plain_function_schema_is_invalid() -> None:
     with pytest.raises(
         TypeError,
-        match="'function-plain' is not a valid discriminated union variant; " "should be a `BaseModel` or `dataclass`",
+        match="'function-plain' is not a valid discriminated union variant; " 'should be a `BaseModel` or `dataclass`',
     ):
         apply_discriminator(
             core_schema.union_schema(

tests/test_edge_cases.py

@@ -1127,7 +1127,7 @@ class C(A):
         TypeError,
         match=(
             "Field 'integer' defined on a base class was overridden by a non-annotated attribute. "
-            "All field definitions, including overrides, require a type annotation."
+            'All field definitions, including overrides, require a type annotation.'
         ),
     ):
 
@@ -1197,8 +1197,8 @@ def test_unable_to_infer():
     with pytest.raises(
         errors.PydanticUserError,
         match=re.escape(
-            "A non-annotated attribute was detected: `x = None`. All model fields require a type annotation; "
-            "if `x` is not meant to be a field, you may be able to resolve this error by annotating it as a "
+            'A non-annotated attribute was detected: `x = None`. All model fields require a type annotation; '
+            'if `x` is not meant to be a field, you may be able to resolve this error by annotating it as a '
             "`ClassVar` or updating `model_config['ignored_types']`"
         ),
     ):
@@ -1541,7 +1541,7 @@ class Model(BaseModel):
 
         model_config = dict(arbitrary_types_allowed=True)
 
-    assert re.search(fr'\(annotation={re.escape(expected)},', str(Model.model_fields))
+    assert re.search(rf'\(annotation={re.escape(expected)},', str(Model.model_fields))
 
 
 def test_any_none():

tests/test_generics.py

@@ -271,7 +271,7 @@ class Result(BaseModel):
 
     assert str(exc_info.value) == (
         "<class 'tests.test_generics.test_must_inherit_from_generic.<locals>.Result'> cannot be "
-        "parametrized because it does not inherit from typing.Generic"
+        'parametrized because it does not inherit from typing.Generic'
     )
 
 

tests/test_main.py

@@ -1511,8 +1511,8 @@ def test_untyped_fields_warning():
     with pytest.raises(
         PydanticUserError,
         match=re.escape(
-            "A non-annotated attribute was detected: `x = 1`. All model fields require a type annotation; "
-            "if `x` is not meant to be a field, you may be able to resolve this error by annotating it "
+            'A non-annotated attribute was detected: `x = 1`. All model fields require a type annotation; '
+            'if `x` is not meant to be a field, you may be able to resolve this error by annotating it '
             "as a `ClassVar` or updating `model_config['ignored_types']`."
         ),
     ):

tests/test_networks.py

@@ -805,7 +805,6 @@ def test_address_valid(value, name, email):
         ('\u0020@example.com', None),
         ('\u001f@example.com', None),
         ('"@example.com', None),
-        ('\"@example.com', None),
         (',@example.com', None),
         ('foobar <foobar<@example.com>', None),
         ('foobar <foobar@example.com>>', None),

tests/test_plugins.py

@@ -284,7 +284,7 @@ class Model(BaseModel):
         assert Model.model_validate_json('{"a": 2}', context={'c': 2}).model_dump() == {'a': 2}
         # insert_assert(log)
         assert log == [
-            'json enter input={"a": 2} kwargs={\'strict\': None, \'context\': {\'c\': 2}}',
+            "json enter input={\"a\": 2} kwargs={'strict': None, 'context': {'c': 2}}",
             'json success result=a=2',
         ]
         log.clear()

tests/test_private_attributes.py

@@ -289,7 +289,7 @@ class Model(ParentAModel, ParentBModel):
 def test_private_attributes_not_dunder() -> None:
     with pytest.raises(
         NameError,
-        match="Private attributes must not use dunder names;" " use a single underscore prefix instead of '__foo__'.",
+        match='Private attributes must not use dunder names;' " use a single underscore prefix instead of '__foo__'.",
     ):
 
         class MyModel(BaseModel):

tests/test_types.py

@@ -4852,7 +4852,7 @@ def test_union_uuid_str_left_to_right():
 
     # in smart mode JSON and python are currently validated differently in this
     # case, because in Python this is a str but in JSON a str is also a UUID
-    assert TypeAdapter(IdOrSlug).validate_json('\"f4fe10b4-e0c8-4232-ba26-4acd491c2414\"') == UUID(
+    assert TypeAdapter(IdOrSlug).validate_json('"f4fe10b4-e0c8-4232-ba26-4acd491c2414"') == UUID(
         'f4fe10b4-e0c8-4232-ba26-4acd491c2414'
     )
     assert (
@@ -4863,7 +4863,7 @@ def test_union_uuid_str_left_to_right():
     IdOrSlugLTR = Annotated[Union[UUID, str], Field(union_mode='left_to_right')]
 
     # in left to right mode both JSON and python are validated as UUID
-    assert TypeAdapter(IdOrSlugLTR).validate_json('\"f4fe10b4-e0c8-4232-ba26-4acd491c2414\"') == UUID(
+    assert TypeAdapter(IdOrSlugLTR).validate_json('"f4fe10b4-e0c8-4232-ba26-4acd491c2414"') == UUID(
         'f4fe10b4-e0c8-4232-ba26-4acd491c2414'
     )
     assert TypeAdapter(IdOrSlugLTR).validate_python('f4fe10b4-e0c8-4232-ba26-4acd491c2414') == UUID(