Implement Pylint #970

charliermarsh · 2022-11-30T04:52:53Z

This is the parent issue for tracking parity with Pylint. Below, we've enumerated all Pylint rules.

Rules that are checked off have been implemented in Ruff already (either as a Pylint rule, e.g., PLE0237, or by way of overlap with another linter like Pyflakes, as with missing-format-string-key).

Rules that are crossed out have been removed some consideration. (In most cases, crossed-out rules represent Pylint specific rules, e.g., rules related to Pylint configuration.)

At time of writing, many of the remaining rules require type inference and/or multi-file analysis, and aren't ready to be implemented in Ruff. (See: #970 (comment) for an enumeration.) If you're looking to start work on a specific rule, I'd suggest commenting in the issue, to get some input on whether Ruff is capable of supporting it at present.

For guidance on getting started, see the Contributing documentation.

Note: Don't implement rules that are part of Pylint extension until #1774 is completed. Don't implement rules that mainly target Python 2.

Error

Warning

Convention

Refactor

The text was updated successfully, but these errors were encountered:

charliermarsh · 2022-11-30T05:26:33Z

Need to figure out what the right "check code" approach is here. We could just start to put these under RUF. Or we could do PYE for "Pylint Error", and so on. Or we could use PYL for all of them. In either case, though, we have to allow four-digit codes, as opposed to our current three-digit codes.

JonathanPlasse · 2022-11-30T06:28:59Z

I vote for PYE as it would keep the same categories and the migration would be easier.

harupy · 2022-12-01T03:49:24Z

I'll work on unneeded-not this weekend.

relsunkaev · 2022-12-01T07:27:04Z

I would suggest PL as the pylint prefix (PLE -> PyLint Error). I think PYE might be a bit ambiguous with PYflakes, PYdocstyle, etc.

MartinBernstorff · 2022-12-01T09:33:12Z

Would absolutely love to see this happen. I know flake8 intentionally decided not to implement e.g. unexpected-keyword-arg because it required looking outside of the current file for imported functions.

I expect you've already considered this, and really hope this won't stop ruff from implementing it, but just wanted to raise it.

charliermarsh · 2022-12-01T15:22:58Z

@relsunkaev 👍 Went with PLE! The first code is checked in as PLE1142 (matching E1142 from Pylint).

charliermarsh · 2022-12-01T15:23:31Z

@MartinBernstorff - Definitely. The multi-file stuff will come, just not as quickly.

hmc-cs-mdrissi · 2022-12-08T02:41:23Z

Not sure if it should be separate issue, but looking at missing-function-docstring rule (C0116), pylint's version of it is different. It only requires that a function has docstring some in class hierarchy and does not require over-ridden methods to have a docstring. As an example,

class Foo:
  def validate(self):
    """Doc."""
    ...

class Bar(Foo):
  def validate(self):
    ...

gives no errors in pylint even though second validate is missing docstring being pylint allows inheriting one. This is very useful when implementing interface and the docstring would really be same for all things that subclass.

charliermarsh · 2023-01-05T18:53:47Z

I'd like to get pointless-statement, unnecessary-ellipsis, and unnecessary-pass in.

charliermarsh · 2023-01-05T19:20:12Z

Relevant source for defining a pointless-statement: https://github.com/PyCQA/pylint/blob/56121344f6c9c223d8e4477c0cdb58c46c840b4b/pylint/checkers/base/basic_checker.py#L447

thejcannon · 2023-01-12T16:08:49Z

A while ago I set out to find all the pylint codes make redundant by type checking.

Unfortunately that code got lost to the sands of time.

You might consider skipping those as type checking tools are very sophisticated, if you can do the effort of compiling that list

thejcannon · 2023-01-12T16:14:48Z

I've also thought very long and hard about the fact that pylint appears very sophisticated when it comes to types because it builds on astroid which works very hard to infer types based on code (pre-type-annotations)

Ideally ruff (or any modern linter) is type-aware to be as helpful as possible, but that requires either:

A Rust-implemented type checkers for Python. Short of a large company writing and maintaining this I doubt it'll keep up with the other big dogs
Having the type information be seeded to ruff. Aside from the overhead and protocol, this actually seems feasible.

dae · 2023-01-12T22:32:06Z

For what it's worth, the type awareness of pylint is the killer feature that keeps us using it in our project despite how painfully slow it is. Our first-party code is almost fully typed, and mypy is generally good at catching typing issues. We've found multiple instances where pylint caught an issue that mypy missed however - usually in third-party code with missing or incomplete type definitions, but occasionally also in our own code when mypy doesn't notice (eg due to the presence of __getattr__: python/mypy#6251).

