Skip to content

Commit f52efc8

Browse files
Gurov Ilyafrankyn
Gurov Ilya
and
frankyn
authored
feat: add if*generation*match support for Bucket.rename_blob() (#141)
* feat: add ifMetageneration*Match support, pt1 * fix unit tests, add test for helper * fix unit tests * add generation match args into more methods * feat: add if*generation*Match support, pt2 * Lint fix. * delete "more than one set "checks * del excess import * delete "more than one set" checks * rename the helper; add error raising in case of wront parameters type * feat: add if*generation*match support for Bucket.rename_blob() * erase resolving conflicts caused blank line Co-authored-by: Frank Natividad <[email protected]>
1 parent dc01c59 commit f52efc8

File tree

2 files changed

+152
-5
lines changed

2 files changed

+152
-5
lines changed

‎google/cloud/storage/bucket.py‎

Lines changed: 95 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1666,7 +1666,21 @@ def copy_blob(
16661666
new_blob._set_properties(copy_result)
16671667
return new_blob
16681668

1669-
def rename_blob(self, blob, new_name, client=None, timeout=_DEFAULT_TIMEOUT):
1669+
def rename_blob(
1670+
self,
1671+
blob,
1672+
new_name,
1673+
client=None,
1674+
timeout=_DEFAULT_TIMEOUT,
1675+
if_generation_match=None,
1676+
if_generation_not_match=None,
1677+
if_metageneration_match=None,
1678+
if_metageneration_not_match=None,
1679+
if_source_generation_match=None,
1680+
if_source_generation_not_match=None,
1681+
if_source_metageneration_match=None,
1682+
if_source_metageneration_not_match=None,
1683+
):
16701684
"""Rename the given blob using copy and delete operations.
16711685
16721686
If :attr:`user_project` is set, bills the API request to that project.
@@ -1699,16 +1713,93 @@ def rename_blob(self, blob, new_name, client=None, timeout=_DEFAULT_TIMEOUT):
16991713
Can also be passed as a tuple (connect_timeout, read_timeout).
17001714
See :meth:`requests.Session.request` documentation for details.
17011715
1716+
:type if_generation_match: long
1717+
:param if_generation_match: (Optional) Makes the operation
1718+
conditional on whether the destination
1719+
object's current generation matches the
1720+
given value. Setting to 0 makes the
1721+
operation succeed only if there are no
1722+
live versions of the object.
1723+
1724+
:type if_generation_not_match: long
1725+
:param if_generation_not_match: (Optional) Makes the operation
1726+
conditional on whether the
1727+
destination object's current
1728+
generation does not match the given
1729+
value. If no live object exists,
1730+
the precondition fails. Setting to
1731+
0 makes the operation succeed only
1732+
if there is a live version
1733+
of the object.
1734+
1735+
:type if_metageneration_match: long
1736+
:param if_metageneration_match: (Optional) Makes the operation
1737+
conditional on whether the
1738+
destination object's current
1739+
metageneration matches the given
1740+
value.
1741+
1742+
:type if_metageneration_not_match: long
1743+
:param if_metageneration_not_match: (Optional) Makes the operation
1744+
conditional on whether the
1745+
destination object's current
1746+
metageneration does not match
1747+
the given value.
1748+
1749+
:type if_source_generation_match: long
1750+
:param if_source_generation_match: (Optional) Makes the operation
1751+
conditional on whether the source
1752+
object's generation matches the
1753+
given value.
1754+
1755+
:type if_source_generation_not_match: long
1756+
:param if_source_generation_not_match: (Optional) Makes the operation
1757+
conditional on whether the source
1758+
object's generation does not match
1759+
the given value.
1760+
1761+
:type if_source_metageneration_match: long
1762+
:param if_source_metageneration_match: (Optional) Makes the operation
1763+
conditional on whether the source
1764+
object's current metageneration
1765+
matches the given value.
1766+
1767+
:type if_source_metageneration_not_match: long
1768+
:param if_source_metageneration_not_match: (Optional) Makes the operation
1769+
conditional on whether the source
1770+
object's current metageneration
1771+
does not match the given value.
1772+
17021773
:rtype: :class:`Blob`
17031774
:returns: The newly-renamed blob.
17041775
"""
17051776
same_name = blob.name == new_name
17061777

1707-
new_blob = self.copy_blob(blob, self, new_name, client=client, timeout=timeout)
1778+
new_blob = self.copy_blob(
1779+
blob,
1780+
self,
1781+
new_name,
1782+
client=client,
1783+
timeout=timeout,
1784+
if_generation_match=if_generation_match,
1785+
if_generation_not_match=if_generation_not_match,
1786+
if_metageneration_match=if_metageneration_match,
1787+
if_metageneration_not_match=if_metageneration_not_match,
1788+
if_source_generation_match=if_source_generation_match,
1789+
if_source_generation_not_match=if_source_generation_not_match,
1790+
if_source_metageneration_match=if_source_metageneration_match,
1791+
if_source_metageneration_not_match=if_source_metageneration_not_match,
1792+
)
17081793

17091794
if not same_name:
1710-
blob.delete(client=client, timeout=timeout)
1711-
1795+
blob.delete(
1796+
client=client,
1797+
timeout=timeout,
1798+
if_generation_match=if_generation_match,
1799+
if_generation_not_match=if_generation_not_match,
1800+
if_metageneration_match=if_metageneration_match,
1801+
if_metageneration_not_match=if_metageneration_not_match,
1802+
)
17121803
return new_blob
17131804

17141805
@property

‎tests/unit/test_bucket.py‎

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1426,7 +1426,63 @@ def test_rename_blob(self):
14261426
self.assertEqual(kw["query_params"], {})
14271427
self.assertEqual(kw["timeout"], 42)
14281428

1429-
blob.delete.assert_called_once_with(client=client, timeout=42)
1429+
blob.delete.assert_called_once_with(
1430+
client=client,
1431+
timeout=42,
1432+
if_generation_match=None,
1433+
if_generation_not_match=None,
1434+
if_metageneration_match=None,
1435+
if_metageneration_not_match=None,
1436+
)
1437+
1438+
def test_rename_blob_with_generation_match(self):
1439+
BUCKET_NAME = "BUCKET_NAME"
1440+
BLOB_NAME = "blob-name"
1441+
NEW_BLOB_NAME = "new-blob-name"
1442+
DATA = {"name": NEW_BLOB_NAME}
1443+
GENERATION_NUMBER = 6
1444+
METAGENERATION_NUMBER = 9
1445+
1446+
connection = _Connection(DATA)
1447+
client = _Client(connection)
1448+
bucket = self._make_one(client=client, name=BUCKET_NAME)
1449+
blob = self._make_blob(BUCKET_NAME, BLOB_NAME)
1450+
1451+
renamed_blob = bucket.rename_blob(
1452+
blob,
1453+
NEW_BLOB_NAME,
1454+
client=client,
1455+
timeout=42,
1456+
if_generation_match=GENERATION_NUMBER,
1457+
if_source_metageneration_not_match=METAGENERATION_NUMBER,
1458+
)
1459+
1460+
self.assertIs(renamed_blob.bucket, bucket)
1461+
self.assertEqual(renamed_blob.name, NEW_BLOB_NAME)
1462+
1463+
COPY_PATH = "/b/{}/o/{}/copyTo/b/{}/o/{}".format(
1464+
BUCKET_NAME, BLOB_NAME, BUCKET_NAME, NEW_BLOB_NAME
1465+
)
1466+
(kw,) = connection._requested
1467+
self.assertEqual(kw["method"], "POST")
1468+
self.assertEqual(kw["path"], COPY_PATH)
1469+
self.assertEqual(
1470+
kw["query_params"],
1471+
{
1472+
"ifGenerationMatch": GENERATION_NUMBER,
1473+
"ifSourceMetagenerationNotMatch": METAGENERATION_NUMBER,
1474+
},
1475+
)
1476+
self.assertEqual(kw["timeout"], 42)
1477+
1478+
blob.delete.assert_called_once_with(
1479+
client=client,
1480+
timeout=42,
1481+
if_generation_match=GENERATION_NUMBER,
1482+
if_generation_not_match=None,
1483+
if_metageneration_match=None,
1484+
if_metageneration_not_match=None,
1485+
)
14301486

14311487
def test_rename_blob_to_itself(self):
14321488
BUCKET_NAME = "BUCKET_NAME"

0 commit comments

Comments
 (0)