Add Ruff for formatting and linting (#877)

* Reformat with ruff

* Add ruff

* Check lint error

* Fix

* Fix test

Author: qubvel

.flake8

@@ -12,8 +12,27 @@ on:
 
 jobs:
 
+  style:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff==0.4.6
+      # Update output format to enable automatic inline annotations.
+      - name: Run Ruff Linter
+        run: ruff check --output-format=github
+      - name: Run Ruff Formatter
+        run: ruff format --check
+
   test:
     runs-on: ubuntu-latest
+    needs: [style]
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python ${{ matrix.python-version }}
@@ -25,3 +44,6 @@ jobs:
         python -m pip install --upgrade pip
         pip install torch==1.9.0+cpu torchvision==0.10.0+cpu -f https://download.pytorch.org/whl/torch_stable.html
         make install_dev
+    - name: Test with pytest
+      run: make test
+

.github/workflows/tests.yml

@@ -105,4 +105,7 @@ venv.bak/
 /site
 
 # mypy
-.mypy_cache/
+.mypy_cache/
+
+# ruff
+.ruff_cache/

.gitignore

@@ -4,8 +4,7 @@
 	python3 -m venv .venv
 
 install_dev: .venv
-	.venv/bin/pip install -e .[test]
-	.venv/bin/pre-commit install
+	.venv/bin/pip install -e ".[test]"
 
 test: .venv
 	.venv/bin/pytest -p no:cacheprovider tests/
@@ -16,7 +15,9 @@ table:
 table_timm:
 	.venv/bin/python misc/generate_table_timm.py
 
-precommit: install_dev
-	.venv/bin/pre-commit run --all-files
+fixup:
+	.venv/bin/ruff check --fix
+	.venv/bin/ruff format
+
+all: fixup test
 
-all: precommit test

.pre-commit-config.yaml

@@ -478,7 +478,7 @@ make install_dev  # create .venv, install SMP in dev mode
 #### Run tests and code checks
 
 ```bash
-make all          # run precommit, tests
+make fixup         # Ruff for formatting and lint checks
 ```
 
 #### Update table with encoders  

Makefile

@@ -14,10 +14,9 @@
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
-import os
-import re
 import sys
 import datetime
+import sphinx_rtd_theme
 
 sys.path.append("..")
 
@@ -68,14 +67,11 @@ def get_version():
 # a list of builtin themes.
 #
 
-import sphinx_rtd_theme
-
 html_theme = "sphinx_rtd_theme"
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # import karma_sphinx_theme
 # html_theme = "karma_sphinx_theme"
-import faculty_sphinx_theme
 
 html_theme = "faculty_sphinx_theme"
 

README.md

@@ -4,19 +4,17 @@
 
 
 WIDTH = 32
-COLUMNS = [
-    "Encoder",
-    "Weights",
-    "Params, M",
-]
+COLUMNS = ["Encoder", "Weights", "Params, M"]
 
 
 def wrap_row(r):
     return "|{}|".format(r)
 
 
 header = "|".join([column.ljust(WIDTH, " ") for column in COLUMNS])
-separator = "|".join(["-" * WIDTH] + [":" + "-" * (WIDTH - 2) + ":"] * (len(COLUMNS) - 1))
+separator = "|".join(
+    ["-" * WIDTH] + [":" + "-" * (WIDTH - 2) + ":"] * (len(COLUMNS) - 1)
+)
 
 print(wrap_row(header))
 print(wrap_row(separator))

docs/conf.py

@@ -24,20 +24,29 @@ def make_table(data):
 
     l1 = "+" + "-" * max_len1 + "+" + "-" * max_len2 + "+\n"
     l2 = "+" + "=" * max_len1 + "+" + "=" * max_len2 + "+\n"
-    top = "| " + "Encoder name".ljust(max_len1 - 2) + " | " + "Support dilation".center(max_len2 - 2) + " |\n"
+    top = (
+        "| "
+        + "Encoder name".ljust(max_len1 - 2)
+        + " | "
+        + "Support dilation".center(max_len2 - 2)
+        + " |\n"
+    )
 
     table = l1 + top + l2
 
     for k in sorted(data.keys()):
-        support = "✅".center(max_len2 - 3) if data[k]["has_dilation"] else " ".center(max_len2 - 2)
+        support = (
+            "✅".center(max_len2 - 3)
+            if data[k]["has_dilation"]
+            else " ".center(max_len2 - 2)
+        )
         table += "| " + k.ljust(max_len1 - 2) + " | " + support + " |\n"
         table += l1
 
     return table
 
 
 if __name__ == "__main__":
-
     supported_models = {}
 
     with tqdm(timm.list_models()) as names:

misc/generate_table.py

@@ -1,19 +0,0 @@
-[tool.black]
-line-length = 119
-target-version = ['py37', 'py38']
-include = '\.pyi?$'
-exclude = '''
-/(
-    \.eggs
-  | \.git
-  | \.hg
-  | \.mypy_cache
-  | \.tox
-  | \.venv
-  | docs
-  | _build
-  | buck-out
-  | build
-  | dist
-)/
-'''