Merge branch 'development' into jorwoods/metadata_paginated_sample

Author: bcantoni

tableauserverclient/__init__.py

@@ -2,6 +2,7 @@
 from tableauserverclient.namespace import NEW_NAMESPACE as DEFAULT_NAMESPACE
 from tableauserverclient.models import (
     BackgroundJobItem,
+    CollectionItem,
     ColumnItem,
     ConnectionCredentials,
     ConnectionItem,
@@ -73,7 +74,7 @@
 
 __all__ = [
     "BackgroundJobItem",
-    "BackgroundJobItem",
+    "CollectionItem",
     "ColumnItem",
     "ConnectionCredentials",
     "ConnectionItem",

tableauserverclient/models/__init__.py

@@ -1,3 +1,4 @@
+from tableauserverclient.models.collection_item import CollectionItem
 from tableauserverclient.models.column_item import ColumnItem
 from tableauserverclient.models.connection_credentials import ConnectionCredentials
 from tableauserverclient.models.connection_item import ConnectionItem
@@ -53,6 +54,7 @@
 from tableauserverclient.models.extract_item import ExtractItem
 
 __all__ = [
+    "CollectionItem",
     "ColumnItem",
     "ConnectionCredentials",
     "ConnectionItem",

tableauserverclient/models/collection_item.py

@@ -0,0 +1,52 @@
+from datetime import datetime
+from typing import Optional
+from xml.etree.ElementTree import Element
+
+from defusedxml.ElementTree import fromstring
+from typing_extensions import Self
+
+from tableauserverclient.datetime_helpers import parse_datetime
+from tableauserverclient.models.user_item import UserItem
+
+
+class CollectionItem:
+    def __init__(self) -> None:
+        self.id: Optional[str] = None
+        self.name: Optional[str] = None
+        self.description: Optional[str] = None
+        self.created_at: Optional[datetime] = None
+        self.updated_at: Optional[datetime] = None
+        self.owner: Optional[UserItem] = None
+        self.total_item_count: Optional[int] = None
+        self.permissioned_item_count: Optional[int] = None
+        self.visibility: Optional[str] = None  # Assuming visibility is a string, adjust as necessary
+
+    @classmethod
+    def from_response(cls, response: bytes, ns) -> list[Self]:
+        parsed_response = fromstring(response)
+
+        collection_elements = parsed_response.findall(".//t:collection", namespaces=ns)
+        if not collection_elements:
+            raise ValueError("No collection element found in the response")
+
+        collections = [cls.from_xml(c, ns) for c in collection_elements]
+        return collections
+
+    @classmethod
+    def from_xml(cls, xml: Element, ns) -> Self:
+        collection_item = cls()
+        collection_item.id = xml.get("id")
+        collection_item.name = xml.get("name")
+        collection_item.description = xml.get("description")
+        collection_item.created_at = parse_datetime(xml.get("createdAt"))
+        collection_item.updated_at = parse_datetime(xml.get("updatedAt"))
+        owner_element = xml.find(".//t:owner", namespaces=ns)
+        if owner_element is not None:
+            collection_item.owner = UserItem.from_xml(owner_element, ns)
+        else:
+            collection_item.owner = None
+        collection_item.total_item_count = int(xml.get("totalItemCount", 0))
+        collection_item.permissioned_item_count = int(xml.get("permissionedItemCount", 0))
+        collection_item.visibility = xml.get("visibility")
+
+        return collection_item

tableauserverclient/models/data_freshness_policy_item.py

@@ -66,7 +66,7 @@ def interval_item(self) -> Optional[list[str]]:
             return self._interval_item
 
         @interval_item.setter
-        def interval_item(self, value: list[str]):
+        def interval_item(self, value: Optional[list[str]]):
             self._interval_item = value
 
         @property
@@ -127,15 +127,15 @@ def fresh_every_schedule(self) -> Optional[FreshEvery]:
         return self._fresh_every_schedule
 
     @fresh_every_schedule.setter
-    def fresh_every_schedule(self, value: FreshEvery):
+    def fresh_every_schedule(self, value: Optional[FreshEvery]):
         self._fresh_every_schedule = value
 
     @property
     def fresh_at_schedule(self) -> Optional[FreshAt]:
         return self._fresh_at_schedule
 
     @fresh_at_schedule.setter
-    def fresh_at_schedule(self, value: FreshAt):
+    def fresh_at_schedule(self, value: Optional[FreshAt]):
         self._fresh_at_schedule = value
 
     @classmethod

tableauserverclient/models/datasource_item.py

@@ -490,7 +490,7 @@ def _set_values(
             self._owner = owner
 
     @classmethod
-    def from_response(cls, resp: str, ns: dict) -> list["DatasourceItem"]:
+    def from_response(cls, resp: bytes, ns: dict) -> list["DatasourceItem"]:
         all_datasource_items = list()
         parsed_response = fromstring(resp)
         all_datasource_xml = parsed_response.findall(".//t:datasource", namespaces=ns)

tableauserverclient/models/favorites_item.py

@@ -1,9 +1,8 @@
 import logging
 
-from typing import Union
+from typing import TypedDict, Union
 from defusedxml.ElementTree import fromstring
-
-from tableauserverclient.models.tableau_types import TableauItem
+from tableauserverclient.models.collection_item import CollectionItem
 from tableauserverclient.models.datasource_item import DatasourceItem
 from tableauserverclient.models.flow_item import FlowItem
 from tableauserverclient.models.project_item import ProjectItem
@@ -13,16 +12,22 @@
 
 from tableauserverclient.helpers.logging import logger
 
-FavoriteType = dict[
-    str,
-    list[TableauItem],
-]
+
+class FavoriteType(TypedDict):
+    collections: list[CollectionItem]
+    datasources: list[DatasourceItem]
+    flows: list[FlowItem]
+    projects: list[ProjectItem]
+    metrics: list[MetricItem]
+    views: list[ViewItem]
+    workbooks: list[WorkbookItem]
 
 
 class FavoriteItem:
     @classmethod
     def from_response(cls, xml: Union[str, bytes], namespace: dict) -> FavoriteType:
         favorites: FavoriteType = {
+            "collections": [],
             "datasources": [],
             "flows": [],
             "projects": [],
@@ -32,6 +37,7 @@ def from_response(cls, xml: Union[str, bytes], namespace: dict) -> FavoriteType:
         }
         parsed_response = fromstring(xml)
 
+        collections_xml = parsed_response.findall(".//t:favorite/t:collection", namespace)
         datasources_xml = parsed_response.findall(".//t:favorite/t:datasource", namespace)
         flows_xml = parsed_response.findall(".//t:favorite/t:flow", namespace)
         metrics_xml = parsed_response.findall(".//t:favorite/t:metric", namespace)
@@ -40,13 +46,14 @@ def from_response(cls, xml: Union[str, bytes], namespace: dict) -> FavoriteType:
         workbooks_xml = parsed_response.findall(".//t:favorite/t:workbook", namespace)
 
         logger.debug(
-            "ds: {}, flows: {}, metrics: {}, projects: {}, views: {}, wbs: {}".format(
+            "ds: {}, flows: {}, metrics: {}, projects: {}, views: {}, wbs: {}, collections: {}".format(
                 len(datasources_xml),
                 len(flows_xml),
                 len(metrics_xml),
                 len(projects_xml),
                 len(views_xml),
                 len(workbooks_xml),
+                len(collections_xml),
             )
         )
         for datasource in datasources_xml:
@@ -85,5 +92,11 @@ def from_response(cls, xml: Union[str, bytes], namespace: dict) -> FavoriteType:
                 logger.debug(fav_workbook)
                 favorites["workbooks"].append(fav_workbook)
 
+        for collection in collections_xml:
+            fav_collection = CollectionItem.from_xml(collection, namespace)
+            if fav_collection:
+                logger.debug(fav_collection)
+                favorites["collections"].append(fav_collection)
+
         logger.debug(favorites)
         return favorites

tableauserverclient/models/flow_item.py

@@ -129,7 +129,7 @@ def description(self) -> Optional[str]:
         return self._description
 
     @description.setter
-    def description(self, value: str) -> None:
+    def description(self, value: Optional[str]) -> None:
         self._description = value
 
     @property

tableauserverclient/models/group_item.py

@@ -92,7 +92,7 @@ def name(self) -> Optional[str]:
         return self._name
 
     @name.setter
-    def name(self, value: str) -> None:
+    def name(self, value: Optional[str]) -> None:
         self._name = value
 
     @property

tableauserverclient/models/groupset_item.py

@@ -24,6 +24,14 @@ def __str__(self) -> str:
     def __repr__(self) -> str:
         return self.__str__()
 
+    @property
+    def name(self) -> Optional[str]:
+        return self._name
+
+    @name.setter
+    def name(self, value: Optional[str]) -> None:
+        self._name = value
+
     @classmethod
     def from_response(cls, response: bytes, ns: dict[str, str]) -> list["GroupSetItem"]:
         parsed_response = fromstring(response)

tableauserverclient/models/permissions_item.py

@@ -43,6 +43,8 @@ class Capability:
         CreateRefreshMetrics = "CreateRefreshMetrics"
         SaveAs = "SaveAs"
         PulseMetricDefine = "PulseMetricDefine"
+        ExtractRefresh = "ExtractRefresh"
+        WebAuthoringForFlows = "WebAuthoringForFlows"
 
         def __repr__(self):
             return "<Enum Capability: AddComment | ChangeHierarchy | ChangePermission ... (17 more) >"