开发工具

The modules described in this chapter help you write software. For example, the pydoc module takes a module and generates documentation based on the module's contents. The doctest and unittest modules contains frameworks for writing unit tests that automatically exercise code and verify that the expected output is produced.

本章中描述的模块列表是：

• typing —— 对类型提示的支持
  • 相关的 PEP
  • 类型别名
  • NewType
  • 标注可调用对象
  • 泛型（Generic）
  • 标注元组
  • 类对象的类型
  • 用户定义的泛型类型
  • Any 类型
  • 名义子类型 vs 结构子类型
  • 模块内容
    • 特殊类型原语
      • 特殊类型
        • Any
        • AnyStr
        • LiteralString
        • Never
        • NoReturn
        • Self
        • TypeAlias
      • 特殊形式
        • Union
        • Optional
        • Concatenate
        • Literal
        • ClassVar
        • Final
        • Required
        • NotRequired
        • Annotated
        • TypeGuard
        • Unpack
      • 构造泛型类型与类型别名
        • Generic
        • TypeVar
          • TypeVar.__name__
          • TypeVar.__covariant__
          • TypeVar.__contravariant__
          • TypeVar.__infer_variance__
          • TypeVar.__bound__
          • TypeVar.__constraints__
        • TypeVarTuple
          • TypeVarTuple.__name__
        • ParamSpec
          • ParamSpec.args
          • ParamSpec.kwargs
          • ParamSpec.__name__
        • ParamSpecArgs
        • ParamSpecKwargs
        • TypeAliasType
          • TypeAliasType.__name__
          • TypeAliasType.__module__
          • TypeAliasType.__type_params__
          • TypeAliasType.__value__
      • 其他特殊指令
        • NamedTuple
        • NewType
          • NewType.__module__
          • NewType.__name__
          • NewType.__supertype__
        • Protocol
        • runtime_checkable()
        • TypedDict
          • TypedDict.__total__
          • TypedDict.__required_keys__
          • TypedDict.__optional_keys__
    • 协议
      • SupportsAbs
      • SupportsBytes
      • SupportsComplex
      • SupportsFloat
      • SupportsIndex
      • SupportsInt
      • SupportsRound
    • 与 IO 相关的抽象基类
      • IO
      • TextIO
      • BinaryIO
    • 函数与装饰器
      • cast()
      • assert_type()
      • assert_never()
      • reveal_type()
      • dataclass_transform()
      • overload()
      • get_overloads()
      • clear_overloads()
      • final()
      • no_type_check()
      • no_type_check_decorator()
      • override()
      • type_check_only()
    • 内省辅助器
      • get_type_hints()
      • get_origin()
      • get_args()
      • get_protocol_members()
      • is_protocol()
      • is_typeddict()
      • ForwardRef
    • 常量
      • TYPE_CHECKING
    • 已弃用的别名
      • 内置类型的别名
        • Dict
        • List
        • Set
        • FrozenSet
        • Tuple
        • Type
      • collections 中的类型的别名。
        • DefaultDict
        • OrderedDict
        • ChainMap
        • Counter
        • Deque
      • 其他具体类型的别名
        • Pattern
        • Match
        • Text
      • collections.abc 中容器 ABC 的别名
        • AbstractSet
        • ByteString
        • Collection
        • Container
        • ItemsView
        • KeysView
        • Mapping
        • MappingView
        • MutableMapping
        • MutableSequence
        • MutableSet
        • Sequence
        • ValuesView
      • collections.abc 中异步 ABC 的别名
        • Coroutine
        • AsyncGenerator
        • AsyncIterable
        • AsyncIterator
        • Awaitable
      • collections.abc 中其他 ABC 的别名
        • Iterable
        • Iterator
        • Callable
        • Generator
        • Hashable
        • Reversible
        • Sized
      • contextlib ABC 的别名
        • ContextManager
        • AsyncContextManager
  • 主要特性的弃用时间线
• pydoc --- 文档生成器和在线帮助系统
• Python 开发模式
  • Python 开发模式的效果
  • ResourceWarning 示例
  • 文件描述符错误示例
