feat: views support all fields

Author: jorwoods

tableauserverclient/__init__.py

@@ -25,6 +25,7 @@
     LinkedTaskItem,
     LinkedTaskStepItem,
     LinkedTaskFlowRunItem,
+    LocationItem,
     MetricItem,
     MonthlyInterval,
     PaginationItem,
@@ -100,6 +101,7 @@
     "LinkedTaskFlowRunItem",
     "LinkedTaskItem",
     "LinkedTaskStepItem",
+    "LocationItem",
     "MetricItem",
     "MissingRequiredFieldError",
     "MonthlyInterval",

tableauserverclient/models/__init__.py

@@ -28,6 +28,7 @@
     LinkedTaskStepItem,
     LinkedTaskFlowRunItem,
 )
+from tableauserverclient.models.location_item import LocationItem
 from tableauserverclient.models.metric_item import MetricItem
 from tableauserverclient.models.pagination_item import PaginationItem
 from tableauserverclient.models.permissions_item import PermissionsRule, Permission
@@ -75,6 +76,7 @@
     "MonthlyInterval",
     "HourlyInterval",
     "BackgroundJobItem",
+    "LocationItem",
     "MetricItem",
     "PaginationItem",
     "Permission",

tableauserverclient/models/user_item.py

@@ -249,6 +249,12 @@ def from_response_as_owner(cls, resp, ns) -> list["UserItem"]:
         element_name = ".//t:owner"
         return cls._parse_xml(element_name, resp, ns)
 
+    @classmethod
+    def from_xml(cls, xml: ET.Element, ns: Optional[dict] = None) -> "UserItem":
+        item = cls()
+        item._set_values(*cls._parse_element(xml, ns))
+        return item
+
     @classmethod
     def _parse_xml(cls, element_name, resp, ns):
         all_user_items = []

tableauserverclient/models/view_item.py

@@ -1,15 +1,21 @@
 import copy
 from datetime import datetime
 from requests import Response
-from typing import Callable, Optional
+from typing import TYPE_CHECKING, Callable, Optional, overload
 from collections.abc import Iterator
 
 from defusedxml.ElementTree import fromstring
 
 from tableauserverclient.datetime_helpers import parse_datetime
 from tableauserverclient.models.exceptions import UnpopulatedPropertyError
+from tableauserverclient.models.location_item import LocationItem
 from tableauserverclient.models.permissions_item import PermissionsRule
+from tableauserverclient.models.project_item import ProjectItem
 from tableauserverclient.models.tag_item import TagItem
+from tableauserverclient.models.user_item import UserItem
+
+if TYPE_CHECKING:
+    from tableauserverclient.models.workbook_item import WorkbookItem
 
 
 class ViewItem:
@@ -84,11 +90,18 @@ def __init__(self) -> None:
         self._workbook_id: Optional[str] = None
         self._permissions: Optional[Callable[[], list[PermissionsRule]]] = None
         self.tags: set[str] = set()
+        self._favorites_total: Optional[int] = None
+        self._view_url_name: Optional[str] = None
         self._data_acceleration_config = {
             "acceleration_enabled": None,
             "acceleration_status": None,
         }
 
