A plugin for flake8 to enable linting .pyi files.
Project description
flake8-pyi
A plugin for Flake8 that provides specializations for type hinting stub files, especially interesting for linting typeshed.
Functionality
-
Adds the
.pyiextension to the default value of the--filenamecommand-line argument to Flake8. This means stubs are linted by default with this plugin enabled, without needing to explicitly list every file. -
Modifies PyFlakes runs for
.pyifiles to defer checking type annotation expressions after the entire file has been read. This enables support for first-class forward references that stub files use. -
Provides a number of
.pyi-specific warnings that enforce typeshed's style guide.
Note: Be careful when using this plugin in the same environment as other flake8
plugins, as they might generate errors that are inappropriate for
.pyi files (e.g., about missing docstrings). We recommend running
flake8-pyi in a dedicated environment in your CI.
List of warnings
This plugin reserves codes starting with Y0. The following warnings are currently emitted:
| Code | Description |
|---|---|
| Y001 | Names of TypeVars, ParamSpecs and TypeVarTuples in stubs should usually start with _. This makes sure you don't accidentally expose names internal to the stub. |
| Y002 | If test must be a simple comparison against sys.platform or sys.version_info. Stub files support simple conditionals to indicate differences between Python versions or platforms, but type checkers only understand a limited subset of Python syntax, and this warning triggers on conditionals that type checkers will probably not understand. |
| Y003 | Unrecognized sys.version_info check. Similar, but triggers on some comparisons involving version checks. |
| Y004 | Version comparison must use only major and minor version. Type checkers like mypy don't know about patch versions of Python (e.g. 3.4.3 versus 3.4.4), only major and minor versions (3.3 versus 3.4). Therefore, version checks in stubs should only use the major and minor versions. If new functionality was introduced in a patch version, pretend that it was there all along. |
| Y005 | Version comparison must be against a length-n tuple. |
| Y006 | Use only < and >= for version comparisons. Comparisons involving > and <= may produce unintuitive results when tools do use the full sys.version_info tuple. |
| Y007 | Unrecognized sys.platform check. Platform checks should be simple string comparisons. |
| Y008 | Unrecognized platform. To prevent you from typos, we warn if you use a platform name outside a small set of known platforms (e.g. "linux" and "win32"). |
| Y009 | Empty body should contain ..., not pass. This is just a stylistic choice, but it's the one typeshed made. |
| Y010 | Function body must contain only .... Stub files should not contain code, so function bodies should be empty. |
| Y011 | All default values for typed function arguments must be .... Type checkers ignore the default value, so the default value is not useful information in a stub file. |
| Y012 | Class body must not contain pass. |
| Y013 | Non-empty class body must not contain .... |
| Y014 | All default values for arguments must be .... A stronger version of Y011 that includes arguments without type annotations. |
| Y015 | Attribute must not have a default value other than .... |
| Y016 | Unions shouldn't contain duplicates, e.g. str | str is not allowed. |
| Y017 | Stubs should not contain assignments with multiple targets or non-name targets. |
| Y018 | A private TypeVar should be used at least once in the file in which it is defined. |
| Y019 | Certain kinds of methods should use _typeshed.Self instead of defining custom TypeVars for their return annotation. This check currently applies for instance methods that return self, class methods that return an instance of cls, and __new__ methods. |
| Y020 | Quoted annotations should never be used in stubs. |
| Y021 | Docstrings should not be included in stubs. |
| Y022 | Imports linting: use typing-module aliases to stdlib objects as little as possible (e.g. builtins.list over typing.List, collections.Counter over typing.Counter, etc.). |
| Y023 | Where there is no detriment to backwards compatibility, import objects such as ClassVar and NoReturn from typing rather than typing_extensions. |
| Y024 | Use typing.NamedTuple instead of collections.namedtuple, as it allows for more precise type inference. |
| Y025 | Always alias collections.abc.Set when importing it, so as to avoid confusion with builtins.set. |
| Y026 | Type aliases should be explicitly demarcated with typing.TypeAlias. |
| Y027 | Same as Y022. Unlike Y022, however, the imports disallowed with this error code are required if you wish to write Python 2-compatible stubs. Switch this error code off in your config file if you support Python 2. |
| Y028 | Always use class-based syntax for typing.NamedTuple, instead of assignment-based syntax. |
| Y029 | It is almost always redundant to define __str__ or __repr__ in a stub file, as the signatures are almost always identical to object.__str__ and object.__repr__. |
| Y030 | Union expressions should never have more than one Literal member, as Literal[1] | Literal[2] is semantically identical to Literal[1, 2]. |
| Y031 | TypedDicts should use class-based syntax instead of assignment-based syntax wherever possible. (In situations where this is not possible, such as if a field is a Python keyword or an invalid identifier, this error will not be raised.) |
| Y032 | The second argument of an __eq__ or __ne__ method should usually be annotated with object rather than Any. |
| Y033 | Do not use type comments (e.g. x = ... # type: int) in stubs, even if the stub supports Python 2. Always use annotations instead (e.g. x: int). |
| Y034 | Y034 detects common errors where certain methods are annotated as having a fixed return type, despite returning self at runtime. Such methods should be annotated with _typeshed.Self. This check looks for:1. Any in-place BinOp dunder methods ( __iadd__, __ior__, etc.) that do not return Self.2. __new__, __enter__ and __aenter__ methods that return the class's name unparameterised.3. __iter__ methods that return Iterator, even if the class inherits directly from Iterator.4. __aiter__ methods that return AsyncIterator, even if the class inherits directly from AsyncIterator.This check excludes methods decorated with @overload or @abstractmethod. |
| Y035 | __all__ in a stub file should always have a value, as __all__ in a .pyi file has identical semantics to __all__ in a .py file. E.g. write __all__ = ["foo", "bar"] instead of __all__: list[str]. |
Many error codes enforce modern conventions, and some cannot yet be used in all cases:
- Y026 is incompatible with the pytype type checker and should be turned off for stubs that need to be compatible with pytype. A fix is tracked here.
- Y027 is incompatible with Python 2 and should only be used in stubs that are meant only for Python 3.
License
MIT
Authors
Originally created by Łukasz Langa and now maintained by Jelle Zijlstra, Alex Waygood, Sebastian Rittau, Akuli, and Shantanu.
See also
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
flake8-pyi-22.2.0.tar.gz
(28.4 kB
view hashes)
Built Distribution
Close
Hashes for flake8_pyi-22.2.0-py37-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c5b7f8d9785d139913fc5e236f191fc4b1fb638471b2f1cf4c90fdf474c99c45 |
|
| MD5 | ff13bcd28bf90688e0b02ed27fdf7a40 |
|
| BLAKE2b-256 | bf0508097fed468c5088ba2069e6a4452a1f2c80e4088655264d62988bdc90d0 |
