Merge pull request #282 from cdragos/chore/streamline-linting

chore: streamline linting and formatting process

Author: iurisilvio

.devcontainer/devcontainer.json

@@ -9,7 +9,7 @@
             "extensions": [
                 "ms-python.python",
                 "ms-python.debugpy",
-                "ms-python.black-formatter"
+                "charliermarsh.ruff"
             ],
             "settings": {
                 "extensions.verifySignature": false

.github/workflows/test.yml

@@ -27,7 +27,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install ".[dev]"
-      - name: 🧹 Lint with flake8
+      - name: 🧹 Lint
         run: |
           make check_code_quality
       - name: Check types with mypy

.pre-commit-config.yaml

@@ -20,40 +20,19 @@ repos:
       - id: forbid-new-submodules
       - id: mixed-line-ending
       - id: pretty-format-json
-        args: ['--autofix', '--no-sort-keys', '--indent=4']
+        args: ["--autofix", "--no-sort-keys", "--indent=4"]
       - id: trailing-whitespace
 
-
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.13.2
-    hooks:
-      - id: isort
-        name: Sort imports
-
-  - repo: https://github.com/PyCQA/flake8
-    rev: 7.1.0
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.7.9
     hooks:
-      - id: flake8
-        name: Flake8 Checks
-        entry: flake8
-        additional_dependencies: [Flake8-pyproject]
-
-
-  -   repo: https://github.com/PyCQA/bandit
-      rev: 1.7.9
-      hooks:
-      -   id: bandit
-          args: ["-c", "pyproject.toml"]
-          additional_dependencies: ["bandit[toml]"]
-
-  -   repo: https://github.com/astral-sh/ruff-pre-commit
-      rev: v0.5.0
-      hooks:
-      -   id: ruff
-          args: [--fix, --exit-non-zero-on-fix]
+      - id: bandit
+        args: ["-c", "pyproject.toml"]
+        additional_dependencies: ["bandit[toml]"]
 
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v3.16.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.5.1
     hooks:
-      - id: pyupgrade
-        args: [--py38-plus]
+      - id: ruff-format
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]

.vscode/settings.json

@@ -12,9 +12,8 @@
     ],
     "editor.formatOnSave": true,
     "[python]": {
-        "editor.defaultFormatter": "ms-python.black-formatter"
+        "editor.defaultFormatter": "charliermarsh.ruff"
     },
-    "python.formatting.provider": "none",
     "python.testing.pytestEnabled": false,
     "editor.inlineSuggest.showToolbar": "onHover"
 }

CONTRIBUTING.md

@@ -28,7 +28,7 @@ pip install -e ".[dev]"
 
 ### Devcontainer
 
