tableauserverclient 0.31__py3-none-any.whl → 0.33__py3-none-any.whl

tableauserverclient/__init__.py

@@ -1,6 +1,6 @@
-from ._version import get_versions
-from .namespace import NEW_NAMESPACE as DEFAULT_NAMESPACE
-from .models import (
+from tableauserverclient._version import get_versions
+from tableauserverclient.namespace import NEW_NAMESPACE as DEFAULT_NAMESPACE
+from tableauserverclient.models import (
     BackgroundJobItem,
     ColumnItem,
     ConnectionCredentials,
@@ -17,10 +17,14 @@ from .models import (
     FlowRunItem,
     FileuploadItem,
     GroupItem,
+    GroupSetItem,
     HourlyInterval,
     IntervalItem,
     JobItem,
     JWTAuth,
+    LinkedTaskItem,
+    LinkedTaskStepItem,
+    LinkedTaskFlowRunItem,
     MetricItem,
     MonthlyInterval,
     PaginationItem,
@@ -39,11 +43,13 @@ from .models import (
     TaskItem,
     UserItem,
     ViewItem,
+    VirtualConnectionItem,
     WebhookItem,
     WeeklyInterval,
     WorkbookItem,
 )
-from .server import (
+
+from tableauserverclient.server import (
     CSVRequestOptions,
     ExcelRequestOptions,
     ImageRequestOptions,
@@ -57,3 +63,67 @@ from .server import (
     Server,
     Sort,
 )
+
+__all__ = [
+    "get_versions",
+    "DEFAULT_NAMESPACE",
+    "BackgroundJobItem",
+    "BackgroundJobItem",
+    "ColumnItem",
+    "ConnectionCredentials",
+    "ConnectionItem",
+    "CustomViewItem",
+    "DQWItem",
+    "DailyInterval",
+    "DataAlertItem",
+    "DatabaseItem",
+    "DataFreshnessPolicyItem",
+    "DatasourceItem",
+    "FavoriteItem",
+    "FlowItem",
+    "FlowRunItem",
+    "FileuploadItem",
+    "GroupItem",
+    "GroupSetItem",
+    "HourlyInterval",
+    "IntervalItem",
+    "JobItem",
+    "JWTAuth",
+    "MetricItem",
+    "MonthlyInterval",
+    "PaginationItem",
+    "Permission",
+    "PermissionsRule",
+    "PersonalAccessTokenAuth",
+    "ProjectItem",
+    "RevisionItem",
+    "ScheduleItem",
+    "SiteItem",
+    "ServerInfoItem",
+    "SubscriptionItem",
+    "TableItem",
+    "TableauAuth",
+    "Target",
+    "TaskItem",
+    "UserItem",
+    "ViewItem",
+    "WebhookItem",
+    "WeeklyInterval",
+    "WorkbookItem",
+    "CSVRequestOptions",
+    "ExcelRequestOptions",
+    "ImageRequestOptions",
+    "PDFRequestOptions",
+    "RequestOptions",
+    "MissingRequiredFieldError",
+    "NotSignedInError",
+    "ServerResponseError",
+    "Filter",
+    "Pager",
+    "Server",
+    "Sort",
+    "LinkedTaskItem",
+    "LinkedTaskStepItem",
+    "LinkedTaskFlowRunItem",
+    "VirtualConnectionItem",
+]

tableauserverclient/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2024-06-03T12:52:39-0700",
+ "date": "2024-09-17T16:51:07-0700",
  "dirty": false,
  "error": null,
- "full-revisionid": "4018a0ffc01bfa7c5b0024c6f112ced158d420b9",
- "version": "0.31"
+ "full-revisionid": "4259316ef2e2656531b0c65c71d043708b37b4a9",
+ "version": "0.33"
 }
 '''  # END VERSION_JSON
 

tableauserverclient/config.py

@@ -1,13 +1,25 @@
-# TODO: check for env variables, else set default values
+import os
 
 ALLOWED_FILE_EXTENSIONS = ["tds", "tdsx", "tde", "hyper", "parquet"]
 
 BYTES_PER_MB = 1024 * 1024
 
-# For when a datasource is over 64MB, break it into 5MB(standard chunk size) chunks
-CHUNK_SIZE_MB = 5 * 10  # 5MB felt too slow, upped it to 50
-
 DELAY_SLEEP_SECONDS = 0.1
 
 # The maximum size of a file that can be published in a single request is 64MB
 FILESIZE_LIMIT_MB = 64
+
+
+class Config:
+    # For when a datasource is over 64MB, break it into 5MB(standard chunk size) chunks
+    @property
+    def CHUNK_SIZE_MB(self):
+        return int(os.getenv("TSC_CHUNK_SIZE_MB", 5 * 10))  # 5MB felt too slow, upped it to 50
+
+    # Default page size
+    @property
+    def PAGE_SIZE(self):
+        return int(os.getenv("TSC_PAGE_SIZE", 100))
+
+
+config = Config()

tableauserverclient/models/__init__.py

@@ -1,43 +1,106 @@
-from .column_item import ColumnItem
-from .connection_credentials import ConnectionCredentials
-from .connection_item import ConnectionItem
-from .custom_view_item import CustomViewItem
-from .data_acceleration_report_item import DataAccelerationReportItem
-from .data_alert_item import DataAlertItem
-from .database_item import DatabaseItem
-from .data_freshness_policy_item import DataFreshnessPolicyItem
-from .datasource_item import DatasourceItem
-from .dqw_item import DQWItem
-from .exceptions import UnpopulatedPropertyError
-from .favorites_item import FavoriteItem
-from .fileupload_item import FileuploadItem
-from .flow_item import FlowItem
-from .flow_run_item import FlowRunItem
-from .group_item import GroupItem
-from .interval_item import (
+from tableauserverclient.models.column_item import ColumnItem
+from tableauserverclient.models.connection_credentials import ConnectionCredentials
+from tableauserverclient.models.connection_item import ConnectionItem
+from tableauserverclient.models.custom_view_item import CustomViewItem
+from tableauserverclient.models.data_acceleration_report_item import DataAccelerationReportItem
+from tableauserverclient.models.data_alert_item import DataAlertItem
+from tableauserverclient.models.database_item import DatabaseItem
+from tableauserverclient.models.data_freshness_policy_item import DataFreshnessPolicyItem
+from tableauserverclient.models.datasource_item import DatasourceItem
+from tableauserverclient.models.dqw_item import DQWItem
+from tableauserverclient.models.exceptions import UnpopulatedPropertyError
+from tableauserverclient.models.favorites_item import FavoriteItem
+from tableauserverclient.models.fileupload_item import FileuploadItem
+from tableauserverclient.models.flow_item import FlowItem
+from tableauserverclient.models.flow_run_item import FlowRunItem
+from tableauserverclient.models.group_item import GroupItem
+from tableauserverclient.models.groupset_item import GroupSetItem
+from tableauserverclient.models.interval_item import (
     IntervalItem,
     DailyInterval,
     WeeklyInterval,
     MonthlyInterval,
     HourlyInterval,
 )
-from .job_item import JobItem, BackgroundJobItem
-from .metric_item import MetricItem
-from .pagination_item import PaginationItem
-from .permissions_item import PermissionsRule, Permission
-from .project_item import ProjectItem
-from .revision_item import RevisionItem
-from .schedule_item import ScheduleItem
-from .server_info_item import ServerInfoItem
-from .site_item import SiteItem
-from .subscription_item import SubscriptionItem
-from .table_item import TableItem
-from .tableau_auth import Credentials, TableauAuth, PersonalAccessTokenAuth, JWTAuth
-from .tableau_types import Resource, TableauItem, plural_type
-from .tag_item import TagItem
-from .target import Target
-from .task_item import TaskItem
-from .user_item import UserItem
-from .view_item import ViewItem
-from .webhook_item import WebhookItem
-from .workbook_item import WorkbookItem
+from tableauserverclient.models.job_item import JobItem, BackgroundJobItem
+from tableauserverclient.models.linked_tasks_item import (
+    LinkedTaskItem,
+    LinkedTaskStepItem,
+    LinkedTaskFlowRunItem,
+)
+from tableauserverclient.models.metric_item import MetricItem
+from tableauserverclient.models.pagination_item import PaginationItem
+from tableauserverclient.models.permissions_item import PermissionsRule, Permission
+from tableauserverclient.models.project_item import ProjectItem
+from tableauserverclient.models.revision_item import RevisionItem
+from tableauserverclient.models.schedule_item import ScheduleItem
+from tableauserverclient.models.server_info_item import ServerInfoItem
+from tableauserverclient.models.site_item import SiteItem
+from tableauserverclient.models.subscription_item import SubscriptionItem
+from tableauserverclient.models.table_item import TableItem
+from tableauserverclient.models.tableau_auth import Credentials, TableauAuth, PersonalAccessTokenAuth, JWTAuth
+from tableauserverclient.models.tableau_types import Resource, TableauItem, plural_type
+from tableauserverclient.models.tag_item import TagItem
+from tableauserverclient.models.target import Target
+from tableauserverclient.models.task_item import TaskItem
+from tableauserverclient.models.user_item import UserItem
+from tableauserverclient.models.view_item import ViewItem
+from tableauserverclient.models.virtual_connection_item import VirtualConnectionItem
+from tableauserverclient.models.webhook_item import WebhookItem
+from tableauserverclient.models.workbook_item import WorkbookItem
+
+__all__ = [
+    "ColumnItem",
+    "ConnectionCredentials",
+    "ConnectionItem",
+    "Credentials",
+    "CustomViewItem",
+    "DataAccelerationReportItem",
+    "DataAlertItem",
+    "DatabaseItem",
+    "DataFreshnessPolicyItem",
+    "DatasourceItem",
+    "DQWItem",
+    "UnpopulatedPropertyError",
+    "FavoriteItem",
+    "FileuploadItem",
+    "FlowItem",
+    "FlowRunItem",
+    "GroupItem",
+    "GroupSetItem",
+    "IntervalItem",
+    "JobItem",
+    "DailyInterval",
+    "WeeklyInterval",
+    "MonthlyInterval",
+    "HourlyInterval",
+    "BackgroundJobItem",
+    "MetricItem",
+    "PaginationItem",
+    "Permission",
+    "PermissionsRule",
+    "ProjectItem",
+    "RevisionItem",
+    "ScheduleItem",
+    "ServerInfoItem",
+    "SiteItem",
+    "SubscriptionItem",
+    "TableItem",
+    "TableauAuth",
+    "PersonalAccessTokenAuth",
+    "JWTAuth",
+    "Resource",
+    "TableauItem",
+    "plural_type",
+    "TagItem",
+    "Target",
+    "TaskItem",
+    "UserItem",
+    "ViewItem",
+    "VirtualConnectionItem",
+    "WebhookItem",
+    "WorkbookItem",
+    "LinkedTaskItem",
+    "LinkedTaskStepItem",
+    "LinkedTaskFlowRunItem",
+]

tableauserverclient/models/connection_item.py

@@ -66,12 +66,14 @@ class ConnectionItem(object):
         for connection_xml in all_connection_xml:
             connection_item = cls()
             connection_item._id = connection_xml.get("id", None)
-            connection_item._connection_type = connection_xml.get("type", None)
+            connection_item._connection_type = connection_xml.get("type", connection_xml.get("dbClass", None))
             connection_item.embed_password = string_to_bool(connection_xml.get("embedPassword", ""))
             connection_item.server_address = connection_xml.get("serverAddress", None)
             connection_item.server_port = connection_xml.get("serverPort", None)
             connection_item.username = connection_xml.get("userName", None)
-            connection_item._query_tagging = string_to_bool(connection_xml.get("queryTaggingEnabled", None))
+            connection_item._query_tagging = (
+                string_to_bool(s) if (s := connection_xml.get("queryTagging", None)) else None
+            )
             datasource_elem = connection_xml.find(".//t:datasource", namespaces=ns)
             if datasource_elem is not None:
                 connection_item._datasource_id = datasource_elem.get("id", None)

tableauserverclient/models/database_item.py

@@ -44,6 +44,12 @@ class DatabaseItem(object):
 
         self._tables = None  # Not implemented yet
 
+    def __str__(self):
+        return "<Database {0} '{1}'>".format(self._id, self.name)
+
+    def __repr__(self):
+        return self.__str__() + "  { " + ", ".join(" % s: % s" % item for item in vars(self).items()) + "}"
+
     @property
     def dqws(self):
         if self._data_quality_warnings is None:

tableauserverclient/models/datasource_item.py

@@ -6,16 +6,16 @@ from typing import Dict, List, Optional, Set, Tuple
 from defusedxml.ElementTree import fromstring
 
 from tableauserverclient.datetime_helpers import parse_datetime
-from .connection_item import ConnectionItem
-from .exceptions import UnpopulatedPropertyError
-from .permissions_item import PermissionsRule
-from .property_decorators import (
+from tableauserverclient.models.connection_item import ConnectionItem
+from tableauserverclient.models.exceptions import UnpopulatedPropertyError
+from tableauserverclient.models.permissions_item import PermissionsRule
+from tableauserverclient.models.property_decorators import (
     property_not_nullable,
     property_is_boolean,
     property_is_enum,
 )
-from .revision_item import RevisionItem
-from .tag_item import TagItem
+from tableauserverclient.models.revision_item import RevisionItem
+from tableauserverclient.models.tag_item import TagItem
 
 
 class DatasourceItem(object):
@@ -47,6 +47,7 @@ class DatasourceItem(object):
         self._initial_tags: Set = set()
         self._project_name: Optional[str] = None
         self._revisions = None
+        self._size: Optional[int] = None
         self._updated_at = None
         self._use_remote_query_agent = None
         self._webpage_url = None
@@ -182,6 +183,10 @@ class DatasourceItem(object):
             raise UnpopulatedPropertyError(error)
         return self._revisions()
 
+    @property
+    def size(self) -> Optional[int]:
+        return self._size
+
     def _set_connections(self, connections):
         self._connections = connections
 
@@ -217,6 +222,7 @@ class DatasourceItem(object):
                 updated_at,
                 use_remote_query_agent,
                 webpage_url,
+                size,
             ) = self._parse_element(datasource_xml, ns)
             self._set_values(
                 ask_data_enablement,
@@ -237,6 +243,7 @@ class DatasourceItem(object):
                 updated_at,
                 use_remote_query_agent,
                 webpage_url,
+                size,
             )
         return self
 
@@ -260,6 +267,7 @@ class DatasourceItem(object):
         updated_at,
         use_remote_query_agent,
         webpage_url,
+        size,
     ):
         if ask_data_enablement is not None:
             self._ask_data_enablement = ask_data_enablement
@@ -297,6 +305,8 @@ class DatasourceItem(object):
             self._use_remote_query_agent = str(use_remote_query_agent).lower() == "true"
         if webpage_url:
             self._webpage_url = webpage_url
+        if size is not None:
+            self._size = int(size)
 
     @classmethod
     def from_response(cls, resp: str, ns: Dict) -> List["DatasourceItem"]:
@@ -330,6 +340,7 @@ class DatasourceItem(object):
         has_extracts = datasource_xml.get("hasExtracts", None)
         use_remote_query_agent = datasource_xml.get("useRemoteQueryAgent", None)
         webpage_url = datasource_xml.get("webpageUrl", None)
+        size = datasource_xml.get("size", None)
 
         tags = None
         tags_elem = datasource_xml.find(".//t:tags", namespaces=ns)
@@ -372,4 +383,5 @@ class DatasourceItem(object):
             updated_at,
             use_remote_query_agent,
             webpage_url,
+            size,
         )

tableauserverclient/models/favorites_item.py

@@ -1,14 +1,14 @@
 import logging
 
 from defusedxml.ElementTree import fromstring
-from .tableau_types import TableauItem
+from tableauserverclient.models.tableau_types import TableauItem
 
-from .datasource_item import DatasourceItem
-from .flow_item import FlowItem
-from .project_item import ProjectItem
-from .metric_item import MetricItem
-from .view_item import ViewItem
-from .workbook_item import WorkbookItem
+from tableauserverclient.models.datasource_item import DatasourceItem
+from tableauserverclient.models.flow_item import FlowItem
+from tableauserverclient.models.project_item import ProjectItem
+from tableauserverclient.models.metric_item import MetricItem
+from tableauserverclient.models.view_item import ViewItem
+from tableauserverclient.models.workbook_item import WorkbookItem
 from typing import Dict, List
 
 from tableauserverclient.helpers.logging import logger

tableauserverclient/models/flow_item.py

@@ -6,12 +6,12 @@ from typing import List, Optional, Set
 from defusedxml.ElementTree import fromstring
 
 from tableauserverclient.datetime_helpers import parse_datetime
-from .connection_item import ConnectionItem
-from .dqw_item import DQWItem
-from .exceptions import UnpopulatedPropertyError
-from .permissions_item import Permission
-from .property_decorators import property_not_nullable
-from .tag_item import TagItem
+from tableauserverclient.models.connection_item import ConnectionItem
+from tableauserverclient.models.dqw_item import DQWItem
+from tableauserverclient.models.exceptions import UnpopulatedPropertyError
+from tableauserverclient.models.permissions_item import Permission
+from tableauserverclient.models.property_decorators import property_not_nullable
+from tableauserverclient.models.tag_item import TagItem
 
 
 class FlowItem(object):

tableauserverclient/models/groupset_item.py

@@ -0,0 +1,53 @@
+from typing import Dict, List, Optional
+import xml.etree.ElementTree as ET
+
+from defusedxml.ElementTree import fromstring
+
+from tableauserverclient.models.group_item import GroupItem
+from tableauserverclient.models.reference_item import ResourceReference
+
+
+class GroupSetItem:
+    tag_name: str = "groupSet"
+
+    def __init__(self, name: Optional[str] = None) -> None:
+        self.name = name
+        self.id: Optional[str] = None
+        self.groups: List["GroupItem"] = []
+        self.group_count: int = 0
+
+    def __str__(self) -> str:
+        name = self.name
+        id = self.id
+        return f"<{self.__class__.__qualname__}({name=}, {id=})>"
+
+    def __repr__(self) -> str:
+        return self.__str__()
+
+    @classmethod
+    def from_response(cls, response: bytes, ns: Dict[str, str]) -> List["GroupSetItem"]:
+        parsed_response = fromstring(response)
+        all_groupset_xml = parsed_response.findall(".//t:groupSet", namespaces=ns)
+        return [cls.from_xml(xml, ns) for xml in all_groupset_xml]
+
+    @classmethod
+    def from_xml(cls, groupset_xml: ET.Element, ns: Dict[str, str]) -> "GroupSetItem":
+        def get_group(group_xml: ET.Element) -> GroupItem:
+            group_item = GroupItem()
+            group_item._id = group_xml.get("id")
+            group_item.name = group_xml.get("name")
+            return group_item
+
+        group_set_item = cls()
+        group_set_item.name = groupset_xml.get("name")
+        group_set_item.id = groupset_xml.get("id")
+        group_set_item.group_count = int(count) if (count := groupset_xml.get("groupCount")) else 0
+        group_set_item.groups = [
+            get_group(group_xml) for group_xml in groupset_xml.findall(".//t:group", namespaces=ns)
+        ]
+
+        return group_set_item
+
+    @staticmethod
+    def as_reference(id_: str) -> ResourceReference:
+        return ResourceReference(id_, GroupSetItem.tag_name)

tableauserverclient/models/interval_item.py

@@ -246,21 +246,34 @@ class MonthlyInterval(object):
 
     @interval.setter
     def interval(self, interval_values):
-        # This is weird because the value could be a str or an int
-        # The only valid str is 'LastDay' so we check that first. If that's not it
-        # try to convert it to an int, if that fails because it's an incorrect string
-        # like 'badstring' we catch and re-raise. Otherwise we convert to int and check
-        # that it's in range 1-31
+        # Valid monthly intervals strings can contain any of the following
+        #   day numbers (1-31) (integer or string)
+        #   relative day within the month (First, Second, ... Last)
+        #   week days (Sunday, Monday, ... LastDay)
+        VALID_INTERVALS = [
+            "Sunday",
+            "Monday",
+            "Tuesday",
+            "Wednesday",
+            "Thursday",
+            "Friday",
+            "Saturday",
+            "LastDay",
+            "First",
+            "Second",
+            "Third",
+            "Fourth",
+            "Fifth",
+            "Last",
+        ]
+        for value in range(1, 32):
+            VALID_INTERVALS.append(str(value))
+            VALID_INTERVALS.append(value)
+
         for interval_value in interval_values:
-            error = "Invalid interval value for a monthly frequency: {}.".format(interval_value)
-
-            if interval_value != "LastDay":
-                try:
-                    if not (1 <= int(interval_value) <= 31):
-                        raise ValueError(error)
-                except ValueError:
-                    if interval_value != "LastDay":
-                        raise ValueError(error)
+            if interval_value not in VALID_INTERVALS:
+                error = f"Invalid monthly interval: {interval_value}"
+                raise ValueError(error)
 
         self._interval = interval_values
 

tableauserverclient/models/job_item.py

@@ -4,7 +4,7 @@ from typing import List, Optional
 from defusedxml.ElementTree import fromstring
 
 from tableauserverclient.datetime_helpers import parse_datetime
-from .flow_run_item import FlowRunItem
+from tableauserverclient.models.flow_run_item import FlowRunItem
 
 
 class JobItem(object):
@@ -33,6 +33,8 @@ class JobItem(object):
         datasource_id: Optional[str] = None,
         flow_run: Optional[FlowRunItem] = None,
         updated_at: Optional[datetime.datetime] = None,
+        workbook_name: Optional[str] = None,
+        datasource_name: Optional[str] = None,
     ):
         self._id = id_
         self._type = job_type
@@ -47,6 +49,8 @@ class JobItem(object):
         self._datasource_id = datasource_id
         self._flow_run = flow_run
         self._updated_at = updated_at
+        self._workbook_name = workbook_name
+        self._datasource_name = datasource_name
 
     @property
     def id(self) -> str:
@@ -117,6 +121,14 @@ class JobItem(object):
     def updated_at(self) -> Optional[datetime.datetime]:
         return self._updated_at
 
+    @property
+    def workbook_name(self) -> Optional[str]:
+        return self._workbook_name
+
+    @property
+    def datasource_name(self) -> Optional[str]:
+        return self._datasource_name
+
     def __str__(self):
         return (
             "<Job#{_id} {_type} created_at({_created_at}) started_at({_started_at}) updated_at({_updated_at}) completed_at({_completed_at})"
@@ -148,8 +160,10 @@ class JobItem(object):
         mode = element.get("mode", None)
         workbook = element.find(".//t:workbook[@id]", namespaces=ns)
         workbook_id = workbook.get("id") if workbook is not None else None
+        workbook_name = workbook.get("name") if workbook is not None else None
         datasource = element.find(".//t:datasource[@id]", namespaces=ns)
         datasource_id = datasource.get("id") if datasource is not None else None
+        datasource_name = datasource.get("name") if datasource is not None else None
         flow_run = None
         updated_at = parse_datetime(element.get("updatedAt", None))
         for flow_job in element.findall(".//t:runFlowJobType", namespaces=ns):
@@ -172,6 +186,8 @@ class JobItem(object):
             datasource_id,
             flow_run,
             updated_at,
+            workbook_name,
+            datasource_name,
         )
 
 
@@ -206,7 +222,7 @@ class BackgroundJobItem(object):
         self._subtitle = subtitle
 
     def __str__(self):
-        return f"<{self.__class__.name} {self._id} {self._type}>"
+        return f"<{self.__class__.__qualname__} {self._id} {self._type}>"
 
     def __repr__(self):
         return self.__str__() + "  { " + ", ".join(" % s: % s" % item for item in vars(self).items()) + "}"