fix: revise and rename is_etag_in_json(data) #483
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
product-auto-label
bot
added
the
api: storage
google-cla
bot
added
the
cla: yes
tritone
reviewed
Jun 29, 2021
tritone
approved these changes
Jul 9, 2021
google/cloud/storage/retry.py
Outdated
| pass | ||
| return False | ||
| :type data: dict or None | ||
| :param data: A dict containing the JSON body. If not passed, returns False. |
There was a problem hiding this comment.
Nit: I think we could be clearer that the dict represents the JSON body rather than containing it. Also, this is specifically intended for calls where metadata is sent in the request body.
It seems like it'd be better to actually just rename this function to is_etag_in_data but I guess technically this is part of the public surface of the library (even if we don't expect external callers to use it directly)?
There was a problem hiding this comment.
We could rename it and leave is_etag_in_json around as a backward-compatibility alias.
There was a problem hiding this comment.
Would it be something like this:
def is_etag_in_data(data):
"""Return True if an etag is contained in the request body.
:type data: dict or None
:param data: A dict representing the request JSON body. If not passed, returns False.
"""
return data is not None and "etag" in data
def is_etag_in_json(data):
"""
``is_etag_in_json`` is supported for backwards-compatibility reasons only;
please use ``is_etag_in_data`` instead.
"""
return is_etag_in_data(data)
tseaver
reviewed
Jul 9, 2021
tritone
approved these changes
Jul 9, 2021
cojenco
changed the title
cojenco
added a commit
to cojenco/python-storage
that referenced
this pull request
Oct 13, 2021
* fix: handle cases where data is a dict in is_etag_in_json(data) * address comments and accept proposed changes * revise is_etag_in_json to check dict data * revise docstring wording * revise docstrings * rename conditional predicate to is_etag_in_data
cojenco
added a commit
to cojenco/python-storage
that referenced
this pull request
Oct 13, 2021
* fix: handle cases where data is a dict in is_etag_in_json(data) * address comments and accept proposed changes * revise is_etag_in_json to check dict data * revise docstring wording * revise docstrings * rename conditional predicate to is_etag_in_data
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 PR revises and renames
retry.is_etag_in_json(data)to ensure that eTags are correctly captured and validated from the request body.retry.is_etag_in_json(data)toretry.is_etag_in_data(data). It returns a boolean whether or not anetagis contained in the request body.retry.is_etag_in_data(data)to reflect library use cases in whichdataisdictorNoneFixes #481 馃