+        self._owner: Optional[UserItem] = None
+        self._project: Optional[ProjectItem] = None
+        self._workbook: Optional["WorkbookItem"] = None
+        self._location: Optional[LocationItem] = None
+
     def __str__(self):
         return "<ViewItem {} '{}' contentUrl='{}' project={}>".format(
             self._id, self.name, self.content_url, self.project_id
@@ -190,6 +203,14 @@ def updated_at(self) -> Optional[datetime]:
     def workbook_id(self) -> Optional[str]:
         return self._workbook_id
 
+    @property
+    def view_url_name(self) -> Optional[str]:
+        return self._view_url_name
+
+    @property
+    def favorites_total(self) -> Optional[int]:
+        return self._favorites_total
+
     @property
     def data_acceleration_config(self):
         return self._data_acceleration_config
@@ -198,6 +219,22 @@ def data_acceleration_config(self):
     def data_acceleration_config(self, value):
         self._data_acceleration_config = value
 
+    @property
+    def project(self) -> Optional["ProjectItem"]:
+        return self._project
+
+    @property
+    def workbook(self) -> Optional["WorkbookItem"]:
+        return self._workbook
+
+    @property
+    def owner(self) -> Optional[UserItem]:
+        return self._owner
+
+    @property
+    def location(self) -> Optional[LocationItem]:
+        return self._location
+
     @property
     def permissions(self) -> list[PermissionsRule]:
         if self._permissions is None:
@@ -228,30 +265,43 @@ def from_xml(cls, view_xml, ns, workbook_id="") -> "ViewItem":
         workbook_elem = view_xml.find(".//t:workbook", namespaces=ns)
         owner_elem = view_xml.find(".//t:owner", namespaces=ns)
         project_elem = view_xml.find(".//t:project", namespaces=ns)
-        tags_elem = view_xml.find(".//t:tags", namespaces=ns)
+        tags_elem = view_xml.find("./t:tags", namespaces=ns)
         data_acceleration_config_elem = view_xml.find(".//t:dataAccelerationConfig", namespaces=ns)
         view_item._created_at = parse_datetime(view_xml.get("createdAt", None))
         view_item._updated_at = parse_datetime(view_xml.get("updatedAt", None))
         view_item._id = view_xml.get("id", None)
         view_item._name = view_xml.get("name", None)
         view_item._content_url = view_xml.get("contentUrl", None)
         view_item._sheet_type = view_xml.get("sheetType", None)
+        view_item._favorites_total = string_to_int(view_xml.get("favoritesTotal", None))
+        view_item._view_url_name = view_xml.get("viewUrlName", None)
         if usage_elem is not None:
             total_view = usage_elem.get("totalViewCount", None)
             if total_view:
                 view_item._total_views = int(total_view)
         if owner_elem is not None:
+            user = UserItem.from_xml(owner_elem, ns)
+            view_item._owner = user
             view_item._owner_id = owner_elem.get("id", None)
         if project_elem is not None:
-            view_item._project_id = project_elem.get("id", None)
+            project_item = ProjectItem.from_xml(project_elem, ns)
+            view_item._project = project_item
+            view_item._project_id = project_item.id
         if workbook_id:
             view_item._workbook_id = workbook_id
         elif workbook_elem is not None:
-            view_item._workbook_id = workbook_elem.get("id", None)
+            from tableauserverclient.models.workbook_item import WorkbookItem
+
+            workbook_item = WorkbookItem.from_xml(workbook_elem, ns)
+            view_item._workbook = workbook_item
+            view_item._workbook_id = workbook_item.id
         if tags_elem is not None:
             tags = TagItem.from_xml_element(tags_elem, ns)
             view_item.tags = tags
             view_item._initial_tags = copy.copy(tags)
+        if (location_elem := view_xml.find(".//t:location", namespaces=ns)) is not None:
+            location = LocationItem.from_xml(location_elem, ns)
+            view_item._location = location
         if data_acceleration_config_elem is not None:
             data_acceleration_config = parse_data_acceleration_config(data_acceleration_config_elem)
             view_item.data_acceleration_config = data_acceleration_config
@@ -274,3 +324,15 @@ def parse_data_acceleration_config(data_acceleration_elem):
 
 def string_to_bool(s: str) -> bool:
     return s.lower() == "true"
+
+
+@overload
+def string_to_int(s: None) -> None: ...
+
+
+@overload
+def string_to_int(s: str) -> int: ...
+
+
+def string_to_int(s):
+    return int(s) if s is not None else None

tableauserverclient/models/workbook_item.py

@@ -2,7 +2,7 @@
 import datetime
 import uuid
 import xml.etree.ElementTree as ET
-from typing import Callable, Optional
+from typing import Callable, Optional, overload
 
 from defusedxml.ElementTree import fromstring
 
@@ -139,6 +139,8 @@ def __init__(
         self._permissions = None
         self.thumbnails_user_id = thumbnails_user_id
         self.thumbnails_group_id = thumbnails_group_id
+        self._sheet_count: Optional[int] = None
+        self._has_extracts: Optional[bool] = None
 
         return None
 
@@ -234,6 +236,14 @@ def show_tabs(self, value: bool):
     def size(self):
         return self._size
 
+    @property
+    def sheet_count(self) -> Optional[int]:
+        return self._sheet_count
+
+    @property
+    def has_extracts(self) -> Optional[bool]:
+        return self._has_extracts
+
     @property
     def updated_at(self) -> Optional[datetime.datetime]:
         return self._updated_at
@@ -342,6 +352,8 @@ def _parse_common_tags(self, workbook_xml, ns):
                 views,
                 data_acceleration_config,
                 data_freshness_policy,
+                sheet_count,
+                has_extracts,
             ) = self._parse_element(workbook_xml, ns)
 
             self._set_values(
@@ -361,6 +373,8 @@ def _parse_common_tags(self, workbook_xml, ns):
                 views,
                 data_acceleration_config,
                 data_freshness_policy,
+                sheet_count,
+                has_extracts,
             )
 
         return self
@@ -383,6 +397,8 @@ def _set_values(
         views,
         data_acceleration_config,
         data_freshness_policy,
+        sheet_count,
+        has_extracts,
     ):
         if id is not None:
             self._id = id
@@ -417,6 +433,10 @@ def _set_values(
             self.data_acceleration_config = data_acceleration_config
         if data_freshness_policy is not None:
             self.data_freshness_policy = data_freshness_policy
+        if sheet_count is not None:
+            self._sheet_count = sheet_count
+        if has_extracts is not None:
+            self._has_extracts = has_extracts
 
     @classmethod
     def from_response(cls, resp: str, ns: dict[str, str]) -> list["WorkbookItem"]:
@@ -443,6 +463,8 @@ def _parse_element(workbook_xml, ns):
         created_at = parse_datetime(workbook_xml.get("createdAt", None))
         description = workbook_xml.get("description", None)
         updated_at = parse_datetime(workbook_xml.get("updatedAt", None))
+        sheet_count = string_to_int(workbook_xml.get("sheetCount", None))
+        has_extracts = string_to_bool(workbook_xml.get("hasExtracts", ""))
 
         size = workbook_xml.get("size", None)
         if size:
@@ -505,6 +527,8 @@ def _parse_element(workbook_xml, ns):
             views,
             data_acceleration_config,
             data_freshness_policy,
+            sheet_count,
+            has_extracts,
         )
 
 
@@ -535,3 +559,15 @@ def parse_data_acceleration_config(data_acceleration_elem):
 # Used to convert string represented boolean to a boolean type
 def string_to_bool(s: str) -> bool:
     return s.lower() == "true"
+
+
+@overload
+def string_to_int(s: None) -> None: ...
+
+
+@overload
+def string_to_int(s: str) -> int: ...
+
+
+def string_to_int(s):
+    return int(s) if s is not None else None

test/assets/view_get_all_fields.xml

@@ -0,0 +1,35 @@
+<ns0:tsResponse xmlns:ns0="http://tableau.com/api" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://tableau.com/api https://help.tableau.com/samples/en-us/rest_api/ts-api_3_25.xsd">
+  <ns0:pagination pageNumber="1" pageSize="100" totalAvailable="40" />
+  <ns0:views>
+    <ns0:view id="2bdcd787-dcc6-4a5d-bc61-2846f1ef4534" name="Overview" contentUrl="Superstore/sheets/Overview" createdAt="2024-02-14T04:42:09Z" updatedAt="2024-02-14T04:42:09Z" sheetType="dashboard" favoritesTotal="0" viewUrlName="Overview">
+      <ns0:workbook id="9df3e2d1-070e-497a-9578-8cc557ced9df" name="Superstore" contentUrl="Superstore" showTabs="true" size="2" createdAt="2024-02-14T04:42:09Z" updatedAt="2024-02-14T04:42:10Z" sheetCount="9" hasExtracts="false">
+        <ns0:tags />
+      </ns0:workbook>
+      <ns0:owner email="[email protected]" fullName="Bob" id="ee8bc9ca-77fe-4ae0-8093-cf77f0ee67a9" lastLogin="2025-02-04T06:39:20Z" name="[email protected]" siteRole="SiteAdministratorCreator" />
+      <ns0:project id="669ca36b-492e-4ccf-bca1-3614fe6a9d7a" name="Samples" description="This project includes automatically uploaded samples." />
+      <ns0:tags />
+      <ns0:usage totalViewCount="0" />
+      <ns0:location id="669ca36b-492e-4ccf-bca1-3614fe6a9d7a" type="Project" />
+    </ns0:view>
+    <ns0:view id="2a3fd19d-9129-413d-9ff7-9dfc36bf7f7e" name="Product" contentUrl="Superstore/sheets/Product" createdAt="2024-02-14T04:42:09Z" updatedAt="2024-02-14T04:42:09Z" sheetType="dashboard" favoritesTotal="0" viewUrlName="Product">
+      <ns0:workbook id="9df3e2d1-070e-497a-9578-8cc557ced9df" name="Superstore" contentUrl="Superstore" showTabs="true" size="2" createdAt="2024-02-14T04:42:09Z" updatedAt="2024-02-14T04:42:10Z" sheetCount="9" hasExtracts="false">
+        <ns0:tags />
+      </ns0:workbook>
+      <ns0:owner email="[email protected]" fullName="Bob" id="ee8bc9ca-77fe-4ae0-8093-cf77f0ee67a9" lastLogin="2025-02-04T06:39:20Z" name="[email protected]" siteRole="SiteAdministratorCreator" />
+      <ns0:project id="669ca36b-492e-4ccf-bca1-3614fe6a9d7a" name="Samples" description="This project includes automatically uploaded samples." />
+      <ns0:tags />
+      <ns0:usage totalViewCount="0" />
+      <ns0:location id="669ca36b-492e-4ccf-bca1-3614fe6a9d7a" type="Project" />
+    </ns0:view>
+    <ns0:view id="459eda9a-85e4-46bf-a2f2-62936bd2e99a" name="Customers" contentUrl="Superstore/sheets/Customers" createdAt="2024-02-14T04:42:09Z" updatedAt="2024-02-14T04:42:09Z" sheetType="dashboard" favoritesTotal="0" viewUrlName="Customers">
+      <ns0:workbook id="9df3e2d1-070e-497a-9578-8cc557ced9df" name="Superstore" contentUrl="Superstore" showTabs="true" size="2" createdAt="2024-02-14T04:42:09Z" updatedAt="2024-02-14T04:42:10Z" sheetCount="9" hasExtracts="false">
+        <ns0:tags />
+      </ns0:workbook>
+      <ns0:owner email="[email protected]" fullName="Bob" id="ee8bc9ca-77fe-4ae0-8093-cf77f0ee67a9" lastLogin="2025-02-04T06:39:20Z" name="[email protected]" siteRole="SiteAdministratorCreator" />
+      <ns0:project id="669ca36b-492e-4ccf-bca1-3614fe6a9d7a" name="Samples" description="This project includes automatically uploaded samples." />
+      <ns0:tags />
+      <ns0:usage totalViewCount="0" />
+      <ns0:location id="669ca36b-492e-4ccf-bca1-3614fe6a9d7a" type="Project" />
+    </ns0:view>
+  </ns0:views>
+</ns0:tsResponse>