feat: download custom views

Author: jorwoods

tableauserverclient/server/endpoint/custom_views_endpoint.py

@@ -1,8 +1,10 @@
+import io
 import logging
-from typing import List, Optional, Tuple
+import os
+from typing import List, Optional, Tuple, Union
 
-from .endpoint import QuerysetEndpoint, api
-from .exceptions import MissingRequiredFieldError
+from tableauserverclient.server.endpoint.endpoint import QuerysetEndpoint, api
+from tableauserverclient.server.endpoint.exceptions import MissingRequiredFieldError
 from tableauserverclient.models import CustomViewItem, PaginationItem
 from tableauserverclient.server import RequestFactory, RequestOptions, ImageRequestOptions
 
@@ -16,6 +18,15 @@
 update the name or owner of a custom view.
 """
 
+FilePath = Union[str, os.PathLike]
+FileObject = Union[io.BufferedReader, io.BytesIO]
+FileObjectR = Union[io.BufferedReader, io.BytesIO]
+FileObjectW = Union[io.BufferedWriter, io.BytesIO]
+PathOrFileR = Union[FilePath, FileObjectR]
+PathOrFileW = Union[FilePath, FileObjectW]
+io_types_r = (io.BufferedReader, io.BytesIO)
+io_types_w = (io.BufferedWriter, io.BytesIO)
+
 
 class CustomViews(QuerysetEndpoint[CustomViewItem]):
     def __init__(self, parent_srv):
@@ -25,6 +36,10 @@ def __init__(self, parent_srv):
     def baseurl(self) -> str:
         return "{0}/sites/{1}/customviews".format(self.parent_srv.baseurl, self.parent_srv.site_id)
 
+    @property
+    def expurl(self) -> str:
+        return f"{self.parent_srv._server_address}/api/exp/sites/{self.parent_srv.site_id}/customviews"
+
     """
     If the request has no filter parameters: Administrators will see all custom views. 
         Other users will see only custom views that they own.
@@ -102,3 +117,16 @@ def delete(self, view_id: str) -> None:
         url = "{0}/{1}".format(self.baseurl, view_id)
         self.delete_request(url)
         logger.info("Deleted single custom view (ID: {0})".format(view_id))
+
+    @api(version="3.21")
+    def download(self, view_item: CustomViewItem, file: PathOrFileW) -> PathOrFileW:
+        url = f"{self.expurl}/{view_item.id}/content"
+        server_response = self.get_request(url)
+        if isinstance(file, io_types_w):
+            file.write(server_response.content)
+            return file
+
+        with open(file, "wb") as f:
+            f.write(server_response.content)
+
+        return file

test/test_custom_view.py

@@ -1,23 +1,26 @@
+import io
 import os
+from pathlib import Path
 import unittest
 
 import requests_mock
 
 import tableauserverclient as TSC
 from tableauserverclient.datetime_helpers import format_datetime
 
-TEST_ASSET_DIR = os.path.join(os.path.dirname(__file__), "assets")
+TEST_ASSET_DIR = Path(__file__).parent / "assets"
 
 GET_XML = os.path.join(TEST_ASSET_DIR, "custom_view_get.xml")
 GET_XML_ID = os.path.join(TEST_ASSET_DIR, "custom_view_get_id.xml")
 POPULATE_PREVIEW_IMAGE = os.path.join(TEST_ASSET_DIR, "Sample View Image.png")
 CUSTOM_VIEW_UPDATE_XML = os.path.join(TEST_ASSET_DIR, "custom_view_update.xml")
+CUSTOM_VIEW_DOWNLOAD = TEST_ASSET_DIR / "custom_view_download.json"
 
 
 class CustomViewTests(unittest.TestCase):
     def setUp(self):
         self.server = TSC.Server("http://test", False)
-        self.server.version = "3.19"  # custom views only introduced in 3.19
+        self.server.version = "3.21"  # custom views only introduced in 3.19
 
         # Fake sign in
         self.server._site_id = "dad65087-b08b-4603-af4e-2887b8aafc67"
@@ -132,3 +135,14 @@ def test_update(self) -> None:
     def test_update_missing_id(self) -> None:
         cv = TSC.CustomViewItem(name="test")
         self.assertRaises(TSC.MissingRequiredFieldError, self.server.custom_views.update, cv)
+
+    def test_download(self) -> None:
+        cv = TSC.CustomViewItem(name="test")
+        cv._id = "1f951daf-4061-451a-9df1-69a8062664f2"
+        content = CUSTOM_VIEW_DOWNLOAD.read_bytes()
+        data = io.BytesIO()
+        with requests_mock.mock() as m:
+            m.get(f"{self.server.custom_views.expurl}/1f951daf-4061-451a-9df1-69a8062664f2/content", content=content)
+            self.server.custom_views.download(cv, data)
+
+        assert data.getvalue() == content