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

tableauserverclient/server/request_factory.py

@@ -1,8 +1,11 @@
 import xml.etree.ElementTree as ET
-from typing import Any, Dict, Iterable, List, Optional, Tuple, TYPE_CHECKING
+from typing import Any, Callable, Dict, Iterable, List, Optional, Set, Tuple, TypeVar, TYPE_CHECKING, Union
+
+from typing_extensions import ParamSpec
 
 from requests.packages.urllib3.fields import RequestField
 from requests.packages.urllib3.filepost import encode_multipart_formdata
+from typing_extensions import Concatenate
 
 from tableauserverclient.models import *
 
@@ -23,8 +26,12 @@ def _add_multipart(parts: Dict) -> Tuple[Any, str]:
     return xml_request, content_type
 
 
-def _tsrequest_wrapped(func):
-    def wrapper(self, *args, **kwargs) -> bytes:
+T = TypeVar("T")
+P = ParamSpec("P")
+
+
+def _tsrequest_wrapped(func: Callable[Concatenate[T, ET.Element, P], Any]) -> Callable[Concatenate[T, P], bytes]:
+    def wrapper(self: T, *args: P.args, **kwargs: P.kwargs) -> bytes:
         xml_request = ET.Element("tsRequest")
         func(self, xml_request, *args, **kwargs)
         return ET.tostring(xml_request)
@@ -387,6 +394,28 @@ class GroupRequest(object):
         user_element.attrib["id"] = user_id
         return ET.tostring(xml_request)
 
+    @_tsrequest_wrapped
+    def add_users_req(self, xml_request: ET.Element, users: Iterable[Union[str, UserItem]]) -> bytes:
+        users_element = ET.SubElement(xml_request, "users")
+        for user in users:
+            user_element = ET.SubElement(users_element, "user")
+            if not (user_id := user.id if isinstance(user, UserItem) else user):
+                raise ValueError("User ID must be populated")
+            user_element.attrib["id"] = user_id
+
+        return ET.tostring(xml_request)
+
+    @_tsrequest_wrapped
+    def remove_users_req(self, xml_request: ET.Element, users: Iterable[Union[str, UserItem]]) -> bytes:
+        users_element = ET.SubElement(xml_request, "users")
+        for user in users:
+            user_element = ET.SubElement(users_element, "user")
+            if not (user_id := user.id if isinstance(user, UserItem) else user):
+                raise ValueError("User ID must be populated")
+            user_element.attrib["id"] = user_id
+
+        return ET.tostring(xml_request)
+
     def create_local_req(self, group_item: GroupItem) -> bytes:
         xml_request = ET.Element("tsRequest")
         group_element = ET.SubElement(xml_request, "group")
@@ -418,19 +447,10 @@ class GroupRequest(object):
             import_element.attrib["siteRole"] = group_item.minimum_site_role
         return ET.tostring(xml_request)
 
-    def update_req(self, group_item: GroupItem, default_site_role: Optional[str] = None) -> bytes:
-        # (1/8/2021): Deprecated starting v0.15
-        if default_site_role is not None:
-            import warnings
-
-            warnings.simplefilter("always", DeprecationWarning)
-            warnings.warn(
-                'RequestFactory.Group.update_req(...default_site_role="") is deprecated, '
-                "please set the minimum_site_role field of GroupItem",
-                DeprecationWarning,
-            )
-            group_item.minimum_site_role = default_site_role
-
+    def update_req(
+        self,
+        group_item: GroupItem,
+    ) -> bytes:
         xml_request = ET.Element("tsRequest")
         group_element = ET.SubElement(xml_request, "group")
 
@@ -491,6 +511,9 @@ class ProjectRequest(object):
             project_element.attrib["contentPermissions"] = project_item.content_permissions
         if project_item.parent_id is not None:
             project_element.attrib["parentProjectId"] = project_item.parent_id
+        if (owner := project_item.owner_id) is not None:
+            owner_element = ET.SubElement(project_element, "owner")
+            owner_element.attrib["id"] = owner
         return ET.tostring(xml_request)
 
     def create_req(self, project_item: "ProjectItem") -> bytes:
@@ -845,6 +868,9 @@ class TableRequest(object):
         return ET.tostring(xml_request)
 
 
+content_types = Iterable[Union["ColumnItem", "DatabaseItem", "DatasourceItem", "FlowItem", "TableItem", "WorkbookItem"]]
+
+
 class TagRequest(object):
     def add_req(self, tag_set):
         xml_request = ET.Element("tsRequest")
