开发工具 ¶

此章描述的模块帮助您编写软件。例如， 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 — 支持类型提示
  • Specification for the Python Type System
  • 类型别名
  • NewType
  • Annotating callable objects
  • 一般
  • Annotating tuples
  • The type of class objects
  • Annotating generators and coroutines
  • 用户定义一般类型
  • The Any type
  • 名义 vs 结构子类型
  • 模块内容
    • 特殊 typing 原语
      • 特殊类型
        • Any
        • AnyStr
        • LiteralString
        • Never
        • NoReturn
        • Self
        • TypeAlias
      • 特殊形式
        • Union
        • Optional
        • Concatenate
        • Literal
        • ClassVar
        • Final
        • Required
        • NotRequired
        • ReadOnly
        • Annotated
        • TypeIs
        • TypeGuard
        • Unpack
      • Building generic types and type aliases
        • Generic
        • TypeVar
          • __name__
          • __covariant__
          • __contravariant__
          • __infer_variance__
          • __bound__
          • __constraints__
          • __default__
          • has_default()
        • TypeVarTuple
          • __name__
          • __default__
          • has_default()
        • ParamSpec
          • args
          • kwargs
          • __name__
          • __default__
          • has_default()
        • ParamSpecArgs
        • ParamSpecKwargs
        • TypeAliasType
          • __name__
          • __module__
          • __type_params__
          • __value__
      • 其它特殊指令
        • NamedTuple
        • NewType
          • __module__
          • __name__
          • __supertype__
        • Protocol
        • runtime_checkable()
        • TypedDict
          • __total__
          • __required_keys__
          • __optional_keys__
          • __readonly_keys__
          • __mutable_keys__
    • 协议
      • SupportsAbs
      • SupportsBytes
      • SupportsComplex
      • SupportsFloat
      • SupportsIndex
      • SupportsInt
      • SupportsRound
    • ABCs for working with 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
      • NoDefault
    • 常量
      • TYPE_CHECKING
    • Deprecated aliases
      • Aliases to built-in types
        • Dict
        • List
        • Set
        • FrozenSet
        • Tuple
        • Type
      • Aliases to types in collections
        • DefaultDict
        • OrderedDict
        • ChainMap
        • Counter
        • Deque
      • Aliases to other concrete types
        • Pattern
        • Match
        • Text
      • Aliases to container ABCs in collections.abc
        • AbstractSet
        • ByteString
        • Collection
        • Container
        • ItemsView
        • KeysView
        • Mapping
        • MappingView
        • MutableMapping
        • MutableSequence
        • MutableSet
        • Sequence
        • ValuesView
      • Aliases to asynchronous ABCs in collections.abc
        • Coroutine
        • AsyncGenerator
        • AsyncIterable
        • AsyncIterator
        • Awaitable
      • Aliases to other ABCs in collections.abc
        • Iterable
        • Iterator
        • Callable
        • Generator
        • Hashable
        • Reversible
        • Sized
      • Aliases to contextlib ABCs
        • ContextManager
        • AsyncContextManager
  • 主要特征弃用时间线
• pydoc — 文档编制生成器和在线帮助系统
• Python 开发模式
  • Python 开发模式的影响
  • ResourceWarning 范例
  • 坏的文件描述符错误范例
• doctest — 测试交互 Python 范例
  • 简单用法：校验 docstring (文档字符串) 中的范例
  • 简单用法：校验文本文件中的范例
  • 它如何工作
    • Which Docstrings Are Examined?
    • How are Docstring Examples Recognized?
    • What’s the Execution Context?
    • What About Exceptions?
    • 选项标志
      • 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
        • examples
        • globs
        • name
        • filename
        • lineno
        • docstring
    • 范例对象
      • Example
        • source
        • want
        • exc_msg
        • lineno
        • indent
        • options
    • DocTestFinder 对象
      • DocTestFinder
        • find()
    • DocTestParser 对象
      • DocTestParser
        • get_doctest()
        • get_examples()
        • parse()
    • TestResults objects
      • TestResults
        • failed
        • attempted
        • skipped
    • DocTestRunner 对象
      • DocTestRunner
        • report_start()
        • report_success()
        • report_failure()
        • report_unexpected_exception()
        • run()
        • summarize()
        • tries
        • failures
        • skips
    • OutputChecker 对象
      • OutputChecker
        • check_output()
        • output_difference()
  • 调试
    • script_from_examples()
    • testsource()
    • debug()
    • debug_src()
    • DebugRunner
    • DocTestFailure
    • test
    • example
    • got
    • UnexpectedException
    • test
    • example
    • exc_info
  • Soapbox
