feat: support page_size in bucket.list_blobs (#1275)

googleapis · May 17, 2024 · c52e882 · c52e882
1 parent 4db96c9
commit c52e882
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/google/cloud/storage/bucket.py b/google/cloud/storage/bucket.py
@@ -1308,6 +1308,7 @@ def list_blobs(
         match_glob=None,
         include_folders_as_prefixes=None,
         soft_deleted=None,
+        page_size=None,
     ):
         """Return an iterator used to find blobs in the bucket.
 
@@ -1401,6 +1402,11 @@ def list_blobs(
             Note ``soft_deleted`` and ``versions`` cannot be set to True simultaneously. See:
             https://cloud.google.com/storage/docs/soft-delete
 
+        :type page_size: int
+        :param page_size:
+            (Optional) Maximum number of blobs to return in each page.
+            Defaults to a value set by the API.
+
         :rtype: :class:`~google.api_core.page_iterator.Iterator`
         :returns: Iterator of all :class:`~google.cloud.storage.blob.Blob`
                   in this bucket matching the arguments.
@@ -1418,6 +1424,7 @@ def list_blobs(
             versions=versions,
             projection=projection,
             fields=fields,
+            page_size=page_size,
             timeout=timeout,
             retry=retry,
             match_glob=match_glob,

diff --git a/tests/unit/test_bucket.py b/tests/unit/test_bucket.py
@@ -1179,6 +1179,7 @@ def test_list_blobs_w_defaults(self):
         expected_fields = None
         expected_include_folders_as_prefixes = None
         soft_deleted = None
+        page_size = None
         client.list_blobs.assert_called_once_with(
             bucket,
             max_results=expected_max_results,
@@ -1196,6 +1197,7 @@ def test_list_blobs_w_defaults(self):
             match_glob=expected_match_glob,
             include_folders_as_prefixes=expected_include_folders_as_prefixes,
             soft_deleted=soft_deleted,
+            page_size=page_size,
         )
 
     def test_list_blobs_w_explicit(self):
@@ -1211,6 +1213,7 @@ def test_list_blobs_w_explicit(self):
         include_folders_as_prefixes = True
         versions = True
         soft_deleted = True
+        page_size = 2
         projection = "full"
         fields = "items/contentLanguage,nextPageToken"
         bucket = self._make_one(client=None, name=name)
@@ -1236,6 +1239,7 @@ def test_list_blobs_w_explicit(self):
             match_glob=match_glob,
             include_folders_as_prefixes=include_folders_as_prefixes,
             soft_deleted=soft_deleted,
+            page_size=page_size,
         )
 
         self.assertIs(iterator, other_client.list_blobs.return_value)
@@ -1253,6 +1257,7 @@ def test_list_blobs_w_explicit(self):
         expected_fields = fields
         expected_include_folders_as_prefixes = include_folders_as_prefixes
         expected_soft_deleted = soft_deleted
+        expected_page_size = page_size
         other_client.list_blobs.assert_called_once_with(
             bucket,
             max_results=expected_max_results,
@@ -1270,6 +1275,7 @@ def test_list_blobs_w_explicit(self):
             match_glob=expected_match_glob,
             include_folders_as_prefixes=expected_include_folders_as_prefixes,
             soft_deleted=expected_soft_deleted,
+            page_size=expected_page_size,
         )
 
     def test_list_notifications_w_defaults(self):