Initial ruff setup.

Signed-off-by: Pavel Kirilin <[email protected]>
s3rius · Jun 27, 2024 · 1c85686 · 1c85686
1 parent f23c99d
commit 1c85686
Show file tree

Hide file tree

Showing 12 changed files with 501 additions and 574 deletions.
diff --git a/fastapi_template/template/{{cookiecutter.project_name}}/.pre-commit-config.yaml b/fastapi_template/template/{{cookiecutter.project_name}}/.pre-commit-config.yaml
@@ -26,33 +26,13 @@ repos:
 
     - repo: local
       hooks:
-          - id: autoflake
-            name: autoflake
-            entry: poetry run autoflake
-            language: system
-            types: [python]
-            args: [--in-place, --remove-all-unused-imports, --remove-duplicate-keys]
 
           - id: black
             name: Format with Black
             entry: poetry run black
             language: system
             types: [python]
 
-          - id: isort
-            name: isort
-            entry: poetry run isort
-            language: system
-            types: [python]
-
-          - id: flake8
-            name: Check with Flake8
-            entry: poetry run flake8
-            language: system
-            pass_filenames: false
-            types: [python]
-            args: [--count, .]
-
           - id: mypy
             name: Validate types with MyPy
             entry: poetry run mypy
@@ -61,3 +41,19 @@ repos:
             pass_filenames: false
             args:
               - "{{cookiecutter.project_name}}"
+          - id: ruff
+            name: Validate project with Ruff
+            entry: poetry run ruff
+            language: system
+            types: [python]
+            pass_filenames: false
+            args:
+              - "{{cookiecutter.project_name}}"
+
+          - id: ruff
+            name: Check with Ruff
+            entry: poetry run ruff
+            language: system
+            pass_filenames: false
+            always_run: true
+            args: ["check", "{{cookiecutter.project_name}}", "tests", "--fix"]
diff --git a/...iecutter.project_name}}/deploy/Dockerfile → .../{{cookiecutter.project_name}}/Dockerfile b/...iecutter.project_name}}/deploy/Dockerfile → .../{{cookiecutter.project_name}}/Dockerfile
diff --git a/fastapi_template/template/{{cookiecutter.project_name}}/deploy/docker-compose.yml b/fastapi_template/template/{{cookiecutter.project_name}}/deploy/docker-compose.yml
@@ -4,7 +4,7 @@ services:
   api: &main_app
     build:
       context: .
-      dockerfile: ./deploy/Dockerfile
+      dockerfile: ./Dockerfile
       target: prod
     image: {{cookiecutter.project_name}}:{{"${" }}{{cookiecutter.project_name | upper }}_VERSION:-latest{{"}"}}
     restart: always

diff --git a/fastapi_template/template/{{cookiecutter.project_name}}/pyproject.toml b/fastapi_template/template/{{cookiecutter.project_name}}/pyproject.toml
@@ -160,13 +160,10 @@ pyzmq = "^25"
 
 [tool.poetry.dev-dependencies]
 pytest = "^7.2.1"
-flake8 = "~4.0.1"
+ruff = "^0"
 mypy = "^1.1.1"
-isort = "^5.11.4"
 pre-commit = "^3.0.1"
-wemake-python-styleguide = "^0.17.0"
 black = "^22.12.0"
-autoflake = "^1.6.1"
 pytest-cov = "^4.0.0"
 anyio = "^3.6.2"
 pytest-env = "^0.8.1"
@@ -254,6 +251,86 @@ src_folder = "./{{cookiecutter.project_name}}"
 {%- endif %}
 {%- endfor %}
 
