Skip to content

[MCC-1535269] Python SDK - Remove dataset_batch_number from publish and dry_publish results - #58

Merged
butsyk-mdsol merged 2 commits into
mainfrom
fix/MCC-1535269-remove-dataset-batch-number
Aug 5, 2026
Merged

[MCC-1535269] Python SDK - Remove dataset_batch_number from publish and dry_publish results#58
butsyk-mdsol merged 2 commits into
mainfrom
fix/MCC-1535269-remove-dataset-batch-number

Conversation

@dsilaghi-mdsol

@dsilaghi-mdsol dsilaghi-mdsol commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Documentation adjustment

  • Python SDK - Remove dataset_batch_number from publish and dry_publish results
  • MCC-1535269

Checklist

  • Review the pull request to fix typos and ensure variable/function names are intuitive, etc.
  • Make sure the pull request does not have excessive number of unnecessary commits. Utilize the git commit --amend --no-edit command to reduce commit messages when making small file changes (like changing linespacing).
  • Make sure you have added unit tests for the code changes. Tests should be added in the tests/ folder.
  • Modify docs, if required. Add any new documentation in the doc/ folder.
  • Rebase on latest active development branch (develop/main).

Changes Summary

Remove dataset_batch_number from ResultMetadata and the _PublishEnvelopeResult flat accessor so the field is absent from both repr() and asdict() output. The previous repr=False fix (v1.1.0) only hid the field from printed output; asdict() — the path used for QA evidence — still exposed it.

  • Drop dataset_batch_number field from ResultMetadata.
  • Drop the flat dataset_batch_number property shim from _PublishEnvelopeResult.
  • Stop mapping the field in _envelope_to_domain; transport/models.py is untouched — server still sends it, transport still parses it.
  • Replace repr-based test assertions with asdict-based ones to match the actual QA evidence path.
  • Update README-v1.1.0.md output sections for dry_publish() and publish() to reflect the canonical envelope shape (metadata/metrics/checks/errors/invalid_records) instead of the old flat field list.

Deployment Notes

result.dataset_batch_number and result.metadata.dataset_batch_number now raise AttributeError. Any callers reading the field directly will need to be updated.

@dsilaghi-mdsol dsilaghi-mdsol self-assigned this Aug 5, 2026
@dsilaghi-mdsol dsilaghi-mdsol added the documentation Improvements or additions to documentation label Aug 5, 2026
@butsyk-mdsol
butsyk-mdsol merged commit 8af4f0a into main Aug 5, 2026
2 of 3 checks passed
@butsyk-mdsol
butsyk-mdsol deleted the fix/MCC-1535269-remove-dataset-batch-number branch August 5, 2026 13:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants