Add build-sequence-summary.json #526
Conversation
Machine readable version of the current markdown table Useful in pipeline environments to filter skipped or prebuilt packages from a subsequent twine publish Signed-off-by: Pris Nasrat <[email protected]>
pnasrat
changed the title
| @staticmethod | ||
| def dict_factory(x): | ||
| return { | ||
| k: str(v) if isinstance(v, pathlib.Path | Version) else v for (k, v) in x |
There was a problem hiding this comment.
I would have expected the 2nd argument to be a tuple, but TIL about union type. Does that come from type hints?
There was a problem hiding this comment.
That was my first approach - then my editor/pyright complained with the recommendation to use union type not tuple here. Looks like came in via https://peps.python.org/pep-0604/#isinstance-and-issubclass
There was a problem hiding this comment.
Nice, thanks for sharing that link! I'm still learning about some of the recent changes to the language after spending a few years away from Python, so every little bit helps. :-)
There was a problem hiding this comment.
The feature was introduced in Python 3.10 as part of PEP 604, https://docs.python.org/3.10/whatsnew/3.10.html#pep-604-new-type-union-operator
| with open(ctx.work_dir / "build-sequence-summary.json", "w", encoding="utf-8") as f: | ||
| json.dump( | ||
| [ | ||
| dataclasses.asdict(e, dict_factory=BuildSequenceEntry.dict_factory) |
There was a problem hiding this comment.
I think this could just be dataclasses.asdict(e). Did you find you needed to pass the factory function explicitly or does that do something extra?
There was a problem hiding this comment.
So both Version and pathlib.Path failed to serialize with errors like
ERROR: Object of type PosixPath is not JSON serializable
Using the custom dict_factory (set on the dataclass) here to use str for those worked. I debated switching to pydantic here, used else but this seemed sufficient given it's a report.
There was a problem hiding this comment.
What you have looks good. Pydantic wouldn't be wrong, but is probably an extra complication here.
|
I've triggered a new release including this feature. Thank you for contributing! https://github.com/python-wheel-build/fromager/releases/tag/0.36.0 |
Machine readable version of the current markdown table
Useful in pipeline environments to filter skipped or prebuilt packages from a subsequent twine publish
Signed-off-by: Pris Nasrat [email protected]