Revise ArrangementMapping to fix RDF conversion#25
Merged
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #25 +/- ##
==========================================
+ Coverage 94.61% 94.66% +0.04%
==========================================
Files 15 15
Lines 1021 1030 +9
==========================================
+ Hits 966 975 +9
Misses 55 55 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
This pull request updates the way arrangements and their mount paths are represented and handled throughout the codebase and documentation. The main change is the replacement of the old
ArrangementRef(which paired arrangement IDs with optional paths) with a newArrangementBindingmodel that unambiguously ties an arrangement, its mount path, and the performance together. This affects the API, the JSON-LD serialization, and the test suite. The documentation and tests have been updated to reflect this new model and terminology.Key changes:
API and Model Updates
ArrangementRefwithArrangementBindingthroughout the codebase, updating all references, imports, and usage in the Python API and documentation. Now, arrangement references are represented as(arrangement_id, mount_path)tuples or asArrangementBindingobjects, ensuring a clear association between arrangements and their mount paths. [1] [2] [3] [4]add_performancemethod and related documentation to accept arrangements as either a string (no path) or a(id, path)tuple, with both single values and lists supported. [1] [2]JSON-LD Serialization and Data Structure
trov:ArrangementBindingobject, which includes the arrangement ID and an optionaltrov:boundTomount path, replacing the previous direct@idortrov:mountPathfields. [1] [2] [3] [4]Documentation and Terminology
ArrangementBinding. [1] [2] [3] [4]CLI and Internal Parsing
(id, path)tuples instead ofArrangementRefobjects, aligning with the new model and simplifying downstream handling.Test Suite
ArrangementBindingstructure and updated their expected outputs, ensuring comprehensive coverage of the new model and serialization format. [1] [2] [3] [4] [5] [6] [7] [8] [9]These changes provide a more robust and unambiguous way to associate arrangements with their mount paths in performances, improving both the internal model and external interoperability.