How Ruff Works

Ruff is written in Rust, however right here’s the magic: as a consumer, you received’t even discover it’s not written in Python. It leverages Rust Python’s AST parser and implements its personal AST traversal, customer abstraction, and lint-rule logic. It helps Python 3.10 and three.11, together with the brand new sample matching syntax. Ruff can also be pip-installable, making it straightforward to include into your workflow.

Ruff is constructed on two core hypotheses: Python tooling might be rewritten in additional performant languages, and an built-in toolchain can faucet into efficiencies that aren’t obtainable to a disparate set of instruments. Ruff exemplifies these concepts by producing all violations in a single move and even autofixing points with out a noticeable efficiency penalty.

For those who’re curious to expertise the velocity and effectivity of Ruff for your self, you’ll be able to strive it immediately by operating or the bundle supervisor you’re utilizing, like Poetry poetry add ruff.

As linter, as it’s said within the Ruff documentation, ” designed as a drop-in substitute for Flake8 (plus dozens of plugins), isort, pydocstyle, pyupgrade, autoflake, and extra.” Ruff has a set of over 700 guidelines in its linter functionallity.

You can begin by operating it for all present folder recordsdata:

If you wish to run the Ruff formatter for the primary time, as a beginning step I might suggest you to make use of ruff format . --diff. The --diffflag means that you can overview the modifications earlier than they’re utilized. It’s thought as a drop-in substitute for Black.

Integrating Ruff in you undertaking with Pyproject yaml and pre-commit

Until immediately, there’s not a mantained solution to migrate from Black to Ruff) as it will be a one-timer and dear to ongoing assist.

With the next code you will note

Suposse the folowing pyproject.toml file that might be standard in a knowledge associated undertaking:

[tool.poetry]
identify = "data-project"
model = "1.0.0"
description = "Python 🐍 service that's meant to do fantastic issues✧"
authors = ["TypeThePipe.com"]
readme = "README.md"
classifiers = [
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Programming Language :: Python :: 3.11",
]


[tool.poetry.dependencies]
python = "~3.11.0"
sqlmodel = "^0.0.8"
pydantic = "^1.10.4"
numpy = "^1.24.2"
pandas = "^1.5.3"
scipy = "^1.10.1"
statsmodels = "^0.13.5"
rollbar = "^0.16.3"
sqlalchemy = "1.4.35"
alembic = "^1.10.2"
psycopg2 = "^2.9.5"


[tool.poetry.group.dev.dependencies]
black = "^23.1"
flake8 = "^4.0"
isort = "^5.10"
flakeheaven = "^0.11"
pytest = "^7.2"
pytest-postgresql = "^4.1.1"
psycopg = "^3.1.8"
protection = {model = "^7.2.1", extras = ["toml"]}
pre-commit = "^2.17.0"
mypy = "^1.0.1"
pytest-dependency = "^0.5.1"
dvc = { model = "^2.10.2", extras = ["s3"] }
mkdocs = "^1.4.2"
mkdocstrings = "^0.19.1"
mkdocs-materials = "^9.0.5"


[tool.poetry.group.notebook.dependencies]
jupyterlab = "^3.6.1"
pocket book = "^6.5.2"
plotly = "^5.13.0"

[build-system]
requires = ["poetry-core"]
construct-backend = "poetry.core.masonry.api"


#####
# Typing
#####

[tool.isort]
# Black Compatibility
profile = "black"

[tool.mypy]
python_version = "3.11"
warn_return_any = true
warn_unused_configs = true
ignore_missing_imports = true
exclude = ["nb"]

#####
# Flake8
#####

[tool.flakeheaven]
exclude = ["README.md"]
format = "stat"
max_line_length = 120 # YOLO
show_source = true

[tool.flakeheaven.plugins]
pyflakes = ["+*", "-F401"]
# allow solely codes from S100 to S199
flake8-bandit = ["-*", "+S1??"]
flake8-docstrings = ["+*"]
flake8-bugbear = ["+*"]
flake8-builtins = ["+*", "-A003"]
flake8-comprehensions = ["+*"]
flake8-eradicate = ["+*"]
flake8-isort = ["+*"]
flake8-mutable = ["+*"]
flake8-pytest-fashion = ["+*"]
pyflakes = ["+*"]
pylint = ["+*"]

This Ruff code can be the substitute of the Flake8 pyproject part. We use the instrument.rufffor generic configuration and the instrument.ruff.lint for particular Ruff guidelines you wish to apply in your linter. These chosen ones can be the substitute of the earlier configuration.

[tool.ruff]
line-size = 120 # YOLO
goal-model = "py311"

[tool.ruff.lint]
choose = [
    "F", #Pyflakes
    "B", #flake8-bugbear
    "A", #flake8-builtins 
    "C4", #flake8-comprehensions
    "ERA", #eradicate
    "I", #isort
    "PT", #flake8-pytest-style
    "C90", #mccabe
    "N", #pep8-naming
    "E", #pycodestyle error
    "PL" #Pylint
]
ignore = ["A003"]

[tool.ruff.format]
quote-fashion = "single"
indent-fashion = "tab"

#.pre-commit-config.yaml file
- repo: https://github.com/astral-sh/ruff-pre-commit
  # Ruff model.
  rev: v0.1.6
  hooks:
    # Run the linter.
    - id: ruff
      args: [ --fix ]
    # Run the formatter.
    - id: ruff-format
- repo: https://github.com/tox-dev/pyproject-fmt
  rev: "1.5.2"
  hooks:
    - id: pyproject-fmt

The instrument.ruff.lint is now most popular the way in which to configure the linter, regardless of it’s sill experimental and should embody modifications.

Keep up to date on Ruff and Python suggestions

Hopefully, this publish has helped you grow to be accustomed to a newcomer to the Python linter and pre-commit hook panorama, say hello to Ruff.

If you wish to keep up to date…