Jorwoods/type hint flow runs (#950)

* Fix slack once and for all (#946)

The red X keeps coming back so I'd like to mark this as allowably fail-able -- that way the innards of Slack/OAuth/Tableau credentials don't keep polluting test run reports :)

(cherry picked from commit c8170ae)

* Type hint Flow run item

* Continue on error for slack step

* Fix formatting

Co-authored-by: Tyler Doyle <[email protected]>
Co-authored-by: Jac <[email protected]>

Author: 3 people

tableauserverclient/models/flow_run_item.py

@@ -2,43 +2,48 @@
 from ..datetime_helpers import parse_datetime
 import itertools
 
+from typing import Dict, List, Optional, Type, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from datetime import datetime
+
 
 class FlowRunItem(object):
     def __init__(self) -> None:
-        self._id = None
-        self._flow_id = None
-        self._status = None
-        self._started_at = None
-        self._completed_at = None
-        self._progress = None
-        self._background_job_id = None
+        self._id: str = ""
+        self._flow_id: Optional[str] = None
+        self._status: Optional[str] = None
+        self._started_at: Optional["datetime"] = None
+        self._completed_at: Optional["datetime"] = None
+        self._progress: Optional[str] = None
+        self._background_job_id: Optional[str] = None
 
     @property
-    def id(self):
+    def id(self) -> str:
         return self._id
 
     @property
-    def flow_id(self):
+    def flow_id(self) -> Optional[str]:
         return self._flow_id
 
     @property
-    def status(self):
+    def status(self) -> Optional[str]:
         return self._status
 
     @property
-    def started_at(self):
+    def started_at(self) -> Optional["datetime"]:
         return self._started_at
 
     @property
-    def completed_at(self):
+    def completed_at(self) -> Optional["datetime"]:
         return self._completed_at
 
     @property
-    def progress(self):
+    def progress(self) -> Optional[str]:
         return self._progress
 
     @property
-    def background_job_id(self):
+    def background_job_id(self) -> Optional[str]:
         return self._background_job_id
 
     def _set_values(
@@ -67,7 +72,7 @@ def _set_values(
             self._background_job_id = background_job_id
 
     @classmethod
-    def from_response(cls, resp, ns):
+    def from_response(cls: Type["FlowRunItem"], resp: bytes, ns: Optional[Dict]) -> List["FlowRunItem"]:
         all_flowrun_items = list()
         parsed_response = ET.fromstring(resp)
         all_flowrun_xml = itertools.chain(

tableauserverclient/server/endpoint/flow_runs_endpoint.py

@@ -5,20 +5,27 @@
 
 import logging
 
+from typing import List, Optional, Tuple, TYPE_CHECKING, Union
+
 logger = logging.getLogger("tableau.endpoint.flowruns")
 
+if TYPE_CHECKING:
+    from ..server import Server
+    from ..request_options import RequestOptions
+
 
 class FlowRuns(QuerysetEndpoint):
-    def __init__(self, parent_srv):
+    def __init__(self, parent_srv: "Server") -> None:
         super(FlowRuns, self).__init__(parent_srv)
+        return None
 
     @property
-    def baseurl(self):
+    def baseurl(self) -> str:
         return "{0}/sites/{1}/flows/runs".format(self.parent_srv.baseurl, self.parent_srv.site_id)
 
     # Get all flows
     @api(version="3.10")
-    def get(self, req_options=None):
+    def get(self, req_options: Optional["RequestOptions"] = None) -> Tuple[List[FlowRunItem], PaginationItem]:
         logger.info("Querying all flow runs on site")
         url = self.baseurl
         server_response = self.get_request(url, req_options)
@@ -28,7 +35,7 @@ def get(self, req_options=None):
 
     # Get 1 flow by id
     @api(version="3.10")
-    def get_by_id(self, flow_run_id):
+    def get_by_id(self, flow_run_id: str) -> FlowRunItem:
         if not flow_run_id:
             error = "Flow ID undefined."
             raise ValueError(error)
@@ -39,7 +46,7 @@ def get_by_id(self, flow_run_id):
 
     # Cancel 1 flow run by id
     @api(version="3.10")
-    def cancel(self, flow_run_id):
+    def cancel(self, flow_run_id: str) -> None:
         if not flow_run_id:
             error = "Flow ID undefined."
             raise ValueError(error)
@@ -49,7 +56,7 @@ def cancel(self, flow_run_id):
         logger.info("Deleted single flow (ID: {0})".format(id_))
 
     @api(version="3.10")
-    def wait_for_job(self, flow_run_id, *, timeout=None):
+    def wait_for_job(self, flow_run_id: str, *, timeout: Optional[int] = None) -> FlowRunItem:
         if isinstance(flow_run_id, FlowRunItem):
             flow_run_id = flow_run_id.id
         assert isinstance(flow_run_id, str)

test/test_flowruns.py

@@ -15,7 +15,7 @@
 
 
 class FlowRunTests(unittest.TestCase):
-    def setUp(self):
+    def setUp(self) -> None:
         self.server = TSC.Server("http://test")
 
         # Fake signin
@@ -25,7 +25,7 @@ def setUp(self):
 
         self.baseurl = self.server.flow_runs.baseurl
 
-    def test_get(self):
+    def test_get(self) -> None:
         response_xml = read_xml_asset(GET_XML)
         with requests_mock.mock() as m:
             m.get(self.baseurl, text=response_xml)
@@ -46,7 +46,7 @@ def test_get(self):
         self.assertEqual("100", all_flow_runs[1].progress)
         self.assertEqual("1ad21a9d-2530-4fbf-9064-efd3c736e023", all_flow_runs[1].background_job_id)
 
-    def test_get_by_id(self):
+    def test_get_by_id(self) -> None:
         response_xml = read_xml_asset(GET_BY_ID_XML)
         with requests_mock.mock() as m:
             m.get(self.baseurl + "/cc2e652d-4a9b-4476-8c93-b238c45db968", text=response_xml)
@@ -59,19 +59,19 @@ def test_get_by_id(self):
         self.assertEqual("100", flow_run.progress)
         self.assertEqual("1ad21a9d-2530-4fbf-9064-efd3c736e023", flow_run.background_job_id)
 
-    def test_cancel_id(self):
+    def test_cancel_id(self) -> None:
         with requests_mock.mock() as m:
             m.put(self.baseurl + "/ee8c6e70-43b6-11e6-af4f-f7b0d8e20760", status_code=204)
             self.server.flow_runs.cancel("ee8c6e70-43b6-11e6-af4f-f7b0d8e20760")
 
-    def test_cancel_item(self):
+    def test_cancel_item(self) -> None:
         run = TSC.FlowRunItem()
         run._id = "ee8c6e70-43b6-11e6-af4f-f7b0d8e20760"
         with requests_mock.mock() as m:
             m.put(self.baseurl + "/ee8c6e70-43b6-11e6-af4f-f7b0d8e20760", status_code=204)
             self.server.flow_runs.cancel(run)
 
-    def test_wait_for_job_finished(self):
+    def test_wait_for_job_finished(self) -> None:
         # Waiting for an already finished job, directly returns that job's info
         response_xml = read_xml_asset(GET_BY_ID_XML)
         flow_run_id = "cc2e652d-4a9b-4476-8c93-b238c45db968"
@@ -82,7 +82,7 @@ def test_wait_for_job_finished(self):
             self.assertEqual(flow_run_id, flow_run.id)
             self.assertEqual(flow_run.progress, "100")
 
-    def test_wait_for_job_failed(self):
+    def test_wait_for_job_failed(self) -> None:
         # Waiting for a failed job raises an exception
         response_xml = read_xml_asset(GET_BY_ID_FAILED_XML)
         flow_run_id = "c2b35d5a-e130-471a-aec8-7bc5435fe0e7"
@@ -91,7 +91,7 @@ def test_wait_for_job_failed(self):
             with self.assertRaises(FlowRunFailedException):
                 self.server.flow_runs.wait_for_job(flow_run_id)
 
-    def test_wait_for_job_timeout(self):
+    def test_wait_for_job_timeout(self) -> None:
         # Waiting for a job which doesn't terminate will throw an exception
         response_xml = read_xml_asset(GET_BY_ID_INPROGRESS_XML)
         flow_run_id = "71afc22c-9c06-40be-8d0f-4c4166d29e6c"