feat: Switch to Ruff (#96)

* feat: Switch to Ruff
 - Use `ruff` instead of `black`, `isort` and `flake8`
 - Switch to pre-commit for linting in CI
 - Infer Python version from `pyproject.toml`

* fix: Formatting

Author: khvn26

.flake8

@@ -17,33 +17,22 @@ jobs:
             FLAGSMITH_API_TOKEN: test_token
             ENVIRONMENT_API_KEYS: placeholder_key1
 
-        strategy:
-            max-parallel: 4
-            matrix:
-                python-version: ["3.12"]
-
         steps:
             - name: Cloning repo
               uses: actions/checkout@v4
 
-            - name: Set up Python ${{ matrix.python-version }}
+            - name: Set up Python
               uses: actions/setup-python@v5
               with:
-                  python-version: ${{ matrix.python-version }}
+                  python-version-file: pyproject.toml
+
+            - name: Check linting
+              uses: pre-commit/action@v3.0.1
 
             - name: Install Dependencies
               run: |
                   python -m pip install --upgrade pip
                   pip install -r requirements.txt -r requirements-dev.txt
 
-            - name: Check black formatting
-              run: black --check .
-
-            - name: Check flake8 linting
-              run: flake8 --config=.flake8 .
-
-            - name: Check import order
-              run: isort --check .
-
             - name: Run Tests
               run: pytest -p no:warnings

.github/workflows/pull-request.yml

@@ -1,18 +1,6 @@
 repos:
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.12.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.5
     hooks:
-      - id: isort
-        name: isort (python)
-  - repo: https://github.com/psf/black
-    rev: 22.6.0
-    hooks:
-      - id: black
-        language_version: python3
-        exclude: migrations
-  - repo: https://github.com/pycqa/flake8
-    rev: '4.0.1'
-    hooks:
-      - id: flake8
-        name: flake8
-        entry: bash -c 'git diff --staged -- "$@" | flake8 --diff' --
+      - id: ruff
+      - id: ruff-format

.pre-commit-config.yaml

@@ -42,7 +42,7 @@ def repeat_every(  # noqa: C901
     """
 
     def decorator(
-        func: Union[NoArgsNoReturnAsyncFuncT, NoArgsNoReturnFuncT]
+        func: Union[NoArgsNoReturnAsyncFuncT, NoArgsNoReturnFuncT],
     ) -> NoArgsNoReturnAsyncFuncT:
         """
         Converts the decorated function into a repeated, periodically-called version of itself.

fastapi_utils/tasks.py

@@ -3,29 +3,12 @@
 # verbose regular expressions by Black.  Use [ ] to denote a significant space
 # character.
 
-[tool.black]
+[tool.ruff]
+target-version = 'py312'
 line-length = 88
-target-version = ['py312']
-include = '\.pyi?$'
-exclude = '''
-/(
-    \.eggs
-  | \.git
-  | \.hg
-  | \.mypy_cache
-  | \.tox
-  | \.venv
-  | _build
-  | buck-out
-  | build
-  | dist
-  | migrations
-)/
-'''
 
-[tool.isort]
-use_parentheses=true
-multi_line_output=3
-include_trailing_comma=true
-line_length=79
-known_first_party=['fastapi_utils']
+[tool.ruff.lint.isort]
+known-first-party = ['fastapi_utils']
+
+[tool.ruff.lint.mccabe]
+max-complexity = 10

pyproject.toml

@@ -1,10 +1,4 @@
-pylint
-pep8
-autopep8
-black
 pre-commit
-isort
-flake8
 pytest
 pytest-asyncio
 pytest-mock

requirements-dev.in

@@ -1,76 +1,37 @@
 #
-# This file is autogenerated by pip-compile with Python 3.12
+# This file is autogenerated by pip-compile with Python 3.10
 # by the following command:
 #
 #    pip-compile requirements-dev.in
 #
-astroid==2.15.8
-    # via pylint
-autopep8==2.0.4
-    # via -r requirements-dev.in
-black==24.3.0
-    # via -r requirements-dev.in
 certifi==2023.7.22
     # via -r requirements-dev.in
 cfgv==3.4.0
     # via pre-commit
 classify-imports==4.2.0
     # via reorder-python-imports
-click==8.1.7
-    # via black
-dill==0.3.7
-    # via pylint
 distlib==0.3.7
     # via virtualenv
+exceptiongroup==1.2.0
+    # via pytest
 filelock==3.12.4
     # via virtualenv
-flake8==6.1.0
-    # via -r requirements-dev.in
 freezegun==1.4.0
     # via pytest-freezegun
 identify==2.5.29
     # via pre-commit
 iniconfig==2.0.0
     # via pytest
-isort==5.12.0
-    # via
-    #   -r requirements-dev.in
-    #   pylint
-lazy-object-proxy==1.9.0
-    # via astroid
-mccabe==0.7.0
-    # via
-    #   flake8
-    #   pylint
-mypy-extensions==1.0.0
-    # via black
 nodeenv==1.8.0
     # via pre-commit
 packaging==23.1
-    # via
-    #   black
-    #   pytest
-pathspec==0.11.2
-    # via black
-pep8==1.7.1
-    # via -r requirements-dev.in
+    # via pytest
 platformdirs==3.10.0
-    # via
-    #   black
-    #   pylint
-    #   virtualenv
+    # via virtualenv
 pluggy==1.3.0
     # via pytest
 pre-commit==3.4.0
     # via -r requirements-dev.in
-pycodestyle==2.11.0
-    # via
-    #   autopep8
-    #   flake8
-pyflakes==3.1.0
-    # via flake8
-pylint==2.17.6
-    # via -r requirements-dev.in
 pytest==7.4.2
     # via
     #   -r requirements-dev.in
@@ -91,12 +52,10 @@ reorder-python-imports==3.11.0
     # via -r requirements-dev.in
 six==1.16.0
     # via python-dateutil
-tomlkit==0.12.1
-    # via pylint
+tomli==2.0.1
+    # via pytest
 virtualenv==20.24.5
     # via pre-commit
-wrapt==1.15.0
-    # via astroid
 
 # The following packages are considered to be unsafe in a requirements file:
 # setuptools

requirements-dev.txt

@@ -30,9 +30,9 @@ def environment_1_feature_states_response_list() -> typing.List[dict]:
 def environment_1_feature_states_response_list_response_with_segment_override(
     environment_1_feature_states_response_list,
 ):
-    environment_1_feature_states_response_list[1][
-        "feature_state_value"
-    ] = "segment_override"
+    environment_1_feature_states_response_list[1]["feature_state_value"] = (
+        "segment_override"
+    )
     return environment_1_feature_states_response_list