feat: project support all fields

jorwoods · jorwoods · commit 1b292b75f947 · 2025-02-05T22:55:28.000-06:00
diff --git a/tableauserverclient/models/location_item.py b/tableauserverclient/models/location_item.py
@@ -0,0 +1,38 @@
+from typing import Optional
+import xml.etree.ElementTree as ET
+
+
+class LocationItem:
+    class Type:
+        PersonalSpace = "PersonalSpace"
+        Project = "Project"
+
+    def __init__(self):
+        self._id: Optional[str] = None
+        self._type: Optional[str] = None
+        self._name: Optional[str] = None
+
+    def __repr__(self):
+        return f"{self.__class__.__name__}({self.__dict__!r})"
+
+    @property
+    def id(self) -> Optional[str]:
+        return self._id
+
+    @property
+    def type(self) -> Optional[str]:
+        return self._type
+
+    @property
+    def name(self) -> Optional[str]:
+        return self._name
+
+    @classmethod
+    def from_xml(cls, xml: ET.Element, ns: Optional[dict] = None) -> "LocationItem":
+        if ns is None:
+            ns = {}
+        location = cls()
+        location._id = xml.get("id", None)
+        location._type = xml.get("type", None)
+        location._name = xml.get("name", None)
+        return location
diff --git a/tableauserverclient/models/project_item.py b/tableauserverclient/models/project_item.py
@@ -1,11 +1,10 @@
-import logging
 import xml.etree.ElementTree as ET
-from typing import Optional
+from typing import Optional, overload
 
 from defusedxml.ElementTree import fromstring
 
 from tableauserverclient.models.exceptions import UnpopulatedPropertyError
-from tableauserverclient.models.property_decorators import property_is_enum, property_not_empty
+from tableauserverclient.models.property_decorators import property_is_enum
 
 
 class ProjectItem:
@@ -75,6 +74,8 @@ def __init__(
         self.parent_id: Optional[str] = parent_id
         self._samples: Optional[bool] = samples
         self._owner_id: Optional[str] = None
+        self._top_level_project: Optional[bool] = None
+        self._writeable: Optional[bool] = None
 
         self._permissions = None
         self._default_workbook_permissions = None
@@ -87,6 +88,11 @@ def __init__(
         self._default_database_permissions = None
         self._default_table_permissions = None
 
+        self._project_count: Optional[int] = None
+        self._workbok_count: Optional[int] = None
+        self._view_count: Optional[int] = None
+        self._datasource_count: Optional[int] = None
+
     @property
     def content_permissions(self):
         return self._content_permissions
@@ -176,25 +182,48 @@ def owner_id(self) -> Optional[str]:
     def owner_id(self, value: str) -> None:
         self._owner_id = value
 
+    @property
+    def top_level_project(self) -> Optional[bool]:
+        return self._top_level_project
+
+    @property
+    def writeable(self) -> Optional[bool]:
+        return self._writeable
+
+    @property
+    def project_count(self) -> Optional[int]:
+        return self._project_count
+
+    @property
+    def workbok_count(self) -> Optional[int]:
+        return self._workbok_count
+
+    @property
+    def view_count(self) -> Optional[int]:
+        return self._view_count
+
+    @property
+    def datasource_count(self) -> Optional[int]:
+        return self._datasource_count
+
     def is_default(self):
         return self.name.lower() == "default"
 
-    def _parse_common_tags(self, project_xml, ns):
-        if not isinstance(project_xml, ET.Element):
-            project_xml = fromstring(project_xml).find(".//t:project", namespaces=ns)
-
-        if project_xml is not None:
-            (
-                _,
-                name,
-                description,
-                content_permissions,
-                parent_id,
-            ) = self._parse_element(project_xml)
-            self._set_values(None, name, description, content_permissions, parent_id)
-        return self
-
-    def _set_values(self, project_id, name, description, content_permissions, parent_id, owner_id):
+    def _set_values(
+        self,
+        project_id,
+        name,
+        description,
+        content_permissions,
+        parent_id,
+        owner_id,
+        top_level_project,
+        writeable,
+        project_count,
+        workbok_count,
+        view_count,
+        datasource_count,
+    ):
         if project_id is not None:
             self._id = project_id
         if name:
@@ -207,6 +236,18 @@ def _set_values(self, project_id, name, description, content_permissions, parent
             self.parent_id = parent_id
         if owner_id:
             self._owner_id = owner_id
+        if project_count is not None:
+            self._project_count = project_count
+        if workbok_count is not None:
+            self._workbok_count = workbok_count
+        if view_count is not None:
+            self._view_count = view_count
+        if datasource_count is not None:
+            self._datasource_count = datasource_count
+        if top_level_project is not None:
+            self._top_level_project = top_level_project
+        if writeable is not None:
+            self._writeable = writeable
 
     def _set_permissions(self, permissions):
         self._permissions = permissions
@@ -220,31 +261,68 @@ def _set_default_permissions(self, permissions, content_type):
         )
 
     @classmethod
-    def from_response(cls, resp, ns) -> list["ProjectItem"]:
+    def from_response(cls, resp: bytes, ns: Optional[dict]) -> list["ProjectItem"]:
         all_project_items = list()
         parsed_response = fromstring(resp)
         all_project_xml = parsed_response.findall(".//t:project", namespaces=ns)
 
         for project_xml in all_project_xml:
-            project_item = cls.from_xml(project_xml)
+            project_item = cls.from_xml(project_xml, namespace=ns)
             all_project_items.append(project_item)
         return all_project_items
 
     @classmethod
-    def from_xml(cls, project_xml, namespace=None) -> "ProjectItem":
+    def from_xml(cls, project_xml: ET.Element, namespace: Optional[dict] = None) -> "ProjectItem":
         project_item = cls()
-        project_item._set_values(*cls._parse_element(project_xml))
+        project_item._set_values(*cls._parse_element(project_xml, namespace))
         return project_item
 
     @staticmethod
-    def _parse_element(project_xml):
+    def _parse_element(project_xml: ET.Element, namespace: Optional[dict]) -> tuple:
         id = project_xml.get("id", None)
         name = project_xml.get("name", None)
         description = project_xml.get("description", None)
         content_permissions = project_xml.get("contentPermissions", None)
         parent_id = project_xml.get("parentProjectId", None)
+        top_level_project = str_to_bool(project_xml.get("topLevelProject", None))
+        writeable = str_to_bool(project_xml.get("writeable", None))
         owner_id = None
-        for owner in project_xml:
-            owner_id = owner.get("id", None)
+        if (owner_elem := project_xml.find(".//t:owner", namespaces=namespace)) is not None:
+            owner_id = owner_elem.get("id", None)
+
+        project_count = None
+        workbok_count = None
+        view_count = None
+        datasource_count = None
+        if (count_elem := project_xml.find(".//t:contentsCounts", namespaces=namespace)) is not None:
+            project_count = int(count_elem.get("projectCount", 0))
+            workbok_count = int(count_elem.get("workbookCount", 0))
+            view_count = int(count_elem.get("viewCount", 0))
+            datasource_count = int(count_elem.get("dataSourceCount", 0))
+
+        return (
+            id,
+            name,
+            description,
+            content_permissions,
+            parent_id,
+            owner_id,
+            top_level_project,
+            writeable,
+            project_count,
+            workbok_count,
+            view_count,
+            datasource_count,
+        )
+
+
+@overload
+def str_to_bool(value: str) -> bool: ...
+
+
+@overload
+def str_to_bool(value: None) -> None: ...
+
 
-        return id, name, description, content_permissions, parent_id, owner_id
+def str_to_bool(value):
+    return value.lower() == "true" if value is not None else None
diff --git a/tableauserverclient/server/endpoint/users_endpoint.py b/tableauserverclient/server/endpoint/users_endpoint.py
@@ -87,7 +87,7 @@ def get(self, req_options: Optional[RequestOptions] = None) -> tuple[list[UserIt
 
         if req_options is None:
             req_options = RequestOptions()
-        req_options._all_fields = True
+        req_options.all_fields = True
 
         url = self.baseurl
         server_response = self.get_request(url, req_options)
diff --git a/tableauserverclient/server/request_options.py b/tableauserverclient/server/request_options.py
@@ -62,8 +62,9 @@ def __init__(self, pagenumber=1, pagesize=None):
         self.pagesize = pagesize or config.PAGE_SIZE
         self.sort = set()
         self.filter = set()
+        self.fields = set()
         # This is private until we expand all of our parsers to handle the extra fields
-        self._all_fields = False
+        self.all_fields = False
 
     def get_query_params(self) -> dict:
         params = {}
@@ -75,12 +76,14 @@ def get_query_params(self) -> dict:
             filter_options = (str(filter_item) for filter_item in self.filter)
             ordered_filter_options = sorted(filter_options)
             params["filter"] = ",".join(ordered_filter_options)
-        if self._all_fields:
+        if self.all_fields:
             params["fields"] = "_all_"
         if self.pagenumber:
             params["pageNumber"] = self.pagenumber
         if self.pagesize:
             params["pageSize"] = self.pagesize
+        if self.fields:
+            params["fields"] = ",".join(self.fields)
         return params
 
     def page_size(self, page_size):
@@ -181,6 +184,116 @@ class Direction:
         Desc = "desc"
         Asc = "asc"
 
+    class SelectFields:
+        class Common:
+            All = "_all_"
+            Default = "_default_"
+
+        class ContentsCounts:
+            ProjectCount = "contentsCounts.projectCount"
+            ViewCount = "contentsCounts.viewCount"
+            DatasourceCount = "contentsCounts.datasourceCount"
+            WorkbookCount = "contentsCounts.workbookCount"
+
+        class Datasource:
+            ContentUrl = "datasource.contentUrl"
+            ID = "datasource.id"
+            Name = "datasource.name"
+            Type = "datasource.type"
+            Description = "datasource.description"
+            CreatedAt = "datasource.createdAt"
+            UpdatedAt = "datasource.updatedAt"
+            EncryptExtracts = "datasource.encryptExtracts"
+            IsCertified = "datasource.isCertified"
+            UseRemoteQueryAgent = "datasource.useRemoteQueryAgent"
+            WebPageURL = "datasource.webpageUrl"
+            Size = "datasource.size"
+            Tag = "datasource.tag"
+            FavoritesTotal = "datasource.favoritesTotal"
+            DatabaseName = "datasource.databaseName"
+            ConnectedWorkbooksCount = "datasource.connectedWorkbooksCount"
+            HasAlert = "datasource.hasAlert"
+            HasExtracts = "datasource.hasExtracts"
+            IsPublished = "datasource.isPublished"
+            ServerName = "datasource.serverName"
+
+        class Favorite:
+            Label = "favorite.label"
+            ParentProjectName = "favorite.parentProjectName"
+            TargetOwnerName = "favorite.targetOwnerName"
+
+        class Group:
+            ID = "group.id"
+            Name = "group.name"
+            DomainName = "group.domainName"
+            UserCount = "group.userCount"
+            MinimumSiteRole = "group.minimumSiteRole"
+
+        class Job:
+            ID = "job.id"
+            Status = "job.status"
+            CreatedAt = "job.createdAt"
+            StartedAt = "job.startedAt"
+            EndedAt = "job.endedAt"
+            Priority = "job.priority"
+            JobType = "job.jobType"
+            Title = "job.title"
+            Subtitle = "job.subtitle"
+
+        class Owner:
+            ID = "owner.id"
+            Name = "owner.name"
+            FullName = "owner.fullName"
+            SiteRole = "owner.siteRole"
+            LastLogin = "owner.lastLogin"
+            Email = "owner.email"
+
+        class Project:
+            ID = "project.id"
+            Name = "project.name"
+            Description = "project.description"
+            CreatedAt = "project.createdAt"
+            UpdatedAt = "project.updatedAt"
+            ContentPermissions = "project.contentPermissions"
+            ParentProjectID = "project.parentProjectId"
+            TopLevelProject = "project.topLevelProject"
+            Writeable = "project.writeable"
+
+        class User:
+            ExternalAuthUserId = "user.externalAuthUserId"
+            ID = "user.id"
+            Name = "user.name"
+            SiteRole = "user.siteRole"
+            LastLogin = "user.lastLogin"
+            FullName = "user.fullName"
+            Email = "user.email"
+            AuthSetting = "user.authSetting"
+
+        class View:
+            ID = "view.id"
+            Name = "view.name"
+            ContentUrl = "view.contentUrl"
+            CreatedAt = "view.createdAt"
+            UpdatedAt = "view.updatedAt"
+            Tags = "view.tags"
+            SheetType = "view.sheetType"
+            Usage = "view.usage"
+
+        class Workbook:
+            ID = "workbook.id"
+            Description = "workbook.description"
+            Name = "workbook.name"
+            ContentUrl = "workbook.contentUrl"
+            ShowTabs = "workbook.showTabs"
+            Size = "workbook.size"
+            CreatedAt = "workbook.createdAt"
+            UpdatedAt = "workbook.updatedAt"
+            SheetCount = "workbook.sheetCount"
+            HasExtracts = "workbook.hasExtracts"
+            Tags = "workbook.tags"
+            WebpageUrl = "workbook.webpageUrl"
+            DefaultViewId = "workbook.defaultViewId"
+
 
 """
 These options can be used by methods that are fetching data exported from a specific content item
diff --git a/test/assets/project_get_all_fields.xml b/test/assets/project_get_all_fields.xml
@@ -0,0 +1,9 @@
+<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="3" />
+  <ns0:projects>
+    <ns0:project id="ee8c6e70-43b6-11e6-af4f-f7b0d8e20760" name="Samples" description="This project includes automatically uploaded samples." topLevelProject="true" writeable="true" createdAt="2024-02-14T04:42:03Z" updatedAt="2024-02-14T04:42:03Z" contentPermissions="ManagedByOwner">
+      <ns0:owner email="Bob@example.com" fullName="Bob" id="ee8bc9ca-77fe-4ae0-8093-cf77f0ee67a9" lastLogin="2025-02-04T06:39:20Z" name="Bob" siteRole="SiteAdministratorCreator" />
+      <ns0:contentsCounts projectCount="0" workbookCount="2" viewCount="17" datasourceCount="1" />
+    </ns0:project>
+  </ns0:projects>
+</ns0:tsResponse>
diff --git a/test/test_project.py b/test/test_project.py
diff --git a/test/test_request_option.py b/test/test_request_option.py