thejcannon · 2023-01-12T22:41:02Z

Out of curiosity, have you tried pyright? It claims to have inference support for codebases that aren't fully typed.

dae · 2023-01-12T22:49:36Z

Mypy has a check_untyped_defs which sounds equivalent, and we use that. We currently rely on mypy's no_strict_optional which pyright has no equivalent to, so pyright is not currently usable on our codebase.

This PR adds [Pylint `R2004`](https://pylint.pycqa.org/en/latest/user_guide/messages/refactor/magic-value-comparison.html#magic-value-comparison-r2004) Feel free to suggest changes and additions, I have tried to maintain parity with the Pylint implementation [`magic_value.py`](https://github.com/PyCQA/pylint/blob/main/pylint/extensions/magic_value.py) See #970

diceroll123 · 2024-08-04T21:16:10Z

consider-using-from-import / R0402 can be checked off, exists already as manual_from_import

fruch · 2024-08-07T06:16:52Z

@MartinBernstorff - Definitely. The multi-file stuff will come, just not as quickly.

@charliermarsh any advancements in that direction ?
(just got bitten by not having one of those)

Hnasar · 2024-08-07T20:54:43Z

lucaspar wrote:
I ported the script of @cidrblock to run interactively without setting up a local env.

There was an error from a ~~strikethrough~~ rule in the original post — here's a patched version (uses bs4's find_all) — https://trinket.io/python3/2341d58536

As of that script's output, Ruff has implemented this much of the Pylint rules:

✅ 215 / 380 (56.58%) implemented

rhoban13 · 2024-08-08T14:14:17Z

broad-exception-caught / W0718 is checked above yet I'm not seeing it in available rules. Is that implemented?

There is a similar blind-except from flake8, but that one seems to only apply to except BaseException, not except Exception?

lucaspar · 2024-08-08T14:46:11Z

@rhoban13 BLE001 also works for except Exception:

diceroll123 · 2024-08-09T05:55:41Z

C0305 is covered by PyCodeStyle W391, implemented ~5 months ago

diceroll123 · 2024-08-09T06:16:40Z

W0311 is covered by PyCodeStyle E111

echoix · 2024-08-13T02:51:09Z

Is it possible to add bad-chained-comparison / W3601 to the tracked list?
Thanks!

R-Peleg · 2024-08-13T07:22:32Z

For me the no-member / E1101 and no-name-in-module / E0611 could be the most useful, since I do a lot of typo and failed merged that fails in long tests on that things. Is there a plan to support them? Is it reasonable to try and implement them as my first contribution to this repo, in terms of expected complexity?

dhruvmanila · 2024-08-13T07:57:21Z

I think it's difficult to implement no-member / E1101 and no-name-in-module / E0611 without type-inference and multifile analysis. These two features are currently a work in progress and will require some time. The reason being that no-member requires Ruff to have knowledge of the variable type and no-name-in-module requires Ruff to follow through the import and collect all the symbols from that module which requires analyzing multiple files at once (currently, Ruff only analyzes one file at a time).

serjflint · 2024-08-19T20:33:31Z

I wrote bash script to exclude ready rules via [tool.pylint].disable pyproject.toml section
curl https://api.github.com/repos/astral-sh/ruff/issues/970 | jq -r .body | grep -F '[x]' | cut -d'/' -f 2 | cut -c 3-7 | awk '{printf "\"%s\",", $1}'

I used the bash script above to make a Python script for missing rules

https://gist.github.com/serjflint/d31e64a70438ab9e13630ad05c987a11

And the current result

https://gist.github.com/serjflint/0c9d8b7c44074f2450f92b1c108117f9

For me the most frequent issue is superfluous-parens / C0325.

diceroll123 · 2024-08-29T05:29:48Z

superfluous-parens / C0325 is covered (EDIT: partially covered) by UP034 https://docs.astral.sh/ruff/rules/UP034

lucaspar · 2024-08-29T05:43:33Z

@diceroll123 ruff doesn't flag the pylint examples though, I don't think UP034 has the same coverage.

diceroll123 · 2024-08-29T05:45:56Z

@lucaspar Fair point!

The right move here would probably be to extend UP034's capabilities.

diceroll123 · 2024-08-29T05:49:48Z

unnecessary-ellipsis / W2301 is covered by PIE790

SonGokussj4 · 2024-09-09T11:23:27Z

Hi, just a question. I'm migrating Pylint+Flake8 checks to ruff but we have E0401 which results in pylint to

