Mypy 1.8.0 Documentation

• 语言: 英语
• 格式: .pdf
• 来源: mypy.readthedocs.io

摘要

Mypy is a static type checker for Python that supports incremental mode and various report generations. It uses a configuration file to set options such as report generation, cache settings, and platform specifics. Mypy can generate reports in different formats like HTML, XML, and JSON, providing insights into type coverage and usage. It also handles third-party library stubs and supports user-defined protocols for structural subtyping. The tool is extensible through plugins and offers options to manage caching for performance.

AI总结

《Mypy 1.8.0 Documentation》主要介绍了Mypy的配置文件、命令行选项、核心功能及其常见问题解答。以下是文档内容的总结：

### 1. Mypy配置文件
Mypy的配置文件（通常为`mypy.ini`或`setup.cfg`）允许用户自定义类型检查行为。以下是核心配置选项：
- **报告生成**：支持生成多种报告格式，包括：
- `any_exprs_report`：记录代码中`Any`类型表达式的数量。
- `cobertura_xml_report`、`html_report`等：生成代码覆盖率报告。
- `linecount_report`：统计已类型化和未类型化的函数和行。
- **平台配置**：可设置目标程序的Python版本（`python_version`）和操作系统平台（`platform`）。
- **高级选项**：包括缓存设置（如`incremental`、`cache_dir`）和插件支持（`plugins`）。
- **Miscellaneous**：如`no_site_packages`禁用第三方包类型信息，`junit_xml`生成JUnit格式报告。

### 2. 安装与运行
- **安装**：Mypy需要Python 3.8或更高版本，可通过`pip install mypy`安装。
- **运行**：执行`mypy program.py`进行静态类型检查。Mypy不会阻止代码运行，用户可选择忽略错误。

### 3. 类型系统与核心功能
- **类型注解**：Mypy通过代码中的类型注解进行静态类型检查，支持从Python 3.8起的类型系统特性。
- **协议与结构化子类型**：支持用户定义协议（继承`Protocol`类）和子协议，实现灵活的类型检查。
- **预定义协议**：如`Iterable`，可通过定义兼容方法实现协议。

### 4. 常见问题
- **Mypy是否支持PyPy**：部分支持，PyPy 3.8版本可以运行Mypy，但旧版本存在兼容性问题。
- **如何贡献**：欢迎社区贡献，包括开发、文档、测试等。

### 总结
文档详细介绍了Mypy的配置文件、核心功能、安装运行和常见问题，重点突出了类型系统的灵活性和自定义能力，为开发者提供了全面了解Mypy的参考指南。