• doctest --- 测试交互性的Python示例
  • 简单用法：检查Docstrings中的示例
  • 简单的用法：检查文本文件中的例子
  • 它是如何工作的
    • 哪些文件串被检查了？
    • 文档串的例子是如何被识别的？
    • 什么是执行上下文？
    • 异常如何处理？
    • 选项标记
      • DONT_ACCEPT_TRUE_FOR_1
      • DONT_ACCEPT_BLANKLINE
      • NORMALIZE_WHITESPACE
      • ELLIPSIS
      • IGNORE_EXCEPTION_DETAIL
      • SKIP
      • COMPARISON_FLAGS
      • REPORT_UDIFF
      • REPORT_CDIFF
      • REPORT_NDIFF
      • REPORT_ONLY_FIRST_FAILURE
      • FAIL_FAST
      • REPORTING_FLAGS
      • register_optionflag()
    • 指令
    • 警告
  • 基本API
    • testfile()
    • testmod()
    • run_docstring_examples()
  • Unittest API
    • DocFileSuite()
    • DocTestSuite()
    • failureException
    • set_unittest_reportflags()
  • 高级 API
    • DocTest 对象
      • DocTest
        • DocTest.examples
        • DocTest.globs
        • DocTest.name
        • DocTest.filename
        • DocTest.lineno
        • DocTest.docstring
    • Example 对象
      • Example
        • Example.source
        • Example.want
        • Example.exc_msg
        • Example.lineno
        • Example.indent
        • Example.options
    • DocTestFinder 对象
      • DocTestFinder
        • DocTestFinder.find()
    • DocTestParser 对象
      • DocTestParser
        • DocTestParser.get_doctest()
        • DocTestParser.get_examples()
        • DocTestParser.parse()
    • TestResults objects
      • TestResults
        • TestResults.failed
        • TestResults.attempted
        • TestResults.skipped
    • DocTestRunner 对象
      • DocTestRunner
        • DocTestRunner.report_start()
        • DocTestRunner.report_success()
        • DocTestRunner.report_failure()
        • DocTestRunner.report_unexpected_exception()
        • DocTestRunner.run()
        • DocTestRunner.summarize()
        • DocTestRunner.tries
        • DocTestRunner.failures
        • DocTestRunner.skips
    • OutputChecker 对象
      • OutputChecker
        • OutputChecker.check_output()
        • OutputChecker.output_difference()
  • 调试
    • script_from_examples()
    • testsource()
    • debug()
    • debug_src()
    • DebugRunner
    • DocTestFailure
      • DocTestFailure.test
      • DocTestFailure.example
      • DocTestFailure.got
    • UnexpectedException
      • UnexpectedException.test
      • UnexpectedException.example
      • UnexpectedException.exc_info
  • 肥皂盒
