From c0a4edd5ef21899cfa583633585fab83c22329fc Mon Sep 17 00:00:00 2001 From: Inada Naoki Date: Mon, 22 Feb 2021 15:14:26 +0900 Subject: [PATCH] bpo-23882: Doc: Clarify unittest discovery document (GH-21560) 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/`. (cherry picked from commit 5a4aa4c03e27ca5007b86c9c1ee62c77ad08a120) Co-authored-by: Inada Naoki --- Doc/library/unittest.rst | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst index 9fc6620335f88c..d05e15e7808f91 100644 --- a/Doc/library/unittest.rst +++ b/Doc/library/unittest.rst @@ -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 `. + Test discovery supports :term:`namespace packages ` + 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: @@ -1849,11 +1851,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 `. - 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 `. + + .. 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