feat: datasourceitem _all_ fields

Author: jorwoods

tableauserverclient/models/datasource_item.py

@@ -1,21 +1,23 @@
 import copy
 import datetime
 import xml.etree.ElementTree as ET
-from typing import Optional
+from typing import Optional, overload
 
 from defusedxml.ElementTree import fromstring
 
 from tableauserverclient.datetime_helpers import parse_datetime
 from tableauserverclient.models.connection_item import ConnectionItem
 from tableauserverclient.models.exceptions import UnpopulatedPropertyError
 from tableauserverclient.models.permissions_item import PermissionsRule
+from tableauserverclient.models.project_item import ProjectItem
 from tableauserverclient.models.property_decorators import (
     property_not_nullable,
     property_is_boolean,
     property_is_enum,
 )
 from tableauserverclient.models.revision_item import RevisionItem
 from tableauserverclient.models.tag_item import TagItem
+from tableauserverclient.models.user_item import UserItem
 
 
 class DatasourceItem:
@@ -143,6 +145,13 @@ def __init__(self, project_id: Optional[str] = None, name: Optional[str] = None)
         self.owner_id: Optional[str] = None
         self.project_id: Optional[str] = project_id
         self.tags: set[str] = set()
+        self._connected_workbooks_count: Optional[int] = None
+        self._favorites_total: Optional[int] = None
+        self._has_alert: Optional[bool] = None
+        self._is_published: Optional[bool] = None
+        self._server_name: Optional[str] = None
+        self._project: Optional[ProjectItem] = None
+        self._owner: Optional[UserItem] = None
 
         self._permissions = None
         self._data_quality_warnings = None
@@ -274,6 +283,34 @@ def revisions(self) -> list[RevisionItem]:
     def size(self) -> Optional[int]:
         return self._size
 
+    @property
+    def connected_workbooks_count(self) -> Optional[int]:
+        return self._connected_workbooks_count
+
+    @property
+    def favorites_total(self) -> Optional[int]:
+        return self._favorites_total
+
+    @property
+    def has_alert(self) -> Optional[bool]:
+        return self._has_alert
+
+    @property
+    def is_published(self) -> Optional[bool]:
+        return self._is_published
+
+    @property
+    def server_name(self) -> Optional[str]:
+        return self._server_name
+
+    @property
+    def project(self) -> Optional[ProjectItem]:
+        return self._project
+
+    @property
+    def owner(self) -> Optional[UserItem]:
+        return self._owner
+
     def _set_connections(self, connections) -> None:
         self._connections = connections
 
@@ -310,6 +347,13 @@ def _parse_common_elements(self, datasource_xml, ns):
                 use_remote_query_agent,
                 webpage_url,
                 size,
+                connected_workbooks_count,
+                favorites_total,
+                has_alert,
+                is_published,
+                server_name,
+                project,
+                owner,
             ) = self._parse_element(datasource_xml, ns)
             self._set_values(
                 ask_data_enablement,
@@ -331,6 +375,13 @@ def _parse_common_elements(self, datasource_xml, ns):
                 use_remote_query_agent,
                 webpage_url,
                 size,
+                connected_workbooks_count,
+                favorites_total,
+                has_alert,
+                is_published,
+                server_name,
+                project,
+                owner,
             )
         return self
 
@@ -355,6 +406,13 @@ def _set_values(
         use_remote_query_agent,
         webpage_url,
         size,
+        connected_workbooks_count,
+        favorites_total,
+        has_alert,
+        is_published,
+        server_name,
+        project,
+        owner,
     ):
         if ask_data_enablement is not None:
             self._ask_data_enablement = ask_data_enablement