• unittest --- 单元测试框架
  • 基本实例
  • 命令行接口
    • 命令行选项
  • 探索性测试
  • 组织你的测试代码
  • 复用已有的测试代码
  • 跳过测试与预计的失败
    • skip()
    • skipIf()
    • skipUnless()
    • expectedFailure()
    • SkipTest
  • 使用子测试区分测试迭代
  • 类与函数
    • 测试用例
      • TestCase
        • TestCase.setUp()
        • TestCase.tearDown()
        • TestCase.setUpClass()
        • TestCase.tearDownClass()
        • TestCase.run()
        • TestCase.skipTest()
        • TestCase.subTest()
        • TestCase.debug()
        • TestCase.assertEqual()
        • TestCase.assertNotEqual()
        • TestCase.assertTrue()
        • TestCase.assertFalse()
        • TestCase.assertIs()
        • TestCase.assertIsNot()
        • TestCase.assertIsNone()
        • TestCase.assertIsNotNone()
        • TestCase.assertIn()
        • TestCase.assertNotIn()
        • TestCase.assertIsInstance()
        • TestCase.assertNotIsInstance()
        • TestCase.assertRaises()
        • TestCase.assertRaisesRegex()
        • TestCase.assertWarns()
        • TestCase.assertWarnsRegex()
        • TestCase.assertLogs()
        • TestCase.records
        • TestCase.output
        • TestCase.assertNoLogs()
        • TestCase.assertAlmostEqual()
        • TestCase.assertNotAlmostEqual()
        • TestCase.assertGreater()
        • TestCase.assertGreaterEqual()
        • TestCase.assertLess()
        • TestCase.assertLessEqual()
        • TestCase.assertRegex()
        • TestCase.assertNotRegex()
        • TestCase.assertCountEqual()
        • TestCase.addTypeEqualityFunc()
        • TestCase.assertMultiLineEqual()
        • TestCase.assertSequenceEqual()
        • TestCase.assertListEqual()
        • TestCase.assertTupleEqual()
        • TestCase.assertSetEqual()
        • TestCase.assertDictEqual()
        • TestCase.fail()
        • TestCase.failureException
        • TestCase.longMessage
        • TestCase.maxDiff
        • TestCase.countTestCases()
        • TestCase.defaultTestResult()
        • TestCase.id()
        • TestCase.shortDescription()
        • TestCase.addCleanup()
        • TestCase.enterContext()
        • TestCase.doCleanups()
        • TestCase.addClassCleanup()
        • TestCase.enterClassContext()
        • TestCase.doClassCleanups()
      • IsolatedAsyncioTestCase
        • IsolatedAsyncioTestCase.loop_factory
        • IsolatedAsyncioTestCase.asyncSetUp()
        • IsolatedAsyncioTestCase.asyncTearDown()
        • IsolatedAsyncioTestCase.addAsyncCleanup()
        • IsolatedAsyncioTestCase.enterAsyncContext()
        • IsolatedAsyncioTestCase.run()
      • FunctionTestCase
    • 分组测试
      • TestSuite
        • TestSuite.addTest()
        • TestSuite.addTests()
        • TestSuite.run()
        • TestSuite.debug()
        • TestSuite.countTestCases()
        • TestSuite.__iter__()
    • 加载和运行测试
      • TestLoader
        • TestLoader.errors
        • TestLoader.loadTestsFromTestCase()
        • TestLoader.loadTestsFromModule()
        • TestLoader.loadTestsFromName()
        • TestLoader.loadTestsFromNames()
        • TestLoader.getTestCaseNames()
        • TestLoader.discover()
        • TestLoader.testMethodPrefix
        • TestLoader.sortTestMethodsUsing
        • TestLoader.suiteClass
        • TestLoader.testNamePatterns
      • TestResult
        • TestResult.errors
        • TestResult.failures
        • TestResult.skipped
        • TestResult.expectedFailures
        • TestResult.unexpectedSuccesses
        • TestResult.collectedDurations
        • TestResult.shouldStop
        • TestResult.testsRun
        • TestResult.buffer
        • TestResult.failfast
        • TestResult.tb_locals
        • TestResult.wasSuccessful()
        • TestResult.stop()
        • TestResult.startTest()
        • TestResult.stopTest()
        • TestResult.startTestRun()
        • TestResult.stopTestRun()
        • TestResult.addError()
        • TestResult.addFailure()
        • TestResult.addSuccess()
        • TestResult.addSkip()
        • TestResult.addExpectedFailure()
        • TestResult.addUnexpectedSuccess()
        • TestResult.addSubTest()
        • TestResult.addDuration()
      • TextTestResult
      • defaultTestLoader
      • TextTestRunner
        • TextTestRunner._makeResult()
        • TextTestRunner.run()
      • main()
      • load_tests 协议
  • 类与模块设定
    • setUpClass 和 tearDownClass
    • setUpModule 和 tearDownModule
      • addModuleCleanup()
      • enterModuleContext()
      • doModuleCleanups()
  • 信号处理
    • installHandler()
    • registerResult()
    • removeResult()
    • removeHandler()
