Skip to main content

A framework for custom Python linters with auto-fixes and hierarchical configuration

Project description

Rattle

Tests PyPI version Supported versions Downloads license

Rattle is a Python linting framework built on LibCST with support for autofixes, custom in-repo lint rules, and hierarchical configuration.

Rattle is a fork of Fixit.

Features

  • Built-in lint rules for common Python issues
  • Autofix support when a rule can safely rewrite code
  • Local custom rules that can live inside your repository
  • Hierarchical pyproject.toml configuration
  • Pre-commit integration for CI and local workflows
  • LSP support

Install

Install the CLI from PyPI:

pip install rattle-lint

Install editor/LSP support too:

pip install "rattle-lint[lsp]"

Basic Usage

rattle lint

Apply available autofixes:

rattle fix

Example Configuration

[tool.rattle]
root = true
python-version = "3.10"
output-format = "rattle"
disable = [
    "NoStaticIfCondition",
    "UseAssertIn",
]
per-file-disable = {"tests/generated.py" = ["UseFstring"]}

[tool.rattle.options.UseFstring]
simple_expression_max_length = 40

[[tool.rattle.overrides]]
path = "tests"
enable = ["UseAssertIn"]
options = { UseFstring = { simple_expression_max_length = 60 } }

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rattle_lint-1.0.5.tar.gz (171.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rattle_lint-1.0.5-py3-none-any.whl (104.6 kB view details)

Uploaded Python 3

File details

Details for the file rattle_lint-1.0.5.tar.gz.

File metadata

  • Download URL: rattle_lint-1.0.5.tar.gz
  • Upload date:
  • Size: 171.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for rattle_lint-1.0.5.tar.gz
Algorithm Hash digest
SHA256 82de88acdd6c1e45be0bf4b570597f5ee6eddf0fae7026a8da8265bd7719b24f
MD5 7d8af756b46f6f5f11b7eb766e590b8f
BLAKE2b-256 0a97dd8cdb5ba186075748bfe26d18b8ff38357775ad5e3ea1d8b25473c80300

See more details on using hashes here.

File details

Details for the file rattle_lint-1.0.5-py3-none-any.whl.

File metadata

  • Download URL: rattle_lint-1.0.5-py3-none-any.whl
  • Upload date:
  • Size: 104.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for rattle_lint-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 01a0fdf8a069cc58b0c958811e951cae157b0a78fbec26ee6dd86aa864ef99aa
MD5 036e355c143a76ec81e06b99304acbb9
BLAKE2b-256 4058f368cc4872cc4fb0d2a4885d4f442be5c3025dedb57283f84927bd6d6ef2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page