chore: remove deprecated workbook publish arguments

Author: jorwoods

tableauserverclient/server/endpoint/workbooks_endpoint.py

@@ -308,21 +308,12 @@ def publish(
         workbook_item: WorkbookItem,
         file: PathOrFileR,
         mode: str,
-        connection_credentials: Optional["ConnectionCredentials"] = None,
         connections: Optional[Sequence[ConnectionItem]] = None,
         as_job: bool = False,
         hidden_views: Optional[Sequence[str]] = None,
         skip_connection_check: bool = False,
         parameters=None,
     ):
-        if connection_credentials is not None:
-            import warnings
-
-            warnings.warn(
-                "connection_credentials is being deprecated. Use connections instead",
-                DeprecationWarning,
-            )
-
         if isinstance(file, (str, os.PathLike)):
             if not os.path.isfile(file):
                 error = "File path does not lead to an existing file."
@@ -384,12 +375,9 @@ def publish(
             logger.info("Publishing {0} to server with chunking method (workbook over 64MB)".format(workbook_item.name))
             upload_session_id = self.parent_srv.fileuploads.upload(file)
             url = "{0}&uploadSessionId={1}".format(url, upload_session_id)
-            conn_creds = connection_credentials
             xml_request, content_type = RequestFactory.Workbook.publish_req_chunked(
                 workbook_item,
-                connection_credentials=conn_creds,
                 connections=connections,
-                hidden_views=hidden_views,
             )
         else:
             logger.info("Publishing {0} to server".format(filename))
@@ -404,14 +392,11 @@ def publish(
             else:
                 raise TypeError("file should be a filepath or file object.")
 
-            conn_creds = connection_credentials
             xml_request, content_type = RequestFactory.Workbook.publish_req(
                 workbook_item,
                 filename,
                 file_contents,
-                connection_credentials=conn_creds,
                 connections=connections,
-                hidden_views=hidden_views,
             )
         logger.debug("Request xml: {0} ".format(redact_xml(xml_request[:1000])))
 

tableauserverclient/server/request_factory.py

@@ -881,9 +881,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")
@@ -893,12 +891,6 @@ def _generate_xml(
         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:
@@ -907,17 +899,6 @@ def _generate_xml(
         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:
@@ -1000,15 +981,11 @@ def publish_req(
         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 = {
@@ -1020,15 +997,11 @@ def publish_req(
     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")}

test/test_workbook.py

@@ -621,31 +621,6 @@ def test_publish_with_hidden_views_on_workbook(self) -> None:
             self.assertTrue(re.search(rb"<views><view.*?hidden=\"true\".*?\/><\/views>", request_body))
             self.assertTrue(re.search(rb"<views><view.*?name=\"GDP per capita\".*?\/><\/views>", request_body))
 
-    # this tests the old method of including workbook views as a parameter for publishing
-    # should be removed when that functionality is removed
-    # see https://github.com/tableau/server-client-python/pull/617
-    def test_publish_with_hidden_view(self) -> None:
-        with open(PUBLISH_XML, "rb") as f:
-            response_xml = f.read().decode("utf-8")
-        with requests_mock.mock() as m:
-            m.post(self.baseurl, text=response_xml)
-
-            new_workbook = TSC.WorkbookItem(
-                name="Sample", show_tabs=False, project_id="ee8c6e70-43b6-11e6-af4f-f7b0d8e20760"
-            )
-
-            sample_workbook = os.path.join(TEST_ASSET_DIR, "SampleWB.twbx")
-            publish_mode = self.server.PublishMode.CreateNew
-
-            new_workbook = self.server.workbooks.publish(
-                new_workbook, sample_workbook, publish_mode, hidden_views=["GDP per capita"]
-            )
-
-            request_body = m._adapter.request_history[0]._request.body
-            # order of attributes in xml is unspecified
-            self.assertTrue(re.search(rb"<views><view.*?hidden=\"true\".*?\/><\/views>", request_body))
-            self.assertTrue(re.search(rb"<views><view.*?name=\"GDP per capita\".*?\/><\/views>", request_body))
-
     def test_publish_with_query_params(self) -> None:
         with open(PUBLISH_ASYNC_XML, "rb") as f:
             response_xml = f.read().decode("utf-8")
@@ -775,63 +750,6 @@ def test_publish_multi_connection_flat(self) -> None:
         self.assertEqual(connection_results[1].get("serverAddress", None), "pgsql.test.com")
         self.assertEqual(connection_results[1].find("connectionCredentials").get("password", None), "secret")  # type: ignore[union-attr]
 
-    def test_publish_single_connection(self) -> None:
-        new_workbook = TSC.WorkbookItem(
-            name="Sample", show_tabs=False, project_id="ee8c6e70-43b6-11e6-af4f-f7b0d8e20760"
-        )
-        connection_creds = TSC.ConnectionCredentials("test", "secret", True)
-
-        response = RequestFactory.Workbook._generate_xml(new_workbook, connection_credentials=connection_creds)
-        # Can't use ConnectionItem parser due to xml namespace problems
-        credentials = fromstring(response).findall(".//connectionCredentials")
-        self.assertEqual(len(credentials), 1)
-        self.assertEqual(credentials[0].get("name", None), "test")
-        self.assertEqual(credentials[0].get("password", None), "secret")
-        self.assertEqual(credentials[0].get("embed", None), "true")
-
-    def test_publish_single_connection_username_none(self) -> None:
-        new_workbook = TSC.WorkbookItem(
-            name="Sample", show_tabs=False, project_id="ee8c6e70-43b6-11e6-af4f-f7b0d8e20760"
-        )
-        connection_creds = TSC.ConnectionCredentials(None, "secret", True)
-
-        self.assertRaises(
-            ValueError,
-            RequestFactory.Workbook._generate_xml,
-            new_workbook,
-            connection_credentials=connection_creds,
-        )
-
-    def test_publish_single_connection_username_empty(self) -> None:
-        new_workbook = TSC.WorkbookItem(
-            name="Sample", show_tabs=False, project_id="ee8c6e70-43b6-11e6-af4f-f7b0d8e20760"
-        )
-        connection_creds = TSC.ConnectionCredentials("", "secret", True)
-
-        response = RequestFactory.Workbook._generate_xml(new_workbook, connection_credentials=connection_creds)
-        # Can't use ConnectionItem parser due to xml namespace problems
-        credentials = fromstring(response).findall(".//connectionCredentials")
-        self.assertEqual(len(credentials), 1)
-        self.assertEqual(credentials[0].get("name", None), "")
-        self.assertEqual(credentials[0].get("password", None), "secret")
-        self.assertEqual(credentials[0].get("embed", None), "true")
-
-    def test_credentials_and_multi_connect_raises_exception(self) -> None:
-        new_workbook = TSC.WorkbookItem(
-            name="Sample", show_tabs=False, project_id="ee8c6e70-43b6-11e6-af4f-f7b0d8e20760"
-        )
-
-        connection_creds = TSC.ConnectionCredentials("test", "secret", True)
-
-        connection1 = TSC.ConnectionItem()
-        connection1.server_address = "mysql.test.com"
-        connection1.connection_credentials = TSC.ConnectionCredentials("test", "secret", True)
-
-        with self.assertRaises(RuntimeError):
-            response = RequestFactory.Workbook._generate_xml(
-                new_workbook, connection_credentials=connection_creds, connections=[connection1]
-            )
-
     def test_synchronous_publish_timeout_error(self) -> None:
         with requests_mock.mock() as m:
             m.register_uri("POST", self.baseurl, status_code=504)