tableauserverclient 0.39__tar.gz → 0.40__tar.gz

{tableauserverclient-0.39 → tableauserverclient-0.40}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tableauserverclient
-Version: 0.39
+Version: 0.40
 Summary: A Python module for working with the Tableau Server REST API.
 Author-email: Tableau <github@tableau.com>
 Project-URL: repository, https://github.com/tableau/server-client-python

{tableauserverclient-0.39 → tableauserverclient-0.40}/pyproject.toml

@@ -35,8 +35,14 @@ repository = "https://github.com/tableau/server-client-python"
 test = ["black==24.10", "build", "mypy==1.4", "pytest>=7.0", "pytest-cov", "pytest-subtests",
     "pytest-xdist", "requests-mock>=1.0,<2.0", "types-requests>=2.32.4.20250913"]
 
+[tool.setuptools.package-data]
+# Only include data for tableauserverclient, not for samples, test, docs
+tableauserverclient = ["*"]
+
 [tool.setuptools.packages.find]
-where = ["tableauserverclient"]
+where = ["."]
+include = ["tableauserverclient*"]
+
 [tool.setuptools.dynamic]
 version = {attr = "versioneer.get_version"}
 

tableauserverclient-0.40/tableauserverclient/__init__.py

@@ -0,0 +1,150 @@
+from tableauserverclient.bin._version import get_versions
+from tableauserverclient.namespace import NEW_NAMESPACE as DEFAULT_NAMESPACE
+from tableauserverclient.models import (
+    BackgroundJobItem,
+    CollectionItem,
+    ColumnItem,
+    ConnectionCredentials,
+    ConnectionItem,
+    CustomViewItem,
+    DQWItem,
+    DailyInterval,
+    DataAlertItem,
+    DatabaseItem,
+    DataFreshnessPolicyItem,
+    DatasourceItem,
+    ExtensionsServer,
+    ExtensionsSiteSettings,
+    FavoriteItem,
+    FlowItem,
+    FlowRunItem,
+    FileuploadItem,
+    GroupItem,
+    GroupSetItem,
+    HourlyInterval,
+    IntervalItem,
+    JobItem,
+    JWTAuth,
+    LinkedTaskItem,
+    LinkedTaskStepItem,
+    LinkedTaskFlowRunItem,
+    LocationItem,
+    MetricItem,
+    MonthlyInterval,
+    PaginationItem,
+    Permission,
+    PermissionsRule,
+    PersonalAccessTokenAuth,
+    ProjectItem,
+    Resource,
+    RevisionItem,
+    SafeExtension,
+    ScheduleItem,
+    SiteAuthConfiguration,
+    SiteOIDCConfiguration,
+    SiteItem,
+    ServerInfoItem,
+    SubscriptionItem,
+    TableauItem,
+    TableItem,
+    TableauAuth,
+    Target,
+    TaskItem,
+    UserItem,
+    ViewItem,
+    VirtualConnectionItem,
+    WebhookItem,
+    WeeklyInterval,
+    WorkbookItem,
+)
+
+from tableauserverclient.server import (
+    CSVRequestOptions,
+    ExcelRequestOptions,
+    ImageRequestOptions,
+    PDFRequestOptions,
+    PPTXRequestOptions,
+    RequestOptions,
+    MissingRequiredFieldError,
+    FailedSignInError,
+    NotSignedInError,
+    ServerResponseError,
+    Filter,
+    Pager,
+    Server,
+    Sort,
+)
+
+__all__ = [
+    "BackgroundJobItem",
+    "CollectionItem",
+    "ColumnItem",
+    "ConnectionCredentials",
+    "ConnectionItem",
+    "CSVRequestOptions",
+    "CustomViewItem",
+    "DailyInterval",
+    "DataAlertItem",
+    "DatabaseItem",
+    "DataFreshnessPolicyItem",
+    "DatasourceItem",
+    "DEFAULT_NAMESPACE",
+    "DQWItem",
+    "ExcelRequestOptions",
+    "ExtensionsServer",
+    "ExtensionsSiteSettings",
+    "FailedSignInError",
+    "FavoriteItem",
+    "FileuploadItem",
+    "Filter",
+    "FlowItem",
+    "FlowRunItem",
+    "get_versions",
+    "GroupItem",
+    "GroupSetItem",
+    "HourlyInterval",
+    "ImageRequestOptions",
+    "IntervalItem",
+    "JobItem",
+    "JWTAuth",
+    "LinkedTaskFlowRunItem",
+    "LinkedTaskItem",
+    "LinkedTaskStepItem",
+    "LocationItem",
+    "MetricItem",
+    "MissingRequiredFieldError",
+    "MonthlyInterval",
+    "NotSignedInError",
+    "Pager",
+    "PaginationItem",
+    "PDFRequestOptions",
+    "PPTXRequestOptions",
+    "Permission",
+    "PermissionsRule",
+    "PersonalAccessTokenAuth",
+    "ProjectItem",
+    "RequestOptions",
+    "Resource",
+    "RevisionItem",
+    "SafeExtension",
+    "ScheduleItem",
+    "Server",
+    "ServerInfoItem",
+    "ServerResponseError",
+    "SiteItem",
+    "SiteAuthConfiguration",
+    "SiteOIDCConfiguration",
+    "Sort",
+    "SubscriptionItem",
+    "TableauAuth",
+    "TableauItem",
+    "TableItem",
+    "Target",
+    "TaskItem",
+    "UserItem",
+    "ViewItem",
+    "VirtualConnectionItem",
+    "WebhookItem",
+    "WeeklyInterval",
+    "WorkbookItem",
+]

