Conversation
Collaborator
tzschmidt
commented
May 22, 2026
- Update evaluation format
- Update evaluation parser
- Improve documentation
There was a problem hiding this comment.
Pull request overview
This PR updates the benchmark evaluation XML format and aligns both the writer (runscript) and reader (result parser/classes) to the new structure, with accompanying test and documentation updates.
Changes:
- Extend evaluation/result model to capture richer metadata (e.g.,
cmdlineas{pre, post},memout,template_options,dist_template/dist_options, per-setting encodings). - Refactor the result XML parser into smaller helpers with stricter required-attribute handling and clearer errors.
- Update tests, reference XML, and getting-started docs to reflect the new attributes/paths.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
src/benchmarktool/result/parser.py |
Refactors XML parsing into helper methods; parses new attributes (cmdline dicts, memout, template options, setting encodings). |
src/benchmarktool/result/result.py |
Updates dataclasses (new fields, kw_only=True in several types) to represent the new parsed format. |
src/benchmarktool/runscript/runscript.py |
Updates XML emission to the new attribute names/structure (e.g., encoding_tag, optional template_options, instance encodings). |
tests/result/test_result_parser.py |
Adjusts expectations for the new parsed structures/fields. |
tests/result/test_result_classes.py |
Updates unit tests to match new dataclass signatures/fields (including keyword-only constructors). |
tests/runscript/test_runscript_classes.py |
Updates XML-string assertions for renamed/added XML attributes and instance encodings. |
tests/ref/test_eval.xml |
Updates the reference evaluation XML fixture to the new format. |
docs/getting_started/workflow/index.md |
Rewords/moves an executable-permissions note into an admonition block. |
docs/getting_started/gen/runscript.md |
Updates example encoding paths and clarifies path relativity. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
BenKaufmann
approved these changes
May 22, 2026
Contributor
BenKaufmann
left a comment
There was a problem hiding this comment.
Looks ok to me, but let's wait until @rkaminsk had a look.
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
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.