V2

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, InternalPager
+from .pager import Pager
 from .exceptions import NotSignedInError

tableauserverclient/server/endpoint/groups_endpoint.py

@@ -25,14 +25,14 @@ 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
+        from .. import Pager
         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))
+        # TODO should this be a list or a Pager directly?
+        all_users = list(Pager(lambda options: self._get_users_for_group(group_item, options), req_options))
+        group_item._set_users(all_users)
 
     def _get_users_for_group(self, group_item, req_options=None):
         url = "{0}/{1}/users".format(self.baseurl, group_item.id)

tableauserverclient/server/pager.py

@@ -8,8 +8,15 @@ class Pager(object):
     """
 
     def __init__(self, endpoint, request_opts=None):
-        self._endpoint = endpoint.get
+        if hasattr(endpoint, 'get'):
+            # The simpliest case is to take an Endpoint and call its get
+            self._endpoint = endpoint.get
+        else:
+            # but if they pass a callable then use that instead (used internally)
+            self._endpoint = endpoint
+
         self._options = request_opts
+        self._length = None
 
         # If we have options we could be starting on any page, backfill the count
         if self._options:
@@ -20,6 +27,7 @@ def __init__(self, endpoint, request_opts=None):
     def __iter__(self):
         # Fetch the first page
         current_item_list, last_pagination_item = self._endpoint(self._options)
+        self._length = int(last_pagination_item.total_available)
 
         # Get the rest on demand as a generator
         while self._count < last_pagination_item.total_available:
@@ -34,48 +42,18 @@ def __iter__(self):
                 # 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(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 __len__(self):
+        if not self._length:
+            # We have no length yet, so get the first page and then we'll know total size
+            # TODO This isn't needed if we convert to list
+            next(self.__iter__())
+            return self._length
+        return self._length
 
     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)
+        current_item_list, last_pagination_item = self._endpoint(opts)
         return current_item_list, last_pagination_item

test/test_group.py

@@ -55,10 +55,10 @@ def test_populate_users(self):
             m.get(self.baseurl + '/e7833b48-c6f7-47b5-a2a7-36e7dd232758/users', text=response_xml)
             single_group = TSC.GroupItem(name='Test Group')
             single_group._id = 'e7833b48-c6f7-47b5-a2a7-36e7dd232758'
-            pagination_item = self.server.groups.populate_users(single_group)
+            self.server.groups.populate_users(single_group)
+            user = list(single_group.users).pop()
 
-        self.assertEqual(1, pagination_item.total_available)
-        user = single_group.users.pop()
+        self.assertEqual(1, len(single_group.users))
         self.assertEqual('dd2239f6-ddf1-4107-981a-4cf94e415794', user.id)
         self.assertEqual('alice', user.name)
         self.assertEqual('Publisher', user.site_role)