Fast Linting and Formatting with Ruff

Beginner6 minTrending

Use Ruff to lint and format Python code at extreme speed, replacing Flake8, isort, Black, and dozens of other tools in a single binary.

Prerequisites

-Python 3.8+ installed

Steps

Install Ruff

Install the Ruff linter and formatter. It is a single Rust binary that runs 10-100x faster than Flake8 and Black combined.

$ pip install ruff

You can also install via 'uv tool install ruff' or 'pipx install ruff' for a global installation.

Lint your project

Run the linter across all Python files in the current directory. Ruff supports 800+ lint rules from Flake8, isort, pyupgrade, and more.

$ ruff check .

Auto-fix lint violations

Automatically fix all safely fixable lint violations. Ruff will only apply fixes that do not change program behavior.

$ ruff check --fix .

Review the changes after auto-fix. While safe fixes preserve behavior, they may alter code style in ways you want to verify.

Format code (Black-compatible)

Format all Python files using Ruff's built-in formatter, which is compatible with Black's output style. This replaces the need for a separate Black installation.

$ ruff format .

Check formatting without modifying files

Preview formatting changes without writing them. Useful in CI pipelines to enforce formatting standards without modifying code.

$ ruff format --check --diff .

Use this command in your CI pipeline to fail the build if code is not properly formatted.

Full Script

full-script.sh

#!/bin/bash
# Ruff linting and formatting workflow
set -e

pip install ruff

# Add Ruff config to pyproject.toml if it exists
if [ -f pyproject.toml ]; then
  cat >> pyproject.toml << 'TOMLEOF'

[tool.ruff]
target-version = "py311"
line-length = 88

[tool.ruff.lint]
select = ["E", "F", "I", "N", "UP", "B", "SIM", "RUF"]
ignore = ["E501"]

[tool.ruff.format]
quote-style = "double"
indent-style = "space"
TOMLEOF
  echo "Ruff config added to pyproject.toml"
fi

echo "=== Linting ==="
ruff check . --fix

echo "=== Formatting ==="
ruff format .

echo "Linting and formatting complete."

FAQ

Discussion

Loading comments...

#!/bin/bash # Ruff linting and formatting workflow set -e pip install ruff # Add Ruff config to pyproject.toml if it exists if [ -f pyproject.toml ]; then cat >> pyproject.toml << 'TOMLEOF' [tool.ruff] target-version = "py311" line-length = 88 [tool.ruff.lint] select = ["E", "F", "I", "N", "UP", "B", "SIM", "RUF"] ignore = ["E501"] [tool.ruff.format] quote-style = "double" indent-style = "space" TOMLEOF echo "Ruff config added to pyproject.toml" fi echo "=== Linting ===" ruff check . --fix echo "=== Formatting ===" ruff format . echo "Linting and formatting complete."