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

tableauserverclient/server/endpoint/resource_tagger.py

@@ -1,19 +1,31 @@
+import abc
 import copy
+from typing import Generic, Optional, Protocol, TypeVar, Union, TYPE_CHECKING, runtime_checkable
+from collections.abc import Iterable
 import urllib.parse
 
-from .endpoint import Endpoint
-from .exceptions import ServerResponseError
-from ..exceptions import EndpointUnavailableError
+from tableauserverclient.server.endpoint.endpoint import Endpoint, api
+from tableauserverclient.server.endpoint.exceptions import ServerResponseError
+from tableauserverclient.server.exceptions import EndpointUnavailableError
 from tableauserverclient.server import RequestFactory
 from tableauserverclient.models import TagItem
 
 from tableauserverclient.helpers.logging import logger
 
+if TYPE_CHECKING:
+    from tableauserverclient.models.column_item import ColumnItem
+    from tableauserverclient.models.database_item import DatabaseItem
+    from tableauserverclient.models.datasource_item import DatasourceItem
+    from tableauserverclient.models.flow_item import FlowItem
+    from tableauserverclient.models.table_item import TableItem
+    from tableauserverclient.models.workbook_item import WorkbookItem
+    from tableauserverclient.server.server import Server
+
 
 class _ResourceTagger(Endpoint):
     # Add new tags to resource
     def _add_tags(self, baseurl, resource_id, tag_set):
-        url = "{0}/{1}/tags".format(baseurl, resource_id)
+        url = f"{baseurl}/{resource_id}/tags"
         add_req = RequestFactory.Tag.add_req(tag_set)
 
         try:
@@ -28,7 +40,7 @@ class _ResourceTagger(Endpoint):
     # Delete a resource's tag by name
     def _delete_tag(self, baseurl, resource_id, tag_name):
         encoded_tag_name = urllib.parse.quote(tag_name)
-        url = "{0}/{1}/tags/{2}".format(baseurl, resource_id, encoded_tag_name)
+        url = f"{baseurl}/{resource_id}/tags/{encoded_tag_name}"
 
         try:
             self.delete_request(url)
@@ -48,4 +60,125 @@ class _ResourceTagger(Endpoint):
             if add_set:
                 resource_item.tags = self._add_tags(baseurl, resource_item.id, add_set)
             resource_item._initial_tags = copy.copy(resource_item.tags)
-        logger.info("Updated tags to {0}".format(resource_item.tags))
+        logger.info(f"Updated tags to {resource_item.tags}")
+
+
+class Response(Protocol):
+    content: bytes
+
+
+@runtime_checkable
+class Taggable(Protocol):
+    tags: set[str]
+    _initial_tags: set[str]
+
+    @property
+    def id(self) -> Optional[str]:
+        pass
+
+
+T = TypeVar("T")
+
+
+class TaggingMixin(abc.ABC, Generic[T]):
+    parent_srv: "Server"
+
+    @property
+    @abc.abstractmethod
+    def baseurl(self) -> str:
+        pass
+
+    @abc.abstractmethod
+    def put_request(self, url, request) -> Response:
+        pass
+
+    @abc.abstractmethod
+    def delete_request(self, url) -> None:
+        pass
+
+    def add_tags(self, item: Union[T, str], tags: Union[Iterable[str], str]) -> set[str]:
+        item_id = getattr(item, "id", item)
+
+        if not isinstance(item_id, str):
+            raise ValueError("ID not found.")
+
+        if isinstance(tags, str):
+            tag_set = {tags}
+        else:
+            tag_set = set(tags)
+
+        url = f"{self.baseurl}/{item_id}/tags"
+        add_req = RequestFactory.Tag.add_req(tag_set)
+        server_response = self.put_request(url, add_req)
+        return TagItem.from_response(server_response.content, self.parent_srv.namespace)
+
+    def delete_tags(self, item: Union[T, str], tags: Union[Iterable[str], str]) -> None:
+        item_id = getattr(item, "id", item)
+
+        if not isinstance(item_id, str):
+            raise ValueError("ID not found.")
+
+        if isinstance(tags, str):
+            tag_set = {tags}
+        else:
+            tag_set = set(tags)
+
+        for tag in tag_set:
+            encoded_tag_name = urllib.parse.quote(tag)
+            url = f"{self.baseurl}/{item_id}/tags/{encoded_tag_name}"
+            self.delete_request(url)
+
+    def update_tags(self, item: T) -> None:
+        if (initial_tags := getattr(item, "_initial_tags", None)) is None:
+            raise ValueError(f"{item} does not have initial tags.")
+        if (tags := getattr(item, "tags", None)) is None:
+            raise ValueError(f"{item} does not have tags.")
+        if tags == initial_tags:
+            return
+
+        add_set = tags - initial_tags
+        remove_set = initial_tags - tags
+        self.delete_tags(item, remove_set)
+        if add_set:
+            tags = self.add_tags(item, add_set)
+            setattr(item, "tags", tags)
+
+        setattr(item, "_initial_tags", copy.copy(tags))
+        logger.info(f"Updated tags to {tags}")
+
+
+content = Iterable[Union["ColumnItem", "DatabaseItem", "DatasourceItem", "FlowItem", "TableItem", "WorkbookItem"]]
+
+
+class Tags(Endpoint):
+    def __init__(self, parent_srv: "Server"):
+        super().__init__(parent_srv)
+
+    @property
+    def baseurl(self):
+        return f"{self.parent_srv.baseurl}/tags"
+
+    @api(version="3.9")
+    def batch_add(self, tags: Union[Iterable[str], str], content: content) -> set[str]:
+        if isinstance(tags, str):
+            tag_set = {tags}
+        else:
+            tag_set = set(tags)
+
+        url = f"{self.baseurl}:batchCreate"
+        batch_create_req = RequestFactory.Tag.batch_create(tag_set, content)
+        server_response = self.put_request(url, batch_create_req)
+        return TagItem.from_response(server_response.content, self.parent_srv.namespace)
+
+    @api(version="3.9")
+    def batch_delete(self, tags: Union[Iterable[str], str], content: content) -> set[str]:
+        if isinstance(tags, str):
+            tag_set = {tags}
+        else:
+            tag_set = set(tags)
+
+        url = f"{self.baseurl}:batchDelete"
+        # The batch delete XML is the same as the batch create XML.
+        batch_delete_req = RequestFactory.Tag.batch_create(tag_set, content)
+        server_response = self.put_request(url, batch_delete_req)
+        return TagItem.from_response(server_response.content, self.parent_srv.namespace)

