First run at internal pager

Author: t8y8

tableauserverclient/server/__init__.py

@@ -8,5 +8,5 @@
 from .endpoint import Auth, Datasources, Endpoint, Groups, Projects, Schedules, \
     Sites, Users, Views, Workbooks, ServerResponseError, MissingRequiredFieldError
 from .server import Server
-from .pager import Pager
+from .pager import Pager, InternalPager
 from .exceptions import NotSignedInError

tableauserverclient/server/endpoint/groups_endpoint.py

@@ -25,15 +25,22 @@ def get(self, req_options=None):
     # Gets all users in a given group
     @api(version="2.0")
     def populate_users(self, group_item, req_options=None):
+        from .. import InternalPager
         if not group_item.id:
             error = "Group item missing ID. Group must be retrieved from server first."
             raise MissingRequiredFieldError(error)
+
+        all_users = InternalPager(self._get_users_for_group, group_item, request_opts=req_options)
+
+        group_item._set_users(list(all_users))
+
+    def _get_users_for_group(self, group_item, req_options=None):
         url = "{0}/{1}/users".format(self.baseurl, group_item.id)
         server_response = self.get_request(url, req_options)
-        group_item._set_users(UserItem.from_response(server_response.content))
+        user_item = UserItem.from_response(server_response.content)
         pagination_item = PaginationItem.from_response(server_response.content)
         logger.info('Populated users for group (ID: {0})'.format(group_item.id))
-        return pagination_item
+        return user_item, pagination_item
 
     # Deletes 1 group by id
     @api(version="2.0")

tableauserverclient/server/pager.py

@@ -41,3 +41,41 @@ def _load_next_page(self, last_pagination_item):
             opts.sort, opts.filter = self._options.sort, self._options.filter
         current_item_list, last_pagination_item = self._endpoint(opts)
         return current_item_list, last_pagination_item
+
+class InternalPager(object):
+
+    def __init__(self, caller, *args, request_opts=None, **kwargs):
+        self._endpoint = caller
+        self._options = request_opts
+        self._funcargs = args
+        self._kwargs = kwargs
+        # If we have options we could be starting on any page, backfill the count
+        if self._options:
+            self._count = ((self._options.pagenumber - 1) * self._options.pagesize)
+        else:
+            self._count = 0
+
+    def __iter__(self):
+        # Fetch the first page
+        current_item_list, last_pagination_item = self._endpoint(*self._funcargs, **self._kwargs, req_options=self._options)
+
+        # Get the rest on demand as a generator
+        while self._count < last_pagination_item.total_available:
+            if len(current_item_list) == 0:
+                current_item_list, last_pagination_item = self._load_next_page(last_pagination_item)
+
+            try:
+                yield current_item_list.pop(0)
+                self._count += 1
+
+            except IndexError:
+                # The total count on Server changed while fetching exit gracefully
+                raise StopIteration
+
+    def _load_next_page(self, last_pagination_item):
+        next_page = last_pagination_item.page_number + 1
+        opts = RequestOptions(pagenumber=next_page, pagesize=last_pagination_item.page_size)
+        if self._options is not None:
+            opts.sort, opts.filter = self._options.sort, self._options.filter
+        current_item_list, last_pagination_item = self._endpoint(*self._funcargs, **self._kwargs, req_options=opts)
+        return current_item_list, last_pagination_item