跳转到主要内容

Traits 包的类型注解

项目描述

traits-stubs 包包含对 Traits 包的外部类型注解。这些注解可以与静态类型检查器(如 mypy)一起使用,以检查您使用的 Traits 的 Python 代码的类型。

安装

  • 要从 PyPI 安装,只需使用 pip install traits-stubs 即可。

  • 要从源安装,请在此目录中运行 pip install .

使用

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

mypy <somefile.py>

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

开发

要本地测试 traits 存根

  • 创建一个新的 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 install .

  • 以可编辑模式安装 traits 存根(从存储库,而不是从 PyPI)

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

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

    $ python -m pip install mypy

  • 从 traits-stubs 目录,使用以下方式运行 mypy 对 traits_stubs_tests/examples 中的单个文件进行测试

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

  • 从 traits-stubs 目录,运行测试套件

    $ python -m unittest discover -v traits_stubs_tests

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

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

依赖关系

此包依赖于 Traits

项目详情


下载文件

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

源分发

traits-stubs-6.4.0.tar.gz (20.1 kB 查看散列)

上传时间

构建分发

traits_stubs-6.4.0-py3-none-any.whl (45.6 kB 查看散列)

上传时间 Python 3

由...