René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Storage: Bucket.list_blobs(max_results=n) does not behave as documented","articleBody":"The `max_results` parameter of `list_blobs()` is documented as controlling the maximum number of blobs returned in each page of results, but actually limits the total number of results as the name implies.\r\n\r\nCompare the `Bucket.list_blobs()` documentation:\r\nhttps://googleapis.dev/python/storage/latest/buckets.html#google.cloud.storage.bucket.Bucket.list_blobs\r\n\u003e max_results (int) – The maximum number of blobs in each page of results from this request. Non-positive values are ignored. Defaults to a sensible value set by the API.\r\n\r\nWith the `Iterator` documentation:\r\nhttps://googleapis.dev/python/google-api-core/latest/page_iterator.html#google.api_core.page_iterator.Iterator\r\n\u003e max_results (int) – The maximum number of results to fetch.\r\n\r\nAlso the implementation of `HTTPIterator` which is used by `list_blobs()` internally does treat `max_results` as a hard limit for total `num_results`:\r\nhttps://github.com/googleapis/google-cloud-python/blob/master/api_core/google/api_core/page_iterator.py#L378\r\n\r\n#### Code example\r\n\r\n```python\r\niterator = some_big_bucket.list_blobs(max_results=100)\r\nassert len(list(iterator)) \u003e 100  # throws\r\nassert sum(len(list(page)) for page in iterator.pages) \u003e 100  # throws\r\n```\r\n\r\n#### Suggested resolution\r\n\r\nChange the documentation to match what the parameter actually does. If supplying a paging size is required, a new argument to `HTTPIterator` could be added and exposed up through the `list_blobs()` interface.","author":{"url":"https://github.com/bz2","@type":"Person","name":"bz2"},"datePublished":"2020-01-02T16:34:29.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":1},"url":"https://github.com/19/python-storage/issues/19"}