Default layout strategy for catalogs #1295
Merged
Conversation
This file contains 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
5 tasks
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #1295 +/- ##
==========================================
+ Coverage 91.12% 91.15% +0.03%
==========================================
Files 51 51
Lines 6994 7002 +8
Branches 1001 1002 +1
==========================================
+ Hits 6373 6383 +10
Misses 444 444
+ Partials 177 175 -2 ☔ View full report in Codecov by Sentry. |
jsignell
reviewed
Jan 9, 2024
docs/concepts.rst
Outdated
|
|
||
| catalog = Catalog(..., | ||
| href="/some/location/catalog.json", | ||
| layout_strategy=custom_strategy) |
There was a problem hiding this comment.
In other places we just call this kwarg strategy - did that feel too opaque?
pystac/catalog.py
Outdated
| @@ -167,6 +171,9 @@ class Catalog(STACObject): | |||
| a canonical format. | |||
| """ | |||
|
|
|||
| _layout_strategy: HrefLayoutStrategy = BestPracticesLayoutStrategy() | |||
There was a problem hiding this comment.
So the idea is that pystac will be able to override this in the Client class?
There was a problem hiding this comment.
Yes, correct. For example, the pystac_client.Client could set the fallback strategy to APILayoutStrategy
|
Thanks for the review, I updated the argument name. |
jsignell
reviewed
Jan 10, 2024
| if root.strategy is not None: | ||
| return root.strategy | ||
| else: | ||
| return root._fallback_strategy |
There was a problem hiding this comment.
I think this rename is a lot clearer too 👍
jsignell
approved these changes
Jan 10, 2024
3 tasks
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.
Related Issue(s):
Description:
This PR enables setting a default layout strategy for a catalog. Users can either set the default layout strategy
when instantiating the catalog or defining a fall back strategy when subclassing Catalog.
Together with #1294, this PR is part of setting the foundation for enabling API transactions using
pystac-client.PR Checklist:
pre-commithooks pass locallyscripts/test)