Enable Ruff PLC (Pylint Convention) by Avasam · Pull Request #13306 · python/typeshed

Avasam · 2024-12-26T19:53:23Z

Ref #13295
https://docs.astral.sh/ruff/rules/#convention-c

The only stub changes are flagged by type-name-incorrect-variance (PLC0105), which enforces the _co/_contra suffix. Which we didn't consistently do. Even sometimes incorrectly suffixed.

import-private-name (PLC2701) is still in preview, so we're not affected yet, but typeshed uses many private imports in its stubs to reference types accurately. I don't think this rule applies to our stubs.
It's unclear whether Ruff should consider disabling it for stubs entirely, but it's mentioned here: astral-sh/ruff#14535

lib/ts_utils/utils.py

stdlib/typing.pyi

srittau · 2025-02-26T16:43:26Z

boltons now needs fixes as well. Can be merged when that is fixed. (Unfortunately I don't have permissions to make these changes myself.)

Avasam · 2025-03-02T04:14:31Z

pyproject.toml

-    # Most pep8-naming rules don't apply for third-party stubs like typeshed.
-    # N811 to N814 could apply, but we often use them to disambiguate a name whilst making it look like a more common one
-    "N8",
+    # Ruff 0.8.0 added sorting of __all__ and __slots_.
+    # There is no consensus on whether we want to apply this to stubs, so keeping the status quo.
+    # See https://github.com/python/typeshed/pull/13108
+    "RUF022", # `__all__` is not sorted
+    "RUF023", # `{}.__slots__` is not sorted
+    ###
    # Rules that are out of the control of stub authors:
+    ###
    "F403", # `from . import *` used; unable to detect undefined names
    # Stubs can sometimes re-export entire modules.
    # Issues with using a star-imported name will be caught by type-checkers.
    "F405", # may be undefined, or defined from star imports
-    # Ruff 0.8.0 added sorting of __all__ and __slots_.
-    # There is no consensus on whether we want to apply this to stubs, so keeping the status quo.
-    # See https://github.com/python/typeshed/pull/13108
-    "RUF022",
-    "RUF023",
+    # Most pep8-naming rules don't apply for third-party stubs like typeshed.
+    # N811 to N814 could apply, but we often use them to disambiguate a name whilst making it look like a more common one
+    "N8", # pep8-naming
+    "PLC2701", # Private name import from external module
+]


All this is just moving some rules so they appear in the right section and are in alphabetical order. Technically not directly related to this PR.

github-actions · 2025-03-02T04:25:52Z

Diff from mypy_primer, showing the effect of this PR on open source code:

pyinstrument (https://github.com/joerick/pyinstrument)
- pyinstrument/vendor/decorator.py:295: error: Incompatible types in assignment (expression has type "Callable[[Any, Any, VarArg(Any), KwArg(Any)], Any]", variable has type "Callable[[_GeneratorContextManagerBase[_G], Callable[..., _G], tuple[Any, ...], dict[str, Any]], None]")  [assignment]
+ pyinstrument/vendor/decorator.py:295: error: Incompatible types in assignment (expression has type "Callable[[Any, Any, VarArg(Any), KwArg(Any)], Any]", variable has type "Callable[[_GeneratorContextManagerBase[_G_co], Callable[..., _G_co], tuple[Any, ...], dict[str, Any]], None]")  [assignment]
- pyinstrument/vendor/decorator.py:301: error: Incompatible types in assignment (expression has type "Callable[[Any, Any, VarArg(Any), KwArg(Any)], Any]", variable has type "Callable[[_GeneratorContextManagerBase[_G], Callable[..., _G], tuple[Any, ...], dict[str, Any]], None]")  [assignment]
+ pyinstrument/vendor/decorator.py:301: error: Incompatible types in assignment (expression has type "Callable[[Any, Any, VarArg(Any), KwArg(Any)], Any]", variable has type "Callable[[_GeneratorContextManagerBase[_G_co], Callable[..., _G_co], tuple[Any, ...], dict[str, Any]], None]")  [assignment]

Enable Ruff PLC

65759ee

JelleZijlstra reviewed Dec 26, 2024

View reviewed changes

lib/ts_utils/utils.py Outdated Show resolved Hide resolved