tableauserverclient 0.30.post0.dev1__py3-none-any.whl → 0.32__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,
@@ -43,7 +43,8 @@ from .models import (
     WeeklyInterval,
     WorkbookItem,
 )
-from .server import (
+
+from tableauserverclient.server import (
     CSVRequestOptions,
     ExcelRequestOptions,
     ImageRequestOptions,
@@ -57,3 +58,62 @@ 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",
+    "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",
+]

tableauserverclient/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2024-06-03T12:52:39-0700",
+ "date": "2024-07-27T15:44:04-0700",
  "dirty": false,
  "error": null,
- "full-revisionid": "4018a0ffc01bfa7c5b0024c6f112ced158d420b9",
- "version": "0.30.post0.dev1"
+ "full-revisionid": "257cf616f35cc36b24a73e9e102886a52ead1853",
+ "version": "0.32"
 }
 '''  # END VERSION_JSON
 

tableauserverclient/models/__init__.py

@@ -1,43 +1,94 @@
-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.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.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.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",
+    "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",
+    "WebhookItem",
+    "WorkbookItem",
+]

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/permissions_item.py

@@ -45,7 +45,7 @@ class Permission:
             return "<Enum Capability: AddComment | ChangeHierarchy | ChangePermission ... (17 more) >"
 
 
-class PermissionsRule(object):
+class PermissionsRule:
     def __init__(self, grantee: ResourceReference, capabilities: Dict[str, str]) -> None:
         self.grantee = grantee
         self.capabilities = capabilities
@@ -53,6 +53,51 @@ class PermissionsRule(object):
     def __repr__(self):
         return "<PermissionsRule grantee={}, capabilities={}>".format(self.grantee, self.capabilities)
 
+    def __eq__(self, other: object) -> bool:
+        if not hasattr(other, "grantee") or not hasattr(other, "capabilities"):
+            return False
+        return self.grantee == other.grantee and self.capabilities == other.capabilities
+
+    def __and__(self, other: "PermissionsRule") -> "PermissionsRule":
+        if self.grantee != other.grantee:
+            raise ValueError("Cannot AND two permissions rules with different grantees")
+
+        if self.capabilities == other.capabilities:
+            return self
+
+        capabilities = set((*self.capabilities.keys(), *other.capabilities.keys()))
+        new_capabilities = {}
+        for capability in capabilities:
+            if (self.capabilities.get(capability), other.capabilities.get(capability)) == (
+                Permission.Mode.Allow,
+                Permission.Mode.Allow,
+            ):
+                new_capabilities[capability] = Permission.Mode.Allow
+            elif Permission.Mode.Deny in (self.capabilities.get(capability), other.capabilities.get(capability)):
+                new_capabilities[capability] = Permission.Mode.Deny
+
+        return PermissionsRule(self.grantee, new_capabilities)
+
+    def __or__(self, other: "PermissionsRule") -> "PermissionsRule":
+        if self.grantee != other.grantee:
+            raise ValueError("Cannot OR two permissions rules with different grantees")
+
+        if self.capabilities == other.capabilities:
+            return self
+
+        capabilities = set((*self.capabilities.keys(), *other.capabilities.keys()))
+        new_capabilities = {}
+        for capability in capabilities:
+            if Permission.Mode.Allow in (self.capabilities.get(capability), other.capabilities.get(capability)):
+                new_capabilities[capability] = Permission.Mode.Allow
+            elif (self.capabilities.get(capability), other.capabilities.get(capability)) == (
+                Permission.Mode.Deny,
+                Permission.Mode.Deny,
+            ):
+                new_capabilities[capability] = Permission.Mode.Deny
+
+        return PermissionsRule(self.grantee, new_capabilities)
+
     @classmethod
     def from_response(cls, resp, ns=None) -> List["PermissionsRule"]:
         parsed_response = fromstring(resp)

tableauserverclient/models/project_item.py

@@ -4,8 +4,8 @@ from typing import List, Optional
 
 from defusedxml.ElementTree import fromstring
 
-from .exceptions import UnpopulatedPropertyError
-from .property_decorators import property_is_enum, property_not_empty
+from tableauserverclient.models.exceptions import UnpopulatedPropertyError
+from tableauserverclient.models.property_decorators import property_is_enum, property_not_empty
 
 
 class ProjectItem(object):
@@ -34,6 +34,7 @@ class ProjectItem(object):
         self.content_permissions: Optional[str] = content_permissions
         self.parent_id: Optional[str] = parent_id
         self._samples: Optional[bool] = samples
+        self._owner_id: Optional[str] = None
 
         self._permissions = None
         self._default_workbook_permissions = None
@@ -119,7 +120,7 @@ class ProjectItem(object):
 
     @owner_id.setter
     def owner_id(self, value: str) -> None:
-        raise NotImplementedError("REST API does not currently support updating project owner.")
+        self._owner_id = value
 
     def is_default(self):
         return self.name.lower() == "default"

tableauserverclient/models/reference_item.py

@@ -8,6 +8,11 @@ class ResourceReference(object):
 
     __repr__ = __str__
 
+    def __eq__(self, other: object) -> bool:
+        if not hasattr(other, "id") or not hasattr(other, "tag_name"):
+            return False
+        return (self.id == other.id) and (self.tag_name == other.tag_name)
+
     @property
     def id(self):
         return self._id

tableauserverclient/models/tableau_auth.py

@@ -1,16 +1,20 @@
 import abc
+from typing import Dict, Optional
 
 
 class Credentials(abc.ABC):
-    def __init__(self, site_id=None, user_id_to_impersonate=None):
+    def __init__(self, site_id: Optional[str] = None, user_id_to_impersonate: Optional[str] = None) -> None:
         self.site_id = site_id or ""
         self.user_id_to_impersonate = user_id_to_impersonate or None
 
     @property
     @abc.abstractmethod
-    def credentials(self):
-        credentials = "Credentials can be username/password, Personal Access Token, or JWT"
-        +"This method returns values to set as an attribute on the credentials element of the request"
+    def credentials(self) -> Dict[str, str]:
+        credentials = (
+            "Credentials can be username/password, Personal Access Token, or JWT"
+            "This method returns values to set as an attribute on the credentials element of the request"
+        )
+        return {"key": "value"}
 
     @abc.abstractmethod
     def __repr__(self):
@@ -28,10 +32,9 @@ def deprecate_site_attribute():
 
 # The traditional auth type: username/password
 class TableauAuth(Credentials):
-    def __init__(self, username, password, site=None, site_id=None, user_id_to_impersonate=None):
-        if site is not None:
-            deprecate_site_attribute()
-            site_id = site
+    def __init__(
+        self, username: str, password: str, site_id: Optional[str] = None, user_id_to_impersonate: Optional[str] = None
+    ) -> None:
         super().__init__(site_id, user_id_to_impersonate)
         if password is None:
             raise TabError("Must provide a password when using traditional authentication")
@@ -39,7 +42,7 @@ class TableauAuth(Credentials):
         self.username = username
 
     @property
-    def credentials(self):
+    def credentials(self) -> Dict[str, str]:
         return {"name": self.username, "password": self.password}
 
     def __repr__(self):
@@ -49,20 +52,16 @@ class TableauAuth(Credentials):
             uid = ""
         return f"<Credentials username={self.username} password=redacted (site={self.site_id}{uid})>"
 
-    @property
-    def site(self):
-        deprecate_site_attribute()
-        return self.site_id
-
-    @site.setter
-    def site(self, value):
-        deprecate_site_attribute()
-        self.site_id = value
-
 
 # A Tableau-generated Personal Access Token
 class PersonalAccessTokenAuth(Credentials):
-    def __init__(self, token_name, personal_access_token, site_id=None, user_id_to_impersonate=None):
+    def __init__(
+        self,
+        token_name: str,
+        personal_access_token: str,
+        site_id: Optional[str] = None,
+        user_id_to_impersonate: Optional[str] = None,
+    ) -> None:
         if personal_access_token is None or token_name is None:
             raise TabError("Must provide a token and token name when using PAT authentication")
         super().__init__(site_id=site_id, user_id_to_impersonate=user_id_to_impersonate)
@@ -70,7 +69,7 @@ class PersonalAccessTokenAuth(Credentials):
         self.personal_access_token = personal_access_token
 
     @property
-    def credentials(self):
+    def credentials(self) -> Dict[str, str]:
         return {
             "personalAccessTokenName": self.token_name,
             "personalAccessTokenSecret": self.personal_access_token,
@@ -89,14 +88,14 @@ class PersonalAccessTokenAuth(Credentials):
 
 # A standard JWT generated specifically for Tableau
 class JWTAuth(Credentials):
-    def __init__(self, jwt: str, site_id=None, user_id_to_impersonate=None):
+    def __init__(self, jwt: str, site_id: Optional[str] = None, user_id_to_impersonate: Optional[str] = None) -> None:
         if jwt is None:
             raise TabError("Must provide a JWT token when using JWT authentication")
         super().__init__(site_id, user_id_to_impersonate)
         self.jwt = jwt
 
     @property
-    def credentials(self):
+    def credentials(self) -> Dict[str, str]:
         return {"jwt": self.jwt}
 
     def __repr__(self):

tableauserverclient/server/__init__.py

@@ -1,16 +1,91 @@
 # These two imports must come first
-from .request_factory import RequestFactory
-from .request_options import (
+from tableauserverclient.server.request_factory import RequestFactory
+from tableauserverclient.server.request_options import (
     CSVRequestOptions,
     ExcelRequestOptions,
     ImageRequestOptions,
     PDFRequestOptions,
     RequestOptions,
 )
+from tableauserverclient.server.filter import Filter
+from tableauserverclient.server.sort import Sort
+from tableauserverclient.server.server import Server
+from tableauserverclient.server.pager import Pager
+from tableauserverclient.server.endpoint.exceptions import NotSignedInError
 
-from .filter import Filter
-from .sort import Sort
-from .endpoint import *
-from .server import Server
-from .pager import Pager
-from .endpoint.exceptions import NotSignedInError
+from tableauserverclient.server.endpoint import (
+    Auth,
+    CustomViews,
+    DataAccelerationReport,
+    DataAlerts,
+    Databases,
+    Datasources,
+    QuerysetEndpoint,
+    MissingRequiredFieldError,
+    Endpoint,
+    Favorites,
+    Fileuploads,
+    FlowRuns,
+    Flows,
+    FlowTasks,
+    Groups,
+    Jobs,
+    Metadata,
+    Metrics,
+    Projects,
+    Schedules,
+    ServerInfo,
+    ServerResponseError,
+    Sites,
+    Subscriptions,
+    Tables,
+    Tasks,
+    Users,
+    Views,
+    Webhooks,
+    Workbooks,
+)
+
+__all__ = [
+    "RequestFactory",
+    "CSVRequestOptions",
+    "ExcelRequestOptions",
+    "ImageRequestOptions",
+    "PDFRequestOptions",
+    "RequestOptions",
+    "Filter",
+    "Sort",
+    "Server",
+    "Pager",
+    "NotSignedInError",
+    "Auth",
+    "CustomViews",
+    "DataAccelerationReport",
+    "DataAlerts",
+    "Databases",
+    "Datasources",
+    "QuerysetEndpoint",
+    "MissingRequiredFieldError",
+    "Endpoint",
+    "Favorites",
+    "Fileuploads",
+    "FlowRuns",
+    "Flows",
+    "FlowTasks",
+    "Groups",
+    "Jobs",
+    "Metadata",
+    "Metrics",
+    "Projects",
+    "Schedules",
+    "ServerInfo",
+    "ServerResponseError",
+    "Sites",
+    "Subscriptions",
+    "Tables",
+    "Tasks",
+    "Users",
+    "Views",
+    "Webhooks",
+    "Workbooks",
+]