fix: set unknown size to sys.maxsize

jorwoods · jorwoods · commit b0840b6e83ca · 2024-09-19T03:57:05.000-05:00
Users may length check a QuerySet as part of a normal workflow. A len of
0 would be misleading, indicating to the user that there are no matches
for the endpoint and/or filters they supplied. __len__ must return a
non-negative int. Sentinel values such as -1 or None do not work. This
only leaves maxsize as the possible flag.
diff --git a/tableauserverclient/server/query.py b/tableauserverclient/server/query.py
@@ -48,8 +48,9 @@ class QuerySet(Iterable[T], Sized):
     QuerySet is needed. The length of the QuerySet is the total number of items
     available in the QuerySet, not just the number of items that have been
     fetched. If the endpoint does not return a total count of items, the length
-    of the QuerySet will be None. If there is no total count, the QuerySet will
-    continue to fetch items until there are no more items to fetch.
+    of the QuerySet will be sys.maxsize. If there is no total count, the
+    QuerySet will continue to fetch items until there are no more items to
+    fetch.
 
     QuerySet is not re-entrant. It is not designed to be used in multiple places
     at the same time. If you need to use a QuerySet in multiple places, you
@@ -158,7 +159,7 @@ def _fetch_all(self: Self) -> None:
                 self._pagination_item = PaginationItem()
 
     def __len__(self: Self) -> int:
-        return self.total_available or 0
+        return self.total_available or sys.maxsize
 
     @property
     def total_available(self: Self) -> int:
diff --git a/test/test_flowruns.py b/test/test_flowruns.py
@@ -1,3 +1,4 @@
+import sys
 import unittest
 import xml.etree.ElementTree as ET
 
@@ -121,4 +122,4 @@ def test_queryset(self) -> None:
             m.get(f"{self.baseurl}?pageNumber=1", text=response_xml)
             m.get(f"{self.baseurl}?pageNumber=2", text=error_response)
             queryset = self.server.flow_runs.all()
-            assert len(queryset) == 0
+            assert len(queryset) == sys.maxsize
