Skip to main content

Traits 包的类型注释

项目描述

traits-stubs包包含Traits包的外部类型注释 。这些注释可以与mypy等静态类型检查器一起使用,以使用 Python 代码对 Traits 进行类型检查。

安装

  • 要从 PyPI 安装,只需使用pip install tr​​aits -stubs。

  • 要从源安装,请运行pip install 。从这个目录。

用法

您通常希望将mypy(或其他类型检查器)与这些存根一起安装到您的 Python 环境中。然后,您可以从命令行使用mypy来检查文件或目录,例如:

mypy <somefile.py>

或者,可以将某些 IDE(包括 VS Code 和 PyCharm)配置为在您编辑时执行类型检查。

发展

要在本地测试特征存根:

  • 创建一个新的 venv 并激活它,例如:

    $ python -m venv --clear ~/.venvs/traits-stubs && source ~/.venvs/traits-stubs/bin/activate
  • 确保所有与构建相关的包都是最新的

    $ python -m pip install --upgrade pip setuptools wheel

  • 将 Traits 库安装到环境中(不可编辑安装)

    $ python -m pip 安装。

  • 以可编辑模式安装特征存根(来自 repo,而不是来自 PyPI)。

    $ python -m pip install -e traits-stubs/

  • 安装 mypy(或您最喜欢的类型检查器)

    $ python -m pip 安装 mypy

  • 在 traits-stubs 目录中,对 traits_stubs_tests/examples 中的单个文件运行 mypy,例如,

    $ python -m mypy traits_stubs_tests/examples/completeness.py

  • 在 traits-stubs 目录中,使用以下命令运行测试套件:

    $ python -m unittest 发现 -v traits_stubs_tests

注意:如果您不小心使用了错误版本的 mypy,很容易得到令人困惑的结果。为避免这种情况,您可以确保没有全局安装 mypy,和/或始终在环境中使用python -m mypy调用 mypy 。

注意:在存在陈旧的 .mypy_cache的情况下,unittest 运行可能会给出错误的结果。如果您在预期会失败的地方获得通过(反之亦然),请尝试删除本地缓存并重试。

依赖项

这个包依赖于Traits。

下载文件

下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。

源分布

traits-stubs-6.4.0.tar.gz (20.1 kB 查看哈希)

已上传 source

内置分布

traits_stubs-6.4.0-py3-none-any.whl (45.6 kB 查看哈希)

已上传 py3