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

Uploaded Source

Built Distribution

flake8_pyi-24.4.0-py3-none-any.whl (25.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flake8_pyi-24.4.0.tar.gz
  • Upload date:
  • Size: 60.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for flake8_pyi-24.4.0.tar.gz
Algorithm Hash digest
SHA256 4a50d2fe395d8ff08ee4a7e7b8a3cb532046335f0985c2537ffd3abedc56c9ab
MD5 d50c375c6585d348cf577fd8f51246f0
BLAKE2b-256 7145c1799a6255badaac63c095926823d9adf950de2de97340c11047212aae07

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: flake8_pyi-24.4.0-py3-none-any.whl
  • Upload date:
  • Size: 25.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for flake8_pyi-24.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 57e1a545a02a57b9814c238cd260a344d8a9db9a378671815e7ca9183637aa02
MD5 d4cbd66a8e93f1d7c41dadb7a5c21190
BLAKE2b-256 b232fb9e67692e925575f0ccd2aabae28bfcf6fe443cede35ebd6c8e6d42e71a

See more details on using hashes here.

Provenance

Supported by

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