1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
|
"""A helper function that executes a series of List queries for many APIs."""
import copy
__all__ = [
'YieldFromList',
]
def YieldFromList(
service, request, limit=None, batch_size=100,
method='List', field='items'):
"""Make a series of List requests, keeping track of page tokens.
Args:
service: apitools_base.BaseApiService, A service with a .List() method.
request: protorpc.messages.Message, The request message corresponding to the
service's .List() method, with all the attributes populated except
the .maxResults and .pageToken attributes.
limit: int, The maximum number of requests to yield. None if all available
records should be yielded.
batch_size: int, The number of items to retrieve per request.
method: str, The name of the method used to fetch resources.
field: str, The field in the response that will be a list of items.
Yields:
protorpc.message.Message, The resources listed by the service.
"""
request = copy.deepcopy(request)
request.maxResults = batch_size
request.pageToken = None
while limit is None or limit:
response = getattr(service, method)(request)
for item in getattr(response, field):
yield item
if limit is None:
continue
limit -= 1
if not limit:
return
request.pageToken = response.nextPageToken
if not request.pageToken:
return
|
