No project description provided
Project description
ruff
A performance-focused, Pyflakes-inspired Python linter, written in Rust.
Features:
- Python 3.10 compatibility
- ESLint-inspired cache semantics
- TypeScript-inspired
--watch
semantics pyproject.toml
support
Installation
Available as ruff
on PyPI:
pip install ruff
Usage
To run the linter, try any of the following:
ruff path/to/code/to/check.py
# ...or...
ruff path/to/code/
# ...or...
ruff path/to/code/*.py
You can also run in --watch
mode to automatically re-run the linter on-change with, e.g.:
ruff path/to/code/ --watch
Development
ruff
is written in Rust:
cargo fmt
cargo clippy
cargo run resources/test/src
Deployment
ruff
is released for Python using maturin
:
maturin publish --skip-existing --target x86_64-apple-darwin
maturin publish --skip-existing --target aarch64-apple-darwin
Benchmarking
First, clone CPython. It's a large and diverse Python codebase, which makes it a good target for benchmarking.
git clone --branch 3.10 https://github.com/python/cpython.git resources/test/cpython
Add this pyproject.toml
to the directory:
[tool.linter]
line-length = 88
exclude = [
"Lib/ctypes/test/test_numbers.py",
"Lib/dataclasses.py",
"Lib/lib2to3/tests/data/bom.py",
"Lib/lib2to3/tests/data/crlf.py",
"Lib/lib2to3/tests/data/different_encoding.py",
"Lib/lib2to3/tests/data/false_encoding.py",
"Lib/lib2to3/tests/data/py2_test_grammar.py",
"Lib/sqlite3/test/factory.py",
"Lib/sqlite3/test/hooks.py",
"Lib/sqlite3/test/regression.py",
"Lib/sqlite3/test/transactions.py",
"Lib/sqlite3/test/types.py",
"Lib/test/bad_coding2.py",
"Lib/test/badsyntax_3131.py",
"Lib/test/badsyntax_pep3120.py",
"Lib/test/encoded_modules/module_iso_8859_1.py",
"Lib/test/encoded_modules/module_koi8_r.py",
"Lib/test/sortperf.py",
"Lib/test/test_email/torture_test.py",
"Lib/test/test_fstring.py",
"Lib/test/test_genericpath.py",
"Lib/test/test_getopt.py",
"Lib/test/test_grammar.py",
"Lib/test/test_htmlparser.py",
"Lib/test/test_importlib/stubs.py",
"Lib/test/test_importlib/test_files.py",
"Lib/test/test_importlib/test_metadata_api.py",
"Lib/test/test_importlib/test_open.py",
"Lib/test/test_importlib/test_util.py",
"Lib/test/test_named_expressions.py",
"Lib/test/test_patma.py",
"Lib/test/test_peg_generator/__main__.py",
"Lib/test/test_pipes.py",
"Lib/test/test_source_encoding.py",
"Lib/test/test_weakref.py",
"Lib/test/test_webbrowser.py",
"Lib/tkinter/__main__.py",
"Lib/tkinter/test/test_tkinter/test_variables.py",
"Modules/_decimal/libmpdec/literature/fnt.py",
"Modules/_decimal/tests/deccheck.py",
"Tools/c-analyzer/c_parser/parser/_delim.py",
"Tools/i18n/pygettext.py",
"Tools/test2to3/maintest.py",
"Tools/test2to3/setup.py",
"Tools/test2to3/test/test_foo.py",
"Tools/test2to3/test2to3/hello.py",
]
Next, to benchmark the release build:
cargo build --release
hyperfine --warmup 5 \
"./target/release/ruff ./resources/test/cpython/ --no-cache" \
"./target/release/ruff ./resources/test/cpython/"
Benchmark 1: ./target/release/ruff ./resources/test/cpython/ --no-cache
Time (mean ± σ): 353.6 ms ± 7.6 ms [User: 2868.8 ms, System: 171.5 ms]
Range (min … max): 344.4 ms … 367.3 ms 10 runs
Benchmark 2: ./target/release/ruff ./resources/test/cpython/
Time (mean ± σ): 59.6 ms ± 2.5 ms [User: 36.4 ms, System: 345.6 ms]
Range (min … max): 55.9 ms … 67.0 ms 48 runs
To benchmark the ecosystem's existing tools:
python -m venv .venv
source .venv/bin/activate
pip install pylint pycodestyle flake8 autoflake pyflakes
hyperfine --ignore-failure --warmup 5 \
"pycodestyle resources/test/cpython" \
"pyflakes resources/test/cpython" \
"flake8 resources/test/cpython" \
"autoflake --recursive --expand-star-imports --remove-all-unused-imports --remove-unused-variables --remove-duplicate-keys resources/test/cpython" \
"pylint --recursive=y resources/test/cpython/" \
"pycodestyle --select E501 resources/test/cpython" \
"flake8 --select=F831,F541,F634,F403,F706,F901,E501 resources/test/cpython" \
"python -m run_flake8 resources/test/cpython --select=F831,F541,F634,F403,F706,F901,E501" \
"python -m run_flake8 resources/test/cpython"
∴ hyperfine --ignore-failure --warmup 5 \
→ "pycodestyle resources/test/cpython" \
→ "pyflakes resources/test/cpython" \
→ "flake8 resources/test/cpython" \
→ "autoflake --recursive --expand-star-imports --remove-all-unused-imports --remove-unused-variables --remove-duplicate-keys resources/test/cpython" \
→ "pylint --recursive=y resources/test/cpython/" \
→ "pycodestyle --select E501 resources/test/cpython" \
→ "flake8 --select=F831,F541,F634,F403,F706,F901,E501 resources/test/cpython" \
→ "python -m run_flake8 resources/test/cpython --select=F831,F541,F634,F403,F706,F901,E501" \
→ "python -m run_flake8 resources/test/cpython"
Benchmark 1: pycodestyle resources/test/cpython
Time (mean ± σ): 41.921 s ± 1.409 s [User: 41.451 s, System: 0.194 s]
Range (min … max): 41.182 s … 45.894 s 10 runs
Warning: Ignoring non-zero exit code.
Warning: Statistical outliers were detected. Consider re-running this benchmark on a quiet PC without any interferences from other programs. It might help to use the '--warmup' or '--prepare' options.
Benchmark 2: pyflakes resources/test/cpython
Time (mean ± σ): 27.960 s ± 1.251 s [User: 27.491 s, System: 0.236 s]
Range (min … max): 26.449 s … 29.899 s 10 runs
Warning: Ignoring non-zero exit code.
Benchmark 3: flake8 resources/test/cpython
Time (mean ± σ): 75.320 s ± 0.909 s [User: 74.625 s, System: 0.610 s]
Range (min … max): 74.181 s … 77.336 s 10 runs
Warning: Ignoring non-zero exit code.
Benchmark 4: autoflake --recursive --expand-star-imports --remove-all-unused-imports --remove-unused-variables --remove-duplicate-keys resources/test/cpython
Time (mean ± σ): 32.690 s ± 0.585 s [User: 32.300 s, System: 0.296 s]
Range (min … max): 31.948 s … 33.326 s 10 runs
Warning: Ignoring non-zero exit code.
Benchmark 5: pylint --recursive=y resources/test/cpython/
Time (mean ± σ): 27.592 s ± 0.227 s [User: 26.627 s, System: 0.911 s]
Range (min … max): 27.325 s … 27.955 s 10 runs
Warning: Ignoring non-zero exit code.
Benchmark 6: pycodestyle --select E501 resources/test/cpython
Time (mean ± σ): 14.540 s ± 0.156 s [User: 14.397 s, System: 0.121 s]
Range (min … max): 14.384 s … 14.920 s 10 runs
Warning: Ignoring non-zero exit code.
Benchmark 7: flake8 --select=F831,F541,F634,F403,F706,F901,E501 resources/test/cpython
Time (mean ± σ): 75.391 s ± 0.600 s [User: 74.642 s, System: 0.591 s]
Range (min … max): 74.458 s … 76.550 s 10 runs
Warning: Ignoring non-zero exit code.
Benchmark 8: python -m run_flake8 resources/test/cpython --select=F831,F541,F634,F403,F706,F901,E501
Time (mean ± σ): 12.542 s ± 0.467 s [User: 87.891 s, System: 0.816 s]
Range (min … max): 11.771 s … 13.034 s 10 runs
Benchmark 9: python -m run_flake8 resources/test/cpython
Time (mean ± σ): 12.276 s ± 0.398 s [User: 86.720 s, System: 0.792 s]
Range (min … max): 11.809 s … 12.865 s 10 runs
Summary
'python -m run_flake8 resources/test/cpython' ran
1.02 ± 0.05 times faster than 'python -m run_flake8 resources/test/cpython --select=F831,F541,F634,F403,F706,F901,E501'
1.18 ± 0.04 times faster than 'pycodestyle --select E501 resources/test/cpython'
2.25 ± 0.08 times faster than 'pylint --recursive=y resources/test/cpython/'
2.28 ± 0.13 times faster than 'pyflakes resources/test/cpython'
2.66 ± 0.10 times faster than 'autoflake --recursive --expand-star-imports --remove-all-unused-imports --remove-unused-variables --remove-duplicate-keys resources/test/cpython'
3.41 ± 0.16 times faster than 'pycodestyle resources/test/cpython'
6.14 ± 0.21 times faster than 'flake8 resources/test/cpython'
6.14 ± 0.21 times faster than 'flake8 --select=F831,F541,F634,F403,F706,F901,E501 resources/test/cpython'
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ruff-0.0.13.tar.gz
(46.1 kB
view hashes)
Built Distributions
Close
Hashes for ruff-0.0.13-cp38-cp38-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 671b62f3fed2bdf4f583d27cdf9d22ead658888edbd09f1a26d9708e88300d5f |
|
MD5 | 9c6ca16c0257676b9cc746c76a38f72c |
|
BLAKE2b-256 | bd5f1c1eb9ce661e62e4ebdd8d17583192e8a82257588915dfb65f33167874fd |
Close
Hashes for ruff-0.0.13-cp38-cp38-macosx_10_7_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d73637262e3955ad6948d4c79317bdc1b2729054866e37405711485a7c037849 |
|
MD5 | c9a99b9843c64ecaa79bedba400fe314 |
|
BLAKE2b-256 | 93efcda0c59e6839245c741ce5cbd292a43c85f4be28005187f4f144260114cf |