annotation ID is now by default in long form #318
Merged
+454
−292
Conversation
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #318 +/- ##
===========================================
- Coverage 92.59% 87.74% -4.86%
===========================================
Files 10 13 +3
Lines 1405 1648 +243
===========================================
+ Hits 1301 1446 +145
- Misses 104 202 +98
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
keighrim
force-pushed
the
296-always-longid
branch
from
59695d8 to
3b23a17
Compare
keighrim
force-pushed
the
296-always-longid
branch
3 times, most recently
from
79241fb to
711bc35
Compare
- `Annotation.id` property now must be in the "long" form, providing better disambiguation.
- automatically generated IDs will be in the long form.
- old MMIF files (specver 1.0.x) are sill supported, as long as the ID ambiguity is reasonably "solvable" see `View._fix_old_short_ids()` methods.
- DEPRECATED `Annotation.long_id` getter/setter, and `Annotation._short_id` (private) getter/setter.
- `Mmif.__getitem__()` (`[]` indexing) no longer raises "ambiguous id" error.
- (possibly breakinig change) For dict-like sub-fields, behavior of `__getitem__()` and `get()` are updated for consistency with Python.
- When the key is not found, `get()` will return a default value (which is `None` by default), while `__getitem__` raises `KeyError`
- `Annotation` (search for explicit (in its own propoerties) prop key and implicit (in contains metadata) prop key)
- `AnnotationProperties` (straightforwardly search for prop key)
- `View` (straightforwardly search for top-level field names, or ID in `annotations`)
- `Mmif` (search for top-level field names, or for ID in `documents`, `views`, all `views[].annotations`)
- DEPRECATED `get_X-by_id()` methods, `[]` indexing method should be enough
- Simplified `Annotation.parent` getter, DEPRECATED its setter (no longer keep them in memory as ID string can serve the purpose)
- Additional validations in place
- When an annotation is added to a view, its ID is validated against view ID (check if correctly prefixed)
- When a view is added to a mmif, its ID is checked for existing duplicates
- Updated test cases to handle the change in ID (or marked skip if not properly manageable)
keighrim
force-pushed
the
296-always-longid
branch
from
711bc35 to
d814030
Compare
Merged
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.
fixes #296