From flake8 to ruff

Author: pamelafox

.devcontainer/Dockerfile

@@ -2,4 +2,4 @@
 
 # [Choice] Python version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.10, 3.9, 3.8, 3.7, 3.6, 3-bullseye, 3.10-bullseye, 3.9-bullseye, 3.8-bullseye, 3.7-bullseye, 3.6-bullseye, 3-buster, 3.10-buster, 3.9-buster, 3.8-buster, 3.7-buster, 3.6-buster
 ARG VARIANT="3.10-bullseye"
-FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT}
+FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT}

.devcontainer/devcontainer.json

@@ -6,7 +6,7 @@
 	"build": {
 		"dockerfile": "Dockerfile",
 		"context": "..",
-		"args": { 
+		"args": {
 			// Update 'VARIANT' to pick a Python version: 3, 3.10, 3.9, 3.8, 3.7, 3.6
 			// Append -bullseye or -buster to pin to an OS version.
 			// Use -bullseye variants on local on arm64/Apple Silicon.
@@ -19,23 +19,22 @@
 		// Configure properties specific to VS Code.
 		"vscode": {
 			// Set *default* container specific settings.json values on container create.
-			"settings": { 
+			"settings": {
 				"python.defaultInterpreterPath": "/usr/local/bin/python",
 				"python.linting.enabled": true,
 				"python.linting.pylintEnabled": true,
 				"python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
 				"python.formatting.blackPath": "/usr/local/py-utils/bin/black",
 				"python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
 				"python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
-				"python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
 				"python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
 				"python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
 				"python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
 				"python.linting.pylintPath": "/usr/local/py-utils/bin/pylint",
                 "python.testing.unittestEnabled": false,
                 "python.testing.pytestEnabled": true
 			},
-			
+
 			// Add the IDs of extensions you want installed when the container is created.
 			"extensions": [
 				"ms-python.python",
@@ -52,4 +51,4 @@
 
 	// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
 	"remoteUser": "vscode"
-}
+}

.flake8

@@ -19,9 +19,9 @@ jobs:
           run: |
             python -m pip install --upgrade pip
             pip install -r requirements-dev.txt
-        - name: Lint with flake8
+        - name: Lint with ruff
           run: |
-            flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+            ruff . --select=E9,F63,F7,F82 --show-source
         - name: Check pyupgrade
           run: pyupgrade --py310-plus *.py tests/*.py
         - name: Check formatting with black

.github/workflows/python.yaml

@@ -15,12 +15,10 @@ repos:
     hooks:
       - id: isort
         name: isort (python)
--   repo: https://gitlab.com/pycqa/flake8
-    rev: 4.0.1
+-   repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.0.116
     hooks:
-    -   id: flake8
-        exclude: '.venv/'
-        args: ['--config=.flake8']
+      - id: ruff
 -   repo: https://github.com/asottile/pyupgrade
     rev: v3.1.0
     hooks:

.pre-commit-config.yaml

@@ -4,7 +4,7 @@ This is a template repository for any Python project that comes with the followi
 
 * `black`: auto-formats code
 * `isort`: sorts the imports
-* `flake8`: looks for common errors
+* `ruff`: looks for common errors
 * `pyupgrade`: upgrades Python syntax
 
 All of those checks are run as pre-commit hooks using the `pre-commit` library.
@@ -63,7 +63,6 @@ Here's a short explanation of each file/folder in this template:
     * `python.yaml`: File configuring Github action that runs tools and tests
 * `tests`: Folder containing Python tests
   * `main_test.py`: File with pytest-style tests of main.py
-* `.flake8`: File configuring the flake8 tool
 * `.gitignore`: File describing what file patterns Git should never track
 * `.pre-commit-config.yaml`: File listing all the pre-commit hooks and args
 * `main.py`: The main (and currently only) Python file for the program

README.md

@@ -11,4 +11,8 @@ pythonpath = ['.']
 disable = "C0114,C0115,C0116"
 
 [tool.isort]
-profile = "black"
+profile = "black"
+
+[tool.ruff]
+line-length = 100
+ignore = ["D203"]

pyproject.toml

@@ -2,7 +2,7 @@
 pre-commit
 black
 isort
-flake8
+ruff
 pyupgrade
 pytest
 coverage

requirements-dev.txt

@@ -1 +0,0 @@
-