34 support upsert into empty documents without sentinel workaround#35
Merged
nathanjmcdougall merged 10 commits intoMay 21, 2026
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds first-class support for mutating “empty” YAML documents (no root data node) so that structure-creating operations (upsert, add, and therefore sync) can bootstrap a root mapping without requiring a sentinel workaround (Issue #34).
Changes:
- Extend
Document.add()/Document.upsert()to detect empty documents and bootstrap root mappings when creating new paths. - Introduce a new native helper
_core.serialize_value()(Rust → Python) to serialize Python values to YAML for bootstrapping. - Add test coverage for mutations and error cases on empty / whitespace-only / comment-only documents, plus a design spec describing the approach.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_document.py | Adds tests for upsert/add/sync behavior on empty documents and verifies expected errors. |
| src/yamltrip/document.py | Implements empty-document detection and bootstrapping logic for add()/upsert(). |
| src/yamltrip/_core.pyi | Updates native module stubs to expose serialize_value. |
| src/lib.rs | Exposes serialize_value from the Rust _core module to Python. |
| src/convert.rs | Implements serialize_value using existing Python→YAML conversion + serde_yaml. |
| doc/specs/2026-05-22-empty-document-mutations-design.md | Documents the design/behavior for empty-document mutations (Issue #34). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
No description provided.