Outils de développement

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.

La liste des modules documentés dans ce chapitre est :

• typing — Prise en charge des annotations de type
  • Specification for the Python Type System
  • Alias de type
  • NewType
  • Annotating callable objects
  • Génériques
  • Annotating tuples
  • The type of class objects
  • Annotating generators and coroutines
  • Types génériques définis par l'utilisateur
  • Le type Any
  • Sous-typage nominal et sous-typage structurel
  • Classe de données
    • Special typing primitives
      • Special types
        • Any
        • AnyStr
        • LiteralString
        • Never
        • NoReturn
        • Self
        • TypeAlias
      • Special forms
        • 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__
      • Other special directives
        • NamedTuple
        • NewType
          • __module__
          • __name__
          • __supertype__
        • Protocol
        • runtime_checkable()
        • TypedDict
          • __total__
          • __required_keys__
          • __optional_keys__
          • __readonly_keys__
          • __mutable_keys__
    • Protocoles
      • SupportsAbs
      • SupportsBytes
      • SupportsComplex
      • SupportsFloat
      • SupportsIndex
      • SupportsInt
      • SupportsRound
    • ABCs for working with IO
      • IO
      • TextIO
      • BinaryIO
    • Functions and decorators
      • 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()
    • Utilitaires d'introspection
      • get_type_hints()
      • get_origin()
      • get_args()
      • get_protocol_members()
      • is_protocol()
      • is_typeddict()
      • ForwardRef
      • NoDefault
    • Constante
      • 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
  • Étapes d'Obsolescence des Fonctionnalités Majeures
• pydoc --- Documentation generator and online help system
• Python Development Mode
  • Effects of the Python Development Mode
  • ResourceWarning Example
  • Bad file descriptor error example
• doctest — Exemples de tests interactifs en Python
  • Utilisation simple : vérifier des exemples dans des docstrings
  • Utilisation simple : vérifier des exemples dans un fichier texte
  • Comment ça marche
    • Quelles docstrings sont considérées ?
    • Comment les exemples docstring sont-ils identifiés ?
    • Quel est le contexte d'exécution ?
    • Qu'en est-il des exceptions ?
    • Options de ligne de commande
      • 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()
    • Instructions
    • Avertissements
  • API de base
    • testfile()
    • testmod()
    • run_docstring_examples()
  • API de tests unitaires
    • DocFileSuite()
    • DocTestSuite()
    • failureException
    • set_unittest_reportflags()
  • API avancé
    • Objets doctest
      • DocTest
        • examples
        • globs
        • name
        • filename
        • lineno
        • docstring
    • Exemples d'objets
      • Example
        • source
        • want
        • exc_msg
        • lineno
        • indent
        • options
    • Objets DocTestFinder
      • DocTestFinder
        • find()
    • Objets DocTestParser
      • DocTestParser
        • get_doctest()
        • get_examples()
        • parse()
    • Objets TestResults
      • TestResults
        • failed
        • attempted
        • skipped
    • Objets DocTestRunner
      • DocTestRunner
        • report_start()
        • report_success()
        • report_failure()
        • report_unexpected_exception()
        • run()
        • summarize()
        • tries
        • failures
        • skips
    • Objets OutputChecker
      • OutputChecker
        • check_output()
        • output_difference()
  • Débogage
    • script_from_examples()
    • testsource()
    • debug()
    • debug_src()
    • DebugRunner
    • DocTestFailure
    • test
    • example
    • got
    • UnexpectedException
    • test
    • example
    • exc_info
  • Éditorial
• unittest --- Unit testing framework
  • Exemple basique
  • Interface en ligne de commande
    • Options de la ligne de commande
  • Découverte des tests
  • Organiser le code de test
  • Réutilisation d'ancien code de test
  • Ignorer des tests et des erreurs prévisibles
    • skip()
    • skipIf()
    • skipUnless()
    • expectedFailure()
    • SkipTest
  • Distinguer les itérations de test à l'aide de sous-tests
  • Classes et fonctions
    • Scénarios de tests
      • 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
    • Regroupement des tests
      • TestSuite
        • addTest()
        • addTests()
        • run()
        • debug()
        • countTestCases()
        • __iter__()
    • Chargement et exécution des 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()
      • Protocole de chargement des tests (load_tests Protocol)
  • Classes et modules d'aménagements des tests
    • Classes de mise en place (setUpClass) et de démantèlement des tests (tearDownClass)
    • Module de mise en place (setUpModule) et de démantèlement des tests (tearDownModule)
      • addModuleCleanup()
      • enterModuleContext()
      • doModuleCleanups()
  • Traitement des signaux
    • installHandler()
    • registerResult()
    • removeResult()
    • removeHandler()
• unittest.mock --- mock object library
  • Guide rapide
  • La classe Mock
    • 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
    • Calling
    • 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
  • Helpers
    • sentinel
      • sentinel
    • DEFAULT
      • DEFAULT
    • appel
      • 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 --- getting started
  • Utilisation de Mock ou l'art de singer
    • Simulation des méthodes
    • S'assurer de la bonne utilisation d'un objet
    • Simulation des classes
    • Naming your mocks
    • Tracking all Calls
    • 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
  • Patch Decorators
  • 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
    • Nesting Patches
    • 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 --- Regression tests package for Python
  • Writing Unit Tests for the test package
  • Running tests using the command-line interface
• test.support --- Utilities for the Python test suite
  • 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 --- Utilities for socket tests
  • IPV6_ENABLED
  • find_unused_port()
  • bind_port()
  • bind_unix_socket()
  • skip_unless_bind_unix_socket()
  • transient_internet()
• test.support.script_helper --- Utilities for the Python execution tests
  • 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 --- Support tools for testing correct bytecode generation
  • BytecodeTestCase
  • get_disassembly_as_string()
  • assertInBytecode()
  • assertNotInBytecode()
• test.support.threading_helper --- Utilities for threading tests
  • join_thread()
  • reap_threads()
  • start_threads()
  • threading_cleanup()
  • threading_setup()
  • wait_threads_exit()
  • catch_threading_exception()
• test.support.os_helper --- Utilities for os tests
  • 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 --- Utilities for import tests
  • forget()
  • import_fresh_module()
  • import_module()
  • modules_setup()
  • modules_cleanup()
  • unload()
  • make_legacy_pyc()
  • CleanImport
  • DirsOnSysPath
• test.support.warnings_helper --- Utilities for warnings tests
  • ignore_warnings()
  • check_no_resource_warning()
  • check_syntax_warning()
  • check_warnings()
  • WarningsRecorder