用于启用对.pyi存根文件的代码检查的flake8插件。
项目描述
flake8-pyi
Flake8 的一个插件,为 类型提示存根文件 提供了专门的扩展,尤其适用于 typeshed 的代码检查。
有关存根文件的更多详细信息,请参阅 此文档。
功能
-
将
.pyi
扩展名添加到 Flake8 的--filename
命令行参数的默认值中。这意味着默认情况下,启用了此插件,会检查存根文件,无需显式列出每个文件。 -
修改 PyFlakes 对
.pyi
文件的运行,以在读取整个文件之后延迟检查类型注解表达式。这支持存根文件使用的一级向前引用。 -
提供了一些针对
.pyi
的特定警告,以强制执行 typeshed 的风格指南。
注意:在与其他 flake8 插件相同的环境中使用此插件时要小心,因为它们可能会生成不适用于 .pyi
文件(例如,关于缺少文档字符串)的错误。我们建议在 CI 中为 flake8-pyi
运行一个专用环境。
提供的代码检查
此插件保留以 Y0 开头的代码。有关 flake8-pyi 当前提供的所有代码检查的完整列表,请参阅 错误代码列表。
注意,几个错误代码建议使用来自 typing_extensions
或 _typeshed
的类型。严格来说,这些包不是标准库的一部分。然而,这些包包含在 typeshed 的 stdlib/
目录中,这意味着类型检查器认为它们是标准库的一部分,即使这并不反映运行时的现实。由于存根永远不会在运行时执行,因此即使在没有明确依赖 typing_extensions
或 typeshed 的包中,也可以在存根包中自由使用来自 typing_extensions
和 _typeshed
的类型。
flake8-pyi 的检查可能会在旨在支持 Python 2 的存根上产生假阳性。
许可证
MIT 许可证
作者
最初由 Łukasz Langa 创建,现由 Jelle Zijlstra、Alex Waygood、Sebastian Rittau、Akuli 和 Shantanu 维护。
另请参阅
项目详情
下载文件
下载您平台的文件。如果您不确定选择哪个,请了解有关 安装包 的更多信息。
源代码发行版
构建分发版
flake8_pyi-24.9.0.tar.gz的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 64fb735022958147afedd52781f263de337a34d118f3294ab2deb184f1c20cd9 |
|
MD5 | 70121c5ea0663e09942a2b3be045bcaa |
|
BLAKE2b-256 | 911e8793d84ce4d6ffc69d524ca70ebf776380dd7afd3a95f98e13c572c5803c |
flake8_pyi-24.9.0-py3-none-any.whl的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | c199b21e5a00b509d337bf376310437f16987e03bff4b1055d8b579d7bb3c01a |
|
MD5 | b78b1210b5080412de5fc8f669ba1e2a |
|
BLAKE2b-256 | 248d80aa81fb85e16c34cbc49dac59094b162fd972e49fca6db9d61653977897 |