tableauserverclient 0.32__py3-none-any.whl → 0.34__py3-none-any.whl

tableauserverclient/__init__.py

@@ -17,10 +17,14 @@ from tableauserverclient.models import (
     FlowRunItem,
     FileuploadItem,
     GroupItem,
+    GroupSetItem,
     HourlyInterval,
     IntervalItem,
     JobItem,
     JWTAuth,
+    LinkedTaskItem,
+    LinkedTaskStepItem,
+    LinkedTaskFlowRunItem,
     MetricItem,
     MonthlyInterval,
     PaginationItem,
@@ -28,17 +32,20 @@ from tableauserverclient.models import (
     PermissionsRule,
     PersonalAccessTokenAuth,
     ProjectItem,
+    Resource,
     RevisionItem,
     ScheduleItem,
     SiteItem,
     ServerInfoItem,
     SubscriptionItem,
+    TableauItem,
     TableItem,
     TableauAuth,
     Target,
     TaskItem,
     UserItem,
     ViewItem,
+    VirtualConnectionItem,
     WebhookItem,
     WeeklyInterval,
     WorkbookItem,
@@ -51,6 +58,7 @@ from tableauserverclient.server import (
     PDFRequestOptions,
     RequestOptions,
     MissingRequiredFieldError,
+    FailedSignInError,
     NotSignedInError,
     ServerResponseError,
     Filter,
@@ -60,60 +68,68 @@ from tableauserverclient.server import (
 )
 
 __all__ = [
-    "get_versions",
-    "DEFAULT_NAMESPACE",
     "BackgroundJobItem",
     "BackgroundJobItem",
     "ColumnItem",
     "ConnectionCredentials",
     "ConnectionItem",
+    "CSVRequestOptions",
     "CustomViewItem",
-    "DQWItem",
     "DailyInterval",
     "DataAlertItem",
     "DatabaseItem",
     "DataFreshnessPolicyItem",
     "DatasourceItem",
+    "DEFAULT_NAMESPACE",
+    "DQWItem",
+    "ExcelRequestOptions",
+    "FailedSignInError",
     "FavoriteItem",
+    "FileuploadItem",
+    "Filter",
     "FlowItem",
     "FlowRunItem",
-    "FileuploadItem",
+    "get_versions",
     "GroupItem",
+    "GroupSetItem",
     "HourlyInterval",
+    "ImageRequestOptions",
     "IntervalItem",
     "JobItem",
     "JWTAuth",
+    "LinkedTaskFlowRunItem",
+    "LinkedTaskItem",
+    "LinkedTaskStepItem",
     "MetricItem",
+    "MissingRequiredFieldError",
     "MonthlyInterval",
+    "NotSignedInError",
+    "Pager",
     "PaginationItem",
+    "PDFRequestOptions",
     "Permission",
     "PermissionsRule",
     "PersonalAccessTokenAuth",
     "ProjectItem",
+    "RequestOptions",
+    "Resource",
     "RevisionItem",
     "ScheduleItem",
-    "SiteItem",
+    "Server",
     "ServerInfoItem",
+    "ServerResponseError",
+    "SiteItem",
+    "Sort",
     "SubscriptionItem",
-    "TableItem",
     "TableauAuth",
+    "TableauItem",
+    "TableItem",
     "Target",
     "TaskItem",
     "UserItem",
     "ViewItem",
+    "VirtualConnectionItem",
     "WebhookItem",
     "WeeklyInterval",
     "WorkbookItem",
-    "CSVRequestOptions",
-    "ExcelRequestOptions",
-    "ImageRequestOptions",
-    "PDFRequestOptions",
-    "RequestOptions",
-    "MissingRequiredFieldError",
-    "NotSignedInError",
-    "ServerResponseError",
-    "Filter",
-    "Pager",
-    "Server",
-    "Sort",
 ]

tableauserverclient/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2024-07-27T15:44:04-0700",
+ "date": "2024-10-25T16:34:58-0700",
  "dirty": false,
  "error": null,
- "full-revisionid": "257cf616f35cc36b24a73e9e102886a52ead1853",
- "version": "0.32"
+ "full-revisionid": "1d98fdad189ebed130fb904e8fa5dca2207f9011",
+ "version": "0.34"
 }
 '''  # END VERSION_JSON
 

tableauserverclient/config.py

@@ -1,13 +1,27 @@
-# 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:
+    # The maximum size of a file that can be published in a single request is 64MB
+    @property
+    def FILESIZE_LIMIT_MB(self):
+        return min(int(os.getenv("TSC_FILESIZE_LIMIT_MB", 64)), 64)
+
+    # 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

@@ -14,6 +14,7 @@ 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,
@@ -22,6 +23,11 @@ from tableauserverclient.models.interval_item import (
     HourlyInterval,
 )
 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
@@ -39,6 +45,7 @@ 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
 
@@ -60,6 +67,7 @@ __all__ = [
     "FlowItem",
     "FlowRunItem",
     "GroupItem",
+    "GroupSetItem",
     "IntervalItem",
     "JobItem",
     "DailyInterval",
@@ -89,6 +97,10 @@ __all__ = [
     "TaskItem",
     "UserItem",
     "ViewItem",
+    "VirtualConnectionItem",
     "WebhookItem",
     "WorkbookItem",
+    "LinkedTaskItem",
+    "LinkedTaskStepItem",
+    "LinkedTaskFlowRunItem",
 ]

tableauserverclient/models/column_item.py

@@ -3,7 +3,7 @@ from defusedxml.ElementTree import fromstring
 from .property_decorators import property_not_empty
 
 
-class ColumnItem(object):
+class ColumnItem:
     def __init__(self, name, description=None):
         self._id = None
         self.description = description

tableauserverclient/models/connection_credentials.py

@@ -1,7 +1,7 @@
 from .property_decorators import property_is_boolean
 
 
-class ConnectionCredentials(object):
+class ConnectionCredentials:
     """Connection Credentials for Workbooks and Datasources publish request.
 
     Consider removing this object and other variables holding secrets

tableauserverclient/models/connection_item.py

@@ -1,5 +1,5 @@
 import logging
-from typing import List, Optional
+from typing import Optional
 
 from defusedxml.ElementTree import fromstring
 
@@ -8,7 +8,7 @@ from .property_decorators import property_is_boolean
 from tableauserverclient.helpers.logging import logger
 
 
-class ConnectionItem(object):
+class ConnectionItem:
     def __init__(self):
         self._datasource_id: Optional[str] = None
         self._datasource_name: Optional[str] = None
@@ -48,7 +48,7 @@ class ConnectionItem(object):
         # if connection type = hyper, Snowflake, or Teradata, we can't change this value: it is always true
         if self._connection_type in ["hyper", "snowflake", "teradata"]:
             logger.debug(
-                "Cannot update value: Query tagging is always enabled for {} connections".format(self._connection_type)
+                f"Cannot update value: Query tagging is always enabled for {self._connection_type} connections"
             )
             return
         self._query_tagging = value
@@ -59,19 +59,21 @@ class ConnectionItem(object):
         )
 
     @classmethod
-    def from_response(cls, resp, ns) -> List["ConnectionItem"]:
+    def from_response(cls, resp, ns) -> list["ConnectionItem"]:
         all_connection_items = list()
         parsed_response = fromstring(resp)
         all_connection_xml = parsed_response.findall(".//t:connection", namespaces=ns)
         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)
@@ -80,7 +82,7 @@ class ConnectionItem(object):
         return all_connection_items
 
     @classmethod
-    def from_xml_element(cls, parsed_response, ns) -> List["ConnectionItem"]:
+    def from_xml_element(cls, parsed_response, ns) -> list["ConnectionItem"]:
         """
         <connections>
             <connection serverAddress="mysql.test.com">
@@ -91,7 +93,7 @@ class ConnectionItem(object):
                 </connection>
         </connections>
         """
-        all_connection_items: List["ConnectionItem"] = list()
+        all_connection_items: list["ConnectionItem"] = list()
         all_connection_xml = parsed_response.findall(".//t:connection", namespaces=ns)
 
         for connection_xml in all_connection_xml:

tableauserverclient/models/custom_view_item.py

@@ -2,7 +2,8 @@ from datetime import datetime
 
 from defusedxml import ElementTree
 from defusedxml.ElementTree import fromstring, tostring
-from typing import Callable, List, Optional
+from typing import Callable, Optional
+from collections.abc import Iterator
 
 from .exceptions import UnpopulatedPropertyError
 from .user_item import UserItem
@@ -11,12 +12,14 @@ from .workbook_item import WorkbookItem
 from ..datetime_helpers import parse_datetime
 
 
-class CustomViewItem(object):
+class CustomViewItem:
     def __init__(self, id: Optional[str] = None, name: Optional[str] = None) -> None:
         self._content_url: Optional[str] = None  # ?
         self._created_at: Optional["datetime"] = None
         self._id: Optional[str] = id
         self._image: Optional[Callable[[], bytes]] = None
+        self._pdf: Optional[Callable[[], bytes]] = None
+        self._csv: Optional[Callable[[], Iterator[bytes]]] = None
         self._name: Optional[str] = name
         self._shared: Optional[bool] = False
         self._updated_at: Optional["datetime"] = None
@@ -35,11 +38,17 @@ class CustomViewItem(object):
         owner_info = ""
         if self._owner:
             owner_info = " owner='{}'".format(self._owner.name or self._owner.id or "unknown")
-        return "<CustomViewItem id={} name=`{}`{}{}{}>".format(self.id, self.name, view_info, wb_info, owner_info)
+        return f"<CustomViewItem id={self.id} name=`{self.name}`{view_info}{wb_info}{owner_info}>"
 
     def _set_image(self, image):
         self._image = image
 
+    def _set_pdf(self, pdf):
+        self._pdf = pdf
+
+    def _set_csv(self, csv):
+        self._csv = csv
+
     @property
     def content_url(self) -> Optional[str]:
         return self._content_url
@@ -55,10 +64,24 @@ class CustomViewItem(object):
     @property
     def image(self) -> bytes:
         if self._image is None:
-            error = "View item must be populated with its png image first."
+            error = "Custom View item must be populated with its png image first."
             raise UnpopulatedPropertyError(error)
         return self._image()
 
+    @property
+    def pdf(self) -> bytes:
+        if self._pdf is None:
+            error = "Custom View item must be populated with its pdf first."
+            raise UnpopulatedPropertyError(error)
+        return self._pdf()
+
+    @property
+    def csv(self) -> Iterator[bytes]:
+        if self._csv is None:
+            error = "Custom View item must be populated with its csv first."
+            raise UnpopulatedPropertyError(error)
+        return self._csv()
+
     @property
     def name(self) -> Optional[str]:
         return self._name
@@ -104,7 +127,7 @@ class CustomViewItem(object):
             return item[0]
 
     @classmethod
-    def list_from_response(cls, resp, ns, workbook_id="") -> List["CustomViewItem"]:
+    def list_from_response(cls, resp, ns, workbook_id="") -> list["CustomViewItem"]:
         return cls.from_xml_element(fromstring(resp), ns, workbook_id)
 
     """
@@ -121,7 +144,7 @@ class CustomViewItem(object):
     """
 
     @classmethod
-    def from_xml_element(cls, parsed_response, ns, workbook_id="") -> List["CustomViewItem"]:
+    def from_xml_element(cls, parsed_response, ns, workbook_id="") -> list["CustomViewItem"]:
         all_view_items = list()
         all_view_xml = parsed_response.findall(".//t:customView", namespaces=ns)
         for custom_view_xml in all_view_xml:

tableauserverclient/models/data_acceleration_report_item.py

@@ -1,8 +1,8 @@
 from defusedxml.ElementTree import fromstring
 
 
-class DataAccelerationReportItem(object):
-    class ComparisonRecord(object):
+class DataAccelerationReportItem:
+    class ComparisonRecord:
         def __init__(
             self,
             site,

tableauserverclient/models/data_alert_item.py

@@ -1,5 +1,5 @@
 from datetime import datetime
-from typing import List, Optional
+from typing import Optional
 
 from defusedxml.ElementTree import fromstring
 
@@ -10,7 +10,7 @@ from .property_decorators import (
 )
 
 
-class DataAlertItem(object):
+class DataAlertItem:
     class Frequency:
         Once = "Once"
         Frequently = "Frequently"
@@ -34,7 +34,7 @@ class DataAlertItem(object):
         self._workbook_name: Optional[str] = None
         self._project_id: Optional[str] = None
         self._project_name: Optional[str] = None
-        self._recipients: Optional[List[str]] = None
+        self._recipients: Optional[list[str]] = None
 
     def __repr__(self) -> str:
         return "<Data Alert {_id} subject={_subject} frequency={_frequency} \
@@ -78,7 +78,7 @@ class DataAlertItem(object):
         return self._creatorId
 
     @property
-    def recipients(self) -> List[str]:
+    def recipients(self) -> list[str]:
         return self._recipients or list()
 
     @property
@@ -174,7 +174,7 @@ class DataAlertItem(object):
             self._recipients = recipients
 
     @classmethod
-    def from_response(cls, resp, ns) -> List["DataAlertItem"]:
+    def from_response(cls, resp, ns) -> list["DataAlertItem"]:
         all_alert_items = list()
         parsed_response = fromstring(resp)
         all_alert_xml = parsed_response.findall(".//t:dataAlert", namespaces=ns)

tableauserverclient/models/data_freshness_policy_item.py

@@ -1,6 +1,6 @@
 import xml.etree.ElementTree as ET
 
-from typing import Optional, Union, List
+from typing import Optional
 from tableauserverclient.models.property_decorators import property_is_enum, property_not_nullable
 from .interval_item import IntervalItem
 
@@ -50,11 +50,11 @@ class DataFreshnessPolicyItem:
             Week = "Week"
             Month = "Month"
 
-        def __init__(self, frequency: str, time: str, timezone, interval_item: Optional[List[str]] = None):
+        def __init__(self, frequency: str, time: str, timezone, interval_item: Optional[list[str]] = None):
             self.frequency = frequency
             self.time = time
             self.timezone = timezone
-            self.interval_item: Optional[List[str]] = interval_item
+            self.interval_item: Optional[list[str]] = interval_item
 
         def __repr__(self):
             return (
@@ -62,11 +62,11 @@ class DataFreshnessPolicyItem:
             ).format(**vars(self))
 
         @property
-        def interval_item(self) -> Optional[List[str]]:
+        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: list[str]):
             self._interval_item = value
 
         @property
@@ -186,7 +186,7 @@ def parse_week_intervals(interval_values):
 
 
 def parse_month_intervals(interval_values):
-    error = "Invalid interval value for a monthly frequency: {}.".format(interval_values)
+    error = f"Invalid interval value for a monthly frequency: {interval_values}."
 
     # Month interval can have value either only ['LastDay'] or list of dates e.g. ["1", 20", "30"]
     # First check if the list only have LastDay value. When using LastDay, there shouldn't be

tableauserverclient/models/database_item.py

@@ -10,7 +10,7 @@ from .property_decorators import (
 )
 
 
-class DatabaseItem(object):
+class DatabaseItem:
     class ContentPermissions:
         LockedToProject = "LockedToDatabase"
         ManagedByOwner = "ManagedByOwner"
@@ -44,6 +44,12 @@ class DatabaseItem(object):
 
         self._tables = None  # Not implemented yet
 
+    def __str__(self):
+        return f"<Database {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:
@@ -244,7 +250,7 @@ class DatabaseItem(object):
         self._tables = tables
 
     def _set_default_permissions(self, permissions, content_type):
-        attr = "_default_{content}_permissions".format(content=content_type)
+        attr = f"_default_{content_type}_permissions"
         setattr(
             self,
             attr,

tableauserverclient/models/datasource_item.py

@@ -1,7 +1,7 @@
 import copy
 import datetime
 import xml.etree.ElementTree as ET
-from typing import Dict, List, Optional, Set, Tuple
+from typing import Optional
 
 from defusedxml.ElementTree import fromstring
 
@@ -18,14 +18,14 @@ from tableauserverclient.models.revision_item import RevisionItem
 from tableauserverclient.models.tag_item import TagItem
 
 
-class DatasourceItem(object):
+class DatasourceItem:
     class AskDataEnablement:
         Enabled = "Enabled"
         Disabled = "Disabled"
         SiteDefault = "SiteDefault"
 
     def __repr__(self):
-        return "<Datasource {0} '{1}' ({2} parent={3} >".format(
+        return "<Datasource {} '{}' ({} parent={} >".format(
             self._id,
             self.name,
             self.description or "No Description",
@@ -44,7 +44,7 @@ class DatasourceItem(object):
         self._encrypt_extracts = None
         self._has_extracts = None
         self._id: Optional[str] = None
-        self._initial_tags: Set = set()
+        self._initial_tags: set = set()
         self._project_name: Optional[str] = None
         self._revisions = None
         self._size: Optional[int] = None
@@ -55,7 +55,7 @@ class DatasourceItem(object):
         self.name = name
         self.owner_id: Optional[str] = None
         self.project_id = project_id
-        self.tags: Set[str] = set()
+        self.tags: set[str] = set()
 
         self._permissions = None
         self._data_quality_warnings = None
@@ -72,14 +72,14 @@ class DatasourceItem(object):
         self._ask_data_enablement = value
 
     @property
-    def connections(self) -> Optional[List[ConnectionItem]]:
+    def connections(self) -> Optional[list[ConnectionItem]]:
         if self._connections is None:
             error = "Datasource item must be populated with connections first."
             raise UnpopulatedPropertyError(error)
         return self._connections()
 
     @property
-    def permissions(self) -> Optional[List[PermissionsRule]]:
+    def permissions(self) -> Optional[list[PermissionsRule]]:
         if self._permissions is None:
             error = "Project item must be populated with permissions first."
             raise UnpopulatedPropertyError(error)
@@ -177,7 +177,7 @@ class DatasourceItem(object):
         return self._webpage_url
 
     @property
-    def revisions(self) -> List[RevisionItem]:
+    def revisions(self) -> list[RevisionItem]:
         if self._revisions is None:
             error = "Datasource item must be populated with revisions first."
             raise UnpopulatedPropertyError(error)
@@ -309,7 +309,7 @@ class DatasourceItem(object):
             self._size = int(size)
 
     @classmethod
-    def from_response(cls, resp: str, ns: Dict) -> List["DatasourceItem"]:
+    def from_response(cls, resp: str, ns: dict) -> list["DatasourceItem"]:
         all_datasource_items = list()
         parsed_response = fromstring(resp)
         all_datasource_xml = parsed_response.findall(".//t:datasource", namespaces=ns)
@@ -326,7 +326,7 @@ class DatasourceItem(object):
         return datasource_item
 
     @staticmethod
-    def _parse_element(datasource_xml: ET.Element, ns: Dict) -> Tuple:
+    def _parse_element(datasource_xml: ET.Element, ns: dict) -> tuple:
         id_ = datasource_xml.get("id", None)
         name = datasource_xml.get("name", None)
         datasource_type = datasource_xml.get("type", None)

tableauserverclient/models/dqw_item.py

@@ -3,7 +3,7 @@ from defusedxml.ElementTree import fromstring
 from tableauserverclient.datetime_helpers import parse_datetime
 
 
-class DQWItem(object):
+class DQWItem:
     class WarningType:
         WARNING = "WARNING"
         DEPRECATED = "DEPRECATED"

tableauserverclient/models/favorites_item.py

@@ -1,28 +1,27 @@
 import logging
 
+from typing import Union
 from defusedxml.ElementTree import fromstring
-from tableauserverclient.models.tableau_types import TableauItem
 
+from tableauserverclient.models.tableau_types import TableauItem
 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
-from typing import Dict, List, Union
 
-FavoriteType = Dict[
+FavoriteType = dict[
     str,
-    List[TableauItem],
+    list[TableauItem],
 ]
 
 
 class FavoriteItem:
     @classmethod
-    def from_response(cls, xml: str, namespace: Dict) -> FavoriteType:
+    def from_response(cls, xml: Union[str, bytes], namespace: dict) -> FavoriteType:
         favorites: FavoriteType = {
             "datasources": [],
             "flows": [],

tableauserverclient/models/fileupload_item.py

@@ -1,7 +1,7 @@
 from defusedxml.ElementTree import fromstring
 
 
-class FileuploadItem(object):
+class FileuploadItem:
     def __init__(self):
         self._file_size = None
         self._upload_session_id = None