@@ -854,6 +880,22 @@ class TagRequest(object):
             tag_element.attrib["label"] = tag
         return ET.tostring(xml_request)
 
+    @_tsrequest_wrapped
+    def batch_create(self, element: ET.Element, tags: Set[str], content: content_types) -> bytes:
+        tag_batch = ET.SubElement(element, "tagBatch")
+        tags_element = ET.SubElement(tag_batch, "tags")
+        for tag in tags:
+            tag_element = ET.SubElement(tags_element, "tag")
+            tag_element.attrib["label"] = tag
+        contents_element = ET.SubElement(tag_batch, "contents")
+        for item in content:
+            content_element = ET.SubElement(contents_element, "content")
+            if item.id is None:
+                raise ValueError(f"Item {item} must have an ID to be tagged.")
+            content_element.attrib["id"] = item.id
+
+        return ET.tostring(element)
+
 
 class UserRequest(object):
     def update_req(self, user_item: UserItem, password: Optional[str]) -> bytes:
@@ -893,9 +935,7 @@ class WorkbookRequest(object):
     def _generate_xml(
         self,
         workbook_item,
-        connection_credentials=None,
         connections=None,
-        hidden_views=None,
     ):
         xml_request = ET.Element("tsRequest")
         workbook_element = ET.SubElement(xml_request, "workbook")
@@ -905,12 +945,6 @@ class WorkbookRequest(object):
         project_element = ET.SubElement(workbook_element, "project")
         project_element.attrib["id"] = str(workbook_item.project_id)
 
-        if connection_credentials is not None and connections is not None:
-            raise RuntimeError("You cannot set both `connections` and `connection_credentials`")
-
-        if connection_credentials is not None and connection_credentials != False:
-            _add_credentials_element(workbook_element, connection_credentials)
-
         if connections is not None and connections != False and len(connections) > 0:
             connections_element = ET.SubElement(workbook_element, "connections")
             for connection in connections:
@@ -919,17 +953,6 @@ class WorkbookRequest(object):
         if workbook_item.description is not None:
             workbook_element.attrib["description"] = workbook_item.description
 
-        if hidden_views is not None:
-            import warnings
-
-            warnings.simplefilter("always", DeprecationWarning)
-            warnings.warn(
-                "the hidden_views parameter should now be set on the workbook directly",
-                DeprecationWarning,
-            )
-            if workbook_item.hidden_views is None:
-                workbook_item.hidden_views = hidden_views
-
         if workbook_item.hidden_views is not None:
             views_element = ET.SubElement(workbook_element, "views")
             for view_name in workbook_item.hidden_views:
@@ -1012,15 +1035,11 @@ class WorkbookRequest(object):
         workbook_item,
         filename,
         file_contents,
-        connection_credentials=None,
         connections=None,
