Added ItemSearch.item_collection #277
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
Adds an ItemSearch.item_collection method as a replacement for the deprecated `get_all_items()`. A few other notes: 1. I haven't implemented any of the `max_items` changes being worked out in stac-utils#237. That can be done before / after this PR once things are ironed out 2. I changed the `get_all_items` method to use Sphinx's builtin `deprecated` directive. 3. I updated the tests (a bit) I'd like to enable pytest's `-W error` flag to fail on warnings. But it looks like the `cli` is using the (deprecated) `get_all_items_as_dict` method. I haven't touched that in this PR, but I don't think the CLI should be using a deprecated function.
|
cc @philvarner, @gadomski |
TomAugspurger
commented
Jul 27, 2022
philvarner
approved these changes
Jul 28, 2022
|
Hmm, I just noticed that there was already an What are people's thoughts on method names that differ by only the trailing |
TomAugspurger
pushed a commit
to TomAugspurger/pystac-client
that referenced
this pull request
Jul 28, 2022
Followup to stac-utils#277 and closes stac-utils#279 the `cli.search` and `get_all_items()` / `item_collection()` were using this deprecated method. Users using non-deprecated APIs shouldn't be getting deprecation warnings. Clearly it's useful, so let's either un-deprecate it or move the implementaiton to a private method and call that directly. I've chosen to un-deprecate it. I've also configured pytest to fail on warnings, to catch this type of issue in CI.
This was referenced Jul 28, 2022
gadomski
added a commit
that referenced
this pull request
Aug 8, 2022
* Un-deprecate get_all_items_as_dict Followup to #277 and closes #279 the `cli.search` and `get_all_items()` / `item_collection()` were using this deprecated method. Users using non-deprecated APIs shouldn't be getting deprecation warnings. Clearly it's useful, so let's either un-deprecate it or move the implementaiton to a private method and call that directly. I've chosen to un-deprecate it. I've also configured pytest to fail on warnings, to catch this type of issue in CI. * Implement the new result methods * docstring * cleanup * Fixup * typo * table * Added a table * updated for signing * Updated recording * Apply suggestions from code review Co-authored-by: Pete Gadomski <[email protected]> Co-authored-by: Pete Gadomski <[email protected]>
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.
Description:
Adds an ItemSearch.item_collection method as a replacement for
the deprecated
get_all_items().A few other notes:
max_itemschanges being workedout in Replacement functionality for get_all_items #237. That
can be done before / after this PR once things are ironed out
get_all_itemsmethod to use Sphinx's builtindeprecateddirective.I'd like to enable pytest's
-W errorflag to fail on warnings. Butit looks like the
cliis using the (deprecated)get_all_items_as_dictmethod. I haven't touched that in this PR, but I don't think the CLI
should be using a deprecated function.
PR Checklist: