Implement Pylint #970

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

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

charliermarsh · 2023-06-16T17:54:16Z

Yeah, I need to do a pass over this issue to make it more useful / actionable based on @antonagestam's excellent analysis.

tusharsadhwani · 2023-06-16T18:42:23Z

@charliermarsh while pylint and mypy lints may have significant overlap, do note that mypy can only effectively catch these problems if the given code is properly type hinted. pylint however works with zero type hints.

Using both mypy and ruff for example, can probably cover the vast majority of pylint issues, but that would only work for users that have fully type checked code.

Igetin · 2023-06-16T22:25:42Z

Mypy does infer types when the code isn’t type annotated, although not to the extent where it would output warnings like Pylint does without them.

I think that problem can be alleviated by running Mypy in strict mode, and probably disallowing dynamic typing.

tusharsadhwani · 2023-06-17T04:20:48Z

@Igetin The problem here is that any variables coming from function parameters will never be inferred or checked, for example. all mypy will say is that "the type is not known". mypy without type hints is really not that useful.

tjkuson · 2023-06-19T15:59:47Z

Rules

no-else-break / R1723,
no-else-continue / R1724,
no-else-raise / R1720,
and no-else-return / R1705

are all implemented as RET508, RET507, RET506, RET505 respectively.

…string-slots` (`PLC0205`) (#5399) ## Summary Implement Pylint rule `single-string-used-for-slots` (`C0205`) as `single-string-slots` (`PLC0205`). This rule checks for single strings being assigned to `__slots__`. For example ```python class Foo: __slots__: str = "bar" def __init__(self, bar: str) -> None: self.bar = bar ``` should be ```python class Foo: __slots__: tuple[str, ...] = ("bar",) def __init__(self, bar: str) -> None: self.bar = bar ``` Related to #970. Includes documentation. ## Test Plan `cargo test`

## Summary Completes the documentation for the `flake8-logging-format` rules. Related to #2646. I included both the `flake8-logging-format` recommendation to use the `extra` keyword and the Pylint recommendation to pass format values as parameters so that formatting is done lazily, as #970 suggests the Pylint logging rules are covered by this ruleset. Using lazy formatting via parameters is probably more common than avoiding formatting entirely in favour of the `extra` argument, regardless. ## Test Plan `python scripts/check_docs_formatted.py`

## Summary Implement Pylint `typevar-name-mismatch` (`C0132`) as `type-param-name-mismatch` (`PLC0132`). Includes documentation. Related to #970. The Pylint implementation checks only `TypeVar`, but this PR checks `TypeVarTuple`, `ParamSpec`, and `NewType` as well. This seems to better represent the Pylint rule's [intended behaviour](pylint-dev/pylint#5224). Full disclosure: I am not a fan of the translated name and think it should probably be different. ## Test Plan `cargo test`

## Summary Implement Pylint `typevar-double-variance` (`C0131`) as `type-bivariance` (`PLC0131`). Includes documentation. Related to #970. Renamed the rule to be more clear (it's not immediately obvious what 'double' means, IMO). The Pylint implementation checks only `TypeVar`, but this PR checks `ParamSpec` as well. ## Test Plan Added tests. `cargo test`

Based on <astral-sh/ruff#970> there are still some missing pylint rules so it doesn't seem like we're ready to get rid of pylint yet, but having ruff check them first will help fail faster and prepare us for the eventual day we can drop it entirely.

…`) (#5651) ## Summary Implement Pylint `typevar-name-incorrect-variance` (`C0105`) as `type-name-incorrect-variance` (`PLC0105`). Includes documentation. Related to #970. The Pylint implementation checks only `TypeVar`, but this PR checks `ParamSpec` as well. ## Test Plan Added test fixture. `cargo test`

## Summary Implement Pylint rule [`consider-using-in` (`R1714`)](https://pylint.pycqa.org/en/latest/user_guide/messages/refactor/consider-using-in.html) as `repeated-equality-comparison-target` (`PLR1714`). This rule checks for expressions that can be re-written as a membership test for better readability and performance. For example, ```python foo == "bar" or foo == "baz" or foo == "qux" ``` should be rewritten as ```python foo in {"bar", "baz", "qux"} ``` Related to #970. Includes documentation. ### Implementation quirks The implementation does not work with Yoda conditions (e.g., `"a" == foo` instead of `foo == "a"`). The Pylint version does. I couldn't find a way of supporting Yoda-style conditions without it being inefficient, so didn't (I don't think people write Yoda conditions any way). ## Test Plan Added fixture. `cargo test`

tjkuson · 2023-07-13T12:59:08Z

broad-exception-raised (W0719) has been implemented as raise-vanilla-class (TRY002)

## Summary Implement Pylint rule [`consider-using-in` (`R1714`)](https://pylint.pycqa.org/en/latest/user_guide/messages/refactor/consider-using-in.html) as `repeated-equality-comparison-target` (`PLR1714`). This rule checks for expressions that can be re-written as a membership test for better readability and performance. For example, ```python foo == "bar" or foo == "baz" or foo == "qux" ``` should be rewritten as ```python foo in {"bar", "baz", "qux"} ``` Related to #970. Includes documentation. ### Implementation quirks The implementation does not work with Yoda conditions (e.g., `"a" == foo` instead of `foo == "a"`). The Pylint version does. I couldn't find a way of supporting Yoda-style conditions without it being inefficient, so didn't (I don't think people write Yoda conditions any way). ## Test Plan Added fixture. `cargo test`

Implement empty-comment https://pylint.pycqa.org/en/latest/user_guide/messages/refactor/empty-comment.html Issue astral-sh#970

charliermarsh added the rule Implementing or modifying a known 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 known 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

ashanbrown mentioned this issue Jun 19, 2023

Implement pylint import-outside-toplevel rule (C0415) #5180

Open

tjkuson mentioned this issue Jun 19, 2023

Implement Pylint consider-using-in #5193

Merged

tjkuson mentioned this issue Jun 27, 2023

Implement Pylint single-string-used-for-slots (C0205) as single-string-slots (PLC0205) #5399

Merged

tjkuson mentioned this issue Jun 28, 2023

Add documentation to flake8-logging-format rules #5417

Merged

tjkuson mentioned this issue Jul 4, 2023

[pylint] Implement Pylint typevar-name-mismatch (C0132) #5501

Merged

allisonkarlitskaya mentioned this issue Jul 4, 2023

python bridge: rewrite packages.py cockpit-project/cockpit#19065

Merged

tjkuson mentioned this issue Jul 4, 2023

[pylint] Implement Pylint typevar-double-variance (C0131) #5517

Merged

tjkuson mentioned this issue Jul 10, 2023

[pylint] Implement Pylint typevar-name-incorrect-variance (C0105) #5651

Merged

silvanocerza mentioned this issue Jul 11, 2023

[pylint] Implement Pylint abstract-class-instantiated (E0110) #5685

Draft

wakamex mentioned this issue Jul 18, 2023

lint docstrings delvtech/elf-simulations#500

Draft

jelly added a commit to jelly/ruff that referenced this issue Jul 19, 2023

Implement pylint's empty-comment rule (PLR2044)

f7ed9f4

Implement empty-comment https://pylint.pycqa.org/en/latest/user_guide/messages/refactor/empty-comment.html Issue astral-sh#970

jelly mentioned this issue Jul 19, 2023

Implement pylint's empty-comment rule (PLR2044) #5900

Draft

jelly added a commit to jelly/ruff that referenced this issue Jul 19, 2023

Implement pylint's empty-comment rule (PLR2044)

529dd8b

Implement empty-comment https://pylint.pycqa.org/en/latest/user_guide/messages/refactor/empty-comment.html Issue astral-sh#970

jelly added a commit to jelly/ruff that referenced this issue Jul 19, 2023

Implement pylint's empty-comment rule (PLR2044)

33dbc71

Implement empty-comment https://pylint.pycqa.org/en/latest/user_guide/messages/refactor/empty-comment.html Issue astral-sh#970

Implement Pylint #970

Implement Pylint #970

charliermarsh commented Nov 30, 2022 •

edited

charliermarsh commented Nov 30, 2022 •

edited

JonathanPlasse commented Nov 30, 2022

harupy commented Dec 1, 2022

relsunkaev commented Dec 1, 2022 •

edited

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

thejcannon commented Jan 12, 2023

dae commented Jan 12, 2023

charliermarsh commented Jun 16, 2023

tusharsadhwani commented Jun 16, 2023

Igetin commented Jun 16, 2023

tusharsadhwani commented Jun 17, 2023 •

edited

tjkuson commented Jun 19, 2023

tjkuson commented Jul 13, 2023

Implement Pylint #970

Implement Pylint #970

Comments

charliermarsh commented Nov 30, 2022 • edited

Error

Warning

Convention

Refactor

charliermarsh commented Nov 30, 2022 • edited

JonathanPlasse commented Nov 30, 2022

harupy commented Dec 1, 2022

relsunkaev commented Dec 1, 2022 • edited

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

thejcannon commented Jan 12, 2023

dae commented Jan 12, 2023

charliermarsh commented Jun 16, 2023

tusharsadhwani commented Jun 16, 2023

Igetin commented Jun 16, 2023

tusharsadhwani commented Jun 17, 2023 • edited

tjkuson commented Jun 19, 2023

tjkuson commented Jul 13, 2023

charliermarsh commented Nov 30, 2022 •

edited

charliermarsh commented Nov 30, 2022 •

edited

relsunkaev commented Dec 1, 2022 •

edited

dae commented Jan 12, 2023 •

edited

tusharsadhwani commented Jun 17, 2023 •

edited