Skip to content
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

Jump to bottom

Allow doctest_show_success=False option #10938

Merged
merged 2 commits into from Jul 28, 2023
Merged

Allow doctest_show_success=False option #10938

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
766c895
Allow doctest_show_success=False option
treyhunner Sep 20, 2022
8002b5f
Fix linting issues
treyhunner Oct 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 8 additions & 5 deletions sphinx/ext/doctest.py
View file
Open in desktop
Expand Up @@ -454,21 +454,23 @@ def condition(node: Node) -> bool:
if not groups:
return

self._out('\nDocument: %s\n----------%s\n' %
(docname, '-' * len(docname)))
if self.config.doctest_show_successes:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
if self.config.doctest_show_successes:
show_successes = self.config.doctest_show_successes
if show_successes :

self._out('\nDocument: %s\n----------%s\n' %
(docname, '-' * len(docname)))
Comment on lines +458 to +459
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
self._out('\nDocument: %s\n----------%s\n' %
(docname, '-' * len(docname)))
self._out('\n'
f'Document: {docname}\n'
f'----------{"-" * len(docname)}\n')

for group in groups.values():
self.test_group(group)
# Separately count results from setup code
res_f, res_t = self.setup_runner.summarize(self._out, verbose=False)
self.setup_failures += res_f
self.setup_tries += res_t
if self.test_runner.tries:
res_f, res_t = self.test_runner.summarize(self._out, verbose=True)
res_f, res_t = self.test_runner.summarize(
self._out, verbose=self.config.doctest_show_successes)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
self._out, verbose=self.config.doctest_show_successes)
self._out, verbose=show_successes)

self.total_failures += res_f
self.total_tries += res_t
if self.cleanup_runner.tries:
res_f, res_t = self.cleanup_runner.summarize(self._out,
verbose=True)
res_f, res_t = self.cleanup_runner.summarize(
self._out, verbose=self.config.doctest_show_successes)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
self._out, verbose=self.config.doctest_show_successes)
self._out, verbose=show_successes)

self.cleanup_failures += res_f
self.cleanup_tries += res_t

Expand Down Expand Up @@ -555,6 +557,7 @@ def setup(app: "Sphinx") -> Dict[str, Any]:
app.add_directive('testoutput', TestoutputDirective)
app.add_builder(DocTestBuilder)
# this config value adds to sys.path
app.add_config_value('doctest_show_successes', True, False)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
app.add_config_value('doctest_show_successes', True, False)
app.add_config_value('doctest_show_successes', True, False, (bool,))

app.add_config_value('doctest_path', [], False)
app.add_config_value('doctest_test_doctest_blocks', 'default', False)
app.add_config_value('doctest_global_setup', '', False)
Expand Down