Skip to content

Commit b91e57d

Browse files
andrewsgandrewsg
authored
fix: Amend default retry behavior for bucket operations on client (#358)
* fix: Amend default retry behavior for bucket operations on client * Amend default for blob/bucket get and exist methods * fix tests for new behavior
1 parent 6d5a667 commit b91e57d

File tree

6 files changed

+84
-14
lines changed

6 files changed

+84
-14
lines changed

‎google/cloud/storage/blob.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -597,7 +597,7 @@ def exists(
597597
if_generation_not_match=None,
598598
if_metageneration_match=None,
599599
if_metageneration_not_match=None,
600-
retry=DEFAULT_RETRY_IF_GENERATION_SPECIFIED,
600+
retry=DEFAULT_RETRY,
601601
):
602602
"""Determines whether or not this blob exists.
603603

‎google/cloud/storage/bucket.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -723,7 +723,7 @@ def exists(
723723
timeout=_DEFAULT_TIMEOUT,
724724
if_metageneration_match=None,
725725
if_metageneration_not_match=None,
726-
retry=DEFAULT_RETRY_IF_METAGENERATION_SPECIFIED,
726+
retry=DEFAULT_RETRY,
727727
):
728728
"""Determines whether or not this bucket exists.
729729
@@ -1108,7 +1108,7 @@ def get_blob(
11081108
if_generation_not_match=None,
11091109
if_metageneration_match=None,
11101110
if_metageneration_not_match=None,
1111-
retry=DEFAULT_RETRY_IF_METAGENERATION_SPECIFIED,
1111+
retry=DEFAULT_RETRY,
11121112
**kwargs
11131113
):
11141114
"""Get a blob object by name.

‎google/cloud/storage/client.py‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@
5252
from google.cloud.storage.acl import DefaultObjectACL
5353
from google.cloud.storage.constants import _DEFAULT_TIMEOUT
5454
from google.cloud.storage.retry import DEFAULT_RETRY
55-
from google.cloud.storage.retry import DEFAULT_RETRY_IF_METAGENERATION_SPECIFIED
5655

5756

5857
_marker = object()
@@ -320,7 +319,7 @@ def get_bucket(
320319
timeout=_DEFAULT_TIMEOUT,
321320
if_metageneration_match=None,
322321
if_metageneration_not_match=None,
323-
retry=DEFAULT_RETRY_IF_METAGENERATION_SPECIFIED,
322+
retry=DEFAULT_RETRY,
324323
):
325324
"""API call: retrieve a bucket via a GET request.
326325
@@ -407,7 +406,7 @@ def lookup_bucket(
407406
timeout=_DEFAULT_TIMEOUT,
408407
if_metageneration_match=None,
409408
if_metageneration_not_match=None,
410-
retry=DEFAULT_RETRY_IF_METAGENERATION_SPECIFIED,
409+
retry=DEFAULT_RETRY,
411410
):
412411
"""Get a bucket by name, returning None if not found.
413412
@@ -865,7 +864,7 @@ def list_blobs(
865864

866865
path = bucket.path + "/o"
867866
api_request = functools.partial(
868-
self._connection.api_request, timeout=timeout, retry=DEFAULT_RETRY
867+
self._connection.api_request, timeout=timeout, retry=retry
869868
)
870869
iterator = page_iterator.HTTPIterator(
871870
client=self,

‎tests/unit/test_blob.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -669,7 +669,7 @@ def test_exists_miss(self):
669669
"query_params": {"fields": "name"},
670670
"_target_object": None,
671671
"timeout": 42,
672-
"retry": DEFAULT_RETRY_IF_GENERATION_SPECIFIED,
672+
"retry": DEFAULT_RETRY,
673673
},
674674
)
675675

@@ -692,7 +692,7 @@ def test_exists_hit_w_user_project(self):
692692
"query_params": {"fields": "name", "userProject": USER_PROJECT},
693693
"_target_object": None,
694694
"timeout": self._get_default_timeout(),
695-
"retry": DEFAULT_RETRY_IF_GENERATION_SPECIFIED,
695+
"retry": DEFAULT_RETRY,
696696
},
697697
)
698698

@@ -715,7 +715,7 @@ def test_exists_hit_w_generation(self):
715715
"query_params": {"fields": "name", "generation": GENERATION},
716716
"_target_object": None,
717717
"timeout": self._get_default_timeout(),
718-
"retry": DEFAULT_RETRY_IF_GENERATION_SPECIFIED,
718+
"retry": DEFAULT_RETRY,
719719
},
720720
)
721721

@@ -749,7 +749,7 @@ def test_exists_w_generation_match(self):
749749
},
750750
"_target_object": None,
751751
"timeout": self._get_default_timeout(),
752-
"retry": DEFAULT_RETRY_IF_GENERATION_SPECIFIED,
752+
"retry": DEFAULT_RETRY,
753753
},
754754
)
755755

‎tests/unit/test_bucket.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -672,7 +672,7 @@ def api_request(cls, *args, **kwargs):
672672
"query_params": {"fields": "name"},
673673
"_target_object": None,
674674
"timeout": 42,
675-
"retry": DEFAULT_RETRY_IF_METAGENERATION_SPECIFIED,
675+
"retry": DEFAULT_RETRY,
676676
}
677677
expected_cw = [((), expected_called_kwargs)]
678678
self.assertEqual(_FakeConnection._called_with, expected_cw)
@@ -707,7 +707,7 @@ def api_request(cls, *args, **kwargs):
707707
},
708708
"_target_object": None,
709709
"timeout": 42,
710-
"retry": DEFAULT_RETRY_IF_METAGENERATION_SPECIFIED,
710+
"retry": DEFAULT_RETRY,
711711
}
712712
expected_cw = [((), expected_called_kwargs)]
713713
self.assertEqual(_FakeConnection._called_with, expected_cw)
@@ -735,7 +735,7 @@ def api_request(cls, *args, **kwargs):
735735
"query_params": {"fields": "name", "userProject": USER_PROJECT},
736736
"_target_object": None,
737737
"timeout": self._get_default_timeout(),
738-
"retry": DEFAULT_RETRY_IF_METAGENERATION_SPECIFIED,
738+
"retry": DEFAULT_RETRY,
739739
}
740740
expected_cw = [((), expected_called_kwargs)]
741741
self.assertEqual(_FakeConnection._called_with, expected_cw)

‎tests/unit/test_client.py‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -562,6 +562,54 @@ def test_get_bucket_with_object_hit(self):
562562
parms = dict(urlparse.parse_qsl(qs))
563563
self.assertEqual(parms["projection"], "noAcl")
564564

565+
def test_get_bucket_default_retry(self):
566+
from google.cloud.storage.bucket import Bucket
567+
from google.cloud.storage._http import Connection
568+
569+
PROJECT = "PROJECT"
570+
CREDENTIALS = _make_credentials()
571+
client = self._make_one(project=PROJECT, credentials=CREDENTIALS)
572+
573+
bucket_name = "bucket-name"
574+
bucket_obj = Bucket(client, bucket_name)
575+
576+
with mock.patch.object(Connection, "api_request") as req:
577+
client.get_bucket(bucket_obj)
578+
579+
req.assert_called_once_with(
580+
method="GET",
581+
path=mock.ANY,
582+
query_params=mock.ANY,
583+
headers=mock.ANY,
584+
_target_object=bucket_obj,
585+
timeout=mock.ANY,
586+
retry=DEFAULT_RETRY,
587+
)
588+
589+
def test_get_bucket_respects_retry_override(self):
590+
from google.cloud.storage.bucket import Bucket
591+
from google.cloud.storage._http import Connection
592+
593+
PROJECT = "PROJECT"
594+
CREDENTIALS = _make_credentials()
595+
client = self._make_one(project=PROJECT, credentials=CREDENTIALS)
596+
597+
bucket_name = "bucket-name"
598+
bucket_obj = Bucket(client, bucket_name)
599+
600+
with mock.patch.object(Connection, "api_request") as req:
601+
client.get_bucket(bucket_obj, retry=None)
602+
603+
req.assert_called_once_with(
604+
method="GET",
605+
path=mock.ANY,
606+
query_params=mock.ANY,
607+
headers=mock.ANY,
608+
_target_object=bucket_obj,
609+
timeout=mock.ANY,
610+
retry=None,
611+
)
612+
565613
def test_lookup_bucket_miss(self):
566614
PROJECT = "PROJECT"
567615
CREDENTIALS = _make_credentials()
@@ -658,6 +706,29 @@ def test_lookup_bucket_with_metageneration_match(self):
658706
self.assertEqual(parms["projection"], "noAcl")
659707
self.assertEqual(parms["ifMetagenerationMatch"], str(METAGENERATION_NUMBER))
660708

709+
def test_lookup_bucket_default_retry(self):
710+
from google.cloud.storage.bucket import Bucket
711+
from google.cloud.storage._http import Connection
712+
713+
PROJECT = "PROJECT"
714+
CREDENTIALS = _make_credentials()
715+
client = self._make_one(project=PROJECT, credentials=CREDENTIALS)
716+
717+
bucket_name = "bucket-name"
718+
bucket_obj = Bucket(client, bucket_name)
719+
720+
with mock.patch.object(Connection, "api_request") as req:
721+
client.lookup_bucket(bucket_obj)
722+
req.assert_called_once_with(
723+
method="GET",
724+
path=mock.ANY,
725+
query_params=mock.ANY,
726+
headers=mock.ANY,
727+
_target_object=bucket_obj,
728+
timeout=mock.ANY,
729+
retry=DEFAULT_RETRY,
730+
)
731+
661732
def test_create_bucket_w_missing_client_project(self):
662733
credentials = _make_credentials()
663734
client = self._make_one(project=None, credentials=credentials)

0 commit comments

Comments
 (0)