flake8-pyi - GitLite

KO | EN

gitlite — search

#javascript #python #react #llm #golang #android #machine-learning #deep-learning #nodejs #macos #java #awesome #vue #openai

flake8-pyi

(★ 83)

A plugin for Flake8 that provides specializations for type hinting stub files

File Explorer

Download Latest Version (.zip)

- - bug.md
  - docs.md
  - feature.md
- - typeshed_primer_download_errors.js
  - typeshed_primer_post_comment.js
- - check.yml
  - publish.yml
  - typeshed_primer.yml
  - typeshed_primer_comment.yml
- __init__.py
- checker.py
- errors.py
- visitor.py
- aliases.pyi
- attribute_annotations.pyi
- calls.pyi
- classdefs.pyi
- comparisons.pyi
- defaults.pyi
- del.pyi
- disabled_by_default.pyi
- emptyclasses.pyi
- emptyfunctions.pyi
- exit_methods.pyi
- F822.pyi
- imports.pyi
- incomplete.pyi
- literals.pyi
- names_requiring_values.pyi
- never_vs_noreturn.pyi
- override.pyi
- pep570.pyi
- pep604_union_types.pyi
- pep646_py311.pyi
- pep695_py312.pyi
- protocol_arg.pyi
- quotes.pyi
- single_element_tuples.pyi
- sysplatform.pyi
- sysversioninfo.pyi
- test_pyi_files.py
- type_comments.pyi
- typevar.pyi
- union_duplicates.pyi
- unused_things.pyi
.editorconfig
.flake8
.gitignore
.pre-commit-config.yaml
CHANGELOG.md
CONTRIBUTING.md
ERRORCODES.md
LICENSE
pyproject.toml
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# flake8-pyi

A plugin for Flake8 that provides specializations for
[type hinting stub files](https://www.python.org/dev/peps/pep-0484/#stub-files),
especially interesting for linting
[typeshed](https://github.com/python/typeshed/).

Refer to [this documentation](https://typing.readthedocs.io/en/latest/source/stubs.html) 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](https://github.com/PyCQA/flake8-pyi/blob/main/ERRORCODES.md).

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](mailto:lukasz@langa.pl) and
now maintained by
[Jelle Zijlstra](mailto:jelle.zijlstra@gmail.com),
[Alex Waygood](mailto:alex.waygood@gmail.com),
Sebastian Rittau, Akuli, and Shantanu.

## See also

* [List of error codes](https://github.com/PyCQA/flake8-pyi/blob/main/ERRORCODES.md)
* [Changelog](https://github.com/PyCQA/flake8-pyi/blob/main/CHANGELOG.md)
* [Information for contributors](https://github.com/PyCQA/flake8-pyi/blob/main/CONTRIBUTING.md)