• unittest — 单元测试框架
  • 基本范例
  • 命令行接口
    • 命令行选项
  • 测试探索
  • 组织测试代码
  • 重用旧测试代码
  • Skipping tests and expected failures
    • skip()
    • skipIf()
    • skipUnless()
    • expectedFailure()
    • SkipTest
  • Distinguishing test iterations using subtests
  • 类和函数
    • Test cases
      • TestCase
        • setUp()
        • tearDown()
        • setUpClass()
        • tearDownClass()
        • run()
        • skipTest()
        • subTest()
        • debug()
        • assertEqual()
        • assertNotEqual()
        • assertTrue()
        • assertFalse()
        • assertIs()
        • assertIsNot()
        • assertIsNone()
        • assertIsNotNone()
        • assertIn()
        • assertNotIn()
        • assertIsInstance()
        • assertNotIsInstance()
        • assertRaises()
        • assertRaisesRegex()
        • assertWarns()
        • assertWarnsRegex()
        • assertLogs()
          • records
          • output
        • assertNoLogs()
        • assertAlmostEqual()
        • assertNotAlmostEqual()
        • assertGreater()
        • assertGreaterEqual()
        • assertLess()
        • assertLessEqual()
        • assertRegex()
        • assertNotRegex()
        • assertCountEqual()
        • addTypeEqualityFunc()
        • assertMultiLineEqual()
        • assertSequenceEqual()
        • assertListEqual()
        • assertTupleEqual()
        • assertSetEqual()
        • assertDictEqual()
        • fail()
        • failureException
        • longMessage
        • maxDiff
        • countTestCases()
        • defaultTestResult()
        • id()
        • shortDescription()
        • addCleanup()
        • enterContext()
        • doCleanups()
        • addClassCleanup()
        • enterClassContext()
        • doClassCleanups()
      • IsolatedAsyncioTestCase
        • loop_factory
        • asyncSetUp()
        • asyncTearDown()
        • addAsyncCleanup()
        • enterAsyncContext()
        • run()
      • FunctionTestCase
    • Grouping tests
      • TestSuite
        • addTest()
        • addTests()
        • run()
        • debug()
        • countTestCases()
        • __iter__()
    • Loading and running tests
      • TestLoader
        • errors
        • loadTestsFromTestCase()
        • loadTestsFromModule()
        • loadTestsFromName()
        • loadTestsFromNames()
        • getTestCaseNames()
        • discover()
        • testMethodPrefix
        • sortTestMethodsUsing
        • suiteClass
        • testNamePatterns
      • TestResult
        • errors
        • failures
        • skipped
        • expectedFailures
        • unexpectedSuccesses
        • collectedDurations
        • shouldStop
        • testsRun
        • buffer
        • failfast
        • tb_locals
        • wasSuccessful()
        • stop()
        • startTest()
        • stopTest()
        • startTestRun()
        • stopTestRun()
        • addError()
        • addFailure()
        • addSuccess()
        • addSkip()
        • addExpectedFailure()
        • addUnexpectedSuccess()
        • addSubTest()
        • addDuration()
      • TextTestResult
      • defaultTestLoader
      • TextTestRunner
        • _makeResult()
        • run()
      • main()
      • load_tests Protocol
  • Class and Module Fixtures
    • setUpClass and tearDownClass
    • setUpModule and tearDownModule
      • addModuleCleanup()
      • enterModuleContext()
      • doModuleCleanups()
  • 信号处理
    • installHandler()
    • registerResult()
    • removeResult()
    • removeHandler()
