feat: List server extension settings

Author: jorwoods

tableauserverclient/__init__.py

@@ -13,6 +13,7 @@
     DatabaseItem,
     DataFreshnessPolicyItem,
     DatasourceItem,
+    ExtensionsServer,
     FavoriteItem,
     FlowItem,
     FlowRunItem,
@@ -88,6 +89,7 @@
     "DEFAULT_NAMESPACE",
     "DQWItem",
     "ExcelRequestOptions",
+    "ExtensionsServer",
     "FailedSignInError",
     "FavoriteItem",
     "FileuploadItem",

tableauserverclient/models/__init__.py

@@ -10,6 +10,7 @@
 from tableauserverclient.models.datasource_item import DatasourceItem
 from tableauserverclient.models.dqw_item import DQWItem
 from tableauserverclient.models.exceptions import UnpopulatedPropertyError
+from tableauserverclient.models.extensions_item import ExtensionsServer
 from tableauserverclient.models.favorites_item import FavoriteItem
 from tableauserverclient.models.fileupload_item import FileuploadItem
 from tableauserverclient.models.flow_item import FlowItem
@@ -113,4 +114,5 @@
     "LinkedTaskStepItem",
     "LinkedTaskFlowRunItem",
     "ExtractItem",
+    "ExtensionsServer",
 ]

tableauserverclient/models/extensions_item.py

@@ -0,0 +1,56 @@
+from typing import Optional, TypeVar, overload
+from typing_extensions import Self
+
+from defusedxml.ElementTree import fromstring
+
+T = TypeVar("T")
+
+
+class ExtensionsServer:
+    def __init__(self) -> None:
+        self._enabled: Optional[bool] = None
+        self._block_list: Optional[list[str]] = None
+
+    @property
+    def enabled(self) -> Optional[bool]:
+        """Indicates whether the extensions server is enabled."""
+        return self._enabled
+
+    @enabled.setter
+    def enabled(self, value: Optional[bool]) -> None:
+        self._enabled = value
+
+    @property
+    def block_list(self) -> Optional[list[str]]:
+        """List of blocked extensions."""
+        return self._block_list
+
+    @block_list.setter
+    def block_list(self, value: Optional[list[str]]) -> None:
+        self._block_list = value
+
+    @classmethod
+    def from_response(cls: type[Self], response, ns) -> Self:
+        xml = fromstring(response)
+        obj = cls()
+        element = xml.find(".//t:extensionsServerSettings", namespaces=ns)
+        if element is None:
+            raise ValueError("Missing extensionsServerSettings element in response")
+
+        if (enabled_element := element.find("./t:extensionsGloballyEnabled", namespaces=ns)) is not None:
+            obj.enabled = string_to_bool(enabled_element.text)
+        obj.block_list = [e.text for e in element.findall("./t:blockList", namespaces=ns)]
+
+        return obj
+
+
+@overload
+def string_to_bool(s: str) -> bool: ...
+
+
+@overload
+def string_to_bool(s: None) -> None: ...
+
+
+def string_to_bool(s):
+    return s.lower() == "true" if s is not None else None

tableauserverclient/server/endpoint/__init__.py

@@ -6,6 +6,7 @@
 from tableauserverclient.server.endpoint.datasources_endpoint import Datasources
 from tableauserverclient.server.endpoint.endpoint import Endpoint, QuerysetEndpoint
 from tableauserverclient.server.endpoint.exceptions import ServerResponseError, MissingRequiredFieldError
+from tableauserverclient.server.endpoint.extensions_endpoint import Extensions
 from tableauserverclient.server.endpoint.favorites_endpoint import Favorites
 from tableauserverclient.server.endpoint.fileuploads_endpoint import Fileuploads
 from tableauserverclient.server.endpoint.flow_runs_endpoint import FlowRuns
@@ -42,6 +43,7 @@
     "QuerysetEndpoint",
     "MissingRequiredFieldError",
     "Endpoint",
+    "Extensions",
     "Favorites",
     "Fileuploads",
     "FlowRuns",

tableauserverclient/server/endpoint/extensions_endpoint.py

@@ -0,0 +1,24 @@
+from tableauserverclient.models.extensions_item import ExtensionsServer
+from tableauserverclient.server.endpoint.endpoint import Endpoint
+from tableauserverclient.server.endpoint.endpoint import api
+
+
+class Extensions(Endpoint):
+    def __init__(self, parent_srv):
+        super().__init__(parent_srv)
+
+    @property
+    def _server_baseurl(self) -> str:
+        return f"{self.parent_srv.baseurl}/settings/extensions"
+
+    @api(version="3.21")
+    def get_server_settings(self) -> ExtensionsServer:
+        """Lists the settings for extensions of a server
+
+        Returns
+        -------
+        ExtensionsServer
+            The server extensions settings
+        """
+        response = self.get_request(self._server_baseurl)
+        return ExtensionsServer.from_response(response.content, self.parent_srv.namespace)

tableauserverclient/server/server.py

@@ -39,6 +39,7 @@
     Tags,
     VirtualConnections,
     OIDC,
+    Extensions,
 )
 from tableauserverclient.server.exceptions import (
     ServerInfoEndpointNotFoundError,
@@ -185,6 +186,7 @@ def __init__(self, server_address, use_server_version=False, http_options=None,
         self.tags = Tags(self)
         self.virtual_connections = VirtualConnections(self)
         self.oidc = OIDC(self)
+        self.extensions = Extensions(self)
 
         self._session = self._session_factory()
         self._http_options = dict()  # must set this before making a server call

test/assets/extensions_server_settings_false.xml

@@ -0,0 +1,6 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<tsResponse xmlns="http://tableau.com/api" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://tableau.com/api http://tableau.com/api/ts-api-2.3.xsd">
+<extensionsServerSettings>
+        <extensionsGloballyEnabled>false</extensionsGloballyEnabled>
+    </extensionsServerSettings>
+</tsResponse>

test/assets/extensions_server_settings_true.xml

@@ -0,0 +1,8 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<tsResponse xmlns="http://tableau.com/api" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://tableau.com/api http://tableau.com/api/ts-api-2.3.xsd">
+<extensionsServerSettings>
+        <extensionsGloballyEnabled>true</extensionsGloballyEnabled>
+        <blockList>https://test.com</blockList>
+        <blockList>https://example.com</blockList>
+    </extensionsServerSettings>
+</tsResponse>