Feature/ensure in list#38
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds an idempotent “ensure present” list operation to yamltrip’s Document API (immutable) and Editor API (mutable), enabling users to append items only when missing, with optional dict-item matching via a where filter.
Changes:
- Implement
Document.ensure_in_list(..., value, where=None)with no-op-if-present semantics and path-missing list creation. - Add
Editor.ensure_in_list(...)as a thin delegating wrapper. - Add README examples plus new unit tests covering scalar,
wherematching, path creation, flow sequences, and error cases.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tests/test_editor.py | Adds editor-level tests for ensure_in_list behavior and delegation. |
| tests/test_document.py | Adds document-level coverage for ensure_in_list semantics and edge cases. |
| src/yamltrip/editor.py | Exposes ensure_in_list on Editor by delegating to Document. |
| src/yamltrip/document.py | Implements ensure_in_list using existing query/upsert/append primitives. |
| README.md | Documents the new API with scalar and where examples. |
| doc/specs/2026-05-22-ensure-in-list-design.md | Adds a design/spec document for the new operation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
nathanjmcdougall
force-pushed
the
feature/ensure-in-list
branch
from
f09b2a1 to
cc0e9b0
Compare
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.