Skip to content

Fix #162: Document semantics of upload to existing key. #327

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

Merged
tseaver merged 1 commit into from
Nov 3, 2014
Merged

Fix #162: Document semantics of upload to existing key. #327

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
36 changes: 36 additions & 0 deletions gcloud/storage/key.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,18 @@ def upload_from_file(self, file_obj, rewind=False, size=None,
content_type=None):
"""Upload the contents of this key from a file-like object.

.. note::

The effect of uploading to an existing key depends on the
"versioning" and "lifecycle" policies defined on the key's
bucket. In the absence of those policies, upload will
overwrite any existing contents.

See the `object versioning
<https://cloud.google.com/storage/docs/object-versioning>`_ and
`lifecycle <https://cloud.google.com/storage/docs/lifecycle>`_
API documents for details.

:type file_obj: file
:param file_obj: A file handle open for reading.

Expand Down Expand Up @@ -276,6 +288,18 @@ def upload_from_file(self, file_obj, rewind=False, size=None,
def upload_from_filename(self, filename):
"""Upload this key's contents from the content of f named file.

.. note::

The effect of uploading to an existing key depends on the
"versioning" and "lifecycle" policies defined on the key's
bucket. In the absence of those policies, upload will
overwrite any existing contents.

See the `object versioning
<https://cloud.google.com/storage/docs/object-versioning>`_ and
`lifecycle <https://cloud.google.com/storage/docs/lifecycle>`_
API documents for details.

:type filename: string
:param filename: The path to the file.
"""
Expand All @@ -290,6 +314,18 @@ def upload_from_filename(self, filename):
def upload_from_string(self, data, content_type='text/plain'):
"""Upload contents of this key from the provided string.

.. note::

The effect of uploading to an existing key depends on the
"versioning" and "lifecycle" policies defined on the key's
bucket. In the absence of those policies, upload will
overwrite any existing contents.

See the `object versioning
<https://cloud.google.com/storage/docs/object-versioning>`_ and
`lifecycle <https://cloud.google.com/storage/docs/lifecycle>`_
API documents for details.

:type data: string
:param data: The data to store in this key.

Expand Down