rattle-lint 1.0.1__tar.gz

rattle_lint-1.0.1/.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*.{py,pyi,toml,md}]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+max_line_length = 88

rattle_lint-1.0.1/.gitignore

@@ -0,0 +1,108 @@
+html/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+.ruff_cache/
+
+# Visual Studio Code
+.vscode/

rattle_lint-1.0.1/.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+exclude: "^legacy/.*$"
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-added-large-files
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.8
+    hooks:
+      - id: ruff-check
+        args: [--fix, --exit-zero]
+      - id: ruff-format

rattle_lint-1.0.1/.pre-commit-hooks.yaml

@@ -0,0 +1,12 @@
+- id: rattle-lint
+  name: Rattle - lint
+  description: This hook shows Rattle lints and suggested changes without applying autofixes.
+  entry: rattle lint --diff
+  language: python
+  types: [python]
+- id: rattle-fix
+  name: Rattle - lint and apply autofixes
+  description: This hook shows Rattle lints and applies suggested changes.
+  entry: rattle fix --automatic
+  language: python
+  types: [python]

rattle_lint-1.0.1/.readthedocs.yml

@@ -0,0 +1,13 @@
+version: 2
+sphinx:
+  configuration: docs/conf.py
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

rattle_lint-1.0.1/CONTRIBUTING.md

