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

Uploaded Python 3

File details

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

File metadata

  • Download URL: rattle_lint-1.0.4.tar.gz
  • Upload date:
  • Size: 171.7 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.4.tar.gz
Algorithm Hash digest
SHA256 d1cbe89376fef1fc5a17bad74e6911d900c90025ff7a3bb086838889daebabcf
MD5 7f2077c82ba3dc1bb7d2e6888618b060
BLAKE2b-256 85704c9ce3178946ad1deb2cbd746c78d81aa8c435c99492bcc8cf44d4164117

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rattle_lint-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 104.7 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7c036bd762e8b58878be9e9fef9fa774ea1dedc52f02a9c46939a63cb603dc14
MD5 6799fe28b84cdcf05af9fea1cded4f1e
BLAKE2b-256 cbfb2a91effd1d7c887e7003a0777522071a0e2e890326337ef73a7e6b731a36

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