Lintrunner Adapters

0.13.0 · active · verified Sun Apr 12

Lintrunner Adapters provides a collection of wrappers and tools that integrate various linters (like Black, Ruff, Pylint, Bandit, etc.) with the `lintrunner` framework. It enables unified linting across a project using a single configuration. The current version is 0.13.0, and releases are frequent, primarily adding new linter adapters or fixing issues with existing ones.

Warnings

gotcha The `lintrunner-adapters` library itself does not install the underlying linters (e.g., `ruff`, `black`, `pylint`). You must explicitly install each linter that you intend to use via its respective adapter.
Fix: Ensure all linters referenced in your `lintrunner.toml` are installed in your environment (e.g., `pip install ruff black pylint`).
gotcha Breaking changes in underlying linters (e.g., `ruff`, `black`) can cause adapters to behave unexpectedly or fail. `lintrunner-adapters` updates are typically released to maintain compatibility with new linter versions.
Fix: Keep `lintrunner-adapters` updated to the latest version to ensure compatibility with recent linter releases. Check release notes for specific compatibility information.
breaking The `PylintLinter` adapter changed its behavior to raise an error when Pylint fails, instead of failing silently. Scripts or CI pipelines that relied on silent failures might break.
Fix: Update any scripts or CI configurations that use the `PylintLinter` to handle explicit errors rather than assuming silent failure. Inspect Pylint output for issues.
gotcha This library requires Python 3.9 or newer. Running with older Python versions will result in installation or runtime errors.
Fix: Ensure your environment is using Python 3.9 or a newer version (e.g., `python3.9 -m pip install lintrunner-adapters`).

Install

pip install lintrunner-adapters Install latest version

Imports

RuffLinter
```
from lintrunner_adapters.ruff_linter import RuffLinter
```
Lintrunner adapters are typically referenced as strings in a `lintrunner.toml` configuration file (e.g., `linter_class = "lintrunner_adapters.ruff_linter:RuffLinter"`) rather than directly imported into user Python code. This `from ... import ...` demonstrates how `lintrunner` internally loads the adapter class.
BlackLinter
```
from lintrunner_adapters.black_linter import BlackLinter
```
Lintrunner adapters are typically referenced as strings in a `lintrunner.toml` configuration file (e.g., `linter_class = "lintrunner_adapters.black_linter:BlackLinter"`) rather than directly imported into user Python code. This `from ... import ...` demonstrates how `lintrunner` internally loads the adapter class.

Quickstart

This quickstart demonstrates how to configure `lintrunner` to use adapters from `lintrunner-adapters`. You define linters in a `lintrunner.toml` file, specifying the `linter_class` as a string path to the adapter. You must install `lintrunner` and the underlying linters (e.g., `ruff`, `black`) separately. The example creates a `test_file.py` and `lintrunner.toml` locally, and then provides instructions on how to execute `lintrunner` to apply the configured linters.

import os

# 1. Create a sample Python file to lint
python_code = """def foo ( x ):\n  return x+1\n"""
with open("test_file.py", "w") as f:
    f.write(python_code)

# 2. Create a lintrunner.toml configuration (simulating user setup)
# In a real project, this would be a file named `lintrunner.toml`
lintrunner_toml_content = """
[linter.ruff]
linter_class = "lintrunner_adapters.ruff_linter:RuffLinter"

[linter.black]
linter_class = "lintrunner_adapters.black_linter:BlackLinter"
args = ["--check", "--diff"]
"""
with open("lintrunner.toml", "w") as f:
    f.write(lintrunner_toml_content)

# 3. Ensure lintrunner and the linters are installed for this example to run
# In a real setup, `pip install lintrunner ruff black` would be done.
# We can't actually run lintrunner directly in this snippet, but demonstrate setup.
print("Created test_file.py and lintrunner.toml. To run, execute:")
print("pip install lintrunner ruff black")
print("lintrunner --config lintrunner.toml test_file.py")

# Clean up (optional, for standalone execution)
# os.remove("test_file.py")
# os.remove("lintrunner.toml")

view raw JSON →