Allow resolved self links #555
Conversation
When getting a STAC object's self href, there was a cast that assumed that the object's self link's target was a string, which was not always the case (the self link's target could be a string or another STAC object). This commit removes that cast by splitting a link's target into two separate "private" attributes, `_target_href` and `_target_object`. Fixes #499.
|
What is the situation that causes a STACObject's self link to be a STACObject itself? Should it be the case that a STACObject's self link is either set to a href, or None? Having a resolved self link seems like it's a bit recursive, and I'm unclear there'd be any benefit to having a self link with the target as an object or if there's any potential issues that might arise by allowing that (which we do now, but perhaps mistakenly?) If we shouldn't block self links from being resolved, then I'm +1 on this change. |
I ran into it when naively resolving all links as a part of validation: https://github.com/stac-utils/stactools/pull/151/files#diff-209f36e38a8b60f0a8a376a7bf6b1d00f00885b56aff923de59cacaa73b552c8R66-R75.
Yup, this would be another way to solve the problem. Policing it might be a bit trickier (put Zooming out to how links work, it seems strange (to me at least) to "erase" the href information when resolving a link: Line 227 in e4059c8 This PR keeps the href information after resolution, which could theoretically be useful for debugging or some other use case down the road? |
pystac/link.py
Outdated
| self._target_object = target | ||
|
|
||
| def get_target_str(self) -> Optional[str]: | ||
| """Returns this link's target as a string.""" |
There was a problem hiding this comment.
Perhaps this should be worded differently - if you create a Link with the target that is a STACObject, this would imply to me that it would return the str representation of the link, i.e. call get_self_href on the target; it doesn't and would return None.
Or perhaps this should, and if _target_href is None and there's a _target_object, to return _target_object.get_self_href?
There was a problem hiding this comment.
Implemented in 3561a5c. I think someone could infinitely recurse themselves if they created a self link with only a target object (no string href) but that'd be a weird thing to do.
There was a problem hiding this comment.
Added recursion check in 21feb88.
Codecov Report
@@ Coverage Diff @@
## main #555 +/- ##
========================================
Coverage 94.35% 94.35%
========================================
Files 71 71
Lines 10409 10649 +240
Branches 1089 1099 +10
========================================
+ Hits 9821 10048 +227
- Misses 419 427 +8
- Partials 169 174 +5
Continue to review full report at Codecov.
|
Related Issue(s): #499.
Description: When getting a STAC object's self href, there was a cast that assumed that the object's self link's target was a string, which was not always the case (the self link's target could be a string or another STAC object). This commit removes that cast by splitting a link's target into two separate "private" attributes,
_target_hrefand_target_object.PR Checklist:
pre-commit run --all-files)scripts/test)