Skip to main content

A plugin for flake8 to enable linting .pyi stub files.

Project description

flake8-pyi

A plugin for Flake8 that provides specializations for type hinting stub files, especially interesting for linting typeshed.

Refer to this documentation for more details on stub files.

Functionality

  1. Adds the .pyi extension to the default value of the --filename command-line argument to Flake8. This means stubs are linted by default with this plugin enabled, without needing to explicitly list every file.

  2. Modifies PyFlakes runs for .pyi files 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.

  3. 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.

Lints provided

This plugin reserves codes starting with Y0. For a full list of lints currently provided by flake8-pyi, see the list of error codes.

Note that several error codes recommend using types from typing_extensions or _typeshed. Strictly speaking, these packages are not part of the standard library. However, these packages are included in typeshed's stdlib/ directory, meaning that type checkers believe them to be part of the standard library even if this does not reflect the reality at runtime. As such, since stubs are never executed at runtime, types from typing_extensions and _typeshed can be used freely in a stubs package, even if the package does not have an explicit dependency on either typing_extensions or typeshed.

Flake8-pyi's checks may produce false positives on stubs that aim to support Python 2.

License

MIT

Authors

Originally created by Łukasz Langa and now maintained by Jelle Zijlstra, Alex Waygood, Sebastian Rittau, Akuli, and Shantanu.

See also

Project details


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-25.5.0.tar.gz (63.2 kB view details)

Uploaded Source

Built Distribution

flake8_pyi-25.5.0-py3-none-any.whl (26.7 kB view details)

Uploaded Python 3

File details

Details for the file flake8_pyi-25.5.0.tar.gz.

File metadata

  • Download URL: flake8_pyi-25.5.0.tar.gz
  • Upload date:
  • Size: 63.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.8

File hashes

Hashes for flake8_pyi-25.5.0.tar.gz
Algorithm Hash digest
SHA256 dde18e5b20e6e17433767db97960164a4b4bbe0814a174a9e5ac552d8c73982a
MD5 ad89a907e0fc708fc514f6698164482b
BLAKE2b-256 8438176d5dea8d08a046db8e926d4d687100cc790270deb0407b6042d60c5c40

See more details on using hashes here.

File details

Details for the file flake8_pyi-25.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for flake8_pyi-25.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7aa76f0ee686e67d0ea1f1f9e5c428d3cfa182055813f78406f6802981df7201
MD5 c13397e9f409708fdc7f6d497e596434
BLAKE2b-256 fd60fbd1ea464d3a9899c81430cc89847870f9b9d4716adb908844b8bf434dba

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page