+[tool.ruff]
+# List of enabled rulsets.
+# See https://docs.astral.sh/ruff/rules/ for more information.
+select = [
+    "E",   # Error
+    "F",   # Pyflakes
+    "W",   # Pycodestyle
+    "C90", # McCabe complexity
+    "I",   # Isort
+    "N",   # pep8-naming
+    "D",   # Pydocstyle
+    "ANN", # Pytype annotations
+    "S",   # Bandit
+    "B",   # Bugbear
+    "COM", # Commas
+    "C4",  # Comprehensions
+    "ISC", # Implicit string concat
+    "PIE", # Unnecessary code
+    "T20", # Catch prints
+    "PYI", # validate pyi files
+    "Q",   # Checks for quotes
+    "RSE", # Checks raise statements
+    "RET", # Checks return statements
+    "SLF", # Self checks
+    "SIM", # Simplificator
+    "PTH", # Pathlib checks
+    "ERA", # Checks for commented out code
+    "PL",  # PyLint checks
+    "RUF", # Specific to Ruff checks
+]
+ignore = [
+    "D105",    # Missing docstring in magic method
+    "D107",    # Missing docstring in __init__
+    "D211",    # No blank lines allowed before class docstring
+    "D212",    # Multi-line docstring summary should start at the first line
+    "D401",    # First line should be in imperative mood
+    "D104",    # Missing docstring in public package
+    "D100",    # Missing docstring in public module
+    "D202",    # No blank lines allowed after function docstring
+    "ANN102",  # Missing type annotation for self in method
+    "ANN101",  # Missing type annotation for argument
+    "ANN401",  # typing.Any are disallowed in `**kwargs
+    "PLR0913", # Too many arguments for function call
+    "D106",    # Missing docstring in public nested class
+]
+exclude = [
+    {%- if cookiecutter.orm in ["ormar", "sqlalchemy", "piccolo", "tortoise"] %}
+    "{{ cookiecutter.project_name }}/db/migrations",
+    {%- endif %}
+    ".venv/"
+]
+mccabe = { max-complexity = 10 }
+line-length = 88
+
+[tool.ruff.per-file-ignores]
+"tests/*" = [
+    "S101", # Use of assert detected
+]
+
+[tool.ruff.pydocstyle]
+convention = "pep257"
+ignore-decorators = ["typing.overload"]
+
+[tool.ruff.pylint]
+allow-magic-value-types = ["int", "str", "float", "bytes"]
+
+[tool.ruff.flake8-bugbear]
+extend-immutable-calls = [
+    "fastapi.Depends",
+    "fastapi.Query",
+    "fastapi.Path",
+    {%- if cookiecutter.enable_taskiq == "True" %}
+    "taskiq.TaskiqDepends",
+    {%- endif %}
+    {%- if cookiecutter.orm == "sqlalchemy" %}
+    "sqlalchemy.orm.joinedload",
+    {%- endif %}
+]
+
+
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
diff --git a/...iecutter.project_name}}/tests/__init__.py → ...iecutter.project_name}}/tests/__init__.py b/...iecutter.project_name}}/tests/__init__.py → ...iecutter.project_name}}/tests/__init__.py
diff --git a/...cutter.project_name}}/tests/test_dummy.py → ...cutter.project_name}}/tests/test_dummy.py b/...cutter.project_name}}/tests/test_dummy.py → ...cutter.project_name}}/tests/test_dummy.py
diff --git a/...ecutter.project_name}}/tests/test_echo.py → ...ecutter.project_name}}/tests/test_echo.py b/...ecutter.project_name}}/tests/test_echo.py → ...ecutter.project_name}}/tests/test_echo.py
diff --git a/...cutter.project_name}}/tests/test_kafka.py → ...cutter.project_name}}/tests/test_kafka.py b/...cutter.project_name}}/tests/test_kafka.py → ...cutter.project_name}}/tests/test_kafka.py
diff --git a/...utter.project_name}}/tests/test_rabbit.py → ...utter.project_name}}/tests/test_rabbit.py b/...utter.project_name}}/tests/test_rabbit.py → ...utter.project_name}}/tests/test_rabbit.py
diff --git a/...cutter.project_name}}/tests/test_redis.py → ...cutter.project_name}}/tests/test_redis.py b/...cutter.project_name}}/tests/test_redis.py → ...cutter.project_name}}/tests/test_redis.py
diff --git a/...sts/test_{{cookiecutter.project_name}}.py → ...sts/test_{{cookiecutter.project_name}}.py b/...sts/test_{{cookiecutter.project_name}}.py → ...sts/test_{{cookiecutter.project_name}}.py