-        hidden_views=None,
     ):
         xml_request = self._generate_xml(
             workbook_item,
-            connection_credentials=connection_credentials,
             connections=connections,
-            hidden_views=hidden_views,
         )
 
         parts = {
@@ -1032,37 +1051,41 @@ class WorkbookRequest(object):
     def publish_req_chunked(
         self,
         workbook_item,
-        connection_credentials=None,
         connections=None,
-        hidden_views=None,
     ):
         xml_request = self._generate_xml(
             workbook_item,
-            connection_credentials=connection_credentials,
             connections=connections,
-            hidden_views=hidden_views,
         )
 
         parts = {"request_payload": ("", xml_request, "text/xml")}
         return _add_multipart(parts)
 
     @_tsrequest_wrapped
-    def embedded_extract_req(self, xml_request, include_all=True, datasources=None):
+    def embedded_extract_req(
+        self, xml_request: ET.Element, include_all: bool = True, datasources: Optional[Iterable[DatasourceItem]] = None
+    ) -> None:
         list_element = ET.SubElement(xml_request, "datasources")
         if include_all:
             list_element.attrib["includeAll"] = "true"
         elif datasources:
             for datasource_item in datasources:
                 datasource_element = ET.SubElement(list_element, "datasource")
-                datasource_element.attrib["id"] = datasource_item.id
+                if (id_ := datasource_item.id) is not None:
+                    datasource_element.attrib["id"] = id_
 
 
 class Connection(object):
     @_tsrequest_wrapped
     def update_req(self, xml_request: ET.Element, connection_item: "ConnectionItem") -> None:
         connection_element = ET.SubElement(xml_request, "connection")
-        if connection_item.server_address is not None:
-            connection_element.attrib["serverAddress"] = connection_item.server_address.lower()
+        if (server_address := connection_item.server_address) is not None:
+            if (conn_type := connection_item.connection_type) is not None:
+                if conn_type.casefold() != "odata".casefold():
+                    server_address = server_address.lower()
+            else:
+                server_address = server_address.lower()
+            connection_element.attrib["serverAddress"] = server_address
         if connection_item.server_port is not None:
             connection_element.attrib["serverPort"] = str(connection_item.server_port)
         if connection_item.username is not None:
@@ -1077,7 +1100,7 @@ class Connection(object):
 
 class TaskRequest(object):
     @_tsrequest_wrapped
-    def run_req(self, xml_request, task_item):
+    def run_req(self, xml_request: ET.Element, task_item: Any) -> None:
         # Send an empty tsRequest
         pass
 
@@ -1214,7 +1237,7 @@ class SubscriptionRequest(object):
 
 class EmptyRequest(object):
     @_tsrequest_wrapped
-    def empty_req(self, xml_request):
+    def empty_req(self, xml_request: ET.Element) -> None:
         pass
 
 
@@ -1273,6 +1296,124 @@ class CustomViewRequest(object):
         if custom_view_item.name is not None:
             updating_element.attrib["name"] = custom_view_item.name
 
+    @_tsrequest_wrapped
+    def _publish_xml(self, xml_request: ET.Element, custom_view_item: CustomViewItem) -> bytes:
+        custom_view_element = ET.SubElement(xml_request, "customView")
+        if (name := custom_view_item.name) is not None:
+            custom_view_element.attrib["name"] = name
+        else:
+            raise ValueError(f"Custom View Item missing name: {custom_view_item}")
+        if (shared := custom_view_item.shared) is not None:
+            custom_view_element.attrib["shared"] = str(shared).lower()
+        else:
+            raise ValueError(f"Custom View Item missing shared: {custom_view_item}")
+        if (owner := custom_view_item.owner) is not None:
+            owner_element = ET.SubElement(custom_view_element, "owner")
+            if (owner_id := owner.id) is not None:
+                owner_element.attrib["id"] = owner_id
+            else:
+                raise ValueError(f"Custom View Item owner missing id: {owner}")
+        else:
+            raise ValueError(f"Custom View Item missing owner: {custom_view_item}")
+        if (workbook := custom_view_item.workbook) is not None:
+            workbook_element = ET.SubElement(custom_view_element, "workbook")
+            if (workbook_id := workbook.id) is not None:
+                workbook_element.attrib["id"] = workbook_id
+            else:
+                raise ValueError(f"Custom View Item workbook missing id: {workbook}")
+        else:
+            raise ValueError(f"Custom View Item missing workbook: {custom_view_item}")
+
+        return ET.tostring(xml_request)
+
+    def publish_req_chunked(self, custom_view_item: CustomViewItem):
+        xml_request = self._publish_xml(custom_view_item)
+        parts = {"request_payload": ("", xml_request, "text/xml")}
+        return _add_multipart(parts)
+
+    def publish_req(self, custom_view_item: CustomViewItem, filename: str, file_contents: bytes):
+        xml_request = self._publish_xml(custom_view_item)
+        parts = {
+            "request_payload": ("", xml_request, "text/xml"),
+            "tableau_customview": (filename, file_contents, "application/octet-stream"),
+        }
+        return _add_multipart(parts)
+
+
+class GroupSetRequest:
+    @_tsrequest_wrapped
+    def create_request(self, xml_request: ET.Element, group_set_item: "GroupSetItem") -> bytes:
+        group_set_element = ET.SubElement(xml_request, "groupSet")
+        if group_set_item.name is not None:
+            group_set_element.attrib["name"] = group_set_item.name
+        return ET.tostring(xml_request)
+
+    @_tsrequest_wrapped
+    def update_request(self, xml_request: ET.Element, group_set_item: "GroupSetItem") -> bytes:
+        group_set_element = ET.SubElement(xml_request, "groupSet")
+        if group_set_item.name is not None:
+            group_set_element.attrib["name"] = group_set_item.name
+        return ET.tostring(xml_request)
+
+
+class VirtualConnectionRequest:
+    @_tsrequest_wrapped
+    def update_db_connection(self, xml_request: ET.Element, connection_item: ConnectionItem) -> bytes:
+        connection_element = ET.SubElement(xml_request, "connection")
+        if connection_item.server_address is not None:
+            connection_element.attrib["serverAddress"] = connection_item.server_address
+        if connection_item.server_port is not None:
+            connection_element.attrib["serverPort"] = str(connection_item.server_port)
+        if connection_item.username is not None:
+            connection_element.attrib["userName"] = connection_item.username
+        if connection_item.password is not None:
+            connection_element.attrib["password"] = connection_item.password
+
+        return ET.tostring(xml_request)
+
+    @_tsrequest_wrapped
+    def update(self, xml_request: ET.Element, virtual_connection: VirtualConnectionItem) -> bytes:
+        vc_element = ET.SubElement(xml_request, "virtualConnection")
+        if virtual_connection.name is not None:
+            vc_element.attrib["name"] = virtual_connection.name
+        if virtual_connection.is_certified is not None:
+            vc_element.attrib["isCertified"] = str(virtual_connection.is_certified).lower()
+        if virtual_connection.certification_note is not None:
+            vc_element.attrib["certificationNote"] = virtual_connection.certification_note
+        if virtual_connection.project_id is not None:
+            project_element = ET.SubElement(vc_element, "project")
+            project_element.attrib["id"] = virtual_connection.project_id
+        if virtual_connection.owner_id is not None:
+            owner_element = ET.SubElement(vc_element, "owner")
+            owner_element.attrib["id"] = virtual_connection.owner_id
+
+        return ET.tostring(xml_request)
+
+    @_tsrequest_wrapped
+    def publish(self, xml_request: ET.Element, virtual_connection: VirtualConnectionItem, content: str) -> bytes:
+        vc_element = ET.SubElement(xml_request, "virtualConnection")
+        if virtual_connection.name is not None:
+            vc_element.attrib["name"] = virtual_connection.name
+        else:
+            raise ValueError("Virtual Connection must have a name.")
+        if virtual_connection.project_id is not None:
+            project_element = ET.SubElement(vc_element, "project")
+            project_element.attrib["id"] = virtual_connection.project_id
+        else:
+            raise ValueError("Virtual Connection must have a project id.")
+        if virtual_connection.owner_id is not None:
+            owner_element = ET.SubElement(vc_element, "owner")
+            owner_element.attrib["id"] = virtual_connection.owner_id
+        else:
+            raise ValueError("Virtual Connection must have an owner id.")
+        if content is not None:
+            content_element = ET.SubElement(vc_element, "content")
+            content_element.text = content
+        else:
+            raise ValueError("Virtual Connection must have content.")
+
+        return ET.tostring(xml_request)
+
 
 class RequestFactory(object):
     Auth = AuthRequest()
@@ -1289,6 +1430,7 @@ class RequestFactory(object):
     Flow = FlowRequest()
     FlowTask = FlowTaskRequest()
     Group = GroupRequest()
+    GroupSet = GroupSetRequest()
     Metric = MetricRequest()
     Permission = PermissionRequest()
     Project = ProjectRequest()
@@ -1299,5 +1441,6 @@ class RequestFactory(object):
     Tag = TagRequest()
     Task = TaskRequest()
     User = UserRequest()
+    VirtualConnection = VirtualConnectionRequest()
     Workbook = WorkbookRequest()
     Webhook = WebhookRequest()

tableauserverclient/server/request_options.py

@@ -2,6 +2,7 @@ import sys
 
 from typing_extensions import Self
 
+from tableauserverclient.config import config
 from tableauserverclient.models.property_decorators import property_is_int
 import logging
 
@@ -38,6 +39,7 @@ class RequestOptions(RequestOptionsBase):
         LessThanOrEqual = "lte"
         In = "in"
         Has = "has"
+        CaseInsensitiveEquals = "cieq"
 
     class Field:
         Args = "args"
@@ -115,9 +117,9 @@ class RequestOptions(RequestOptionsBase):
         Desc = "desc"
         Asc = "asc"
 
-    def __init__(self, pagenumber=1, pagesize=100):
+    def __init__(self, pagenumber=1, pagesize=None):
         self.pagenumber = pagenumber
-        self.pagesize = pagesize
+        self.pagesize = pagesize or config.PAGE_SIZE
         self.sort = set()
         self.filter = set()
 

tableauserverclient/server/server.py

@@ -5,9 +5,7 @@ import urllib3
 
 from defusedxml.ElementTree import fromstring, ParseError
 from packaging.version import Version
-
-from . import CustomViews
-from .endpoint import (
+from tableauserverclient.server.endpoint import (
     Sites,
     Views,
     Users,
@@ -34,13 +32,18 @@ from .endpoint import (
     FlowRuns,
     Metrics,
     Endpoint,
+    CustomViews,
+    LinkedTasks,
+    GroupSets,
+    Tags,
+    VirtualConnections,
 )
-from .exceptions import (
+from tableauserverclient.server.exceptions import (
     ServerInfoEndpointNotFoundError,
     EndpointUnavailableError,
 )
-from .endpoint.exceptions import NotSignedInError
-from ..namespace import Namespace
+from tableauserverclient.server.endpoint.exceptions import NotSignedInError
+from tableauserverclient.namespace import Namespace
 
 
 _PRODUCT_TO_REST_VERSION = {
@@ -100,6 +103,10 @@ class Server(object):
         self.flow_runs = FlowRuns(self)
         self.metrics = Metrics(self)
         self.custom_views = CustomViews(self)
+        self.linked_tasks = LinkedTasks(self)
+        self.group_sets = GroupSets(self)
+        self.tags = Tags(self)
+        self.virtual_connections = VirtualConnections(self)
 
         self._session = self._session_factory()
         self._http_options = dict()  # must set this before making a server call

{tableauserverclient-0.31.dist-info → tableauserverclient-0.33.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tableauserverclient
-Version: 0.31
+Version: 0.33
 Summary: A Python module for working with the Tableau Server REST API.
 Author-email: Tableau <github@tableau.com>
 License: The MIT License (MIT)
@@ -37,20 +37,19 @@ Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: LICENSE.versioneer
-Requires-Dist: defusedxml >=0.7.1
-Requires-Dist: packaging >=23.1
-Requires-Dist: requests >=2.31
-Requires-Dist: urllib3 ==2.0.7
-Requires-Dist: typing-extensions >=4.0.1
+Requires-Dist: defusedxml>=0.7.1
+Requires-Dist: packaging>=23.1
+Requires-Dist: requests>=2.31
+Requires-Dist: urllib3==2.2.2
+Requires-Dist: typing-extensions>=4.0.1
 Provides-Extra: test
-Requires-Dist: argparse ; extra == 'test'
-Requires-Dist: black ==23.7 ; extra == 'test'
-Requires-Dist: mock ; extra == 'test'
-Requires-Dist: mypy ==1.4 ; extra == 'test'
-Requires-Dist: pytest >=7.0 ; extra == 'test'
-Requires-Dist: pytest-cov ; extra == 'test'
-Requires-Dist: pytest-subtests ; extra == 'test'
-Requires-Dist: requests-mock <2.0,>=1.0 ; extra == 'test'
+Requires-Dist: black==23.7; extra == "test"
+Requires-Dist: build; extra == "test"
+Requires-Dist: mypy==1.4; extra == "test"
+Requires-Dist: pytest>=7.0; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-subtests; extra == "test"
+Requires-Dist: requests-mock<2.0,>=1.0; extra == "test"
 
 # Tableau Server Client (Python)
 
@@ -63,14 +62,14 @@ Use the Tableau Server Client (TSC) library to increase your productivity as you
 * Create users and groups.
 * Query projects, sites, and more.
 
-This repository contains Python source code for the library and sample files showing how to use it. As of May 2022, Python versions 3.7 and up are supported.
+This repository contains Python source code for the library and sample files showing how to use it. As of September 2024, support for Python 3.7 and 3.8 will be dropped - support for older versions of Python aims to match https://devguide.python.org/versions/
 
 To see sample code that works directly with the REST API (in Java, Python, or Postman), visit the [REST API Samples](https://github.com/tableau/rest-api-samples) repo.
 
 For more information on installing and using TSC, see the documentation:
 <https://tableau.github.io/server-client-python/docs/>
  
-
+To contribute, see our [Developer Guide](https://tableau.github.io/server-client-python/docs/dev-guide). A list of all our contributors to date is in [CONTRIBUTORS.md].
 
 ## License
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ftableau%2Fserver-client-python.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Ftableau%2Fserver-client-python?ref=badge_large)