• unittest.mock — 仿造对象库
  • Quick Guide
  • The Mock Class
    • Mock
      • assert_called()
      • assert_called_once()
      • assert_called_with()
      • assert_called_once_with()
      • assert_any_call()
      • assert_has_calls()
      • assert_not_called()
      • reset_mock()
      • mock_add_spec()
      • attach_mock()
      • configure_mock()
      • __dir__()
      • _get_child_mock()
      • called
      • call_count
      • return_value
      • side_effect
      • call_args
      • call_args_list
      • method_calls
      • mock_calls
      • __class__
    • NonCallableMock
    • PropertyMock
    • AsyncMock
      • assert_awaited()
      • assert_awaited_once()
      • assert_awaited_with()
      • assert_awaited_once_with()
      • assert_any_await()
      • assert_has_awaits()
      • assert_not_awaited()
      • reset_mock()
      • await_count
      • await_args
      • await_args_list
    • ThreadingMock
      • wait_until_called()
      • wait_until_any_call_with()
      • DEFAULT_TIMEOUT
    • 调用
    • Deleting Attributes
    • Mock names and the name attribute
    • Attaching Mocks as Attributes
  • The patchers
    • patch
      • patch()
    • patch.object
      • object()
    • patch.dict
      • dict()
    • patch.multiple
      • multiple()
    • patch methods: start and stop
      • stopall()
    • patch builtins
    • TEST_PREFIX
    • Nesting Patch Decorators
    • Where to patch
    • Patching Descriptors and Proxy Objects
  • MagicMock and magic method support
    • Mocking Magic Methods
    • Magic Mock
      • MagicMock
      • NonCallableMagicMock
  • 帮手
    • sentinel
      • sentinel
    • DEFAULT
      • DEFAULT
    • call
      • call()
      • call_list()
    • create_autospec
      • create_autospec()
    • ANY
      • ANY
    • FILTER_DIR
      • FILTER_DIR
    • mock_open
      • mock_open()
    • Autospeccing
    • Sealing mocks
      • seal()
  • Order of precedence of side_effect , return_value and wraps
• unittest.mock — 快速入门
  • Using Mock
    • Mock Patching Methods
    • Mock for Method Calls on an Object
    • Mocking Classes
    • Naming your mocks
    • 追踪所有调用
    • Setting Return Values and Attributes
    • Raising exceptions with mocks
    • Side effect functions and iterables
    • Mocking asynchronous iterators
    • Mocking asynchronous context manager
    • Creating a Mock from an Existing Object
    • Using side_effect to return per file content
  • 补丁装饰器
  • Further Examples
    • Mocking chained calls
    • Partial mocking
    • Mocking a Generator Method
    • Applying the same patch to every test method
    • Mocking Unbound Methods
    • Checking multiple calls with mock
    • Coping with mutable arguments
    • 嵌套补丁
    • Mocking a dictionary with MagicMock
    • Mock subclasses and their attributes
    • Mocking imports with patch.dict
    • Tracking order of calls and less verbose call assertions
    • More complex argument matching
• test — 用于 Python 的回归测试包
  • 编写单元测试为 test 包
  • Running tests using the command-line interface
• 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_gil_enabled()
  • 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
    • save()
    • restore()
  • Matcher
    • matches()
    • 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
  • get_disassembly_as_string()
  • assertInBytecode()
  • 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 — 用于 OS 测试的实用程序
  • FS_NONASCII
  • SAVEDCWD
  • TESTFN
  • TESTFN_NONASCII
  • TESTFN_UNENCODABLE
  • TESTFN_UNDECODABLE
  • TESTFN_UNICODE
  • EnvironmentVarGuard
  • FakePath
  • set()
  • unset()
  • 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