fix: avoid mutating Document.from_dict input#11330
Merged
julian-risch merged 4 commits intoMay 19, 2026
Merged
Conversation
|
@pragnyanramtha is attempting to deploy a commit to the deepset Team on Vercel. A member of the Team first needs to authorize it. |
pragnyanramtha
requested review from
Copilot and
julian-risch
and removed request for
a team
The existing test only covered flattened metadata keys. This adds a
second case using an explicit `meta=` key, which exercises the
`data.pop("meta", {})` mutation site.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
julian-risch
approved these changes
May 19, 2026
Member
julian-risch
left a comment
julian-risch
left a comment
There was a problem hiding this comment.
Thank you for opening this PR @pragnyanramtha . The change looks good to me. I added another test case to explicitly test the behavior for the meta field in input data.
Contributor
Coverage report
Click to see where and how coverage changed
This report was generated by python-coverage-comment-action |
||||||||||||||||||||||||
This was referenced May 22, 2026
5 tasks
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
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.
Related Issues
Document.from_dict().Proposed Changes:
Document.from_dict()previously mutated the dictionary passed by the caller while converting serializedblobandsparse_embeddingvalues and while unflattening metadata. This PR copies the input mapping before those transformations so callers can safely reuse their serialized document data after deserialization.It also renames an existing intended test from
from_from_dict_with_parameterstotest_from_dict_with_parametersso pytest collects it, and adds a regression test for preserving the input dictionary.How did you test it?
hatch run test:unit test/dataclasses/test_document.pyhatch run fmt-check haystack/dataclasses/document.py test/dataclasses/test_document.pyhatch run reno lintgit diff --checkNotes for the reviewer
This PR was prepared with an AI assistant. I reviewed the changes and ran the relevant focused checks.
Checklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:and added!in case the PR includes breaking changes.