tableauserverclient/server/endpoint/schedules_endpoint.py

@@ -2,7 +2,7 @@ import copy
 import logging
 import warnings
 from collections import namedtuple
-from typing import TYPE_CHECKING, Callable, List, Optional, Tuple, Union
+from typing import TYPE_CHECKING, Callable, Optional, Union
 
 from .endpoint import Endpoint, api, parameter_added_in
 from .exceptions import MissingRequiredFieldError
@@ -22,14 +22,14 @@ if TYPE_CHECKING:
 class Schedules(Endpoint):
     @property
     def baseurl(self) -> str:
-        return "{0}/schedules".format(self.parent_srv.baseurl)
+        return f"{self.parent_srv.baseurl}/schedules"
 
     @property
     def siteurl(self) -> str:
-        return "{0}/sites/{1}/schedules".format(self.parent_srv.baseurl, self.parent_srv.site_id)
+        return f"{self.parent_srv.baseurl}/sites/{self.parent_srv.site_id}/schedules"
 
     @api(version="2.3")
-    def get(self, req_options: Optional["RequestOptions"] = None) -> Tuple[List[ScheduleItem], PaginationItem]:
+    def get(self, req_options: Optional["RequestOptions"] = None) -> tuple[list[ScheduleItem], PaginationItem]:
         logger.info("Querying all schedules")
         url = self.baseurl
         server_response = self.get_request(url, req_options)
@@ -42,8 +42,8 @@ class Schedules(Endpoint):
         if not schedule_id:
             error = "No Schedule ID provided"
             raise ValueError(error)
-        logger.info("Querying a single schedule by id ({})".format(schedule_id))
-        url = "{0}/{1}".format(self.baseurl, schedule_id)
+        logger.info(f"Querying a single schedule by id ({schedule_id})")
+        url = f"{self.baseurl}/{schedule_id}"
         server_response = self.get_request(url)
         return ScheduleItem.from_response(server_response.content, self.parent_srv.namespace)[0]
 
@@ -52,9 +52,9 @@ class Schedules(Endpoint):
         if not schedule_id:
             error = "Schedule ID undefined"
             raise ValueError(error)
-        url = "{0}/{1}".format(self.baseurl, schedule_id)
+        url = f"{self.baseurl}/{schedule_id}"
         self.delete_request(url)
-        logger.info("Deleted single schedule (ID: {0})".format(schedule_id))
+        logger.info(f"Deleted single schedule (ID: {schedule_id})")
 
     @api(version="2.3")
     def update(self, schedule_item: ScheduleItem) -> ScheduleItem:
@@ -62,10 +62,10 @@ class Schedules(Endpoint):
             error = "Schedule item missing ID."
             raise MissingRequiredFieldError(error)
 
-        url = "{0}/{1}".format(self.baseurl, schedule_item.id)
+        url = f"{self.baseurl}/{schedule_item.id}"
         update_req = RequestFactory.Schedule.update_req(schedule_item)
         server_response = self.put_request(url, update_req)
-        logger.info("Updated schedule item (ID: {})".format(schedule_item.id))
+        logger.info(f"Updated schedule item (ID: {schedule_item.id})")
         updated_schedule = copy.copy(schedule_item)
         return updated_schedule._parse_common_tags(server_response.content, self.parent_srv.namespace)
 
