Make pytest.skip work in doctest #4927
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
|
Thanks. I added a test and some lines in docstring. I think it is ready for review. |
blueyed
reviewed
Mar 15, 2019
src/_pytest/outcomes.py
Outdated
| @@ -80,7 +80,8 @@ def skip(msg="", **kwargs): | |||
| Skip an executing test with the given message. | |||
|
|
|||
| This function should be called only during testing (setup, call or teardown) or | |||
| during collection by using the ``allow_module_level`` flag. | |||
| during collection by using the ``allow_module_level`` flag. This function can | |||
| be called in doctest as well. | |||
There was a problem hiding this comment.
Suggested change
| be called in doctest as well. | |
| be called in doctests as well. |
But not sure if it is useful to mention doctests here explicitly..?!
There was a problem hiding this comment.
I'm OK either way. I thought to mention it since doctests are special enough for how they are executed but yet very popular.
Co-Authored-By: tkf <takafumi.a@gmail.com>
Co-Authored-By: tkf <takafumi.a@gmail.com>
|
Thanks a lot! |
no, thanks you! good patch :D |
|
Awesome @tkf! Glad I was incorrect in my first assessment then! 😁 |
3 tasks
|
For reference: #6669 adds it for all OutcomeExceptions (xfail, importorskip). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
As discussed in #4911 (comment), it would be nice if doctest can be conditionally skipped. It seems that just adding three lines is enough (close #4911). All this patch does is throwing
Skippedinstead ofUnexpectedExceptionif the original exception isSkipped.I'll add tests and docs if this direction looks OK.
changelogfolder, with a name like<ISSUE NUMBER>.<TYPE>.rst. See changelog/README.rst for details.Target themasterbranch for bug fixes, documentation updates and trivial changes.featuresbranch for new features and removals/deprecations.Unless your change is trivial or a small documentation fix (e.g., a typo or reword of a small section) please:
AUTHORSin alphabetical order;