Add powerpoint export functionality to TSC (#1012)

Author: jorwoods

tableauserverclient/models/workbook_item.py

@@ -1,7 +1,7 @@
 import copy
 import uuid
 import xml.etree.ElementTree as ET
-from typing import Dict, List, Optional, Set, TYPE_CHECKING
+from typing import Callable, Dict, List, Optional, Set, TYPE_CHECKING
 
 from defusedxml.ElementTree import fromstring
 
@@ -33,6 +33,7 @@ def __init__(self, project_id: str, name: str = None, show_tabs: bool = False) -
         self._id: Optional[str] = None
         self._initial_tags: set = set()
         self._pdf = None
+        self._powerpoint = None
         self._preview_image = None
         self._project_name = None
         self._revisions = None
@@ -91,14 +92,21 @@ def id(self) -> Optional[str]:
         return self._id
 
     @property
-    def pdf(self):
+    def powerpoint(self) -> bytes:
+        if self._powerpoint is None:
+            error = "Workbook item must be populated with its powerpoint first."
+            raise UnpopulatedPropertyError(error)
+        return self._powerpoint()
+
+    @property
+    def pdf(self) -> bytes:
         if self._pdf is None:
             error = "Workbook item must be populated with its pdf first."
             raise UnpopulatedPropertyError(error)
         return self._pdf()
 
     @property
-    def preview_image(self):
+    def preview_image(self) -> bytes:
         if self._preview_image is None:
             error = "Workbook item must be populated with its preview image first."
             raise UnpopulatedPropertyError(error)
@@ -173,13 +181,16 @@ def _set_connections(self, connections):
     def _set_permissions(self, permissions):
         self._permissions = permissions
 
-    def _set_views(self, views):
+    def _set_views(self, views: Callable[[], List[ViewItem]]) -> None:
         self._views = views
 
-    def _set_pdf(self, pdf):
+    def _set_pdf(self, pdf: Callable[[], bytes]) -> None:
         self._pdf = pdf
 
-    def _set_preview_image(self, preview_image):
+    def _set_powerpoint(self, pptx: Callable[[], bytes]) -> None:
+        self._powerpoint = pptx
+
+    def _set_preview_image(self, preview_image: Callable[[], bytes]) -> None:
         self._preview_image = preview_image
 
     def _set_revisions(self, revisions):

tableauserverclient/server/endpoint/workbooks_endpoint.py

@@ -206,7 +206,7 @@ def populate_views(self, workbook_item: WorkbookItem, usage: bool = False) -> No
             error = "Workbook item missing ID. Workbook must be retrieved from server first."
             raise MissingRequiredFieldError(error)
 
-        def view_fetcher():
+        def view_fetcher() -> List[ViewItem]:
             return self._get_views_for_workbook(workbook_item, usage)
 
         workbook_item._set_views(view_fetcher)
@@ -252,32 +252,50 @@ def populate_pdf(self, workbook_item: WorkbookItem, req_options: "RequestOptions
             error = "Workbook item missing ID."
             raise MissingRequiredFieldError(error)
 
-        def pdf_fetcher():
+        def pdf_fetcher() -> bytes:
             return self._get_wb_pdf(workbook_item, req_options)
 
         workbook_item._set_pdf(pdf_fetcher)
         logger.info("Populated pdf for workbook (ID: {0})".format(workbook_item.id))
 
-    def _get_wb_pdf(self, workbook_item, req_options):
+    def _get_wb_pdf(self, workbook_item: WorkbookItem, req_options: Optional["RequestOptions"]) -> bytes:
         url = "{0}/{1}/pdf".format(self.baseurl, workbook_item.id)
         server_response = self.get_request(url, req_options)
         pdf = server_response.content
         return pdf
 
+    @api(version="3.8")
+    def populate_powerpoint(self, workbook_item: WorkbookItem, req_options: Optional["RequestOptions"] = None) -> None:
+        if not workbook_item.id:
+            error = "Workbook item missing ID."
+            raise MissingRequiredFieldError(error)
+
+        def pptx_fetcher() -> bytes:
+            return self._get_wb_pptx(workbook_item, req_options)
+
+        workbook_item._set_powerpoint(pptx_fetcher)
+        logger.info("Populated powerpoint for workbook (ID: {0})".format(workbook_item.id))
+
+    def _get_wb_pptx(self, workbook_item: WorkbookItem, req_options: Optional["RequestOptions"]) -> bytes:
+        url = "{0}/{1}/powerpoint".format(self.baseurl, workbook_item.id)
+        server_response = self.get_request(url, req_options)
+        pptx = server_response.content
+        return pptx
+
     # Get preview image of workbook
     @api(version="2.0")
     def populate_preview_image(self, workbook_item: WorkbookItem) -> None:
         if not workbook_item.id:
             error = "Workbook item missing ID. Workbook must be retrieved from server first."
             raise MissingRequiredFieldError(error)
 
-        def image_fetcher():
+        def image_fetcher() -> bytes:
             return self._get_wb_preview_image(workbook_item)
 
         workbook_item._set_preview_image(image_fetcher)
         logger.info("Populated preview image for workbook (ID: {0})".format(workbook_item.id))
 
-    def _get_wb_preview_image(self, workbook_item):
+    def _get_wb_preview_image(self, workbook_item: WorkbookItem) -> bytes:
         url = "{0}/{1}/previewImage".format(self.baseurl, workbook_item.id)
         server_response = self.get_request(url)
         preview_image = server_response.content

test/assets/populate_powerpoint.pptx

@@ -27,6 +27,7 @@
 GET_XML = os.path.join(TEST_ASSET_DIR, "workbook_get.xml")
 POPULATE_CONNECTIONS_XML = os.path.join(TEST_ASSET_DIR, "workbook_populate_connections.xml")
 POPULATE_PDF = os.path.join(TEST_ASSET_DIR, "populate_pdf.pdf")
+POPULATE_POWERPOINT = os.path.join(TEST_ASSET_DIR, "populate_powerpoint.pptx")
 POPULATE_PERMISSIONS_XML = os.path.join(TEST_ASSET_DIR, "workbook_populate_permissions.xml")
 POPULATE_PREVIEW_IMAGE = os.path.join(TEST_ASSET_DIR, "RESTAPISample Image.png")
 POPULATE_VIEWS_XML = os.path.join(TEST_ASSET_DIR, "workbook_populate_views.xml")
@@ -439,6 +440,22 @@ def test_populate_pdf(self) -> None:
             self.server.workbooks.populate_pdf(single_workbook, req_option)
             self.assertEqual(response, single_workbook.pdf)
 
+    def test_populate_powerpoint(self) -> None:
+        self.server.version = "3.8"
+        self.baseurl = self.server.workbooks.baseurl
+        with open(POPULATE_POWERPOINT, "rb") as f:
+            response = f.read()
+        with requests_mock.mock() as m:
+            m.get(
+                self.baseurl + "/1f951daf-4061-451a-9df1-69a8062664f2/powerpoint",
+                content=response,
+            )
+            single_workbook = TSC.WorkbookItem("test")
+            single_workbook._id = "1f951daf-4061-451a-9df1-69a8062664f2"
+
+            self.server.workbooks.populate_powerpoint(single_workbook)
+            self.assertEqual(response, single_workbook.powerpoint)
+
     def test_populate_preview_image(self) -> None:
         with open(POPULATE_PREVIEW_IMAGE, "rb") as f:
             response = f.read()