Improve support for Transfer filter params
#484
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
This started from the fact that `task_list` was missing first-class
support for `filter`. Users would have to pass it via `query_params`
previously.
However, after clearing up some confusion about how to write a filter
string, it seems that we could provide a better interface for passing
these filters. Rather than an elaborate new ``TransferFilterDict``
object -- a briefly considered approach -- this adds support for
passing a dict of strings or string lists. Lists get comma-separated,
strings get passed unmodified.
The resulting semantics allow for usages like
tc.task_list(filter={"task_id": [...]})
tc.operation_ls(filter={"type": "file"})
which are relatively intuitive to read and are handled correctly by
the SDK for the user.
A new test for task_list exercises the various filter behaviors (and,
NB, relies a little on cpython 3.6+ having order-preserving dicts).
sirosen
force-pushed
the
better-transfer-filters
branch
from
162e620 to
24373e5
Compare
aaschaer
approved these changes
Oct 12, 2021
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 started from the fact that
task_listwas missing first-class support forfilter. Users would have to pass it viaquery_paramspreviously.However, after clearing up some confusion about how to write a filter string, it seems that we could provide a better interface for passing these filters. Rather than an elaborate new
TransferFilterDictobject -- a briefly considered approach -- this adds support for passing a dict of strings or string lists. Lists get comma-separated, strings get passed unmodified.The resulting semantics allow for usages like
which are relatively intuitive to read and are handled correctly by the SDK for the user.
A new test for task_list exercises the various filter behaviors (and, NB, relies a little on cpython 3.6+ having order-preserving dicts).