build: 🛠 Convert everything to use ruff and just

ddanier · ddanier · commit 0c9787ba943e · 2023-08-10T18:41:47.000+02:00
diff --git a/.flake8 b/.flake8
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -13,7 +13,7 @@ jobs:
         run: |
           python -m pip install --upgrade poetry
           poetry install -E fastapi
-      - name: Lint with flake8
+      - name: Lint with ruff & mypy
         run: |
-          poetry run flake8 pydantic_async_validation tests
+          poetry run ruff check pydantic_async_validation tests
           poetry run mypy pydantic_async_validation
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -7,32 +7,11 @@ repos:
       - id: check-merge-conflict
       - id: check-docstring-first
       - id: debug-statements
-  - repo: https://github.com/PyCQA/flake8
-    rev: 6.0.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.0.284
     hooks:
-      - id: flake8
-        args: ["--config=.flake8"]
-        additional_dependencies:
-          - flake8-builtins
-          - flake8-annotations
-          - flake8-commas
-          - flake8-isort
-          - flake8-print
-          - flake8-debugger
-  - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
-    hooks:
-      - id: isort
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v3.9.0
-    hooks:
-      - id: pyupgrade
-        args: ["--py38-plus"]
-  - repo: https://github.com/asottile/add-trailing-comma
-    rev: v3.0.0
-    hooks:
-      - id: add-trailing-comma
-        args: ["--py36-plus"]
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
   - repo: https://github.com/Lucas-C/pre-commit-hooks-safety
     rev: v1.3.1
     hooks:
diff --git a/build/Taskfile b/build/Taskfile
diff --git a/justfile b/justfile
@@ -0,0 +1,30 @@
+install-pre-commit:
+    #!/usr/bin/env bash
+    if ( which pre-commit > /dev/null 2>&1 )
+    then
+        pre-commit install --install-hooks
+    else
+        echo "-----------------------------------------------------------------"
+        echo "pre-commit is not installed - cannot enable pre-commit hooks!"
+        echo "Recommendation: Install pre-commit ('brew install pre-commit')."
+        echo "-----------------------------------------------------------------"
+    fi
+
+install: install-pre-commit (poetry "install")
+
+update: (poetry "install")
+
+poetry *args:
+    poetry {{args}}
+
+test *args: (poetry "run" "pytest" "--cov=pydantic_async_validation" "--cov-report" "term-missing:skip-covered" args)
+
+test-all: (poetry "run" "tox")
+
+ruff *args: (poetry "run" "ruff" "check" "pydantic_async_validation" "tests" args)
+
+mypy *args:  (poetry "run" "mypy" "pydantic_async_validation" args)
+
+lint: ruff mypy
+
+publish: (poetry "publish" "--build")
diff --git a/pydantic_async_validation/fastapi.py b/pydantic_async_validation/fastapi.py
@@ -28,4 +28,4 @@ def ensure_request_validation_errors() -> Generator[None, None, None]:
     try:
         yield
     except ValidationError as O_o:
-        raise RequestValidationError(errors=O_o.errors())
+        raise RequestValidationError(errors=O_o.errors()) from O_o
diff --git a/pydantic_async_validation/metaclasses.py b/pydantic_async_validation/metaclasses.py
@@ -1,6 +1,6 @@
 from typing import TYPE_CHECKING, Any, List, Optional, Tuple
 