@@ -394,6 +452,20 @@ def _set_values(
             self._webpage_url = webpage_url
         if size is not None:
             self._size = int(size)
+        if connected_workbooks_count is not None:
+            self._connected_workbooks_count = connected_workbooks_count
+        if favorites_total is not None:
+            self._favorites_total = favorites_total
+        if has_alert is not None:
+            self._has_alert = has_alert
+        if is_published is not None:
+            self._is_published = is_published
+        if server_name is not None:
+            self._server_name = server_name
+        if project is not None:
+            self._project = project
+        if owner is not None:
+            self._owner = owner
 
     @classmethod
     def from_response(cls, resp: str, ns: dict) -> list["DatasourceItem"]:
@@ -428,6 +500,11 @@ def _parse_element(datasource_xml: ET.Element, ns: dict) -> tuple:
         use_remote_query_agent = datasource_xml.get("useRemoteQueryAgent", None)
         webpage_url = datasource_xml.get("webpageUrl", None)
         size = datasource_xml.get("size", None)
+        connected_workbooks_count = nullable_str_to_int(datasource_xml.get("connectedWorkbooksCount", None))
+        favorites_total = nullable_str_to_int(datasource_xml.get("favoritesTotal", None))
+        has_alert = nullable_str_to_bool(datasource_xml.get("hasAlert", None))
+        is_published = nullable_str_to_bool(datasource_xml.get("isPublished", None))
+        server_name = datasource_xml.get("serverName", None)
 
         tags = None
         tags_elem = datasource_xml.find(".//t:tags", namespaces=ns)
@@ -438,12 +515,14 @@ def _parse_element(datasource_xml: ET.Element, ns: dict) -> tuple:
         project_name = None
         project_elem = datasource_xml.find(".//t:project", namespaces=ns)
         if project_elem is not None:
+            project = ProjectItem.from_xml(project_elem, ns)
             project_id = project_elem.get("id", None)
             project_name = project_elem.get("name", None)
 
         owner_id = None
         owner_elem = datasource_xml.find(".//t:owner", namespaces=ns)
         if owner_elem is not None:
+            owner = UserItem.from_xml(owner_elem, ns)
             owner_id = owner_elem.get("id", None)
 
         ask_data_enablement = None
@@ -471,4 +550,35 @@ def _parse_element(datasource_xml: ET.Element, ns: dict) -> tuple:
             use_remote_query_agent,
             webpage_url,
             size,
+            connected_workbooks_count,
+            favorites_total,
+            has_alert,
+            is_published,
+            server_name,
+            project,
+            owner,
         )
+
+
+@overload
+def nullable_str_to_int(value: None) -> None: ...
+
+
+@overload
+def nullable_str_to_int(value: str) -> int: ...
+
+
+def nullable_str_to_int(value):
+    return int(value) if value is not None else None
+
+
+@overload
+def nullable_str_to_bool(value: None) -> None: ...
+
+
+@overload
+def nullable_str_to_bool(value: str) -> bool: ...
+
+
+def nullable_str_to_bool(value):
+    return str(value).lower() == "true" if value is not None else None

test/assets/datasource_get_all_fields.xml

@@ -0,0 +1,10 @@
+<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="1" />
+  <ns0:datasources>
+    <ns0:datasource connectedWorkbooksCount="0" contentUrl="SuperstoreDatasource" createdAt="2024-02-14T04:42:13Z" encryptExtracts="false" favoritesTotal="0" hasAlert="false" hasExtracts="false" id="a71cdd15-3a23-4ec1-b3ce-9956f5e00bb7" isCertified="false" isPublished="true" name="Superstore Datasource" size="1" type="excel-direct" updatedAt="2024-02-14T04:42:14Z" useRemoteQueryAgent="false" serverName="localhost" webpageUrl="https://10ax.online.tableau.com/#/site/example/datasources/3566752">
+      <ns0:project id="669ca36b-492e-4ccf-bca1-3614fe6a9d7a" name="Samples" description="This project includes automatically uploaded samples." />
+      <ns0:owner email="[email protected]" fullName="Bob Smith" id="ee8bc9ca-77fe-4ae0-8093-cf77f0ee67a9" lastLogin="2025-02-04T06:39:20Z" name="[email protected]" siteRole="SiteAdministratorCreator" />
+      <ns0:tags />
+    </ns0:datasource>
+  </ns0:datasources>
+</ns0:tsResponse>

