]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-23882: Doc: Clarify unittest discovery document (GH-21560)
authorInada Naoki <songofacandy@gmail.com>
Mon, 22 Feb 2021 06:14:26 +0000 (15:14 +0900)
committerGitHub <noreply@github.com>
Mon, 22 Feb 2021 06:14:26 +0000 (15:14 +0900)
Unittest discovery support namespace package as start
directory. But it doesn't find namespace package in
the start directory automatically.

Otherwise, unittest discovery search into unexpected
directories like `vendor/` or `node_modules/`.

Doc/library/unittest.rst

index bb229f0bf9ce0e0fce3fdef40ef80090025fdaaf..d413224fd49836a78e6379a2d170710364366c49 100644 (file)
@@ -330,7 +330,9 @@ Test modules and packages can customize test loading and discovery by through
 the `load_tests protocol`_.
 
 .. versionchanged:: 3.4
-   Test discovery supports :term:`namespace packages <namespace package>`.
+   Test discovery supports :term:`namespace packages <namespace package>`
+   for start directory. Note that you need to the top level directory too.
+   (e.g. ``python -m unittest discover -s root/namespace -t root``).
 
 
 .. _organizing-tests:
@@ -1870,11 +1872,15 @@ Loading and running tests
 
       .. versionchanged:: 3.4
          Modules that raise :exc:`SkipTest` on import are recorded as skips,
-           not errors.
-         Discovery works for :term:`namespace packages <namespace package>`.
-         Paths are sorted before being imported so that execution order is
-           the same even if the underlying file system's ordering is not
-           dependent on file name.
+         not errors.
+
+      .. versionchanged:: 3.4
+         *start_dir* can be a :term:`namespace packages <namespace package>`.
+
+      .. versionchanged:: 3.4
+         Paths are sorted before being imported so that execution order is the
+         same even if the underlying file system's ordering is not dependent
+         on file name.
 
       .. versionchanged:: 3.5
          Found packages are now checked for ``load_tests`` regardless of