Ensure subtest's context kwargs are JSON serializable #13963
+43
−3
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
Convert all the values of `SubtestContext.kwargs` to strings using `saferepr`. This complies with the requirement that the returned dict from `pytest_report_to_serializable` is serializable to JSON, at the cost of losing type information for objects that are natively supported by JSON. Fixes pytest-dev/pytest-xdist#1273
nicoddemus
force-pushed
the
xdist-subtests-serialization
branch
from
a3cf834 to
7585f45
Compare
psf-chronographer
bot
added
the
bot:chronographer:provided
nicoddemus
added
the
backport 9.0.x
bluetech
reviewed
Nov 13, 2025
Member
bluetech
left a comment
bluetech
left a comment
There was a problem hiding this comment.
A couple of comments for your consideration.
| return dataclasses.asdict(self) | ||
| result = dataclasses.asdict(self) | ||
| # Brute-force the returned kwargs dict to be JSON serializable (pytest-dev/pytest-xdist#1273). | ||
| result["kwargs"] = {k: saferepr(v) for (k, v) in result["kwargs"].items()} |
Member
There was a problem hiding this comment.
IMO we should strive to have the property that from_json(to_json(report)) == report. In this case it means that we should have self.kwargs itself should be serializable, not just in to_json.
| return dataclasses.asdict(self) | ||
| result = dataclasses.asdict(self) | ||
| # Brute-force the returned kwargs dict to be JSON serializable (pytest-dev/pytest-xdist#1273). | ||
| result["kwargs"] = {k: saferepr(v) for (k, v) in result["kwargs"].items()} |
Member
There was a problem hiding this comment.
saferepr itself might be non-optimal, e.g. it would make strings "foo" render as 'foo' while we probably want plain foo. The _idval_from_value function does some reasonable conversions I think.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Convert all the values of
SubtestContext.kwargsto strings usingsaferepr.This complies with the requirement that the returned dict from
pytest_report_to_serializableis serializable to JSON, at the cost of losing type information for objects that are natively supported by JSON.Fixes pytest-dev/pytest-xdist#1273