fixture docs: highlight difference between yield and addfinalizer methods #2511
Conversation
This file contains hidden or 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
samjl
reviewed
Jun 21, 2017
doc/en/fixture.rst
Outdated
| request.addfinalizer(fin) | ||
| return smtp # provide the fixture value | ||
|
|
||
| Both ``yield`` and ``addfinalizer`` methods work similar by calling their code after the test |
There was a problem hiding this comment.
...methods work "similarly" by calling...
| r = [] | ||
| for port in ('C1', 'C3', 'C28'): | ||
| equip = connect(port) | ||
| request.addfinalizer(equip.disconnect) |
There was a problem hiding this comment.
Suggestion: I think I would add a note to say that if any code raises an exception before the teardown function is registered with addfinalizer then the teardown function is not executed (even though it's obvious)?
In my specific case the first thing I do in the fixture is register the teardown function with addfinalizer.
Nice worked example though!
samjl
approved these changes
Jun 22, 2017
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.
cc @samjl
Fix #2508