• unittest.mock --- 模拟对象库
  • 快速上手
  • Mock 类
    • Mock
      • Mock.assert_called()
      • Mock.assert_called_once()
      • Mock.assert_called_with()
      • Mock.assert_called_once_with()
      • Mock.assert_any_call()
      • Mock.assert_has_calls()
      • Mock.assert_not_called()
      • Mock.reset_mock()
      • Mock.mock_add_spec()
      • Mock.attach_mock()
      • Mock.configure_mock()
      • Mock.__dir__()
      • Mock._get_child_mock()
      • Mock.called
      • Mock.call_count
      • Mock.return_value
      • Mock.side_effect
      • Mock.call_args
      • Mock.call_args_list
      • Mock.method_calls
      • Mock.mock_calls
      • Mock.__class__
    • NonCallableMock
    • PropertyMock
    • AsyncMock
      • AsyncMock.assert_awaited()
      • AsyncMock.assert_awaited_once()
      • AsyncMock.assert_awaited_with()
      • AsyncMock.assert_awaited_once_with()
      • AsyncMock.assert_any_await()
      • AsyncMock.assert_has_awaits()
      • AsyncMock.assert_not_awaited()
      • AsyncMock.reset_mock()
      • AsyncMock.await_count
      • AsyncMock.await_args
      • AsyncMock.await_args_list
    • ThreadingMock
      • ThreadingMock.wait_until_called()
      • ThreadingMock.wait_until_any_call_with()
      • ThreadingMock.DEFAULT_TIMEOUT
    • 调用
    • 删除属性
    • Mock 的名称与 name 属性
    • 附加 Mock 作为属性
  • patch 装饰器
    • patch
      • patch()
    • patch.object
      • patch.object()
    • patch.dict
      • patch.dict()
    • patch.multiple
      • patch.multiple()
    • 补丁方法: start 和 stop
      • patch.stopall()
    • 为内置函数打补丁
    • TEST_PREFIX
    • 嵌套补丁装饰器
    • 补丁的位置
    • 对描述器和代理对象打补丁
  • MagicMock 与魔术方法支持
    • 模拟魔术方法
    • MagicMock
      • MagicMock
      • NonCallableMagicMock
  • 辅助对象
    • sentinel
      • sentinel
    • DEFAULT
      • DEFAULT
    • call
      • call()
        • call.call_list()
    • create_autospec
      • create_autospec()
    • ANY
      • ANY
    • FILTER_DIR
      • FILTER_DIR
    • mock_open
      • mock_open()
    • 自动 spec
    • 将 mock 封包
      • seal()
• unittest.mock --- 上手指南
  • 使用 mock
    • 模拟方法调用
    • 对象上的方法调用的 mock
    • 模拟类
    • 命名你的 mock
    • 追踪所有的调用
    • 设置返回值和属性
    • 通过 mock 引发异常
    • 附带影响函数和可迭代对象
    • 模拟异步迭代器
    • 模拟异步上下文管理器
    • 基于现有对象创建模拟对象
    • 使用 side_effect 返回每个文件的内容
  • 补丁装饰器
  • 更多示例
    • 模拟链式调用
    • 部分模拟
    • 模拟生成器方法
    • 对每个测试方法应用相同的补丁
    • 模拟未绑定方法
    • 通过 mock 检查多次调用
    • 处理可变参数
    • 嵌套补丁
    • 使用 MagicMock 模拟字典
    • 模拟子类及其属性
    • 通过 patch.dict 模拟导入
    • 追踪调用顺序和不太冗长的调用断言
    • 更复杂的参数匹配
• test --- Python 回归测试包
  • 为 test 包编写单元测试
  • 使用命令行界面运行测试
