Modify documentation to use .stash when storing test results.
#10535
Conversation
|
@The-Compiler @nicoddemus |
doc/en/example/simple.rst
Outdated
| if your_unique_key not in item.stash: | ||
| item.stash[your_unique_key] = {rep.when: rep.passed} | ||
| else: | ||
| item.stash[your_unique_key][rep.when] = rep.passed |
There was a problem hiding this comment.
Can use setdefault to make this more succinct:
| if your_unique_key not in item.stash: | |
| item.stash[your_unique_key] = {rep.when: rep.passed} | |
| else: | |
| item.stash[your_unique_key][rep.when] = rep.passed | |
| item.stash.setdefault(your_unique_key, {})[rep.when] = rep.passed |
There was a problem hiding this comment.
Also refactored the tmpdir.py implementation this way. I can make it to another PR if that's better.
Sure!
doc/en/example/simple.rst
Outdated
|
|
||
| setattr(item, "rep_" + rep.when, rep) | ||
| if your_unique_key not in item.stash: | ||
| item.stash[your_unique_key] = {rep.when: rep.passed} |
There was a problem hiding this comment.
The previous code stored the entire report, I think that's a bit more generally useful, so would keep that instead of storing just passed.
doc/en/example/simple.rst
Outdated
| @@ -895,29 +895,35 @@ here is a little example implemented via a local plugin: | |||
|
|
|||
| import pytest | |||
|
|
|||
| your_unique_key = StashKey[Dict[str, bool]]() | |||
There was a problem hiding this comment.
your_unique_key is not a very good name. How about phase_report_key, if you choose to store the full report, or phase_result_key if not?
There was a problem hiding this comment.
Yeah but isn't stash shared with all the other plugins and stuff? If that's the case, it should be remarked that the key name should be unique to avoid collision.
There was a problem hiding this comment.
Yeah but isn't stash shared with all the other plugins and stuff?
The name doesn't matter, every stash and stash key (i.e. StashKey()) pair are unique.
There was a problem hiding this comment.
Understood. I was confused about it.
doc/en/example/simple.rst
Outdated
| if request.node.rep_call.failed: | ||
| print("executing test failed", request.node.nodeid) | ||
| report = request.node.stash[phase_report_key] | ||
| if ("setup" not in report) or report["setup"].failed: |
There was a problem hiding this comment.
Generally I don't think it's possible to reach here when "setup" not in report is true (but didn't test it), so I'd remove it. Same for "call" not in report (as long as it's in an elif). Regarding "teardown" not in report -- it's either never true or always true, but I'm not sure which one it is off hand.
There was a problem hiding this comment.
This is probably correct on setup and teardown (tested that teadown doesn't exist here).
Updated 9a69170.
But call may not exist like this #10442 (comment) no?
To store test results, it's better to use
.stashinstead of adding attributes on items. However, the documentation currently advises to add attributes. So it's probably better to update the documentation.Some contexts:
#10442 (comment)
#10517