Returned future result in S3Transfer's download and upload#3316
Open
adamsc64 wants to merge 1 commit intoboto:developfrom
Open
Returned future result in S3Transfer's download and upload#3316adamsc64 wants to merge 1 commit intoboto:developfrom
adamsc64 wants to merge 1 commit intoboto:developfrom
Conversation
- Adds a `return` statement to S3Transfer's methods `upload_file()` and `download_file()`. - This gives them the same return behavior as `copy()`, `upload_fileobj()`, and `download_fileobj()` inside `s3/inject.py`. These functions return the value for their future objects. - Returning the value will allow integrations to access metadata returned by the service, such as the "ETag" for uploaded entities for example.
This was referenced Jun 27, 2022
Author
|
@jamesls Looking back in the history, I think this was your code originally, but I'm not sure. Can I get a review of this? Or feel free to let me know if you think someone else would be a better option. |
Author
|
Hi @timgates42. New contributor to boto here! Wondering what is the correct way to officially request a review of this by the boto team. Thanks! |
This file contains hidden or 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
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.
Summary of changes
returnstatement to S3Transfer's methodsupload_file()anddownload_file().copy(),upload_fileobj(), anddownload_fileobj()insides3/inject.py. These functions return the value for their future objects.Rationale
upload_file()andupload_fileobj()on a bucket object. For example, before the changes in this PR, in this case:respwasNone. This is in contrast toput_object(), which does return upload metadata.Caveats
s3transfer, namely this PR: Returned ETag for uploaded entities s3transfer#244. However, these two PRs can be independently merged and are not necessarily related. One might want to merge this PR even indepenently for the sake of ensuring consistent return behavior withcopy(),upload_fileobj(), anddownload_fileobj()insideinject.py.