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.7.tar.gz (189.2 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.7-py3-none-any.whl (123.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rattle_lint-1.0.7.tar.gz
  • Upload date:
  • Size: 189.2 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.7.tar.gz
Algorithm Hash digest
SHA256 5f2e94b97a4c6ffc2eeeff2077a6be54ae2825c149c7c2db4dc62d4566095010
MD5 54bf486b4004b15e8de07cb85620d0c4
BLAKE2b-256 c6658ddb06cb8ae19871f35564582e71451de702d85a21b4ecc3e50f652d571d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rattle_lint-1.0.7-py3-none-any.whl
  • Upload date:
  • Size: 123.8 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 cb55e2a23eb7a810f440c9c459f6104b498874f197e2c62d9de9b76cff7a36cc
MD5 cf576c77068a7426d02828dbef78c4ba
BLAKE2b-256 49c7916a5ad653f3a25bd32d2466fe2ba2022b77caf48b0a0d127b91c9924473

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