E0401: Unable to import 'ada_resource.minio' (import-error)

Do I understand this right that we can't do a full migration because of this and still have to use pylint?
The import-error / E0401 is not checked in the first post.

MichaReiser · 2024-09-09T11:29:58Z

Do I understand this right that we can't do a full migration because of this and still have to use pylint?

That's correct. Ruff doesn't support multifile analysis yet.

pcorpet · 2024-09-19T07:50:31Z

Here is the script I'm using to help us migrate our Pylint config to Ruff.
https://gist.github.com/pcorpet/e776a8e794264b818c9cc6d06c11ef15

charliermarsh added the rule Implementing or modifying a lint rule label Nov 30, 2022

charliermarsh mentioned this issue Nov 30, 2022

How does ruff compare to pylint? #689

Closed

charliermarsh mentioned this issue Nov 30, 2022

Implement await-outside-async / E1142 #972

Merged

charliermarsh added plugin Implementing a known but unsupported plugin and removed rule Implementing or modifying a lint rule labels Dec 31, 2022

sbdchd mentioned this issue Jan 2, 2023

Implement flake8-pie #1543

Closed

7 tasks

max0x53 mentioned this issue Jan 12, 2023

Implement PLR2004 (MagicValueComparison) #1828

Merged

CompRhys mentioned this issue Aug 5, 2024

Move to ruff for linting and formating? ACEsuit/mace#534

Open

qthequartermasterman mentioned this issue Aug 6, 2024

D417 does not respect decorators that change the signature by filling an argument, disagreeing with Pylint W9015 (missing-param-doc) #12705

Open

nejch mentioned this issue Aug 8, 2024

chore: switch to ruff for linting python-gitlab/python-gitlab#2949

Closed

MichaReiser added help wanted Contributions especially welcome and removed good first issue Good for newcomers labels Aug 9, 2024

rhoban13 mentioned this issue Aug 9, 2024

Document that BLE001 supports both BaseException and Exception #12788

Merged

bebound mentioned this issue Aug 15, 2024

[Feature request] Use ruff to replace flake8 and pylint Azure/azure-cli-dev-tools#462

Open

BlindChickens mentioned this issue Aug 23, 2024

Inconsistent strikethrough in pylint tracking issue (#970) #13078

Closed

dhruvmanila mentioned this issue Aug 28, 2024

Feature: Port Sonar's Python scanner checks #4935

Open

This comment was marked as resolved.

Sign in to view

Implement Pylint #970

Implement Pylint #970

Comments

charliermarsh commented Nov 30, 2022 • edited by MichaReiser Loading

Error

Warning

Convention

Refactor

charliermarsh commented Nov 30, 2022 • edited Loading

JonathanPlasse commented Nov 30, 2022

harupy commented Dec 1, 2022

relsunkaev commented Dec 1, 2022 • edited Loading

MartinBernstorff commented Dec 1, 2022

charliermarsh commented Dec 1, 2022

charliermarsh commented Dec 1, 2022

hmc-cs-mdrissi commented Dec 8, 2022

charliermarsh commented Jan 5, 2023

charliermarsh commented Jan 5, 2023

thejcannon commented Jan 12, 2023

thejcannon commented Jan 12, 2023

dae commented Jan 12, 2023 • edited Loading

thejcannon commented Jan 12, 2023

dae commented Jan 12, 2023

diceroll123 commented Aug 4, 2024

fruch commented Aug 7, 2024

Hnasar commented Aug 7, 2024

rhoban13 commented Aug 8, 2024 • edited Loading

lucaspar commented Aug 8, 2024

diceroll123 commented Aug 9, 2024

diceroll123 commented Aug 9, 2024

echoix commented Aug 13, 2024

R-Peleg commented Aug 13, 2024

dhruvmanila commented Aug 13, 2024

serjflint commented Aug 19, 2024

diceroll123 commented Aug 29, 2024 • edited Loading

lucaspar commented Aug 29, 2024

diceroll123 commented Aug 29, 2024

diceroll123 commented Aug 29, 2024

SonGokussj4 commented Sep 9, 2024

MichaReiser commented Sep 9, 2024

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

pcorpet commented Sep 19, 2024

charliermarsh commented Nov 30, 2022 •

edited by MichaReiser

Loading

charliermarsh commented Nov 30, 2022 •

edited

Loading

relsunkaev commented Dec 1, 2022 •

edited

Loading

dae commented Jan 12, 2023 •

edited

Loading

rhoban13 commented Aug 8, 2024 •

edited

Loading

diceroll123 commented Aug 29, 2024 •

edited

Loading