-from pydantic._internal._model_construction import ModelMetaclass  # noqa
+from pydantic._internal._model_construction import ModelMetaclass
 
 from pydantic_async_validation.constants import (
     ASYNC_FIELD_VALIDATOR_CONFIG_KEY,
diff --git a/pydantic_async_validation/utils.py b/pydantic_async_validation/utils.py
@@ -49,7 +49,7 @@ def generic_field_validator_wrapper(
         args -= {'kwargs'}
 
     if not args.issubset(all_field_validator_kwargs):
-        raise PydanticUserError( # noqa
+        raise PydanticUserError(
             f'Invalid signature for validator {validator_func}: {sig}, '
             f'should be: '
             f'(self, value, field, config), '
@@ -62,31 +62,31 @@ def generic_field_validator_wrapper(
             self, value=value, field=field, config=config,
         )
     if args == set():
-        return lambda self, value, field, config: validator_func(
+        return lambda self, value, field, config: validator_func(  # noqa: ARG005
             self,
         )
     if args == {'value'}:
-        return lambda self, value, field, config: validator_func(
+        return lambda self, value, field, config: validator_func(  # noqa: ARG005
             self, value=value,
         )
     if args == {'field'}:
-        return lambda self, value, field, config: validator_func(
+        return lambda self, value, field, config: validator_func(  # noqa: ARG005
             self, field=field,
         )
     if args == {'value', 'field'}:
-        return lambda self, value, field, config: validator_func(
+        return lambda self, value, field, config: validator_func(  # noqa: ARG005
             self, value=value, field=field,
         )
     if args == {'config'}:
-        return lambda self, value, field, config: validator_func(
+        return lambda self, value, field, config: validator_func(  # noqa: ARG005
             self, config=config,
         )
     if args == {'value', 'config'}:
-        return lambda self, value, field, config: validator_func(
+        return lambda self, value, field, config: validator_func(  # noqa: ARG005
             self, value=value, config=config,
         )
     if args == {'field', 'config'}:
-        return lambda self, value, field, config: validator_func(
+        return lambda self, value, field, config: validator_func(  # noqa: ARG005
             self, field=field, config=config,
         )
 
@@ -139,7 +139,7 @@ def generic_model_validator_wrapper(
         args -= {'kwargs'}
 
     if not args.issubset(all_model_validator_kwargs):
-        raise PydanticUserError( # noqa
+        raise PydanticUserError(
             f'Invalid signature for validator {validator_func}: {sig}, '
             f'should be: '
             f'(self, config), '
@@ -152,7 +152,7 @@ def generic_model_validator_wrapper(
             self, config=config,
         )
     if args == set():
-        return lambda self, config: validator_func(
+        return lambda self, config: validator_func(  # noqa: ARG005
             self,
         )
 
diff --git a/pydantic_async_validation/validators.py b/pydantic_async_validation/validators.py
@@ -9,8 +9,8 @@
 if TYPE_CHECKING:  # pragma: no cover
     from inspect import Signature  # noqa
 
-    from pydantic.main import BaseConfig  # noqa
-    from pydantic.types import ModelOrDc  # noqa
+    from pydantic.main import BaseConfig
+    from pydantic.types import ModelOrDc
 
     ValidatorCallable = Callable[
         [
diff --git a/pyproject.toml b/pyproject.toml
@@ -18,24 +18,23 @@ fastapi = ["fastapi"]
 
 [tool.poetry.group.dev.dependencies]
 pytest = ">=7.1.2,<8.0.0"
-isort = "^5.10.1"
-mypy = ">=0.971,<2.0"
-flake8 = ">=5.0.4,<7.0.0"
-flake8-builtins = ">=1.5.3,<3.0.0"
-flake8-annotations = ">=2.9.1,<4.0.0"
-flake8-commas = "^2.1.0"
-flake8-isort = ">=4.2,<7.0"
-flake8-print = "^5.0.0"
-flake8-debugger = "^4.1.2"
 pytest-cov = ">=3,<5"
-tox = ">=3.26,<5.0"
 pytest-asyncio = "^0.21.1"
+mypy = ">=0.971,<2.0"
+tox = ">=3.26,<5.0"
 httpx = "^0.24.1"
+ruff = "^0.0.284"
+
+[tool.ruff]
+select = ["F","E","W","C","I","N","UP","ANN","S","B","A","COM","C4","T20","PT","ARG","TD","RUF"]
+line-length = 115
+target-version = "py38"
+ignore = ["A001","A002","A003","ANN101","ANN102","ANN401","C901","N8","B008","F405","F821"]
 
-[tool.isort]
-multi_line_output = 3
-include_trailing_comma = true
-line_length = 115
+[tool.ruff.per-file-ignores]
+"__init__.py" = ["F401"]
+"conftest.py" = ["S101","ANN","F401"]
+"test_*.py" = ["S101","ANN","F401"]
 
 [build-system]
 requires = ["poetry-core"]
diff --git a/tests/test_fastapi.py b/tests/test_fastapi.py
@@ -21,7 +21,7 @@ async def validate_name(self, value: str) -> None:
             raise ValueError("Invalid name")
 
 
-@pytest.fixture
+@pytest.fixture()
 def app():
     app = fastapi.FastAPI()
 
diff --git a/tests/test_field_validators.py b/tests/test_field_validators.py
@@ -25,27 +25,27 @@ async def validate_age(self, value: int) -> None:
         assert value > 0
 
 
-@pytest.mark.asyncio
+@pytest.mark.asyncio()
 async def test_async_validation_raises_no_issues():
     instance = SomethingModel(name="valid", age=1)
     await instance.model_async_validate()
 
 
-@pytest.mark.asyncio
+@pytest.mark.asyncio()
 async def test_async_validation_raises_when_validation_fails():
     instance = SomethingModel(name="invalid", age=1)
     with pytest.raises(pydantic.ValidationError):
         await instance.model_async_validate()
 
 
-@pytest.mark.asyncio
+@pytest.mark.asyncio()
 async def test_async_validation_raises_when_validation_fails_by_assertion():
     instance = SomethingModel(name="valid", age=0)
     with pytest.raises(pydantic.ValidationError):
         await instance.model_async_validate()
 
 
-@pytest.mark.asyncio
+@pytest.mark.asyncio()
 async def test_all_field_validator_combinations_are_valid():
     class OtherModel(AsyncValidationModelMixin, pydantic.BaseModel):
         name: str
@@ -81,7 +81,7 @@ async def validate_name_9(self, **kwargs) -> None: pass
     await instance.model_async_validate()
 
 
-@pytest.mark.asyncio
+@pytest.mark.asyncio()
 async def test_invalid_validators_are_prohibited():
     with pytest.raises(PydanticUserError):
         class OtherModel1(AsyncValidationModelMixin, pydantic.BaseModel):
@@ -91,28 +91,28 @@ class OtherModel1(AsyncValidationModelMixin, pydantic.BaseModel):
             async def validate_name(self, no_value: Any) -> None: pass
 
     with pytest.raises(PydanticUserError):
-        class OtherModel1(AsyncValidationModelMixin, pydantic.BaseModel):
+        class OtherModel2(AsyncValidationModelMixin, pydantic.BaseModel):
             name: str
 
             @async_field_validator('name')
             async def validate_name(self, no_value: Any) -> None: pass
 
     with pytest.raises(PydanticUserError):
-        class OtherModel2(AsyncValidationModelMixin, pydantic.BaseModel):
+        class OtherModel3(AsyncValidationModelMixin, pydantic.BaseModel):
             name: str
 
             @async_field_validator('name')
             async def validate_name(self, value: str, something_else: Any) -> None: pass
 
     with pytest.raises(PydanticUserError):
-        class OtherModel3(AsyncValidationModelMixin, pydantic.BaseModel):
+        class OtherModel4(AsyncValidationModelMixin, pydantic.BaseModel):
             name: str
 
             @async_field_validator('name')
             async def validate_name(cls, value: str) -> None: pass
 
 
-@pytest.mark.asyncio
+@pytest.mark.asyncio()
 async def test_async_validation_may_get_extra_details():
     class OtherModel(AsyncValidationModelMixin, pydantic.BaseModel):
         name: str
@@ -125,7 +125,7 @@ async def validate_name(self, config: ValidationInfo) -> None:
     await instance.model_async_validate()
 
 
-@pytest.mark.asyncio
+@pytest.mark.asyncio()
 async def test_async_validation_will_call_sub_model_validation():
     class OtherModel(AsyncValidationModelMixin, pydantic.BaseModel):
         something: SomethingModel
diff --git a/tests/test_model_validators.py b/tests/test_model_validators.py

Original file line number	Diff line number	Diff line change
`@@ -9,8 +9,8 @@`
`9`	`9`	`if TYPE_CHECKING: # pragma: no cover`
`10`	`10`	`from inspect import Signature # noqa`
`11`	`11`
`12`		`- from pydantic.main import BaseConfig # noqa`
`13`		`- from pydantic.types import ModelOrDc # noqa`
	`12`	`+ from pydantic.main import BaseConfig`
	`13`	`+ from pydantic.types import ModelOrDc`
`14`	`14`
`15`	`15`	`ValidatorCallable = Callable[`
`16`	`16`	`[`