test/test_datasource.py

@@ -10,7 +10,7 @@
 
 import tableauserverclient as TSC
 from tableauserverclient import ConnectionItem
-from tableauserverclient.datetime_helpers import format_datetime
+from tableauserverclient.datetime_helpers import format_datetime, parse_datetime
 from tableauserverclient.server.endpoint.exceptions import InternalServerError
 from tableauserverclient.server.endpoint.fileuploads_endpoint import Fileuploads
 from tableauserverclient.server.request_factory import RequestFactory
@@ -20,6 +20,7 @@
 GET_XML = "datasource_get.xml"
 GET_EMPTY_XML = "datasource_get_empty.xml"
 GET_BY_ID_XML = "datasource_get_by_id.xml"
+GET_XML_ALL_FIELDS = "datasource_get_all_fields.xml"
 POPULATE_CONNECTIONS_XML = "datasource_populate_connections.xml"
 POPULATE_PERMISSIONS_XML = "datasource_populate_permissions.xml"
 PUBLISH_XML = "datasource_publish.xml"
@@ -733,3 +734,39 @@ def test_bad_download_response(self) -> None:
             )
             file_path = self.server.datasources.download("9dbd2263-16b5-46e1-9c43-a76bb8ab65fb", td)
             self.assertTrue(os.path.exists(file_path))
+
+    def test_get_datasource_all_fields(self) -> None:
+        ro = TSC.RequestOptions()
+        ro.all_fields = True
+        with requests_mock.mock() as m:
+            m.get(f"{self.baseurl}?fields=_all_", text=read_xml_asset(GET_XML_ALL_FIELDS))
+            datasources, _ = self.server.datasources.get(req_options=ro)
+
+        assert datasources[0].connected_workbooks_count == 0
+        assert datasources[0].content_url == "SuperstoreDatasource"
+        assert datasources[0].created_at == parse_datetime("2024-02-14T04:42:13Z")
+        assert not datasources[0].encrypt_extracts
+        assert datasources[0].favorites_total == 0
+        assert not datasources[0].has_alert
+        assert not datasources[0].has_extracts
+        assert datasources[0].id == "a71cdd15-3a23-4ec1-b3ce-9956f5e00bb7"
+        assert not datasources[0].certified
+        assert datasources[0].is_published
+        assert datasources[0].name == "Superstore Datasource"
+        assert datasources[0].size == 1
+        assert datasources[0].datasource_type == "excel-direct"
+        assert datasources[0].updated_at == parse_datetime("2024-02-14T04:42:14Z")
+        assert not datasources[0].use_remote_query_agent
+        assert datasources[0].server_name == "localhost"
+        assert datasources[0].webpage_url == "https://10ax.online.tableau.com/#/site/example/datasources/3566752"
+        assert isinstance(datasources[0].project, TSC.ProjectItem)
+        assert datasources[0].project.id == "669ca36b-492e-4ccf-bca1-3614fe6a9d7a"
+        assert datasources[0].project.name == "Samples"
+        assert datasources[0].project.description == "This project includes automatically uploaded samples."
+        assert datasources[0].owner.email == "[email protected]"
+        assert isinstance(datasources[0].owner, TSC.UserItem)
+        assert datasources[0].owner.fullname == "Bob Smith"
+        assert datasources[0].owner.id == "ee8bc9ca-77fe-4ae0-8093-cf77f0ee67a9"
+        assert datasources[0].owner.last_login == parse_datetime("2025-02-04T06:39:20Z")
+        assert datasources[0].owner.name == "[email protected]"
+        assert datasources[0].owner.site_role == "SiteAdministratorCreator"