Skip to content

Conversation

@phoebusm
Copy link
Collaborator

@phoebusm phoebusm commented Nov 12, 2025

Reference Issues/PRs

What does this implement or fix?

Improve the readability of StageResult along with atom keys' printout

New StageResult printout example:
StageResult(staged_segments=[Key(type=b, id='sym', version_id=0, content_hash=0xac454fbcb62cd989, creation_ts=1763562571272342532, start_index=1735689600000000000, end_index=1735776000000000001), Key(type=b, id='sym', version_id=0, content_hash=0x14e310dcc399815e, creation_ts=1763562571272634201, start_index=1735862400000000000, end_index=1735862400000000001)])

New key printout example:
Key(type=b, id='sym', version_id=0, content_hash=0xac454fbcb62cd989, creation_ts=1763562571272342532, start_index=1735689600000000000, end_index=1735776000000000001)

Docstring for the class has been added to the docs website as well.

Any other comments?

Checklist

Checklist for code changes...
  • Have you updated the relevant docstrings, documentation and copyright notice?
  • Is this contribution tested against all ArcticDB's features?
  • Do all exceptions introduced raise appropriate error messages?
  • Are API changes highlighted in the PR description?
  • Is the PR labelled as enhancement or bug so it appears in autogenerated release notes?

@phoebusm phoebusm added the patch Small change, should increase patch version label Nov 13, 2025
@phoebusm phoebusm marked this pull request as ready for review November 17, 2025 15:18
Copy link
Collaborator

@IvoDD IvoDD left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Can you include an example in the PR description of the new format of the stage result, so that it is visible from the release notes?

auto transform_view =
stage_result.staged_segments | std::views::transform([](const auto& key) {
return arcticdb::entity::
formattable<arcticdb::entity::AtomKey, arcticdb::entity::DisplayAtomKeyFormat>(key);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Can we use key.view_human() here?

@IvoDD IvoDD changed the title Improve stageresult printout Improve StageResult printout Nov 17, 2025
@phoebusm phoebusm merged commit 9a10775 into master Nov 20, 2025
367 of 370 checks passed
@phoebusm phoebusm deleted the improve_stageresult_printout branch November 20, 2025 11:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

patch Small change, should increase patch version

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants