Skip to content

gh-80958: Restore unittest discovery support for namespace packages as start directory #123820

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Oct 23, 2024
Merged

gh-80958: Restore unittest discovery support for namespace packages as start directory #123820

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
7315af0
Revert "bpo-23882: unittest: Drop PEP 420 support from discovery. (GH…
jacobtylerwalls Sep 7, 2024
8344889
gh-80958: Restore unittest discovery of PEP 420 namespace packages
jacobtylerwalls Sep 7, 2024
525c5bc
Attempt to address WASI failure
jacobtylerwalls Sep 7, 2024
26b090f
fixup! gh-80958: Restore unittest discovery of PEP 420 namespace pack…
jacobtylerwalls Sep 8, 2024
378f855
Prevent discovering submodules under start_dir
jacobtylerwalls Sep 8, 2024
99cf5ea
fixup! Prevent discovering submodules under start_dir
jacobtylerwalls Sep 8, 2024
42ea642
Revert some doc edits, add versionchanged
jacobtylerwalls Oct 21, 2024
c042a44
Merge branch 'main' into restore-namespace-pkg-test-discovery
jacobtylerwalls Oct 21, 2024
be8d0e7
Fix typo
jacobtylerwalls Oct 21, 2024
5773305
update docs
methane Oct 22, 2024
e3e210e
[skip ci] Fix typo
jacobtylerwalls Oct 22, 2024
2103ba7
update doc
methane Oct 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 5 additions & 16 deletions Doc/library/unittest.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,28 +344,17 @@ the `load_tests protocol`_.

.. versionchanged:: 3.11
Test discovery dropped the :term:`namespace packages <namespace package>`
support in Python 3.11. It has been broken since Python 3.7. Start directory and
subdirectories containing tests must be regular package that have
``__init__.py`` file.
support. It has been broken since Python 3.7.
Start directory and its subdirectories containing tests must be regular
package that have ``__init__.py`` file.

If the start directory is the dotted name of the package, the ancestor packages
can be namespace packages.

.. versionchanged:: 3.14
Test discovery supports :term:`namespace package` as start directory again.
See following example::

# Directory tree:
# proj/
# namespace/
# mypkg/
# __init__.py
# test_mypkg.py

# Supported since Python 3.4
python -m unittest discover -s namespace.mypkg -t proj
# Supported since Python 3.14. mypkg must not be a namespace package.
python -m unittest discover -s namespace -t proj
To avoid scanning directories unrelated to Python,
tests are not searched in subdirectories that do not contain ``__init__.py``.
Comment on lines +356 to +357
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, this is great 👍



.. _organizing-tests:
Expand Down
Loading