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

zanieb · 2024-09-25T15:16:29Z

@edreamleo we're working on type inference right now! It's a big project though :) You can follow progress with the red-knot Multi-file analysis & type inference label.

edreamleo · 2024-09-25T17:57:03Z

@zanieb Thanks for your comment! I've bookmarked red-knot.

## Summary  Related to #970. Implement [`shallow-copy-environ / W1507`](https://pylint.readthedocs.io/en/stable/user_guide/messages/warning/shallow-copy-environ.html). ## Test Plan  Unit test --------- Co-authored-by: Simon Brugman <[email protected]> Co-authored-by: Charlie Marsh <[email protected]>

bebound · 2024-11-20T08:27:42Z

Could you please add possibly-used-before-assignment / E0606 to the list?

Ref: https://pylint.pycqa.org/en/stable/user_guide/messages/error/possibly-used-before-assignment.html

MichaReiser · 2024-11-20T08:40:14Z

@bebound I don't think we can implement this rule without precise control flow analysis. We already have a similar rule in red knot, our new static analysis backend that we plan on using in ruff long-term.

bebound · 2024-11-21T04:21:08Z

@MichaReiser Thanks for the reply.

Find a minor issue in the mapping list:

- use-dict-literal / R1735 (C406)
+ use-dict-literal / R1735 (C406, C408)
- use-list-literal / R1734 (C405)
+ use-list-literal / R1734 (C408)

C408 checks dict(), list() and tuple().
C405 is unnecessary-literal-set, which converts code to set literal and is not the target of use-list-literal. Not sure if C408 is a superset of R1734.

Ref:
C405: https://docs.astral.sh/ruff/rules/unnecessary-literal-set/
C406: https://docs.astral.sh/ruff/rules/unnecessary-literal-dict/
C408: https://docs.astral.sh/ruff/rules/unnecessary-collection-call/
C411: https://docs.astral.sh/ruff/rules/unnecessary-list-call/

R1735:https://pylint.readthedocs.io/en/stable/user_guide/messages/refactor/use-dict-literal.html
R1734: https://pylint.readthedocs.io/en/stable/user_guide/messages/refactor/use-list-literal.html

This could be slightly controversial, but submitted as a DRAFT for discussion. The case for pylint deprecation: - mostly covered by ruff: what matters most in pylint is already re-implemented - pylint is SLOW, ruff is a million times faster - pre-commit / pylint is one of our longest, most expensive CI step - rules are currently scattered in different places and can conflict at times Very relevant is this link that explains what pylint features are covered or not by ruff: astral-sh/ruff#970 If we agree on the direction, the plan is to follow up and enable all the rules, apply `ruff check --fix` and `ruff check --add-no-qa` Simplify.

alexisdrakopoulos · 2024-12-03T12:53:30Z

I know that mypy deals with E1101 but we are unable to use mypy at the moment, are there any plans for implementing it in Ruff?

NeilGirdhar · 2024-12-03T19:26:11Z

You can mark off W2301. It is covered by PIE790 [*] Unnecessary ... literal.

@alexisdrakopoulos My guess is you'll have to wait for static typing to be completed. Maybe track: "Static type checking à la mypy " (don't want to link it here)

…dera#3703) ## What changes were proposed in this pull request? - Current pylint setup in Hue was linting staged changes only by checking for 3 rules. - Also pylint is comparatively slow and GPL licensed. - Switching to ruff has its own perks which are mentioned on: https://docs.astral.sh/ruff/ and it's MIT licensed. - For starters, it's waaayyy faster, can auto-fix errors and work as both linter and formatter replacing a lot of latest packages (like a all-in-one solution). - It is also supporting pylint rules which is WIP: astral-sh/ruff#970 - Currently this PR only targets the minimal transition from pylint to ruff. Iteratively, we will extend the rules to improve the Hue codebase, add its pre-commit and play around auto-fixing errors capability. This will also help in making our codebase more PEP8 compliant. #### Note - Ruff still does not support pylint's `W0311(bad-indentation)` rule which was present earlier with pylint in Hue. We will update it later when the support lands in a future release. ## How was this patch tested? - Manually in local setup.

echoix · 2024-12-27T17:08:02Z

