feat: do another round of memory optimisations#316
Merged
Conversation
Contributor
Reviewer's GuideRefactors the JSON-to-XML serializer to stream UTF-8 bytes via a new _XMLWriter and append-style helpers instead of building large intermediate strings, applying this both to normal dicttoxml output and XPath 3.1 json-to-xml mode, and updates the architecture docs accordingly. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #316 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 6 6
Lines 569 609 +40
=========================================
+ Hits 569 609 +40
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. |
Contributor
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- The new streaming helpers (e.g.
_append_convert,_append_convert_dict,_append_convert_list,_append_xpath31) duplicate a lot of the branching and type-specific logic from the existingconvert_*functions; consider factoring shared cases into common helpers so the string-returning and streaming paths stay behaviorally aligned over time. - Several
_append_*helpers mutate theattrdict in place whenattr_typeis true (e.g.attr["type"] = ...in_append_dict2xml_strand_append_list2xml_str); if the sameattrinstance can be reused across calls, it may be safer to copy or construct a fresh dict before mutation to avoid subtle attribute leakage between elements.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The new streaming helpers (e.g. `_append_convert`, `_append_convert_dict`, `_append_convert_list`, `_append_xpath31`) duplicate a lot of the branching and type-specific logic from the existing `convert_*` functions; consider factoring shared cases into common helpers so the string-returning and streaming paths stay behaviorally aligned over time.
- Several `_append_*` helpers mutate the `attr` dict in place when `attr_type` is true (e.g. `attr["type"] = ...` in `_append_dict2xml_str` and `_append_list2xml_str`); if the same `attr` instance can be reused across calls, it may be safer to copy or construct a fresh dict before mutation to avoid subtle attribute leakage between elements.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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.
Summary by Sourcery
Stream XML serialization through a lightweight UTF-8 writer to reduce intermediate string allocations while preserving the public dicttoxml API.
New Features:
Enhancements: