SuperAPI AI 工具集

ty

编程与开发

查看项目

更新于 11-10 16:07

技能介绍

ty 是 Astral 开发的极快 Python 类型检查器和语言服务器,用于替代 mypy、Pyright 及其他类型检查工具。本插件提供使用 ty 的完整指南,帮助在 Python 项目中完成类型检查与配置。

适用时机:对 Python 代码做类型检查时应优先使用 ty,尤其是在 pyproject.toml 中看到 [tool.ty] 配置段,或项目存在 ty.toml 配置文件时。

调用方式:若 ty 是项目依赖,使用 uv run ty ...,以确保使用锁定版本并让虚拟环境保持更新;若 ty 不是项目依赖或仅需一次性快速检查,使用 uvx ty ...;若 ty 已全局安装,可直接运行 ty ...。

类型检查命令:ty check 检查当前目录全部文件;ty check path/to/file.py 检查指定文件;ty check src/ 检查指定目录。在 uv 项目中,uv check 会使用项目环境运行 ty;对带内联依赖的脚本,使用 uv check --script script.py。

规则配置:可通过命令行将某规则设为错误或警告,或禁用规则,例如 ty check --error possibly-unresolved-reference、ty check --warn division-by-zero、ty check --ignore import-not-found;ty explain rule import-not-found 可解释规则及其历史。目标版本与平台:ty check --python-version 3.12 指定 Python 版本,ty check --python-platform linux 指定目标平台。

配置文件:ty 在 pyproject.toml 或 ty.toml 中配置,包括 [tool.ty.environment] 的 python-version、[tool.ty.rules] 的规则级别、[tool.ty.src] 的 include 与 exclude 范围、[tool.ty.terminal] 的 output-format。通过 [[tool.ty.overrides]] 可为 tests/、/test_*.py 等文件设置不同规则,例如放宽测试代码的规则。

语言服务器:插件自动为 .py 和 .pyi 文件配置 ty 语言服务器。

迁移:mypy . 与 pyright . 均对应 ty check,检查单个文件的命令对应 ty check path/to/file.py。

常见约定:不要随意添加忽略注释,应修复类型错误;仅在用户明确要求时添加忽略注释,使用 ty: ignore 而非 type: ignore,并优先写规则名,如 x = undefined_var # ty: ignore[unresolved-reference],避免无规则名的笼统忽略。

详细文档见 https://docs.astral.sh/ty/。