I noticed the absence of unnecessary-negation / C0117 in the list
https://pylint.readthedocs.io/en/latest/user_guide/messages/convention/unnecessary-negation.html

InSyncWithFoo · 2024-12-27T17:41:35Z

@echoix That one seems to be the same as SIM208. The not a > b pattern is not currently reported by any rules, however.

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

ahobeost mentioned this issue Sep 30, 2024

Switch to Ruff for code quality SPF-OST/pytrnsys_gui#546

Open

Quexington mentioned this issue Sep 30, 2024

Replace pylint with ruff Chia-Network/chia-blockchain#18649

Closed

emdneto mentioned this issue Oct 13, 2024

Introducing ruff as linter and formatter (basic setup) open-telemetry/opentelemetry-python#4223

Merged

diceroll123 mentioned this issue Oct 14, 2024

new rule - enforce that loop variables are not used outside the loop #13742

Closed

Quexington mentioned this issue Oct 24, 2024

[CHIA-1553] Replace pylint with ruff Chia-Network/chia-blockchain#18759

Merged

LordAro mentioned this issue Nov 6, 2024

B018 does not detect unused tuple expressions #14131

Open

harupy mentioned this issue Nov 10, 2024

[pylint] Implement shallow-copy-environ (W1507) #14241

Merged

bebound mentioned this issue Nov 15, 2024

{Pylint} Fix superfluous-parens Azure/azure-cli#30361

Merged

jiasli mentioned this issue Nov 15, 2024

{Pylint} Fix consider-using-in Azure/azure-cli#30349

Draft

dairiki mentioned this issue Nov 18, 2024

Update to pylint 3.3 lektor/lektor#1208

Merged

bebound mentioned this issue Nov 21, 2024

{Pylint} Fix use-dict-literal Azure/azure-cli#30308

Merged

3 tasks

Hukyl mentioned this issue Nov 23, 2024

Code refactoring and speed optimizations SanGreel/telegram-data-collection#24

Merged

kaddkaka mentioned this issue Nov 28, 2024

Documentation with complete rulesets and parity information #14651

Closed

MichaReiser removed the help wanted Contributions especially welcome label Dec 2, 2024

mistercrunch mentioned this issue Dec 2, 2024

chore: deprecate pylint in favor of ruff apache/superset#31262

Merged

KotlinIsland mentioned this issue Dec 10, 2024

Saner linters data-apis/array-api-extra#58

Closed

pwschaedler mentioned this issue Dec 15, 2024

Option to enable Pylint-compatible rules? #14979

Closed

fhg-isi mentioned this issue Dec 23, 2024

Implement linting workflow fraunhofer-isi/forecast-sites#4

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement Pylint #970

Implement Pylint #970

charliermarsh commented Nov 30, 2022 •

edited by dylwil3

Loading

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

zanieb commented Sep 25, 2024

edreamleo commented Sep 25, 2024

bebound commented Nov 20, 2024

MichaReiser commented Nov 20, 2024

bebound commented Nov 21, 2024 •

edited

Loading

alexisdrakopoulos commented Dec 3, 2024

NeilGirdhar commented Dec 3, 2024 •

edited

Loading

echoix commented Dec 27, 2024

InSyncWithFoo commented Dec 27, 2024

Implement Pylint #970

Implement Pylint #970

Comments

charliermarsh commented Nov 30, 2022 • edited by dylwil3 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

zanieb commented Sep 25, 2024

edreamleo commented Sep 25, 2024

bebound commented Nov 20, 2024

MichaReiser commented Nov 20, 2024

bebound commented Nov 21, 2024 • edited Loading

alexisdrakopoulos commented Dec 3, 2024

NeilGirdhar commented Dec 3, 2024 • edited Loading

echoix commented Dec 27, 2024

InSyncWithFoo commented Dec 27, 2024

charliermarsh commented Nov 30, 2022 •

edited by dylwil3

Loading

charliermarsh commented Nov 30, 2022 •

edited

Loading

relsunkaev commented Dec 1, 2022 •

edited

Loading

dae commented Jan 12, 2023 •

edited

Loading

bebound commented Nov 21, 2024 •

edited

Loading

NeilGirdhar commented Dec 3, 2024 •

edited

Loading