Add ruff (run-llama#881)

MaxJPRey · Mar 25, 2023 · 56c8d40 · 56c8d40
1 parent a9f8989
commit 56c8d40
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 24 deletions.
diff --git a/.flake8 b/.flake8
diff --git a/.gitignore b/.gitignore
@@ -55,6 +55,7 @@ coverage.xml
 *.py,cover
 .hypothesis/
 .pytest_cache/
+.ruff_cache
 
 # Translations
 *.mo

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,5 @@
+repos:
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.0.243
+    hooks:
+      - id: ruff
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -53,7 +53,13 @@ You can format and lint your changes with the following commands in the root dir
 make format; make lint
 ```
 
-We run an assortment of linters: `black`, `isort`, `mypy`, `flake8`.
+You can also make use of our pre-commit hooks by setting up git hook scripts:
+
+```bash
+pre-commit install
+```
+
+We run an assortment of linters: `black`, `ruff`, `mypy`.
 
 ### Testing
 

diff --git a/Makefile b/Makefile
@@ -2,13 +2,11 @@
 
 format:
 	black .
-	isort .
 
 lint:
 	mypy .
 	black . --check
-	isort . --check
-	flake8 .
+	ruff check .
 
 test:
-	pytest tests
+	pytest tests
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,7 +1,15 @@
-[tool.isort]
-profile = "black"
-
 [tool.mypy]
 ignore_missing_imports = "True"
 disallow_untyped_defs = "True"
 exclude = ["notebooks", "build", "examples"]
+
+[tool.ruff]
+exclude = [
+    ".venv",
+    "__pycache__",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".ruff_cache",
+    "examples",
+    "notebooks",
+]
diff --git a/requirements.txt b/requirements.txt
@@ -14,8 +14,7 @@ types-setuptools==67.1.0.0
 
 # linting
 black==22.12.0
-isort==5.11.4
 mypy==0.991
-flake8==6.0.0
-flake8-docstrings==1.6.0
+pre-commit==3.2.0
 pylint==2.15.10
+ruff==0.0.259