Skip to content

Fixed logic for IGNORE_WARNINGS/SHOW_WARNINGS for --remote-data=any #152

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 1 commit into from
Feb 17, 2021
Merged

Fixed logic for IGNORE_WARNINGS/SHOW_WARNINGS for --remote-data=any #152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions CHANGES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
0.10.0 (unreleased)
===================

- Fixed a bug where the command-line option ``--remote-data=any`` (associated
with the ``pytest-remotedata`` plugin) would cause ``IGNORE_WARNINGS`` and
``SHOW_WARNINGS`` options to be ignored in module docstrings. [#152]

- Fix wrong behavior with ``IGNORE_WARNINGS`` and ``SHOW_WARNINGS`` that could
make a block to pass instead of being skipped. [#148]

Expand Down
62 changes: 30 additions & 32 deletions pytest_doctestplus/plugin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,38 +219,36 @@ def collect(self):

for test in finder.find(module):
if test.examples: # skip empty doctests
if config.getoption('remote_data', 'none') != 'any':

ignore_warnings_context_needed = False
show_warnings_context_needed = False

for example in test.examples:

# If warnings are to be ignored we need to catch them by
# wrapping the source in a context manager.
if example.options.get(IGNORE_WARNINGS, False):
example.source = ("with _doctestplus_ignore_all_warnings():\n"
+ indent(example.source, ' '))
ignore_warnings_context_needed = True

# Same for SHOW_WARNINGS
if example.options.get(SHOW_WARNINGS, False):
example.source = ("with _doctestplus_show_all_warnings():\n"
+ indent(example.source, ' '))
show_warnings_context_needed = True

if example.options.get(REMOTE_DATA):
example.options[doctest.SKIP] = True

# We insert the definition of the context manager to ignore
# warnings at the start of the file if needed.
if ignore_warnings_context_needed:
test.examples.insert(0, doctest.Example(
source=IGNORE_WARNINGS_CONTEXT, want=''))

if show_warnings_context_needed:
test.examples.insert(0, doctest.Example(
source=SHOW_WARNINGS_CONTEXT, want=''))
ignore_warnings_context_needed = False
show_warnings_context_needed = False

for example in test.examples:
if (config.getoption('remote_data', 'none') != 'any'
and example.options.get(REMOTE_DATA)):
example.options[doctest.SKIP] = True

# If warnings are to be ignored we need to catch them by
# wrapping the source in a context manager.
elif example.options.get(IGNORE_WARNINGS, False):
example.source = ("with _doctestplus_ignore_all_warnings():\n"
+ indent(example.source, ' '))
ignore_warnings_context_needed = True

# Same for SHOW_WARNINGS
elif example.options.get(SHOW_WARNINGS, False):
example.source = ("with _doctestplus_show_all_warnings():\n"
+ indent(example.source, ' '))
show_warnings_context_needed = True

# We insert the definition of the context manager to ignore
# warnings at the start of the file if needed.
if ignore_warnings_context_needed:
test.examples.insert(0, doctest.Example(
source=IGNORE_WARNINGS_CONTEXT, want=''))

if show_warnings_context_needed:
test.examples.insert(0, doctest.Example(
source=SHOW_WARNINGS_CONTEXT, want=''))

try:
yield doctest_plugin.DoctestItem.from_parent(
Expand Down