Allow doctest_show_success=False option #10938
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AA-Turner
reviewed
Jul 28, 2023
| @@ -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: | |||
There was a problem hiding this comment.
Suggested change
| if self.config.doctest_show_successes: | |
| show_successes = self.config.doctest_show_successes | |
| if show_successes : |
| 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) |
There was a problem hiding this comment.
Suggested change
| self._out, verbose=self.config.doctest_show_successes) | |
| self._out, verbose=show_successes) |
| 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) |
There was a problem hiding this comment.
Suggested change
| self._out, verbose=self.config.doctest_show_successes) | |
| self._out, verbose=show_successes) |
| @@ -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) | |||
There was a problem hiding this comment.
Suggested change
| app.add_config_value('doctest_show_successes', True, False) | |
| app.add_config_value('doctest_show_successes', True, False, (bool,)) |
Comment on lines
+458
to
+459
| self._out('\nDocument: %s\n----------%s\n' % | ||
| (docname, '-' * len(docname))) |
There was a problem hiding this comment.
Suggested change
| self._out('\nDocument: %s\n----------%s\n' % | |
| (docname, '-' * len(docname))) | |
| self._out('\n' | |
| f'Document: {docname}\n' | |
| f'----------{"-" * len(docname)}\n') |
|
Thanks @treyhunner! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Subject: allow hiding verbose doctest successes
Feature
Purpose
For documentation that includes many doctests, seeing both successes and failures can add a lot of noise to the command output.
This change adds a
doctest_show_successoption that, when set toTrue, will hide doctest successes (only failures will be shown).Relates
Fixes #8654