Skip to content

gh-116622: Enable test_doctest on platforms that don't support subprocesses #116758

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 7 commits into from
Apr 9, 2024
Merged

gh-116622: Enable test_doctest on platforms that don't support subprocesses #116758

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4264ca9
Enable `test_doctest` on platforms that don't support subprocesses
mhsmith Mar 13, 2024
7d4f0fb
Fix whitespace
mhsmith Mar 19, 2024
b735bd7
Merge branch 'main' into doctest-subprocess
mhsmith Mar 21, 2024
ffee805
Switch to a doctest_skip_if decorator
mhsmith Mar 21, 2024
d022538
Make DocTestCase report as skipped if all examples in the doctest are…
mhsmith Mar 27, 2024
405d679
Move most of previous commit into #117297
mhsmith Mar 27, 2024
f9e9687
Don't modify docstrings when running in optimized mode
mhsmith Mar 31, 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
11 changes: 8 additions & 3 deletions Lib/test/test_doctest/test_doctest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,12 @@
import contextlib


if not support.has_subprocess_support:
raise unittest.SkipTest("test_CLI requires subprocess support.")
def doctest_skip_if(condition):
def decorator(func):
if condition and support.HAVE_DOCSTRINGS:
func.__doc__ = ">>> pass # doctest: +SKIP"
return func
return decorator


# NOTE: There are some additional tests relating to interaction with
Expand Down Expand Up @@ -466,7 +470,7 @@ def basics(): r"""
>>> tests = finder.find(sample_func)

>>> print(tests) # doctest: +ELLIPSIS
[<DocTest sample_func from test_doctest.py:33 (1 example)>]
[<DocTest sample_func from test_doctest.py:37 (1 example)>]

The exact name depends on how test_doctest was invoked, so allow for
leading path components.
Expand Down Expand Up @@ -2944,6 +2948,7 @@ def test_unicode(): """
TestResults(failed=1, attempted=1)
"""

@doctest_skip_if(not support.has_subprocess_support)
def test_CLI(): r"""
The doctest module can be used to run doctests against an arbitrary file.
These tests test this CLI functionality.
Expand Down
Loading