-This project comes with a [convenient devcontainer](https://www.loom.com/share/a183c4a351ed4700a79476fedf08ab9b) that makes it easier to run tests and has black configured to run on save.
+This project comes with a [convenient devcontainer](https://www.loom.com/share/a183c4a351ed4700a79476fedf08ab9b) that makes it easier to run tests and has lint configured to run on save.
 
 On rare occasions a full rebuild is needed, you can do it in VSCode by pressing `Ctrl+Shift+P` and running `Dev Containers: Rebuild Container`.
 
@@ -57,10 +57,10 @@ def example_function(param1: int, param2: str) -> bool:
 We provide a `Makefile` to format and ensure code quality. **Be sure to run them before creating a PR**.
 
 ```bash
-# format code with `black` and `isort`
+# format code with `ruff`
 make style
 
-# check code with flake8
+# check code with `ruff`
 make check_code_quality
 ```
 

Makefile

@@ -4,16 +4,12 @@ export PYTHONPATH = .
 check_dirs := roboflow
 
 style:
-	black  $(check_dirs)
-	isort --profile black $(check_dirs)
+	ruff format $(check_dirs)
+	ruff check $(check_dirs) --fix
 
 check_code_quality:
-	black --check $(check_dirs)
-	isort --check-only --profile black $(check_dirs)
-	# stop the build if there are Python syntax errors or undefined names
-	flake8 $(check_dirs) --count --select=E9,F63,F7,F82 --show-source --statistics
-	# exit-zero treats all errors as warnings. E203 for black, E501 for docstring, W503 for line breaks before logical operators
-	flake8 $(check_dirs) --count --max-line-length=120 --exit-zero  --ignore=D --extend-ignore=E203,E501,W503  --statistics
+	ruff format $(check_dirs) --check
+	ruff check $(check_dirs)
 
 publish:
 	python setup.py sdist bdist_wheel

pyproject.toml

@@ -2,90 +2,51 @@
 requires = ["setuptools>=57", "wheel"]
 build-backend = "setuptools.build_meta"
 
-
-[tool.flake8]
-exclude = ".venv"
-max-complexity = 10
-max-line-length = 120
-extend-ignore = """
-    W503,
-    E203,
-    E701,
-    C901,
-"""
-per-file-ignores = """
-    __init__.py: F401
-"""
-
-[tool.black]
-line-length = 120
-
-[tool.isort]
-line_length = 120
-profile = "black"
-
 [tool.bandit]
 target = ["test", "roboflow"]
 tests = ["B201", "B301"]
 
-[tool.autoflake]
-check = true
-imports = ["cv2", "roboflow"]
-
 [tool.ruff]
 target-version = "py38"
-# Enable pycodestyle (`E`) and Pyflakes (`F`) codes by default.
-select = ["E", "F"]
-ignore = []
+line-length = 120
 
-# Allow autofix for all enabled rules (when `--fix`) is provided.
-fixable = [
+[tool.ruff.lint]
+select = [
+    "ALL",
+]
+ignore = [
     "A",
-    "B",
-    "C",
-    "D",
-    "E",
-    "F",
-    "G",
-    "I",
-    "N",
-    "Q",
-    "S",
-    "T",
-    "W",
     "ANN",
     "ARG",
+    "B",
     "BLE",
+    "C",
     "COM",
-    "DJ",
+    "D",
     "DTZ",
     "EM",
     "ERA",
-    "EXE",
     "FBT",
-    "ICN",
-    "INP",
+    "FIX",
+    "FLY",
+    "FURB",
     "ISC",
-    "NPY",
-    "PD",
-    "PGH",
+    "N",
+    "PERF",
     "PIE",
-    "PL",
+    "PLR",
+    "PLW",
     "PT",
     "PTH",
-    "PYI",
     "RET",
-    "RSE",
     "RUF",
+    "S",
     "SIM",
     "SLF",
-    "TCH",
-    "TID",
+    "T",
+    "TD",
     "TRY",
-    "UP",
-    "YTT",
 ]
-unfixable = []
 
 # Exclude a variety of commonly ignored directories.
 exclude = [
@@ -116,31 +77,26 @@ exclude = [
     "tests/manual/debugme.py", # file is intentionally broken
 ]
 
-# Same as Black.
-line-length = 120
 
 # Allow unused variables when underscore-prefixed.
 dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
 
-[tool.ruff.flake8-quotes]
-inline-quotes = "double"
-multiline-quotes = "double"
-docstring-quotes = "double"
-
-[tool.ruff.pydocstyle]
+[tool.ruff.lint.pydocstyle]
 convention = "google"
 
-[tool.ruff.per-file-ignores]
-"__init__.py" = ["E402", "F401"]
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = [
+    "E402", # Module level import not at top of file
+    "F401", # Imported but unused
+]
 
-[tool.ruff.pylint]
-max-args = 20
+[tool.ruff.lint.pyupgrade]
+# Preserve types, even if a file imports `from __future__ import annotations`.
+keep-runtime-typing = true
 
 [tool.mypy]
 python_version = "3.8"
-exclude = [
-    "^build/"
-]
+exclude = ["^build/"]
 
 [[tool.mypy.overrides]]
 module = [

roboflow/core/project.py

@@ -401,17 +401,18 @@ def upload(
 
         if not is_file and not is_dir:
             raise RuntimeError(
-                "The provided image path [ {} ] is not a valid path. Please provide a"
-                " path to an image or a directory.".format(image_path)
+                f"The provided image path [ {image_path} ] is not a valid path. Please provide a"
+                " path to an image or a directory."
             )
 
         if is_file:
             is_image = is_hosted or self.check_valid_image(image_path)
 
             if not is_image:
                 raise RuntimeError(
-                    "The image you provided {} is not a supported file format. We"
-                    " currently support: {}.".format(image_path, ", ".join(ACCEPTED_IMAGE_FORMATS))
+                    "The image you provided {} is not a supported file format. We" " currently support: {}.".format(
+                        image_path, ", ".join(ACCEPTED_IMAGE_FORMATS)
+                    )
                 )
 
             self.single_upload(

roboflow/util/versions.py

@@ -6,7 +6,7 @@
 
 
 def get_wrong_dependencies_versions(
-    dependencies_versions: List[Tuple[str, str, str]]
+    dependencies_versions: List[Tuple[str, str, str]],
 ) -> List[Tuple[str, str, str, str]]:
     """
     Get a list of mismatching dependencies with current version installed.

setup.py

@@ -31,17 +31,15 @@
     extras_require={
         "desktop": ["opencv-python==4.8.0.74"],
         "dev": [
-            "flake8",
-            "black==22.3.0",
-            "isort",
+            "mypy",
             "responses",
+            "ruff",
             "twine",
-            "wheel",
-            "mypy",
-            "types-requests",
             "types-pyyaml",
+            "types-requests",
             "types-setuptools",
             "types-tqdm",
+            "wheel",
         ],
     },
     entry_points={