Add google-endpoints to third_party/.

third_party/google-endpoints/apitools/base/py/list_pager.py

+#!/usr/bin/env python
+#
+# Copyright 2015 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""A helper function that executes a series of List queries for many APIs."""
+
+from apitools.base.py import encoding
+
+__all__ = [
+    'YieldFromList',
+]
+
+
+def YieldFromList(
+        service, request, global_params=None, limit=None, batch_size=100,
+        method='List', field='items', predicate=None,
+        current_token_attribute='pageToken',
+        next_token_attribute='nextPageToken',
+        batch_size_attribute='maxResults'):
+    """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.
+      global_params: protorpc.messages.Message, The global query parameters to
+           provide when calling the given method.
+      limit: int, The maximum number of records 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.
+      predicate: lambda, A function that returns true for items to be yielded.
+      current_token_attribute: str, The name of the attribute in a
+          request message holding the page token for the page being
+          requested.
+      next_token_attribute: str, The name of the attribute in a
+          response message holding the page token for the next page.
+      batch_size_attribute: str, The name of the attribute in a
+          response message holding the maximum number of results to be
+          returned.
+
+    Yields:
+      protorpc.message.Message, The resources listed by the service.
+
+    """
+    request = encoding.CopyProtoMessage(request)
+    setattr(request, batch_size_attribute, batch_size)
+    setattr(request, current_token_attribute, None)
+    while limit is None or limit:
+        response = getattr(service, method)(request,
+                                            global_params=global_params)
+        items = getattr(response, field)
+        if predicate:
+            items = list(filter(predicate, items))
+        for item in items:
+            yield item
+            if limit is None:
+                continue
+            limit -= 1
+            if not limit:
+                return
+        token = getattr(response, next_token_attribute)
+        if not token:
+            return
+        setattr(request, current_token_attribute, token)