Skip to content

Commit 9b722e5

Browse files
tseavercojenco
tseaver
authored and
cojenco
committed
fix: apply idempotency policies for ACLs (googleapis#458)
* fix: use 'retry=None' as default for 'Client._put_resource' * fix: use 'retry=None' as default for 'Client._patch_resource' * fix: force 'retry=None' for 'ACL.{save,save_predefined,clear}' * fix: remove 'retry' arg from 'Bucket.make_public' * fix: remove 'retry' arg from 'Bucket.make_private' * fix: remove 'retry' arg from 'Blob.make_public' * fix: remove 'retry' arg from 'Blob.make_private' Per idempotency policy.
1 parent c319578 commit 9b722e5

File tree

8 files changed

+62
-174
lines changed

8 files changed

+62
-174
lines changed

‎google/cloud/storage/acl.py

Lines changed: 8 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -474,9 +474,7 @@ def reload(self, client=None, timeout=_DEFAULT_TIMEOUT, retry=DEFAULT_RETRY):
474474
for entry in found.get("items", ()):
475475
self.add_entity(self.entity_from_dict(entry))
476476

477-
def _save(
478-
self, acl, predefined, client, timeout=_DEFAULT_TIMEOUT, retry=DEFAULT_RETRY,
479-
):
477+
def _save(self, acl, predefined, client, timeout=_DEFAULT_TIMEOUT):
480478
"""Helper for :meth:`save` and :meth:`save_predefined`.
481479
482480
:type acl: :class:`google.cloud.storage.acl.ACL`, or a compatible list.
@@ -524,7 +522,7 @@ def _save(
524522
{self._URL_PATH_ELEM: list(acl)},
525523
query_params=query_params,
526524
timeout=timeout,
527-
retry=retry,
525+
retry=None,
528526
)
529527

530528
self.entities.clear()
@@ -534,9 +532,7 @@ def _save(
534532

535533
self.loaded = True
536534

537-
def save(
538-
self, acl=None, client=None, timeout=_DEFAULT_TIMEOUT, retry=DEFAULT_RETRY
539-
):
535+
def save(self, acl=None, client=None, timeout=_DEFAULT_TIMEOUT):
540536
"""Save this ACL for the current bucket.
541537
542538
If :attr:`user_project` is set, bills the API request to that project.
@@ -555,15 +551,6 @@ def save(
555551
556552
Can also be passed as a tuple (connect_timeout, read_timeout).
557553
See :meth:`requests.Session.request` documentation for details.
558-
559-
:type retry: :class:`~google.api_core.retry.Retry`
560-
:param retry: (Optional) How to retry the RPC.
561-
562-
A None value will disable retries.
563-
564-
A google.api_core.retry.Retry value will enable retries,
565-
and the object will define retriable response codes and errors
566-
and configure backoff and timeout options.
567554
"""
568555
if acl is None:
569556
acl = self
@@ -572,11 +559,9 @@ def save(
572559
save_to_backend = True
573560

574561
if save_to_backend:
575-
self._save(acl, None, client, timeout=timeout, retry=retry)
562+
self._save(acl, None, client, timeout=timeout)
576563

577-
def save_predefined(
578-
self, predefined, client=None, timeout=_DEFAULT_TIMEOUT, retry=DEFAULT_RETRY,
579-
):
564+
def save_predefined(self, predefined, client=None, timeout=_DEFAULT_TIMEOUT):
580565
"""Save this ACL for the current bucket using a predefined ACL.
581566
582567
If :attr:`user_project` is set, bills the API request to that project.
@@ -598,20 +583,11 @@ def save_predefined(
598583
599584
Can also be passed as a tuple (connect_timeout, read_timeout).
600585
See :meth:`requests.Session.request` documentation for details.
601-
602-
:type retry: :class:`~google.api_core.retry.Retry`
603-
:param retry: (Optional) How to retry the RPC.
604-
605-
A None value will disable retries.
606-
607-
A google.api_core.retry.Retry value will enable retries,
608-
and the object will define retriable response codes and errors
609-
and configure backoff and timeout options.
610586
"""
611587
predefined = self.validate_predefined(predefined)
612-
self._save(None, predefined, client, timeout=timeout, retry=retry)
588+
self._save(None, predefined, client, timeout=timeout)
613589

614-
def clear(self, client=None, timeout=_DEFAULT_TIMEOUT, retry=DEFAULT_RETRY):
590+
def clear(self, client=None, timeout=_DEFAULT_TIMEOUT):
615591
"""Remove all ACL entries.
616592
617593
If :attr:`user_project` is set, bills the API request to that project.
@@ -631,17 +607,8 @@ def clear(self, client=None, timeout=_DEFAULT_TIMEOUT, retry=DEFAULT_RETRY):
631607
632608
Can also be passed as a tuple (connect_timeout, read_timeout).
633609
See :meth:`requests.Session.request` documentation for details.
634-
635-
:type retry: :class:`~google.api_core.retry.Retry`
636-
:param retry: (Optional) How to retry the RPC.
637-
638-
A None value will disable retries.
639-
640-
A google.api_core.retry.Retry value will enable retries,
641-
and the object will define retriable response codes and errors
642-
and configure backoff and timeout options.
643610
"""
644-
self.save([], client=client, timeout=timeout, retry=retry)
611+
self.save([], client=client, timeout=timeout)
645612

646613

647614
class BucketACL(ACL):

‎google/cloud/storage/blob.py

Lines changed: 4 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2978,9 +2978,7 @@ def test_iam_permissions(
29782978

29792979
return resp.get("permissions", [])
29802980

2981-
def make_public(
2982-
self, client=None, timeout=_DEFAULT_TIMEOUT, retry=DEFAULT_RETRY,
2983-
):
2981+
def make_public(self, client=None, timeout=_DEFAULT_TIMEOUT):
29842982
"""Update blob's ACL, granting read access to anonymous users.
29852983
29862984
:type client: :class:`~google.cloud.storage.client.Client` or
@@ -2995,27 +2993,11 @@ def make_public(
29952993
29962994
Can also be passed as a tuple (connect_timeout, read_timeout).
29972995
See :meth:`requests.Session.request` documentation for details.
2998-
2999-
:type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy
3000-
:param retry: (Optional) How to retry the RPC. A None value will disable retries.
3001-
A google.api_core.retry.Retry value will enable retries, and the object will
3002-
define retriable response codes and errors and configure backoff and timeout options.
3003-
3004-
A google.cloud.storage.retry.ConditionalRetryPolicy value wraps a Retry object and
3005-
activates it only if certain conditions are met. This class exists to provide safe defaults
3006-
for RPC calls that are not technically safe to retry normally (due to potential data
3007-
duplication or other side-effects) but become safe to retry if a condition such as
3008-
if_metageneration_match is set.
3009-
3010-
See the retry.py source code and docstrings in this package (google.cloud.storage.retry) for
3011-
information on retry types and how to configure them.
30122996
"""
30132997
self.acl.all().grant_read()
3014-
self.acl.save(client=client, timeout=timeout, retry=retry)
2998+
self.acl.save(client=client, timeout=timeout)
30152999

3016-
def make_private(
3017-
self, client=None, timeout=_DEFAULT_TIMEOUT, retry=DEFAULT_RETRY,
3018-
):
3000+
def make_private(self, client=None, timeout=_DEFAULT_TIMEOUT):
30193001
"""Update blob's ACL, revoking read access for anonymous users.
30203002
30213003
:type client: :class:`~google.cloud.storage.client.Client` or
@@ -3030,23 +3012,9 @@ def make_private(
30303012
30313013
Can also be passed as a tuple (connect_timeout, read_timeout).
30323014
See :meth:`requests.Session.request` documentation for details.
3033-
3034-
:type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy
3035-
:param retry: (Optional) How to retry the RPC. A None value will disable retries.
3036-
A google.api_core.retry.Retry value will enable retries, and the object will
3037-
define retriable response codes and errors and configure backoff and timeout options.
3038-
3039-
A google.cloud.storage.retry.ConditionalRetryPolicy value wraps a Retry object and
3040-
activates it only if certain conditions are met. This class exists to provide safe defaults
3041-
for RPC calls that are not technically safe to retry normally (due to potential data
3042-
duplication or other side-effects) but become safe to retry if a condition such as
3043-
if_metageneration_match is set.
3044-
3045-
See the retry.py source code and docstrings in this package (google.cloud.storage.retry) for
3046-
information on retry types and how to configure them.
30473015
"""
30483016
self.acl.all().revoke_read()
3049-
self.acl.save(client=client, timeout=timeout, retry=retry)
3017+
self.acl.save(client=client, timeout=timeout)
30503018

30513019
def compose(
30523020
self,

‎google/cloud/storage/bucket.py

Lines changed: 7 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1996,7 +1996,7 @@ def copy_blob(
19961996
)
19971997

19981998
if not preserve_acl:
1999-
new_blob.acl.save(acl={}, client=client, timeout=timeout, retry=retry)
1999+
new_blob.acl.save(acl={}, client=client, timeout=timeout)
20002000

20012001
new_blob._set_properties(copy_result)
20022002
return new_blob
@@ -3021,12 +3021,7 @@ def test_iam_permissions(
30213021
return resp.get("permissions", [])
30223022

30233023
def make_public(
3024-
self,
3025-
recursive=False,
3026-
future=False,
3027-
client=None,
3028-
timeout=_DEFAULT_TIMEOUT,
3029-
retry=DEFAULT_RETRY,
3024+
self, recursive=False, future=False, client=None, timeout=_DEFAULT_TIMEOUT,
30303025
):
30313026
"""Update bucket's ACL, granting read access to anonymous users.
30323027
@@ -3050,20 +3045,6 @@ def make_public(
30503045
Can also be passed as a tuple (connect_timeout, read_timeout).
30513046
See :meth:`requests.Session.request` documentation for details.
30523047
3053-
:type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy
3054-
:param retry: (Optional) How to retry the RPC. A None value will disable retries.
3055-
A google.api_core.retry.Retry value will enable retries, and the object will
3056-
define retriable response codes and errors and configure backoff and timeout options.
3057-
3058-
A google.cloud.storage.retry.ConditionalRetryPolicy value wraps a Retry object and
3059-
activates it only if certain conditions are met. This class exists to provide safe defaults
3060-
for RPC calls that are not technically safe to retry normally (due to potential data
3061-
duplication or other side-effects) but become safe to retry if a condition such as
3062-
if_metageneration_match is set.
3063-
3064-
See the retry.py source code and docstrings in this package (google.cloud.storage.retry) for
3065-
information on retry types and how to configure them.
3066-
30673048
:raises ValueError:
30683049
If ``recursive`` is True, and the bucket contains more than 256
30693050
blobs. This is to prevent extremely long runtime of this
@@ -3073,7 +3054,7 @@ def make_public(
30733054
for each blob.
30743055
"""
30753056
self.acl.all().grant_read()
3076-
self.acl.save(client=client, timeout=timeout, retry=retry)
3057+
self.acl.save(client=client, timeout=timeout)
30773058

30783059
if future:
30793060
doa = self.default_object_acl
@@ -3089,7 +3070,6 @@ def make_public(
30893070
max_results=self._MAX_OBJECTS_FOR_ITERATION + 1,
30903071
client=client,
30913072
timeout=timeout,
3092-
retry=retry,
30933073
)
30943074
)
30953075
if len(blobs) > self._MAX_OBJECTS_FOR_ITERATION:
@@ -3104,15 +3084,10 @@ def make_public(
31043084

31053085
for blob in blobs:
31063086
blob.acl.all().grant_read()
3107-
blob.acl.save(client=client, timeout=timeout, retry=retry)
3087+
blob.acl.save(client=client, timeout=timeout)
31083088

31093089
def make_private(
3110-
self,
3111-
recursive=False,
3112-
future=False,
3113-
client=None,
3114-
timeout=_DEFAULT_TIMEOUT,
3115-
retry=DEFAULT_RETRY,
3090+
self, recursive=False, future=False, client=None, timeout=_DEFAULT_TIMEOUT,
31163091
):
31173092
"""Update bucket's ACL, revoking read access for anonymous users.
31183093
@@ -3137,20 +3112,6 @@ def make_private(
31373112
Can also be passed as a tuple (connect_timeout, read_timeout).
31383113
See :meth:`requests.Session.request` documentation for details.
31393114
3140-
:type retry: google.api_core.retry.Retry or google.cloud.storage.retry.ConditionalRetryPolicy
3141-
:param retry: (Optional) How to retry the RPC. A None value will disable retries.
3142-
A google.api_core.retry.Retry value will enable retries, and the object will
3143-
define retriable response codes and errors and configure backoff and timeout options.
3144-
3145-
A google.cloud.storage.retry.ConditionalRetryPolicy value wraps a Retry object and
3146-
activates it only if certain conditions are met. This class exists to provide safe defaults
3147-
for RPC calls that are not technically safe to retry normally (due to potential data
3148-
duplication or other side-effects) but become safe to retry if a condition such as
3149-
if_metageneration_match is set.
3150-
3151-
See the retry.py source code and docstrings in this package (google.cloud.storage.retry) for
3152-
information on retry types and how to configure them.
3153-
31543115
:raises ValueError:
31553116
If ``recursive`` is True, and the bucket contains more than 256
31563117
blobs. This is to prevent extremely long runtime of this
@@ -3160,7 +3121,7 @@ def make_private(
31603121
for each blob.
31613122
"""
31623123
self.acl.all().revoke_read()
3163-
self.acl.save(client=client, timeout=timeout, retry=retry)
3124+
self.acl.save(client=client, timeout=timeout)
31643125

31653126
if future:
31663127
doa = self.default_object_acl
@@ -3176,7 +3137,6 @@ def make_private(
31763137
max_results=self._MAX_OBJECTS_FOR_ITERATION + 1,
31773138
client=client,
31783139
timeout=timeout,
3179-
retry=retry,
31803140
)
31813141
)
31823142
if len(blobs) > self._MAX_OBJECTS_FOR_ITERATION:
@@ -3191,7 +3151,7 @@ def make_private(
31913151

31923152
for blob in blobs:
31933153
blob.acl.all().revoke_read()
3194-
blob.acl.save(client=client, timeout=timeout, retry=retry)
3154+
blob.acl.save(client=client, timeout=timeout)
31953155

31963156
def generate_upload_policy(self, conditions, expiration=None, client=None):
31973157
"""Create a signed upload policy for uploading objects.

‎google/cloud/storage/client.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -393,7 +393,7 @@ def _patch_resource(
393393
query_params=None,
394394
headers=None,
395395
timeout=_DEFAULT_TIMEOUT,
396-
retry=DEFAULT_RETRY,
396+
retry=None,
397397
_target_object=None,
398398
):
399399
"""Helper for bucket / blob methods making API 'PATCH' calls.
@@ -464,7 +464,7 @@ def _put_resource(
464464
query_params=None,
465465
headers=None,
466466
timeout=_DEFAULT_TIMEOUT,
467-
retry=DEFAULT_RETRY,
467+
retry=None,
468468
_target_object=None,
469469
):
470470
"""Helper for bucket / blob methods making API 'PUT' calls.

0 commit comments

Comments
 (0)