tableauserverclient 0.37__py3-none-any.whl → 0.38__py3-none-any.whl

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:
@@ -34,9 +40,16 @@ class ViewItem:
         The image of the view. You must first call the `views.populate_image`
         method to access the image.
 
+    location: Optional[LocationItem], default None
+        The location of the view. The location can be a personal space or a
+        project.
+
     name: Optional[str], default None
         The name of the view.
 
+    owner: Optional[UserItem], default None
+        The owner of the view.
+
     owner_id: Optional[str], default None
         The ID for the owner of the view.
 
@@ -48,6 +61,9 @@ class ViewItem:
         The preview image of the view. You must first call the
         `views.populate_preview_image` method to access the preview image.
 
+    project: Optional[ProjectItem], default None
+        The project that contains the view.
+
     project_id: Optional[str], default None
         The ID for the project that contains the view.
 
@@ -60,9 +76,11 @@ class ViewItem:
     updated_at: Optional[datetime], default None
         The date and time when the view was last updated.
 
+    workbook: Optional[WorkbookItem], default None
+        The workbook that contains the view.
+
     workbook_id: Optional[str], default None
         The ID for the workbook that contains the view.
-
     """
 
     def __init__(self) -> None:
@@ -84,11 +102,18 @@ class ViewItem:
         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 +215,14 @@ class ViewItem:
     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 +231,22 @@ class ViewItem:
     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,7 +277,7 @@ class 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))
@@ -236,22 +285,35 @@ class ViewItem:
         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 +336,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,11 +2,14 @@ import copy
 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
 
 from tableauserverclient.datetime_helpers import parse_datetime
+from tableauserverclient.models.location_item import LocationItem
+from tableauserverclient.models.project_item import ProjectItem
+from tableauserverclient.models.user_item import UserItem
 from .connection_item import ConnectionItem
 from .exceptions import UnpopulatedPropertyError
 from .permissions_item import PermissionsRule
@@ -51,13 +54,31 @@ class WorkbookItem:
     created_at : Optional[datetime.datetime]
         The date and time the workbook was created.
 
+    default_view_id : Optional[str]
+        The identifier for the default view of the workbook.
+
     description : Optional[str]
         User-defined description of the workbook.
 
+    encrypt_extracts : Optional[bool]
+        Indicates whether extracts are encrypted.
+
+    has_extracts : Optional[bool]
+        Indicates whether the workbook has extracts.
+
     id : Optional[str]
        The identifier for the workbook. You need this value to query a specific
        workbook or to delete a workbook with the get_by_id and delete methods.
 
+    last_published_at : Optional[datetime.datetime]
+        The date and time the workbook was last published.
+
+    location : Optional[LocationItem]
+        The location of the workbook, such as a personal space or project.
+
+    owner : Optional[UserItem]
+        The owner of the workbook.
+
     owner_id : Optional[str]
         The identifier for the owner (UserItem) of the workbook.
 
@@ -65,6 +86,9 @@ class WorkbookItem:
         The thumbnail image for the view. You must first call the
         workbooks.populate_preview_image method to access this data.
 
+    project: Optional[ProjectItem]
+        The project that contains the workbook.
+
     project_name : Optional[str]
         The name of the project that contains the workbook.
 
@@ -139,6 +163,15 @@ class WorkbookItem:
         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
+        self._project: Optional[ProjectItem] = None
+        self._owner: Optional[UserItem] = None
+        self._location: Optional[LocationItem] = None
+        self._encrypt_extracts: Optional[bool] = None
+        self._default_view_id: Optional[str] = None
+        self._share_description: Optional[str] = None
+        self._last_published_at: Optional[datetime.datetime] = None
 
         return None
 
@@ -234,6 +267,14 @@ class WorkbookItem:
     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
@@ -300,6 +341,34 @@ class WorkbookItem:
     def thumbnails_group_id(self, value: str):
         self._thumbnails_group_id = value
 
+    @property
+    def project(self) -> Optional[ProjectItem]:
+        return self._project
+
+    @property
+    def owner(self) -> Optional[UserItem]:
+        return self._owner
+
+    @property
+    def location(self) -> Optional[LocationItem]:
+        return self._location
+
+    @property
+    def encrypt_extracts(self) -> Optional[bool]:
+        return self._encrypt_extracts
+
+    @property
+    def default_view_id(self) -> Optional[str]:
+        return self._default_view_id
+
+    @property
+    def share_description(self) -> Optional[str]:
+        return self._share_description
+
+    @property
+    def last_published_at(self) -> Optional[datetime.datetime]:
+        return self._last_published_at
+
     def _set_connections(self, connections):
         self._connections = connections
 
@@ -342,6 +411,15 @@ class WorkbookItem:
                 views,
                 data_acceleration_config,
                 data_freshness_policy,
+                sheet_count,
+                has_extracts,
+                project,
+                owner,
+                location,
+                encrypt_extracts,
+                default_view_id,
+                share_description,
+                last_published_at,
             ) = self._parse_element(workbook_xml, ns)
 
             self._set_values(
@@ -361,6 +439,15 @@ class WorkbookItem:
                 views,
                 data_acceleration_config,
                 data_freshness_policy,
+                sheet_count,
+                has_extracts,
+                project,
+                owner,
+                location,
+                encrypt_extracts,
+                default_view_id,
+                share_description,
+                last_published_at,
             )
 
         return self
@@ -383,6 +470,15 @@ class WorkbookItem:
         views,
         data_acceleration_config,
         data_freshness_policy,
+        sheet_count,
+        has_extracts,
+        project,
+        owner,
+        location,
+        encrypt_extracts,
+        default_view_id,
+        share_description,
+        last_published_at,
     ):
         if id is not None:
             self._id = id
@@ -417,6 +513,24 @@ class WorkbookItem:
             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
+        if project:
+            self._project = project
+        if owner:
+            self._owner = owner
+        if location:
+            self._location = location
+        if encrypt_extracts is not None:
+            self._encrypt_extracts = encrypt_extracts
+        if default_view_id is not None:
+            self._default_view_id = default_view_id
+        if share_description is not None:
+            self._share_description = share_description
+        if last_published_at is not None:
+            self._last_published_at = last_published_at
 
     @classmethod
     def from_response(cls, resp: str, ns: dict[str, str]) -> list["WorkbookItem"]:
@@ -443,6 +557,12 @@ class WorkbookItem:
         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", ""))
+        encrypt_extracts = string_to_bool(e) if (e := workbook_xml.get("encryptExtracts", None)) is not None else None
+        default_view_id = workbook_xml.get("defaultViewId", None)
+        share_description = workbook_xml.get("shareDescription", None)
+        last_published_at = parse_datetime(workbook_xml.get("lastPublishedAt", None))
 
         size = workbook_xml.get("size", None)
         if size:
@@ -452,14 +572,18 @@ class WorkbookItem:
 
         project_id = None
         project_name = None
+        project = None
         project_tag = workbook_xml.find(".//t:project", namespaces=ns)
         if project_tag is not None:
+            project = ProjectItem.from_xml(project_tag, ns)
             project_id = project_tag.get("id", None)
             project_name = project_tag.get("name", None)
 
         owner_id = None
+        owner = None
         owner_tag = workbook_xml.find(".//t:owner", namespaces=ns)
         if owner_tag is not None:
+            owner = UserItem.from_xml(owner_tag, ns)
             owner_id = owner_tag.get("id", None)
 
         tags = None
@@ -473,6 +597,11 @@ class WorkbookItem:
         if views_elem is not None:
             views = ViewItem.from_xml_element(views_elem, ns)
 
+        location = None
+        location_elem = workbook_xml.find(".//t:location", namespaces=ns)
+        if location_elem is not None:
+            location = LocationItem.from_xml(location_elem, ns)
+
         data_acceleration_config = {
             "acceleration_enabled": None,
             "accelerate_now": None,
@@ -505,6 +634,15 @@ class WorkbookItem:
             views,
             data_acceleration_config,
             data_freshness_policy,
+            sheet_count,
+            has_extracts,
+            project,
+            owner,
+            location,
+            encrypt_extracts,
+            default_view_id,
+            share_description,
+            last_published_at,
         )
 
 
@@ -535,3 +673,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

tableauserverclient/server/endpoint/databases_endpoint.py

@@ -1,7 +1,8 @@
 import logging
-from typing import Union
+from typing import TYPE_CHECKING, Optional, Union
 from collections.abc import Iterable
 
+from tableauserverclient.models.permissions_item import PermissionsRule
 from tableauserverclient.server.endpoint.default_permissions_endpoint import _DefaultPermissionsEndpoint
 from tableauserverclient.server.endpoint.dqw_endpoint import _DataQualityWarningEndpoint
 from tableauserverclient.server.endpoint.endpoint import api, Endpoint
@@ -13,6 +14,10 @@ from tableauserverclient.models import DatabaseItem, TableItem, PaginationItem,
 
 from tableauserverclient.helpers.logging import logger
 
+if TYPE_CHECKING:
+    from tableauserverclient.models.dqw_item import DQWItem
+    from tableauserverclient.server.request_options import RequestOptions
+
 
 class Databases(Endpoint, TaggingMixin):
     def __init__(self, parent_srv):
@@ -23,11 +28,29 @@ class Databases(Endpoint, TaggingMixin):
         self._data_quality_warnings = _DataQualityWarningEndpoint(parent_srv, Resource.Database)
 
     @property
-    def baseurl(self):
+    def baseurl(self) -> str:
         return f"{self.parent_srv.baseurl}/sites/{self.parent_srv.site_id}/databases"
 
     @api(version="3.5")
-    def get(self, req_options=None):
+    def get(self, req_options: Optional["RequestOptions"] = None) -> tuple[list[DatabaseItem], PaginationItem]:
+        """
+        Get information about all databases on the site. Endpoint is paginated,
+        and will return a default of 100 items per page. Use the `req_options`
+        parameter to customize the request.
+
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_metadata.htm#query_databases
+
+        Parameters
+        ----------
+        req_options : RequestOptions, optional
+            Options to customize the request. If not provided, defaults to None.
+
+        Returns
+        -------
+        tuple[list[DatabaseItem], PaginationItem]
+            A tuple containing a list of DatabaseItem objects and a
+            PaginationItem object.
+        """
         logger.info("Querying all databases on site")
         url = self.baseurl
         server_response = self.get_request(url, req_options)
@@ -37,7 +60,27 @@ class Databases(Endpoint, TaggingMixin):
 
     # Get 1 database
     @api(version="3.5")
-    def get_by_id(self, database_id):
+    def get_by_id(self, database_id: str) -> DatabaseItem:
+        """
+        Get information about a single database asset on the site.
+
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_metadata.htm#query_database
+
+        Parameters
+        ----------
+        database_id : str
+            The ID of the database to retrieve.
+
+        Returns
+        -------
+        DatabaseItem
+            A DatabaseItem object representing the database.
+
+        Raises
+        ------
+        ValueError
+            If the database ID is undefined.
+        """
         if not database_id:
             error = "database ID undefined."
             raise ValueError(error)
@@ -47,7 +90,24 @@ class Databases(Endpoint, TaggingMixin):
         return DatabaseItem.from_response(server_response.content, self.parent_srv.namespace)[0]
 
     @api(version="3.5")
-    def delete(self, database_id):
+    def delete(self, database_id: str) -> None:
+        """
+        Deletes a single database asset from the server.
+
+        Parameters
+        ----------
+        database_id : str
+            The ID of the database to delete.
+
+        Returns
+        -------
+        None
+
+        Raises
+        ------
+        ValueError
+            If the database ID is undefined.
+        """
         if not database_id:
             error = "Database ID undefined."
             raise ValueError(error)
@@ -56,7 +116,28 @@ class Databases(Endpoint, TaggingMixin):
         logger.info(f"Deleted single database (ID: {database_id})")
 
     @api(version="3.5")
-    def update(self, database_item):
+    def update(self, database_item: DatabaseItem) -> DatabaseItem:
+        """
+        Update the database description, certify the database, set permissions,
+        or assign a User as the database contact.
+
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_metadata.htm#update_database
+
+        Parameters
+        ----------
+        database_item : DatabaseItem
+            The DatabaseItem object to update.
+
+        Returns
+        -------
+        DatabaseItem
+            The updated DatabaseItem object.
+
+        Raises
+        ------
+        MissingRequiredFieldError
+            If the database item is missing an ID.
+        """
         if not database_item.id:
             error = "Database item missing ID."
             raise MissingRequiredFieldError(error)
@@ -88,43 +169,45 @@ class Databases(Endpoint, TaggingMixin):
         return tables
 
     @api(version="3.5")
-    def populate_permissions(self, item):
+    def populate_permissions(self, item: DatabaseItem) -> None:
         self._permissions.populate(item)
 
     @api(version="3.5")
-    def update_permissions(self, item, rules):
+    def update_permissions(self, item: DatabaseItem, rules: list[PermissionsRule]) -> list[PermissionsRule]:
         return self._permissions.update(item, rules)
 
     @api(version="3.5")
-    def delete_permission(self, item, rules):
+    def delete_permission(self, item: DatabaseItem, rules: list[PermissionsRule]) -> None:
         self._permissions.delete(item, rules)
 
     @api(version="3.5")
-    def populate_table_default_permissions(self, item):
+    def populate_table_default_permissions(self, item: DatabaseItem):
         self._default_permissions.populate_default_permissions(item, Resource.Table)
 
     @api(version="3.5")
-    def update_table_default_permissions(self, item):
-        return self._default_permissions.update_default_permissions(item, Resource.Table)
+    def update_table_default_permissions(
+        self, item: DatabaseItem, rules: list[PermissionsRule]
+    ) -> list[PermissionsRule]:
+        return self._default_permissions.update_default_permissions(item, rules, Resource.Table)
 
     @api(version="3.5")
-    def delete_table_default_permissions(self, item):
-        self._default_permissions.delete_default_permission(item, Resource.Table)
+    def delete_table_default_permissions(self, rule: PermissionsRule, item: DatabaseItem) -> None:
+        self._default_permissions.delete_default_permission(item, rule, Resource.Table)
 
     @api(version="3.5")
-    def populate_dqw(self, item):
+    def populate_dqw(self, item: DatabaseItem) -> None:
         self._data_quality_warnings.populate(item)
 
     @api(version="3.5")
-    def update_dqw(self, item, warning):
+    def update_dqw(self, item: DatabaseItem, warning: "DQWItem") -> list["DQWItem"]:
         return self._data_quality_warnings.update(item, warning)
 
     @api(version="3.5")
-    def add_dqw(self, item, warning):
+    def add_dqw(self, item: DatabaseItem, warning: "DQWItem") -> list["DQWItem"]:
         return self._data_quality_warnings.add(item, warning)
 
     @api(version="3.5")
-    def delete_dqw(self, item):
+    def delete_dqw(self, item: DatabaseItem) -> None:
         self._data_quality_warnings.clear(item)
 
     @api(version="3.9")

tableauserverclient/server/endpoint/datasources_endpoint.py

@@ -733,7 +733,7 @@ class Datasources(QuerysetEndpoint[DatasourceItem], TaggingMixin[DatasourceItem]
         self._data_quality_warnings.populate(item)
 
     @api(version="3.5")
-    def update_dqw(self, item, warning):
+    def update_dqw(self, item: DatasourceItem, warning: "DQWItem") -> list["DQWItem"]:
         """
         Update the warning type, status, and message of a data quality warning.
 
@@ -755,7 +755,7 @@ class Datasources(QuerysetEndpoint[DatasourceItem], TaggingMixin[DatasourceItem]
         return self._data_quality_warnings.update(item, warning)
 
     @api(version="3.5")
-    def add_dqw(self, item, warning):
+    def add_dqw(self, item: DatasourceItem, warning: "DQWItem") -> list["DQWItem"]:
         """
         Add a data quality warning to a datasource.
 
@@ -786,7 +786,7 @@ class Datasources(QuerysetEndpoint[DatasourceItem], TaggingMixin[DatasourceItem]
         return self._data_quality_warnings.add(item, warning)
 
     @api(version="3.5")
-    def delete_dqw(self, item):
+    def delete_dqw(self, item: DatasourceItem) -> None:
         """
         Delete a data quality warnings from an asset.