{tableauserverclient-0.39 → tableauserverclient-0.40}/tableauserverclient/bin/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2026-02-02T11:01:51-0800",
+ "date": "2026-02-03T12:18:13-0800",
  "dirty": false,
  "error": null,
- "full-revisionid": "34ac954b8edd87e367e4e1f54b4179aee54e2816",
- "version": "0.39"
+ "full-revisionid": "d4b27f42d897883f8b8d0cb5b7edb558df2cbfb6",
+ "version": "0.40"
 }
 '''  # END VERSION_JSON
 

tableauserverclient-0.40/tableauserverclient/config.py

@@ -0,0 +1,27 @@
+import os
+
+ALLOWED_FILE_EXTENSIONS = ["tds", "tdsx", "tde", "hyper", "parquet"]
+
+BYTES_PER_MB = 1024 * 1024
+
+DELAY_SLEEP_SECONDS = 0.1
+
+
+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-0.40/tableauserverclient/datetime_helpers.py

@@ -0,0 +1,45 @@
+import datetime
+
+
+ZERO = datetime.timedelta(0)
+HOUR = datetime.timedelta(hours=1)
+
+
+def timestamp():
+    return datetime.datetime.now().strftime("%H:%M:%S")
+
+
+# This class is a concrete implementation of the abstract base class tzinfo
+# docs: https://docs.python.org/2.3/lib/datetime-tzinfo.html
+class UTC(datetime.tzinfo):
+    """UTC"""
+
+    def utcoffset(self, dt):
+        return ZERO
+
+    def tzname(self, dt):
+        return "UTC"
+
+    def dst(self, dt):
+        return ZERO
+
+
+utc = UTC()
+TABLEAU_DATE_FORMAT = "%Y-%m-%dT%H:%M:%SZ"
+
+
+def parse_datetime(date):
+    if date is None:
+        return None
+
+    try:
+        return datetime.datetime.strptime(date, TABLEAU_DATE_FORMAT).replace(tzinfo=utc)
+    except ValueError:
+        return None
+
+
+def format_datetime(date):
+    if date is None:
+        return None
+
+    return date.astimezone(tz=utc).strftime(TABLEAU_DATE_FORMAT)

tableauserverclient-0.40/tableauserverclient/exponential_backoff.py

@@ -0,0 +1,30 @@
+import time
+
+# Polling for server-side events (such as job completion) uses exponential backoff for the sleep intervals between polls
+ASYNC_POLL_MIN_INTERVAL = 0.5
+ASYNC_POLL_MAX_INTERVAL = 30
+ASYNC_POLL_BACKOFF_FACTOR = 1.4
+
+
+class ExponentialBackoffTimer:
+    def __init__(self, *, timeout=None):
+        self.start_time = time.time()
+        self.timeout = timeout
+        self.current_sleep_interval = ASYNC_POLL_MIN_INTERVAL
+
+    def sleep(self):
+        max_sleep_time = ASYNC_POLL_MAX_INTERVAL
+        if self.timeout is not None:
+            elapsed = time.time() - self.start_time
+            if elapsed >= self.timeout:
+                raise TimeoutError(f"Timeout after {elapsed} seconds waiting for asynchronous event")
+            remaining_time = self.timeout - elapsed
+            # Usually, we would sleep for `ASYNC_POLL_MAX_INTERVAL`, but we don't want to sleep over the timeout
+            max_sleep_time = min(ASYNC_POLL_MAX_INTERVAL, remaining_time)
+            # We want to sleep at least for `ASYNC_POLL_MIN_INTERVAL`. This is important to ensure that, as we get
+            # closer to the timeout, we don't accidentally wake up multiple times and hit the server in rapid succession
+            # due to waking up to early from the `sleep`.
+            max_sleep_time = max(max_sleep_time, ASYNC_POLL_MIN_INTERVAL)
+
+        time.sleep(min(self.current_sleep_interval, max_sleep_time))
+        self.current_sleep_interval *= ASYNC_POLL_BACKOFF_FACTOR

tableauserverclient-0.40/tableauserverclient/filesys_helpers.py

@@ -0,0 +1,63 @@
+import os
+
+ALLOWED_SPECIAL = (" ", ".", "_", "-")
+
+
+def to_filename(string_to_sanitize):
+    sanitized = (c for c in string_to_sanitize if c.isalnum() or c in ALLOWED_SPECIAL)
+    return "".join(sanitized)
+
+
+def make_download_path(filepath, filename):
+    download_path = None
+
+    if filepath is None:
+        download_path = filename
+
+    elif os.path.isdir(filepath):
+        download_path = os.path.join(filepath, filename)
+
+    else:
+        download_path = filepath + os.path.splitext(filename)[1]
+
+    return download_path
+
+
+def get_file_object_size(file):
+    # Returns the size of a file object
+    file.seek(0, os.SEEK_END)
+    file_size = file.tell()
+    file.seek(0)
+    return file_size
+
+
+def get_file_type(file):
+    # Tableau workbooks (twb) and data sources (tds) are both stored as xml files.
+    # Packaged workbooks (twbx) and data sources (tdsx) are zip files
+    # containing original files accompanied with supporting local files.
+
+    # This reference lists magic file signatures: https://www.garykessler.net/library/file_sigs.html
+    MAGIC_BYTES = {
+        "zip": bytes.fromhex("504b0304"),
+        "tde": bytes.fromhex("20020162"),
+        "xml": bytes.fromhex("3c3f786d6c20"),
+        "hyper": bytes.fromhex("487970657208000001000000"),
+    }
+
+    # Peek first bytes of a file
+    first_bytes = file.read(32)
+
+    file_type = None
+    for ft, signature in MAGIC_BYTES.items():
+        if first_bytes.startswith(signature):
+            file_type = ft
+            break
+
+    # Return pointer back to start
+    file.seek(0)
+
+    if file_type is None:
+        error = "Unknown file type!"
+        raise ValueError(error)
+
+    return file_type

tableauserverclient-0.40/tableauserverclient/namespace.py

@@ -0,0 +1,37 @@
+import re
+
+from defusedxml.ElementTree import fromstring
+
+OLD_NAMESPACE = "http://tableausoftware.com/api"
+NEW_NAMESPACE = "http://tableau.com/api"
+NAMESPACE_RE = re.compile(r"\{(.*?)\}")
+
+
+class UnknownNamespaceError(Exception):
+    pass
+
+
+class Namespace:
+    def __init__(self):
+        self._namespace = {"t": NEW_NAMESPACE}
+        self._detected = False
+
+    def __call__(self):
+        return self._namespace
+
+    def detect(self, xml):
+        if self._detected:
+            return
+
+        if not xml.startswith(b"<?xml"):
+            return  # Not an xml file, don't detect anything
+
+        root = fromstring(xml)
+        matches = NAMESPACE_RE.match(root.tag)
+        if matches:
+            detected_ns = matches.group(1)
+            if detected_ns in (OLD_NAMESPACE, NEW_NAMESPACE):
+                self._namespace = {"t": detected_ns}
+                self._detected = True
+            else:
+                raise UnknownNamespaceError(detected_ns)

{tableauserverclient-0.39/tableauserverclient → tableauserverclient-0.40}/tableauserverclient.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tableauserverclient
-Version: 0.39
+Version: 0.40
 Summary: A Python module for working with the Tableau Server REST API.
 Author-email: Tableau <github@tableau.com>
 Project-URL: repository, https://github.com/tableau/server-client-python

{tableauserverclient-0.39/tableauserverclient → tableauserverclient-0.40}/tableauserverclient.egg-info/SOURCES.txt

@@ -48,7 +48,18 @@ samples/update_workbook_data_freshness_policy.py
 samples/getting_started/1_hello_server.py
 samples/getting_started/2_hello_site.py
 samples/getting_started/3_hello_universe.py
+tableauserverclient/__init__.py
+tableauserverclient/config.py
+tableauserverclient/datetime_helpers.py
+tableauserverclient/exponential_backoff.py
+tableauserverclient/filesys_helpers.py
+tableauserverclient/namespace.py
 tableauserverclient/py.typed
+tableauserverclient.egg-info/PKG-INFO
+tableauserverclient.egg-info/SOURCES.txt
+tableauserverclient.egg-info/dependency_links.txt
+tableauserverclient.egg-info/requires.txt
+tableauserverclient.egg-info/top_level.txt
 tableauserverclient/bin/__init__.py
 tableauserverclient/bin/_version.py
 tableauserverclient/helpers/__init__.py
@@ -150,11 +161,6 @@ tableauserverclient/server/endpoint/views_endpoint.py
 tableauserverclient/server/endpoint/virtual_connections_endpoint.py
 tableauserverclient/server/endpoint/webhooks_endpoint.py
 tableauserverclient/server/endpoint/workbooks_endpoint.py
-tableauserverclient/tableauserverclient.egg-info/PKG-INFO
-tableauserverclient/tableauserverclient.egg-info/SOURCES.txt
-tableauserverclient/tableauserverclient.egg-info/dependency_links.txt
-tableauserverclient/tableauserverclient.egg-info/requires.txt
-tableauserverclient/tableauserverclient.egg-info/top_level.txt
 test/__init__.py
 test/_utils.py
 test/test_auth.py

tableauserverclient-0.40/tableauserverclient.egg-info/top_level.txt

@@ -0,0 +1 @@
+tableauserverclient

tableauserverclient-0.39/tableauserverclient/tableauserverclient.egg-info/top_level.txt

@@ -1,4 +0,0 @@
-bin
-helpers
-models
-server