25. 开发工具 — Python 文档

25. 开发工具

本章介绍的模块可帮助您编写软件。 例如，pydoc 模块接受一个模块并根据模块的内容生成文档。 doctest 和 unittest 模块包含用于编写单元测试的框架，这些框架可以自动执行代码并验证是否产生了预期的输出。 2to3 可以将 Python 2.x 源代码翻译成有效的 Python 3.x 代码。

本章描述的模块列表是：

• 25.1. pydoc — 文档生成器和在线帮助系统
• 25.2. doctest — 测试交互式 Python 示例
  • 25.2.1. 简单用法：检查文档字符串中的示例
  • 25.2.2. 简单用法：检查文本文件中的示例
  • 25.2.3. 这个怎么运作
    • 25.2.3.1. 检查哪些文档字符串？
    • 25.2.3.2. 如何识别文档字符串示例？
    • 25.2.3.3. 什么是执行上下文？
    • 25.2.3.4. 异常情况如何？
    • 25.2.3.5. 选项标志
    • 25.2.3.6. 指令
    • 25.2.3.7. 警告
  • 25.2.4. 基本API
  • 25.2.5. 单元测试 API
  • 25.2.6. 高级API
    • 25.2.6.1. DocTest 对象
    • 25.2.6.2. 示例对象
    • 25.2.6.3. DocTestFinder 对象
    • 25.2.6.4. DocTestParser 对象
    • 25.2.6.5. DocTestRunner 对象
    • 25.2.6.6. 输出检查器对象
  • 25.2.7. 调试
  • 25.2.8. 肥皂盒
• 25.3. unittest — 单元测试框架
  • 25.3.1. 基本示例
  • 25.3.2. 命令行界面
    • 25.3.2.1. 命令行选项
  • 25.3.3. 测试发现
  • 25.3.4. 组织测试代码
  • 25.3.5. 重用旧的测试代码
  • 25.3.6. 跳过测试和预期失败
  • 25.3.7. 类和函数
    • 25.3.7.1. 测试用例
      • 25.3.7.1.1. 不推荐使用的别名
    • 25.3.7.2. 分组测试
    • 25.3.7.3. 加载和运行测试
      • 25.3.7.3.1. load_tests 协议
  • 25.3.8. 类和模块夹具
    • 25.3.8.1. setUpClass 和 tearDownClass
    • 25.3.8.2. setUpModule 和 tearDownModule
  • 25.3.9. 信号处理
• 25.4. 2to3 - 自动 Python 2 到 3 代码翻译
  • 25.4.1. 使用 2to3
  • 25.4.2. 修理工
  • 25.4.3. lib2to3 - 2to3 的库
• 25.5. test — Python 的回归测试包
  • 25.5.1. 为 test 包编写单元测试
  • 25.5.2. 使用命令行界面运行测试
• 25.6. test.support — 用于测试的实用函数