@@ -79,7 +79,7 @@ class Schedules(Endpoint):
         create_req = RequestFactory.Schedule.create_req(schedule_item)
         server_response = self.post_request(url, create_req)
         new_schedule = ScheduleItem.from_response(server_response.content, self.parent_srv.namespace)[0]
-        logger.info("Created new schedule (ID: {})".format(new_schedule.id))
+        logger.info(f"Created new schedule (ID: {new_schedule.id})")
         return new_schedule
 
     @api(version="2.8")
@@ -91,12 +91,12 @@ class Schedules(Endpoint):
         datasource: Optional["DatasourceItem"] = None,
         flow: Optional["FlowItem"] = None,
         task_type: Optional[str] = None,
-    ) -> List[AddResponse]:
+    ) -> list[AddResponse]:
         # There doesn't seem to be a good reason to allow one item of each type?
         if workbook and datasource:
             warnings.warn("Passing in multiple items for add_to_schedule will be deprecated", PendingDeprecationWarning)
-        items: List[
-            Tuple[str, Union[WorkbookItem, FlowItem, DatasourceItem], str, Callable[[Optional[str], str], bytes], str]
+        items: list[
+            tuple[str, Union[WorkbookItem, FlowItem, DatasourceItem], str, Callable[[Optional[str], str], bytes], str]
         ] = []
 
         if workbook is not None:
@@ -115,8 +115,7 @@ class Schedules(Endpoint):
             )  # type:ignore[arg-type]
 
         results = (self._add_to(*x) for x in items)
-        # list() is needed for python 3.x compatibility
-        return list(filter(lambda x: not x.result, results))  # type:ignore[arg-type]
+        return [x for x in results if not x.result]
 
     def _add_to(
         self,
@@ -133,13 +132,13 @@ class Schedules(Endpoint):
         item_task_type,
     ) -> AddResponse:
         id_ = resource.id
-        url = "{0}/{1}/{2}s".format(self.siteurl, schedule_id, type_)
+        url = f"{self.siteurl}/{schedule_id}/{type_}s"
         add_req = req_factory(id_, task_type=item_task_type)  # type: ignore[call-arg, arg-type]
         response = self.put_request(url, add_req)
 
         error, warnings, task_created = ScheduleItem.parse_add_to_schedule_response(response, self.parent_srv.namespace)
         if task_created:
-            logger.info("Added {} to {} to schedule {}".format(type_, id_, schedule_id))
+            logger.info(f"Added {type_} to {id_} to schedule {schedule_id}")
 
         if error is not None or warnings is not None:
             return AddResponse(

tableauserverclient/server/endpoint/server_info_endpoint.py

@@ -1,4 +1,5 @@
 import logging
+from typing import Union
 
 from .endpoint import Endpoint, api
 from .exceptions import ServerResponseError
@@ -21,15 +22,49 @@ class ServerInfo(Endpoint):
         return self._info
 
     def __repr__(self):
-        return "<Endpoint {}>".format(self.serverInfo)
+        return f"<Endpoint {self.serverInfo}>"
 
     @property
-    def baseurl(self):
-        return "{0}/serverInfo".format(self.parent_srv.baseurl)
+    def baseurl(self) -> str:
+        return f"{self.parent_srv.baseurl}/serverInfo"
 
     @api(version="2.4")
-    def get(self):
-        """Retrieve the server info for the server.  This is an unauthenticated call"""
+    def get(self) -> Union[ServerInfoItem, None]:
+        """
+        Retrieve the build and version information for the server.
+
+        This method makes an unauthenticated call, so no sign in or
+        authentication token is required.
+
+        Returns
+        -------
+        :class:`~tableauserverclient.models.ServerInfoItem`
+
+        Raises
+        ------
+        :class:`~tableauserverclient.exceptions.ServerInfoEndpointNotFoundError`
+            Raised when the server info endpoint is not found.
+
+        :class:`~tableauserverclient.exceptions.EndpointUnavailableError`
+            Raised when the server info endpoint is not available.
+
+        Examples
+        --------
+        >>> import tableauserverclient as TSC
+
+        >>> # create a instance of server
+        >>> server = TSC.Server('https://MY-SERVER')
+
+        >>> # set the version number > 2.3
+        >>> # the server_info.get() method works in 2.4 and later
+        >>> server.version = '2.5'
+
+        >>> s_info = server.server_info.get()
+        >>> print("\nServer info:")
+        >>> print("\tProduct version: {0}".format(s_info.product_version))
+        >>> print("\tREST API version: {0}".format(s_info.rest_api_version))
+        >>> print("\tBuild number: {0}".format(s_info.build_number))
+        """
         try:
             server_response = self.get_unauthenticated_request(self.baseurl)
         except ServerResponseError as e: