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

Jump to bottom

feat: add if*generation*match support for Bucket.rename_blob() #141

Merged
merged 19 commits into from Jun 9, 2020
Merged

feat: add if*generation*match support for Bucket.rename_blob() #141

Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
3fa6245
feat: add ifMetageneration*Match support, pt1
May 1, 2020
4cbad43
fix unit tests, add test for helper
May 1, 2020
b905487
fix unit tests
May 1, 2020
ddecf53
add generation match args into more methods
May 1, 2020
74961fa
feat: add if*generation*Match support, pt2
May 4, 2020
7e08361
Lint fix.
May 4, 2020
6f9f910
delete "more than one set "checks
May 5, 2020
ff26d2f
del excess import
May 5, 2020
551df43
Merge branch 'metageneration_match_pt1' into metageneration_match_pt2
May 5, 2020
1f4d9c1
delete "more than one set" checks
May 5, 2020
0a34086
Merge branch 'master' into metageneration_match_pt1
frankyn May 5, 2020
e1b67b5
Merge branch 'master' into metageneration_match_pt1
May 12, 2020
bd5b54f
rename the helper; add error raising in case of wront parameters type
May 12, 2020
ea37318
Merge branch 'metageneration_match_pt2' into metageneration_match_pt1
May 12, 2020
9d19e15
Merge branch 'metageneration_match_pt1' of https://github.com/q-logic…
May 12, 2020
f978265
feat: add if*generation*match support for Bucket.rename_blob()
May 12, 2020
ac5bf41
Merge branch 'master' into blob_rename_generation_match
May 29, 2020
a5e34b0
erase resolving conflicts caused blank line
May 29, 2020
ffeb2f7
Merge branch 'master' into blob_rename_generation_match
frankyn Jun 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
99 changes: 95 additions & 4 deletions google/cloud/storage/bucket.py
View file
Open in desktop
Expand Up @@ -1666,7 +1666,21 @@ def copy_blob(
new_blob._set_properties(copy_result)
return new_blob

def rename_blob(self, blob, new_name, client=None, timeout=_DEFAULT_TIMEOUT):
def rename_blob(
self,
blob,
new_name,
client=None,
timeout=_DEFAULT_TIMEOUT,
if_generation_match=None,
if_generation_not_match=None,
if_metageneration_match=None,
if_metageneration_not_match=None,
if_source_generation_match=None,
if_source_generation_not_match=None,
if_source_metageneration_match=None,
if_source_metageneration_not_match=None,
):
"""Rename the given blob using copy and delete operations.

If :attr:`user_project` is set, bills the API request to that project.
Expand Down Expand Up @@ -1699,16 +1713,93 @@ def rename_blob(self, blob, new_name, client=None, timeout=_DEFAULT_TIMEOUT):
Can also be passed as a tuple (connect_timeout, read_timeout).
See :meth:`requests.Session.request` documentation for details.

:type if_generation_match: long
:param if_generation_match: (Optional) Makes the operation
conditional on whether the destination
object's current generation matches the
given value. Setting to 0 makes the
operation succeed only if there are no
live versions of the object.

:type if_generation_not_match: long
:param if_generation_not_match: (Optional) Makes the operation
conditional on whether the
destination object's current
generation does not match the given
value. If no live object exists,
the precondition fails. Setting to
0 makes the operation succeed only
if there is a live version
of the object.

:type if_metageneration_match: long
:param if_metageneration_match: (Optional) Makes the operation
conditional on whether the
destination object's current
metageneration matches the given
value.

:type if_metageneration_not_match: long
:param if_metageneration_not_match: (Optional) Makes the operation
conditional on whether the
destination object's current
metageneration does not match
the given value.

:type if_source_generation_match: long
:param if_source_generation_match: (Optional) Makes the operation
conditional on whether the source
object's generation matches the
given value.

:type if_source_generation_not_match: long
:param if_source_generation_not_match: (Optional) Makes the operation
conditional on whether the source
object's generation does not match
the given value.

:type if_source_metageneration_match: long
:param if_source_metageneration_match: (Optional) Makes the operation
conditional on whether the source
object's current metageneration
matches the given value.

:type if_source_metageneration_not_match: long
:param if_source_metageneration_not_match: (Optional) Makes the operation
conditional on whether the source
object's current metageneration
does not match the given value.

:rtype: :class:`Blob`
:returns: The newly-renamed blob.
"""
same_name = blob.name == new_name

new_blob = self.copy_blob(blob, self, new_name, client=client, timeout=timeout)
new_blob = self.copy_blob(
blob,
self,
new_name,
client=client,
timeout=timeout,
if_generation_match=if_generation_match,
if_generation_not_match=if_generation_not_match,
if_metageneration_match=if_metageneration_match,
if_metageneration_not_match=if_metageneration_not_match,
if_source_generation_match=if_source_generation_match,
if_source_generation_not_match=if_source_generation_not_match,
if_source_metageneration_match=if_source_metageneration_match,
if_source_metageneration_not_match=if_source_metageneration_not_match,
)

if not same_name:
blob.delete(client=client, timeout=timeout)

blob.delete(
client=client,
timeout=timeout,
if_generation_match=if_generation_match,
if_generation_not_match=if_generation_not_match,
if_metageneration_match=if_metageneration_match,
if_metageneration_not_match=if_metageneration_not_match,
)
return new_blob

@property
Expand Down
58 changes: 57 additions & 1 deletion tests/unit/test_bucket.py
View file
Open in desktop
Expand Up @@ -1426,7 +1426,63 @@ def test_rename_blob(self):
self.assertEqual(kw["query_params"], {})
self.assertEqual(kw["timeout"], 42)

blob.delete.assert_called_once_with(client=client, timeout=42)
blob.delete.assert_called_once_with(
client=client,
timeout=42,
if_generation_match=None,
if_generation_not_match=None,
if_metageneration_match=None,
if_metageneration_not_match=None,
)

def test_rename_blob_with_generation_match(self):
BUCKET_NAME = "BUCKET_NAME"
BLOB_NAME = "blob-name"
NEW_BLOB_NAME = "new-blob-name"
DATA = {"name": NEW_BLOB_NAME}
GENERATION_NUMBER = 6
METAGENERATION_NUMBER = 9

connection = _Connection(DATA)
client = _Client(connection)
bucket = self._make_one(client=client, name=BUCKET_NAME)
blob = self._make_blob(BUCKET_NAME, BLOB_NAME)

renamed_blob = bucket.rename_blob(
blob,
NEW_BLOB_NAME,
client=client,
timeout=42,
if_generation_match=GENERATION_NUMBER,
if_source_metageneration_not_match=METAGENERATION_NUMBER,
)

self.assertIs(renamed_blob.bucket, bucket)
self.assertEqual(renamed_blob.name, NEW_BLOB_NAME)

COPY_PATH = "/b/{}/o/{}/copyTo/b/{}/o/{}".format(
BUCKET_NAME, BLOB_NAME, BUCKET_NAME, NEW_BLOB_NAME
)
(kw,) = connection._requested
self.assertEqual(kw["method"], "POST")
self.assertEqual(kw["path"], COPY_PATH)
self.assertEqual(
kw["query_params"],
{
"ifGenerationMatch": GENERATION_NUMBER,
"ifSourceMetagenerationNotMatch": METAGENERATION_NUMBER,
},
)
self.assertEqual(kw["timeout"], 42)

blob.delete.assert_called_once_with(
client=client,
timeout=42,
if_generation_match=GENERATION_NUMBER,
if_generation_not_match=None,
if_metageneration_match=None,
if_metageneration_not_match=None,
)

def test_rename_blob_to_itself(self):
BUCKET_NAME = "BUCKET_NAME"
Expand Down