Is Ruff compatible with Black?#
Yes. Ruff is compatible with Black out-of-the-box, as long as
line-length setting is consistent between the two.
As a project, Ruff is designed to be used alongside Black and, as such, will defer implementing stylistic lint rules that are obviated by autoformatting.
Note that Ruff and Black treat line-length enforcement a little differently. Black makes a
best-effort attempt to adhere to the
line-length, but avoids automatic line-wrapping in some cases
(e.g., within comments). Ruff, on the other hand, will flag rule
E501 for any line that exceeds
line-length setting. As such, if
E501 is enabled, Ruff can still trigger line-length
violations even when Black is enabled.
How does Ruff compare to Flake8?#
(Coming from Flake8? Try
automatically convert your existing configuration.)
Ruff can be used as a drop-in replacement for Flake8 when used (1) without or with a small number of plugins, (2) alongside Black, and (3) on Python 3 code.
Under those conditions, Ruff implements every rule in Flake8. In practice, that means Ruff
implements all of the
F rules (which originate from Pyflakes), along with a subset of the
W rules (which originate from pycodestyle).
Ruff also re-implements some of the most popular Flake8 plugins and related code quality tools natively, including:
- flake8-bandit (#1646)
- flynt (#2102)
Note that, in some cases, Ruff uses different rule codes and prefixes than would be found in the
originating Flake8 plugins. For example, Ruff uses
TID252 to represent the
I252 rule from
flake8-tidy-imports. This helps minimize conflicts across plugins and allows any individual plugin
to be toggled on or off with a single (e.g.)
--select TID, as opposed to
--select I2 (to avoid
conflicts with the isort rules, like
Beyond the rule set, Ruff's primary limitation vis-à-vis Flake8 is that it does not support custom lint rules. (Instead, popular Flake8 plugins are re-implemented in Rust as part of Ruff itself.)
There are a few other minor incompatibilities between Ruff and the originating Flake8 plugins:
- Ruff doesn't implement all the "opinionated" lint rules from flake8-bugbear.
- Depending on your project structure, Ruff and isort can differ in their detection of first-party
code. (This is often solved by modifying the
srcproperty, e.g., to
src = ["src"], if your code is nested in a
How does Ruff compare to Pylint?#
At time of writing, Pylint implements ~409 total rules, while Ruff implements 440, of which at least 89 overlap with the Pylint rule set (you can find the mapping in #970).
Pylint implements many rules that Ruff does not, and vice versa. For example, Pylint does more type inference than Ruff (e.g., Pylint can validate the number of arguments in a function call). As such, Ruff is not a "pure" drop-in replacement for Pylint (and vice versa), as they enforce different sets of rules.
Despite these differences, many users have successfully switched from Pylint to Ruff, especially those using Ruff alongside a type checker, which can cover some of the functionality that Pylint provides.
Like Flake8, Pylint supports plugins (called "checkers"), while Ruff implements all rules natively. Unlike Pylint, Ruff is capable of automatically fixing its own lint violations.
Pylint parity is being tracked in #970.
How does Ruff compare to Mypy, or Pyright, or Pyre?#
Ruff is a linter, not a type checker. It can detect some of the same problems that a type checker can, but a type checker will catch certain errors that Ruff would miss. The opposite is also true: Ruff will catch certain errors that a type checker would typically ignore.
For example, unlike a type checker, Ruff will notify you if an import is unused, by looking for references to that import in the source code; on the other hand, a type checker could flag that you passed an integer argument to a function that expects a string, which Ruff would miss. The tools are complementary.
It's recommended that you use Ruff in conjunction with a type checker, like Mypy, Pyright, or Pyre, with Ruff providing faster feedback on lint violations and the type checker providing more detailed feedback on type errors.
Which tools does Ruff replace?#
Today, Ruff can be used to replace Flake8 when used with any of the following plugins:
- flake8-bandit (#1646)
- flynt (#2102)
Ruff can also replace isort, yesqa, eradicate, and most of the rules implemented in pyupgrade.
If you're looking to use Ruff, but rely on an unsupported Flake8 plugin, feel free to file an issue.
What versions of Python does Ruff support?#
Ruff can lint code for any Python version from 3.7 onwards, including Python 3.10 and 3.11.
Ruff does not support Python 2. Ruff may run on pre-Python 3.7 code, although such versions are not officially supported (e.g., Ruff does not respect type comments).
Ruff is installable under any Python version from 3.7 onwards.
Do I need to install Rust to use Ruff?#
Nope! Ruff is available as
ruff on PyPI:
Ruff ships with wheels for all major platforms, which enables
pip to install Ruff without relying
on Rust at all.
Can I write my own plugins for Ruff?#
Ruff does not yet support third-party plugins, though a plugin system is within-scope for the project. See #283 for more.
How does Ruff's import sorting compare to isort?#
Ruff's import sorting is intended to be near-equivalent to isort's when using isort's
profile = "black".
There are a few known differences in how Ruff and isort treat aliased imports, and in how Ruff and isort treat inline comments in some cases (see: #1381, #2104).
For example, Ruff tends to group non-aliased imports from the same module:
from numpy import cos, int8, int16, int32, int64, tan, uint8, uint16, uint32, uint64 from numpy import sin as np_sin
Whereas isort splits them into separate import statements at each aliased boundary:
from numpy import cos, int8, int16, int32, int64 from numpy import sin as np_sin from numpy import tan, uint8, uint16, uint32, uint64
Like isort, Ruff's import sorting is compatible with Black.
Ruff does not yet support all of isort's configuration options, though it does support many of
them. You can find the supported settings in the API reference.
For example, you can set
known-first-party like so:
[tool.ruff] select = [ # Pyflakes "F", # Pycodestyle "E", "W", # isort "I001" ] # Note: Ruff supports a top-level `src` option in lieu of isort's `src_paths` setting. src = ["src", "tests"] [tool.ruff.isort] known-first-party = ["my_module1", "my_module2"]
Does Ruff support Jupyter Notebooks?#
Ruff is integrated into nbQA, a tool for running linters and code formatters over Jupyter Notebooks.
nbqa, you can run Ruff over a notebook like so:
> nbqa ruff Untitled.ipynb Untitled.ipynb:cell_1:2:5: F841 Local variable `x` is assigned to but never used Untitled.ipynb:cell_2:1:1: E402 Module level import not at top of file Untitled.ipynb:cell_2:1:8: F401 `os` imported but unused Found 3 errors. 1 potentially fixable with the --fix option.
Does Ruff support NumPy- or Google-style docstrings?#
Yes! To enforce a docstring convention, add the following to your
For example, if you're coming from flake8-docstrings, and your originating configuration uses
--docstring-convention=numpy, you'd instead set
convention = "numpy" in your
convention, you'll want to explicitly enable the
D rule code prefix, since the
rules are not enabled by default:
convention force-disables any rules that are incompatible with that convention, no
matter how they're provided, which avoids accidental incompatibilities and simplifies configuration.
By default, no
convention is set, and so the enabled rules are determined by the
How can I tell what settings Ruff is using to check my code?#
ruff check /path/to/code.py --show-settings to view the resolved settings for a given file.
I want to use Ruff, but I don't want to use
pyproject.toml. Is that possible?#
Yes! In lieu of a
pyproject.toml file, you can use a
ruff.toml file for configuration. The two
files are functionally equivalent and have an identical schema, with the exception that a
file can omit the
[tool.ruff] section header.
For example, given this
You could instead use a
ruff.toml file like so:
Ruff doesn't currently support INI files, like
How can I change Ruff's default configuration?#
When no configuration file is found, Ruff will look for a user-specific
ruff.toml file as a last resort. This behavior is similar to Flake8's
On macOS, Ruff expects that file to be located at
On Linux, Ruff expects that file to be located at
On Windows, Ruff expects that file to be located at
For more, see the
Ruff tried to fix something — but it broke my code?#
Ruff's autofix is a best-effort mechanism. Given the dynamic nature of Python, it's difficult to have complete certainty when making changes to code, even for the seemingly trivial fixes.
In the future, Ruff will support enabling autofix behavior based on the safety of the patch.
In the meantime, if you find that the autofix is too aggressive, you can disable it on a per-rule or
per-category basis using the
For example, to disable autofix for some possibly-unsafe rules, you could add the following to your
If you find a case where Ruff's autofix breaks your code, please file an Issue!
How can I disable Ruff's color output?#
Ruff's color output is powered by the
colored crate, which
attempts to automatically detect whether the output stream supports color. However, you can force
colors off by setting the
NO_COLOR environment variable to any value (e.g.,
colored also supports the
environment variables (see the spec).