Skip to content
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

Add metadata to get, fget and get_partial methods #522

Merged
merged 7 commits into from
May 14, 2017
Merged

Add metadata to get, fget and get_partial methods #522

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0e1618d
Add support for custom headers for get_object, fget_object and get_pa…
DrJackilD May 13, 2017
c3e0600
change signature for get_partial_object
DrJackilD May 13, 2017
4fc5e79
fix _get_parial_object call in get_object
DrJackilD May 13, 2017
217c447
add example of usage
DrJackilD May 13, 2017
f5f8708
move encryption example to examples/ instead of API.md
DrJackilD May 13, 2017
eb03b1b
change metadata description
DrJackilD May 13, 2017
e5399e7
change metadata argument in get/fget/get_partial to request_headers
DrJackilD May 14, 2017
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: 3 additions & 6 deletions minio/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -698,8 +698,7 @@ def fget_object(self, bucket_name, object_name, file_path, metadata=None):
:param bucket_name: Bucket to read object from.
:param object_name: Name of the object to read.
:param file_path: Local file path to save the object.
:param metadata: Any additional metadata to be uploaded along
with your GET request.
:param metadata: Any additional metadata to be added to GET request's headers.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO we should keep it as request headers, in put_object it is meant to be saved with the object. Here it is meant to be queried.. so it is better to named request_headers or req_headers makes the code more readable.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, agreed, I will rename it right now :)

"""
is_valid_bucket_name(bucket_name)
is_non_empty_string(object_name)
Expand Down Expand Up @@ -773,8 +772,7 @@ def get_object(self, bucket_name, object_name, metadata=None):

:param bucket_name: Bucket to read object from
:param object_name: Name of object to read
:param metadata: Any additional metadata to be uploaded along
with your GET request.
:param metadata: Any additional metadata to be added to GET request's headers.
:return: :class:`urllib3.response.HTTPResponse` object.

"""
Expand Down Expand Up @@ -802,12 +800,11 @@ def get_partial_object(self, bucket_name, object_name, offset=0, length=0, metad

:param bucket_name: Bucket to retrieve object from
:param object_name: Name of object to retrieve
:param metadata: Any additional metadata to be uploaded along
with your GET request.
:param offset: Optional offset to retrieve bytes from.
Must be >= 0.
:param length: Optional number of bytes to retrieve.
Must be an integer.
:param metadata: Any additional metadata to be added to GET request's headers.
:return: :class:`urllib3.response.HTTPResponse` object.

"""
Expand Down