Added pylint formatter by damienallen · Pull Request #1995 · astral-sh/ruff

damienallen · 2023-01-19T11:33:04Z

Fixes: #1953

@charliermarsh thank you for the tips in the issue.

I'm not very familiar with Rust, so please excuse if my string formatting syntax is messy.

In terms of testing, I compared output of flake8 --format=pylint and cargo run --format=pylint on the same code and the output syntax seems to check out.

README.md

Co-authored-by: messense <[email protected]>

charliermarsh · 2023-01-19T13:01:33Z

Looks great, thank you for putting this together!

charliermarsh · 2023-01-19T13:02:18Z

README.md

-(GitLab CI code quality report).
+(machine-readable), `"junit"` (machine-readable XML), `"github"` (GitHub
+Actions annotations), `"gitlab"` (GitLab CI code quality report), or
+`"pylint"` (Pylint text format).


Just for the future: all these references are auto-generated from the documentation, so this needed to be changed in src/settings/options.rs (followed by an invocation of cargo dev generate-all).

Ah, good to know!

charliermarsh · 2023-01-19T13:02:31Z

ruff_cli/src/printer.rs

+                // See: https://flake8.pycqa.org/en/latest/internal/formatters.html#pylint-formatter
+                for message in &diagnostics.messages {
+                    let label = format!(
+                        "{}:{}: [{}] {}",


Tweaked this to put some of the plain-text characters in the format string directly.

I was unsure about this but this is more what I would expect.

damienallen · 2023-01-19T14:15:08Z

Looks great, thank you for putting this together!

Cheers, thanks for the merge!

Summary -- This is a very simple output format, the only decision is what to do if the file is missing from the diagnostic. For now, I opted to `unwrap_or_default` both the path and the `OneIndexed` row number, giving `:1: main diagnostic message` in the test without a file. Another quirk here is that the path is relativized. I just pasted in the `relativize_path` and `get_cwd` implementations from `ruff_linter::fs` for now, but maybe there's a better place for them. I didn't see any details about why this needs to be relativized in the original [issue](#1953), [PR](#1995), or in the pylint [docs](https://flake8.pycqa.org/en/latest/internal/formatters.html#pylint-formatter), but it did change the results of the CLI integration test when I tried deleting it. I haven't been able to reproduce that in the CLI, though, so it may only happen with `Command::current_dir`. Test Plan -- Tests ported from `ruff_linter` and a new test for the case with no file

Summary -- This is a very simple output format, the only decision is what to do if the file is missing from the diagnostic. For now, I opted to `unwrap_or_default` both the path and the `OneIndexed` row number, giving `:1: main diagnostic message` in the test without a file. Another quirk here is that the path is relativized. I just pasted in the `relativize_path` and `get_cwd` implementations from `ruff_linter::fs` for now, but maybe there's a better place for them. I didn't see any details about why this needs to be relativized in the original [issue](#1953), [PR](#1995), or in the pylint [docs](https://flake8.pycqa.org/en/latest/internal/formatters.html#pylint-formatter), but it did change the results of the CLI integration test when I tried deleting it. I haven't been able to reproduce that in the CLI, though, so it may only happen with `Command::current_dir`. Test Plan -- Tests ported from `ruff_linter` and a new test for the case with no file --------- Co-authored-by: Micha Reiser <[email protected]>

Added pylint formatter

93dc8e6

messense reviewed Jan 19, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

charliermarsh and others added 3 commits January 19, 2023 07:40

Update README.md

5c13127

Co-authored-by: messense <[email protected]>

Change source

41bc07e

Move some pieces into format string

80389ec

charliermarsh merged commit 6ddfe50 into astral-sh:main Jan 19, 2023

charliermarsh reviewed Jan 19, 2023

View reviewed changes

ntBre mentioned this pull request Jul 14, 2025

Move Pylint rendering to ruff_db #19340

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

Added pylint formatter#1995

Added pylint formatter#1995
charliermarsh merged 4 commits intoastral-sh:mainfrom
damienallen:pylint-format

damienallen commented Jan 19, 2023

Uh oh!

Uh oh!

charliermarsh commented Jan 19, 2023

Uh oh!

charliermarsh Jan 19, 2023

Uh oh!

damienallen Jan 19, 2023

Uh oh!

charliermarsh Jan 19, 2023

Uh oh!

damienallen Jan 19, 2023

Uh oh!

damienallen commented Jan 19, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

Conversation

damienallen commented Jan 19, 2023

Uh oh!

Uh oh!

charliermarsh commented Jan 19, 2023

Uh oh!

charliermarsh Jan 19, 2023

Choose a reason for hiding this comment

Uh oh!

damienallen Jan 19, 2023

Choose a reason for hiding this comment

Uh oh!

charliermarsh Jan 19, 2023

Choose a reason for hiding this comment

Uh oh!

damienallen Jan 19, 2023

Choose a reason for hiding this comment

Uh oh!

damienallen commented Jan 19, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants