8000 fix: Pager typing by jorwoods · Pull Request #1449 · tableau/server-client-python · GitHub
[go: up one dir, main page]
Skip to content

fix: Pager typing #1449

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 2, 2024
Merged

fix: Pager typing #1449

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7dc5ad4
fix: Pager typing
jorwoods Aug 27, 2024
a7b5e2c
fix: python3.8 syntax
jorwoods Aug 27, 2024
bb4ba5a
Merge branch 'development' into jorwoods/fix_pager_typing
jacalata Sep 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions tableauserverclient/server/pager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
import copy
from functools import partial
from typing import Generic, Iterable, Iterator, List, Optional, Protocol, Tuple, TypeVar, Union, runtime_checkable
from typing import Iterable, Iterator, List, Optional, Protocol, Tuple, TypeVar, Union, runtime_checkable

from tableauserverclient.models.pagination_item import PaginationItem
from tableauserverclient.server.request_options import RequestOptions


T = TypeVar("T")
ReturnType = Tuple[List[T], PaginationItem]


@runtime_checkable
class Endpoint(Protocol):
def get(self, req_options: Optional[RequestOptions], **kwargs) -> ReturnType:
class Endpoint(Protocol[T]):
def get(self, req_options: Optional[RequestOptions]) -> Tuple[List[T], PaginationItem]:
...


@runtime_checkable
class CallableEndpoint(Protocol):
def __call__(self, __req_options: Optional[RequestOptions], **kwargs) -> ReturnType:
class CallableEndpoint(Protocol[T]):
def __call__(self, __req_options: Optional[RequestOptions], **kwargs) -> Tuple[List[T], PaginationItem]:
...


Expand All @@ -33,7 +32,7 @@ class Pager(Iterable[T]):

def __init__(
self,
endpoint: Union[CallableEndpoint, Endpoint],
endpoint: Union[CallableEndpoint[T], Endpoint[T]],
request_opts: Optional[RequestOptions] = None,
**kwargs,
) -> None:
Expand Down
17 changes: 13 additions & 4 deletions test/test_pager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

TEST_ASSET_DIR = os.path.join(os.path.dirname(__file__), "assets")

GET_VIEW_XML = os.path.join(TEST_ASSET_DIR, "view_get.xml")
GET_XML_PAGE1 = os.path.join(TEST_ASSET_DIR, "workbook_get_page_1.xml")
GET_XML_PAGE2 = os.path.join(TEST_ASSET_DIR, "workbook_get_page_2.xml")
GET_XML_PAGE3 = os.path.join(TEST_ASSET_DIR, "workbook_get_page_3.xml")
Expand All @@ -35,7 +36,7 @@ def setUp(self):

self.baseurl = self.server.workbooks.baseurl

def test_pager_with_no_options(self):
def test_pager_with_no_options(self) -> None:
with open(GET_XML_PAGE1, "rb") as f:
page_1 = f.read().decode("utf-8")
with open(GET_XML_PAGE2, "rb") as f:
Expand All @@ -61,7 +62,7 @@ def test_pager_with_no_options(self):
self.assertEqual(wb2.name, "Page2Workbook")
self.assertEqual(wb3.name, "Page3Workbook")

def test_pager_with_options(self):
def test_pager_with_options(self) -> None:
with open(GET_XML_PAGE1, "rb") as f:
page_1 = f.read().decode("utf-8")
with open(GET_XML_PAGE2, "rb") as f:
Expand Down Expand Up @@ -102,14 +103,22 @@ def test_pager_with_options(self):
wb3 = workbooks.pop()
self.assertEqual(wb3.name, "Page3Workbook")

def test_pager_with_env_var(self):
def test_pager_with_env_var(self) -> None:
with set_env(TSC_PAGE_SIZE="1000"):
assert config.PAGE_SIZE == 1000
loop = TSC.Pager(self.server.workbooks)
assert loop._options.pagesize == 1000

def test_queryset_with_env_var(self):
def test_queryset_with_env_var(self) -> None:
with set_env(TSC_PAGE_SIZE="1000"):
assert config.PAGE_SIZE == 1000
loop = self.server.workbooks.all()
assert loop.request_options.pagesize == 1000

def test_pager_view(self) -> None:
with open(GET_VIEW_XML, "rb") as f:
view_xml = f.read().decode("utf-8")
with requests_mock.mock() as m:
m.get(self.server.views.baseurl, text=view_xml)
for view in TSC.Pager(self.server.views):
assert view.name is not None
Loading
0