• test.support --- 针对 Python 测试套件的工具
  • TestFailed
  • ResourceDenied
  • verbose
  • is_jython
  • is_android
  • unix_shell
  • LOOPBACK_TIMEOUT
  • INTERNET_TIMEOUT
  • SHORT_TIMEOUT
  • LONG_TIMEOUT
  • PGO
  • PIPE_MAX_SIZE
  • Py_DEBUG
  • SOCK_MAX_SIZE
  • TEST_SUPPORT_DIR
  • TEST_HOME_DIR
  • TEST_DATA_DIR
  • MAX_Py_ssize_t
  • max_memuse
  • real_max_memuse
  • MISSING_C_DOCSTRINGS
  • HAVE_DOCSTRINGS
  • TEST_HTTP_URL
  • ALWAYS_EQ
  • NEVER_EQ
  • LARGEST
  • SMALLEST
  • busy_retry()
  • sleeping_retry()
  • is_resource_enabled()
  • python_is_optimized()
  • with_pymalloc()
  • requires()
  • sortdict()
  • findfile()
  • get_pagesize()
  • setswitchinterval()
  • check_impl_detail()
  • set_memlimit()
  • record_original_stdout()
  • get_original_stdout()
  • args_from_interpreter_flags()
  • optim_args_from_interpreter_flags()
  • captured_stdin()
  • captured_stdout()
  • captured_stderr()
  • disable_faulthandler()
  • gc_collect()
  • disable_gc()
  • swap_attr()
  • swap_item()
  • flush_std_streams()
  • print_warning()
  • wait_process()
  • calcobjsize()
  • calcvobjsize()
  • checksizeof()
  • anticipate_failure()
  • system_must_validate_cert()
  • run_with_locale()
  • run_with_tz()
  • requires_freebsd_version()
  • requires_linux_version()
  • requires_mac_version()
  • requires_IEEE_754()
  • requires_zlib()
  • requires_gzip()
  • requires_bz2()
  • requires_lzma()
  • requires_resource()
  • requires_docstrings()
  • requires_limited_api()
  • cpython_only()
  • impl_detail()
  • no_tracing()
  • refcount_test()
  • bigmemtest()
  • bigaddrspacetest()
  • check_syntax_error()
  • open_urlresource()
  • reap_children()
  • get_attribute()
  • catch_unraisable_exception()
  • load_package_tests()
  • detect_api_mismatch()
  • patch()
  • run_in_subinterp()
  • check_free_after_iterating()
  • missing_compiler_executable()
  • check__all__()
  • skip_if_broken_multiprocessing_synchronize()
  • check_disallow_instantiation()
  • adjust_int_max_str_digits()
  • SuppressCrashReport
  • SaveSignals
    • SaveSignals.save()
    • SaveSignals.restore()
  • Matcher
    • Matcher.matches()
    • Matcher.match_value()
• test.support.socket_helper --- 用于套接字测试的工具
  • IPV6_ENABLED
  • find_unused_port()
  • bind_port()
  • bind_unix_socket()
  • skip_unless_bind_unix_socket()
  • transient_internet()
• test.support.script_helper --- 用于 Python 执行测试工具
  • interpreter_requires_environment()
  • run_python_until_end()
  • assert_python_ok()
  • assert_python_failure()
  • spawn_python()
  • kill_python()
  • make_script()
  • make_zip_script()
  • make_pkg()
  • make_zip_pkg()
• test.support.bytecode_helper --- 用于测试正确字节码生成的支持工具
  • BytecodeTestCase
    • BytecodeTestCase.get_disassembly_as_string()
    • BytecodeTestCase.assertInBytecode()
    • BytecodeTestCase.assertNotInBytecode()
• test.support.threading_helper --- 用于线程测试的工具
  • join_thread()
  • reap_threads()
  • start_threads()
  • threading_cleanup()
  • threading_setup()
  • wait_threads_exit()
  • catch_threading_exception()
• test.support.os_helper --- 用于操作系统测试的工具
  • FS_NONASCII
  • SAVEDCWD
  • TESTFN
  • TESTFN_NONASCII
  • TESTFN_UNENCODABLE
  • TESTFN_UNDECODABLE
  • TESTFN_UNICODE
  • EnvironmentVarGuard
    • EnvironmentVarGuard.set()
    • EnvironmentVarGuard.unset()
  • FakePath
  • can_symlink()
  • can_xattr()
  • change_cwd()
  • create_empty_file()
  • fd_count()
  • fs_is_case_insensitive()
  • make_bad_fd()
  • rmdir()
  • rmtree()
  • skip_unless_symlink()
  • skip_unless_xattr()
  • temp_cwd()
  • temp_dir()
  • temp_umask()
  • unlink()
• test.support.import_helper --- 用于导入测试的工具
  • forget()
  • import_fresh_module()
  • import_module()
  • modules_setup()
  • modules_cleanup()
  • unload()
  • make_legacy_pyc()
  • CleanImport
  • DirsOnSysPath
• test.support.warnings_helper --- 用于警告测试的工具
  • ignore_warnings()
  • check_no_resource_warning()
  • check_syntax_warning()
  • check_warnings()
  • WarningsRecorder