Skip to content

Updated docstrings: added clarification about Fileobj close behaviour #3968

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Updated docstrings: added clarification about Fileobj close behaviour #3968

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions boto3/s3/inject.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -599,7 +599,8 @@ def upload_fileobj(

:type Fileobj: a file-like object
:param Fileobj: A file-like object to upload. At a minimum, it must
implement the `read` method, and must return bytes.
implement the `read` method, and must return bytes. This object will
have the `close` method called on it.

:type Bucket: str
:param Bucket: The name of the bucket to upload to.
Expand Down Expand Up @@ -663,7 +664,8 @@ def bucket_upload_fileobj(

:type Fileobj: a file-like object
:param Fileobj: A file-like object to upload. At a minimum, it must
implement the `read` method, and must return bytes.
implement the `read` method, and must return bytes. This object will
have the `close` method called on it.

:type Key: str
:param Key: The name of the key to upload to.
Expand Down Expand Up @@ -713,7 +715,8 @@ def object_upload_fileobj(

:type Fileobj: a file-like object
:param Fileobj: A file-like object to upload. At a minimum, it must
implement the `read` method, and must return bytes.
implement the `read` method, and must return bytes. This object will
have the `close` method called on it.

:type ExtraArgs: dict
:param ExtraArgs: Extra arguments that may be passed to the
Expand Down