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

tableauserverclient/__init__.py

@@ -1,4 +1,4 @@
-from tableauserverclient._version import get_versions
+from tableauserverclient.bin._version import get_versions
 from tableauserverclient.namespace import NEW_NAMESPACE as DEFAULT_NAMESPACE
 from tableauserverclient.models import (
     BackgroundJobItem,
@@ -32,11 +32,13 @@ from tableauserverclient.models import (
     PermissionsRule,
     PersonalAccessTokenAuth,
     ProjectItem,
+    Resource,
     RevisionItem,
     ScheduleItem,
     SiteItem,
     ServerInfoItem,
     SubscriptionItem,
+    TableauItem,
     TableItem,
     TableauAuth,
     Target,
@@ -56,6 +58,7 @@ from tableauserverclient.server import (
     PDFRequestOptions,
     RequestOptions,
     MissingRequiredFieldError,
+    FailedSignInError,
     NotSignedInError,
     ServerResponseError,
     Filter,
@@ -65,65 +68,72 @@ 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",
-    "LinkedTaskItem",
-    "LinkedTaskStepItem",
-    "LinkedTaskFlowRunItem",
-    "VirtualConnectionItem",
 ]
+
+from .bin import _version
+
+__version__ = _version.get_versions()["version"]

tableauserverclient/{_version.py → bin/_version.py}

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2024-09-17T16:51:07-0700",
+ "date": "2025-01-03T19:22:57-0800",
  "dirty": false,
  "error": null,
- "full-revisionid": "4259316ef2e2656531b0c65c71d043708b37b4a9",
- "version": "0.33"
+ "full-revisionid": "c5e016fe5320267f795de4252b0dc92fa84495b5",
+ "version": "0.35"
 }
 '''  # END VERSION_JSON
 

tableauserverclient/config.py

@@ -6,11 +6,13 @@ BYTES_PER_MB = 1024 * 1024
 
 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):

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,12 +1,28 @@
 from .property_decorators import property_is_boolean
 
 
-class ConnectionCredentials(object):
-    """Connection Credentials for Workbooks and Datasources publish request.
+class ConnectionCredentials:
+    """
+    Connection Credentials for Workbooks and Datasources publish request.
 
     Consider removing this object and other variables holding secrets
     as soon as possible after use to avoid them hanging around in memory.
 
+    Parameters
+    ----------
+    name: str
+        The username for the connection.
+
+    password: str
+        The password used for the connection.
+
+    embed: bool, default True
+        Determines whether to embed the password (True) for the workbook or data source connection or not (False).
+
+    oauth: bool, default False
+        Determines whether to use OAuth for the connection (True) or not (False).
+        For more information see: https://help.tableau.com/current/server/en-us/protected_auth.htm
+
     """
 
     def __init__(self, name, password, embed=True, oauth=False):

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,45 @@ from .property_decorators import property_is_boolean
 from tableauserverclient.helpers.logging import logger
 
 
-class ConnectionItem(object):
+class ConnectionItem:
+    """
+    Corresponds to workbook and data source connections.
+
+    Attributes
+    ----------
+    datasource_id: str
+        The identifier of the data source.
+
+    datasource_name: str
+        The name of the data source.
+
+    id: str
+        The identifier of the connection.
+
+    connection_type: str
+        The type of connection.
+
+    username: str
+        The username for the connection. (see ConnectionCredentials)
+
+    password: str
+        The password used for the connection. (see ConnectionCredentials)
+
+    embed_password: bool
+        Determines whether to embed the password (True) for the workbook or data source connection or not (False). (see ConnectionCredentials)
+
+    server_address: str
+        The server address for the connection.
+
+    server_port: str
+        The port used for the connection.
+
+    connection_credentials: ConnectionCredentials
+        The Connection Credentials object containing authentication details for
+        the connection. Replaces username/password/embed_password when
+        publishing a flow, document or workbook file in the request body.
+    """
+
     def __init__(self):
         self._datasource_id: Optional[str] = None
         self._datasource_name: Optional[str] = None
@@ -48,7 +86,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,7 +97,7 @@ 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)
@@ -82,7 +120,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">
@@ -93,7 +131,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,21 +2,68 @@ 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
-from .view_item import ViewItem
-from .workbook_item import WorkbookItem
-from ..datetime_helpers import parse_datetime
+from tableauserverclient.models.exceptions import UnpopulatedPropertyError
+from tableauserverclient.models.user_item import UserItem
+from tableauserverclient.models.view_item import ViewItem
+from tableauserverclient.models.workbook_item import WorkbookItem
+from tableauserverclient.datetime_helpers import parse_datetime
 
 
-class CustomViewItem(object):
+class CustomViewItem:
+    """
+    Represents a Custom View item on Tableau Server.
+
+    Parameters
+    ----------
+    id : Optional[str]
+        The ID of the Custom View item.
+
+    name : Optional[str]
+        The name of the Custom View item.
+
+    Attributes
+    ----------
+    content_url : Optional[str]
+        The content URL of the Custom View item.
+
+    created_at : Optional[datetime]
+        The date and time the Custom View item was created.
+
+    image: bytes
+        The image of the Custom View item. Must be populated first.
+
+    pdf: bytes
+        The PDF of the Custom View item. Must be populated first.
+
+    csv: Iterator[bytes]
+        The CSV of the Custom View item. Must be populated first.
+
+    shared : Optional[bool]
+        Whether the Custom View item is shared.
+
+    updated_at : Optional[datetime]
+        The date and time the Custom View item was last updated.
+
+    owner : Optional[UserItem]
+        The id of the owner of the Custom View item.
+
+    workbook : Optional[WorkbookItem]
+        The id of the workbook the Custom View item belongs to.
+
+    view : Optional[ViewItem]
+        The id of the view the Custom View item belongs to.
+    """
+
     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 +82,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 +108,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 +171,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 +188,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"
@@ -45,7 +45,7 @@ class DatabaseItem(object):
         self._tables = None  # Not implemented yet
 
     def __str__(self):
-        return "<Database {0} '{1}'>".format(self._id, self.name)
+        return f"<Database {self._id} '{self.name}'>"
 
     def __repr__(self):
         return self.__str__() + "  { " + ", ".join(" % s: % s" % item for item in vars(self).items()) + "}"
@@ -250,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": [],