@@ -0,0 +1,144 @@
+# Contributing to Rattle
+
+## Setup
+
+Rattle requires Python 3.10 or newer. We recommend using [uv][] to install Python:
+
+```shell-session
+$ uv python install 3.13
+
+$ uv python pin 3.13
+```
+
+You can then sync a local development environment with `just`:
+
+```shell-session
+$ just sync
+```
+
+This installs all project extras into `.venv` and sets up the local
+`pre-commit` hooks. Once created, activate the environment:
+
+```shell-session
+$ source .venv/bin/activate
+
+(rattle) $
+```
+
+## Developing
+
+Once activated, Rattle can be run locally:
+
+```shell-session
+(rattle) $ rattle [args]
+```
+
+To run the test suite, type checker, and linters:
+
+```shell-session
+$ just test
+
+$ just lint
+
+$ just typecheck
+```
+
+To format code, sort imports, and apply automatic lint fixes:
+
+```shell-session
+$ just fix
+
+$ just format
+```
+
+Documentation is built using sphinx. You can generate and view the documentation
+locally in your browser:
+
+```shell-session
+$ just docs
+
+$ open html/index.html
+```
+
+To run the full test, lint, typecheck, spell-check, and header-check suite:
+
+```shell-session
+$ just check
+```
+
+
+## Submitting PRs
+
+Before submitting PRs, please address the following items:
+
+- Add tests exercising any fixed bugs or new functionality
+- Document any changes to configuration or behavior
+- Apply formatting, regenerate documentation, and run the test suite (see above)
+- Summarize the high level features or behavior changes in your commit message
+
+For most developers, we recommend using the [github cli][gh] to submit pull
+requests:
+
+```shell-session
+$ gh pr create
+```
+
+## Code style
+
+You can ensure your changes are well formatted, and imports are sorted:
+
+```shell-session
+$ just format
+```
+
+If you are using VS Code as your editor, enable Ruff for formatting and linting
+to match the project workflow.
+
+
+## VS Code
+
+Make sure you've created an environment for Rattle:
+
+```shell-session
+$ just sync
+```
+
+Now, the VS Code Python module should be able to find and offer the local
+`.venv` path as an option for your active Python environment, and should then
+be aware of what libraries are available, and enable "Go To Definition" for
+those packages.
+
+
+## git-branchless
+
+[git-branchless](https://github.com/arxanas/git-branchless) is a useful tool
+for improving your local git CLI workflow, especially within a stack of commits.
+It provides a "smartlog" command (`git sl`) to help visual the hierarchy of
+commits and branches in your checkout, as well as `next`/`prev` commands to
+make moving through your stacks even easier:
+
+```shell-session
+amethyst@luxray ~/workspace/Rattle docs  » git sl
+⋮
+◇ a80603c 226d (0.x) Update 'master' (branch) references to 'main' (#220)
+⋮
+◆ c3f8ff9 52d (main, ᐅ docs) Include scripts dir in linters
+┃
+◯ 33863f4 52d (local-rules) Simple example of local rule for copyright headers
+```
+
+git-branchless is a Rust package, and can be installed with cargo:
+
+```shell-session
+$ cargo install --locked git-branchless
+```
+
+Once installed to your system, it must be enabled on each git repo that you
+want to use it with, so that it can install hooks and new commands:
+
+```shell-session
+$ git branchless init
+```
+
+[gh]: https://cli.github.com/
+[uv]: https://docs.astral.sh/uv/

rattle_lint-1.0.1/Justfile

@@ -0,0 +1,90 @@
+@_:
+  just --list
+
+_require-uv:
+  @uv --version > /dev/null || (echo "Please install uv: https://docs.astral.sh/uv/" && exit 1)
+
+# install all project extras into the local environment
+install: _require-uv
+  uv sync --inexact --all-extras
+
+# install the dev and lsp extras used for local testing and CI
+install-dev: _require-uv
+  uv sync --inexact --extra dev --extra lsp
+
+# install only the docs extras used for documentation builds
+install-docs: _require-uv
+  uv sync --inexact --extra docs
+
+# create or refresh the local virtual environment
+venv: install
+  @echo 'run `source .venv/bin/activate` to activate virtualenv'
+
+# check code style and potential issues
+lint: _require-uv
+  uv run --extra dev ruff check src/rattle scripts examples docs/conf.py
+  uv run --extra dev ruff format --check src/rattle scripts examples docs/conf.py
+  uv run --extra dev python -m rattle lint src/rattle
+
+# format code
+format: _require-uv
+  uv run --extra dev ruff format src/rattle scripts examples docs/conf.py
+
+# fix automatically fixable linting issues
+fix: _require-uv
+  uv run --extra dev ruff check --fix src/rattle scripts examples docs/conf.py
+
+# run the pytest suite
+test: _require-uv
+  uv run --extra dev --extra lsp pytest
+
+# build the package
+build: _require-uv
+  uv build
+
+# setup or update local dev environment and install pre-commit hooks
+sync: install
+  uv run --all-extras pre-commit install
+
+# run tests with coverage and show a coverage report
+coverage: _require-uv
+  uv run --extra dev --extra lsp coverage run -m pytest
+  uv run --extra dev coverage report
+
+# build the docs and regenerate the builtins page
+docs: _require-uv
+  uv run --extra docs python scripts/document_rules.py
+  uv run --extra docs sphinx-build -ab html docs html
+
+# check source headers
+headers: _require-uv
+  uv run --extra dev python scripts/check_copyright.py
+
+# clean build artifacts and caches
+clean:
+  rm -rf .venv .pytest_cache .ruff_cache build dist html htmlcov .coverage
+  find . -type d -name "__pycache__" -exec rm -r {} +
+
+# static type check with pyright
+typecheck: _require-uv
+  uv run --extra dev pyright
+
+# check code for common misspellings
+spell: _require-uv
+  uv run --extra dev codespell
+
+# run all quality checks
+check: lint coverage typecheck spell headers
+
+# run the main local workflow
+all: install test lint docs
+
+# list available recipes
+help:
+  just --list
+
+alias fmt := format
+alias cov := coverage
+alias distclean := clean
+alias html := docs
+alias pyright := typecheck

rattle_lint-1.0.1/LICENSE

@@ -0,0 +1,76 @@
+MIT License
+
+Copyright (c) Facebook, Inc. and its affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+-------------------------------------------------------------------------------
+
+PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
+
+1. This LICENSE AGREEMENT is between the Python Software Foundation
+("PSF"), and the Individual or Organization ("Licensee") accessing and
+otherwise using this software ("Python") in source or binary form and
+its associated documentation.
+
+2. Subject to the terms and conditions of this License Agreement, PSF hereby
+grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce,
+analyze, test, perform and/or display publicly, prepare derivative works,
+distribute, and otherwise use Python alone or in any derivative version,
+provided, however, that PSF's License Agreement and PSF's notice of copyright,
+i.e., "Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
+2011, 2012, 2013, 2014, 2015 Python Software Foundation; All Rights Reserved"
+are retained in Python alone or in any derivative version prepared by Licensee.
+
+3. In the event Licensee prepares a derivative work that is based on
+or incorporates Python or any part thereof, and wants to make
+the derivative work available to others as provided herein, then
+Licensee hereby agrees to include in any such work a brief summary of
+the changes made to Python.
+
+4. PSF is making Python available to Licensee on an "AS IS"
+basis.  PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
+IMPLIED.  BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND
+DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON WILL NOT
+INFRINGE ANY THIRD PARTY RIGHTS.
+
+5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
+FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
+A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON,
+OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
+
+6. This License Agreement will automatically terminate upon a material
+breach of its terms and conditions.
+
+7. Nothing in this License Agreement shall be deemed to create any
+relationship of agency, partnership, or joint venture between PSF and
+Licensee.  This License Agreement does not grant permission to use PSF
+trademarks or trade name in a trademark sense to endorse or promote
+products or services of Licensee, or any third party.
+
+8. By copying, installing or otherwise using Python, Licensee
+agrees to be bound by the terms and conditions of this License
+Agreement.
+
+-------------------------------------------------------------------------------
+
+APACHE LICENSE, VERSION 2.0
+
+http://www.apache.org/licenses/LICENSE-2.0

rattle_lint-1.0.1/PKG-INFO

@@ -0,0 +1,190 @@
+Metadata-Version: 2.4
+Name: rattle-lint
+Version: 1.0.1
+Summary: A lint framework that helps you write better Python code.
+Project-URL: Home, https://github.com/zigai/rattle
+Project-URL: Issues, https://github.com/zigai/rattle/issues
+Author: zigai
+License: MIT License
+        
+        Copyright (c) Facebook, Inc. and its affiliates.
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+        -------------------------------------------------------------------------------
+        
+        PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
+        
+        1. This LICENSE AGREEMENT is between the Python Software Foundation
+        ("PSF"), and the Individual or Organization ("Licensee") accessing and
+        otherwise using this software ("Python") in source or binary form and
+        its associated documentation.
+        
+        2. Subject to the terms and conditions of this License Agreement, PSF hereby
+        grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce,
+        analyze, test, perform and/or display publicly, prepare derivative works,
+        distribute, and otherwise use Python alone or in any derivative version,
+        provided, however, that PSF's License Agreement and PSF's notice of copyright,
+        i.e., "Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
+        2011, 2012, 2013, 2014, 2015 Python Software Foundation; All Rights Reserved"
+        are retained in Python alone or in any derivative version prepared by Licensee.
+        
+        3. In the event Licensee prepares a derivative work that is based on
+        or incorporates Python or any part thereof, and wants to make
+        the derivative work available to others as provided herein, then
+        Licensee hereby agrees to include in any such work a brief summary of
+        the changes made to Python.
+        
+        4. PSF is making Python available to Licensee on an "AS IS"
+        basis.  PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
+        IMPLIED.  BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND
+        DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
+        FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON WILL NOT
+        INFRINGE ANY THIRD PARTY RIGHTS.
+        
+        5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
+        FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
+        A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON,
+        OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
+        
+        6. This License Agreement will automatically terminate upon a material
+        breach of its terms and conditions.
+        
+        7. Nothing in this License Agreement shall be deemed to create any
+        relationship of agency, partnership, or joint venture between PSF and
+        Licensee.  This License Agreement does not grant permission to use PSF
+        trademarks or trade name in a trademark sense to endorse or promote
+        products or services of Licensee, or any third party.
+        
+        8. By copying, installing or otherwise using Python, Licensee
+        agrees to be bound by the terms and conditions of this License
+        Agreement.
+        
+        -------------------------------------------------------------------------------
+        
+        APACHE LICENSE, VERSION 2.0
+        
+        http://www.apache.org/licenses/LICENSE-2.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.10
+Requires-Dist: click<8.2,>=8.0
+Requires-Dist: libcst>=0.3.18
+Requires-Dist: moreorless>=0.4.0
+Requires-Dist: packaging>=21
+Requires-Dist: tomli>=2.0; python_version < '3.11'
+Requires-Dist: trailrunner>=1.2
+Provides-Extra: dev
+Requires-Dist: attribution==1.8.0; extra == 'dev'
+Requires-Dist: black==25.11.0; extra == 'dev'
+Requires-Dist: build>1; extra == 'dev'
+Requires-Dist: codespell; extra == 'dev'
+Requires-Dist: coverage; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pyright; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: ruff==0.15.8; extra == 'dev'
+Requires-Dist: tomli; extra == 'dev'
+Requires-Dist: ufmt==2.8.0; extra == 'dev'
+Requires-Dist: usort==1.0.8.post1; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: jinja2==3.1.6; extra == 'docs'
+Requires-Dist: myst-parser==4.0.1; extra == 'docs'
+Requires-Dist: sphinx==8.0.2; extra == 'docs'
+Provides-Extra: lsp
+Requires-Dist: pygls[ws]~=2.0.0; extra == 'lsp'
+Provides-Extra: pretty
+Requires-Dist: rich>=12.6.0; extra == 'pretty'
+Description-Content-Type: text/markdown
+
+# Rattle
+
+Rattle is a Python linting framework built on [LibCST](https://libcst.readthedocs.io) with support for autofixes, custom in-repo lint rules, and hierarchical configuration.
+
+Rattle is a fork of [Fixit](https://github.com/Instagram/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:
+
+```bash
+pip install rattle-lint
+```
+
+Install editor/LSP support too:
+
+```bash
+pip install "rattle-lint[lsp]"
+```
+
+## Basic Usage
+
+
+```bash
+rattle lint
+```
+
+Apply available autofixes:
+
+```bash
+rattle fix
+```
+
+## Example Configuration
+
+
+```toml
+[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