chore(typing): include samples in type checks (#1455)

* chore(typing): include samples in type checks

Including the sample scripts in type checking will allow more
thorough testing to validate the samples work as expected, as
well as more testing around how a library consumer may use the
library.

---------

Co-authored-by: Jordan Woods <[email protected]>
Co-authored-by: Jac <[email protected]>

Author: jorwoods

pyproject.toml

@@ -46,7 +46,7 @@ disable_error_code = [
     # tableauserverclient\server\endpoint\datasources_endpoint.py:48: error: Cannot assign multiple types to name "FilePath" without an explicit "Type[...]" annotation  [misc]
     'annotation-unchecked'  # can be removed when check_untyped_defs = true
 ]
-files = ["tableauserverclient", "test"]
+files = ["tableauserverclient", "test", "samples"]
 show_error_codes = true
 ignore_missing_imports = true  # defusedxml library has no types
 no_implicit_reexport = true

samples/explore_favorites.py

@@ -3,7 +3,7 @@
 import argparse
 import logging
 import tableauserverclient as TSC
-from tableauserverclient import Resource
+from tableauserverclient.models import Resource
 
 
 def main():
@@ -46,8 +46,8 @@ def main():
         # get list of workbooks
         all_workbook_items, pagination_item = server.workbooks.get()
         if all_workbook_items is not None and len(all_workbook_items) > 0:
-            my_workbook: TSC.WorkbookItem = all_workbook_items[0]
-            server.favorites.add_favorite(server, user, Resource.Workbook.name(), all_workbook_items[0])
+            my_workbook = all_workbook_items[0]
+            server.favorites.add_favorite(user, Resource.Workbook, all_workbook_items[0])
             print(
                 "Workbook added to favorites. Workbook Name: {}, Workbook ID: {}".format(
                     my_workbook.name, my_workbook.id

samples/list.py

@@ -48,6 +48,9 @@ def main():
             "webhooks": server.webhooks,
             "workbook": server.workbooks,
         }.get(args.resource_type)
+        if endpoint is None:
+            print("Resource type not found.")
+            sys.exit(1)
 
         options = TSC.RequestOptions()
         options.sort.add(TSC.Sort(TSC.RequestOptions.Field.Name, TSC.RequestOptions.Direction.Desc))

tableauserverclient/models/favorites_item.py

@@ -1,8 +1,9 @@
 import logging
 
+from typing import Union
 from defusedxml.ElementTree import fromstring
-from tableauserverclient.models.tableau_types import TableauItem
 
+from tableauserverclient.models.tableau_types import TableauItem
 from tableauserverclient.models.datasource_item import DatasourceItem
 from tableauserverclient.models.flow_item import FlowItem
 from tableauserverclient.models.project_item import ProjectItem
@@ -20,7 +21,7 @@
 
 class FavoriteItem:
     @classmethod
-    def from_response(cls, xml: str, namespace: dict) -> FavoriteType:
+    def from_response(cls, xml: Union[str, bytes], namespace: dict) -> FavoriteType:
         favorites: FavoriteType = {
             "datasources": [],
             "flows": [],