Jac/repr for models (#1191)

* add repr to several models
* test all model classes for __repr__

add a dumb listing of all existing model classes, and a test that iterates over the whole list. Uses subtests so we get the whole list.

Test is skipped because we know they don't all have it yet. Will update to skip known not-implemented models instead.

Author: jacalata

pyproject.toml

@@ -30,7 +30,7 @@ classifiers = [
 repository = "https://github.com/tableau/server-client-python"
 
 [project.optional-dependencies]
-test = ["argparse", "black", "mock", "mypy", "pytest>=7.0", "requests-mock>=1.0,<2.0"]
+test = ["argparse", "black", "mock", "mypy", "pytest>=7.0", "pytest-subtests", "requests-mock>=1.0,<2.0"]
 
 [tool.black]
 line-length = 120

tableauserverclient/models/datasource_item.py

@@ -24,6 +24,14 @@ class AskDataEnablement:
         Disabled = "Disabled"
         SiteDefault = "SiteDefault"
 
+    def __repr__(self):
+        return "<Datasource {0} '{1}' ({2} parent={3} >".format(
+            self._id,
+            self.name,
+            self.description or "No Description",
+            self.project_id,
+        )
+
     def __init__(self, project_id: str, name: Optional[str] = None) -> None:
         self._ask_data_enablement = None
         self._certified = None

tableauserverclient/models/flow_item.py

@@ -15,6 +15,11 @@
 
 
 class FlowItem(object):
+    def __repr__(self):
+        return "<Flow {0} '{1}' ({2}) Project={3} createdAt={4}".format(
+            self._id, self.name, self.description, self.project_id, self.created_at
+        )
+
     def __init__(self, project_id: str, name: Optional[str] = None) -> None:
         self._webpage_url: Optional[str] = None
         self._created_at: Optional[datetime.datetime] = None

tableauserverclient/models/project_item.py

@@ -14,6 +14,11 @@ class ContentPermissions:
         ManagedByOwner: str = "ManagedByOwner"
         LockedToProjectWithoutNested: str = "LockedToProjectWithoutNested"
 
+    def __repr__(self):
+        return "<Project {0} {1} parent={2} permissions={3}>".format(
+            self._id, self.name, self.parent_id or "None (Top level)", self.content_permissions or "Not Set"
+        )
+
     def __init__(
         self,
         name: str,

tableauserverclient/models/tableau_auth.py

@@ -53,6 +53,8 @@ def site(self, value):
 
 class PersonalAccessTokenAuth(Credentials):
     def __init__(self, token_name, personal_access_token, site_id=None):
+        if personal_access_token is None or token_name is None:
+            raise TabError("Must provide a token and token name when using PAT authentication")
         super().__init__(site_id=site_id)
         self.token_name = token_name
         self.personal_access_token = personal_access_token

tableauserverclient/models/view_item.py

@@ -31,6 +31,11 @@ def __init__(self) -> None:
         self._permissions: Optional[Callable[[], List[PermissionsRule]]] = None
         self.tags: Set[str] = set()
 
+    def __repr__(self):
+        return "<ViewItem {0} '{1}' contentUrl='{2}' project={3}>".format(
+            self._id, self.name, self.content_url, self.project_id
+        )
+
     def _set_preview_image(self, preview_image):
         self._preview_image = preview_image
 

tableauserverclient/models/workbook_item.py

@@ -52,6 +52,11 @@ def __init__(self, project_id: str, name: Optional[str] = None, show_tabs: bool
 
         return None
 
+    def __repr__(self):
+        return "<WorkbookItem {0} '{1}' contentUrl='{2}' project={3}>".format(
+            self._id, self.name, self.content_url, self.project_id
+        )
+
     @property
     def connections(self) -> List[ConnectionItem]:
         if self._connections is None:

tableauserverclient/server/endpoint/endpoint.py

@@ -78,16 +78,16 @@ def _make_request(
             self.parent_srv.http_options, auth_token, content, content_type, parameters
         )
 
-        logger.debug("request {}, url: {}".format(method, url))
+        logger.debug("request method {}, url: {}".format(method.__name__, url))
         if content:
             redacted = helpers.strings.redact_xml(content[:1000])
-            logger.debug("request content: {}".format(redacted))
+            # logger.debug("request content: {}".format(redacted))
 
         server_response = method(url, **parameters)
         self._check_status(server_response, url)
 
         loggable_response = self.log_response_safely(server_response)
-        logger.debug("Server response from {0}:\n\t{1}".format(url, loggable_response))
+        # logger.debug("Server response from {0}:\n\t{1}".format(url, loggable_response))
 
         if content_type == "application/xml":
             self.parent_srv._namespace.detect(server_response.content)
@@ -258,7 +258,7 @@ def all(self, *args, **kwargs):
         return queryset
 
     @api(version="2.0")
-    def filter(self, *_, **kwargs):
+    def filter(self, *_, **kwargs) -> QuerySet:
         if _:
             raise RuntimeError("Only keyword arguments accepted.")
         queryset = QuerySet(self).filter(**kwargs)

tableauserverclient/server/server.py

@@ -48,7 +48,7 @@
     "9.0": "2.0",
 }
 minimum_supported_server_version = "2.3"
-default_server_version = "2.3"
+default_server_version = "3.0"  # at least use the current major version
 
 
 class Server(object):
@@ -114,7 +114,7 @@ def validate_connection_settings(self):
             raise ValueError("Server connection settings not valid", req_ex)
 
     def __repr__(self):
-        return "<TableauServerClient> [Connection: {}, {}]".format(self.baseurl, self.server_info.serverInfo)
+        return "<TableauServerClient [Connection: {}, {}]>".format(self.baseurl, self.server_info.serverInfo)
 
     def add_http_options(self, options_dict: dict):
         try:

test/models/_models.py

@@ -0,0 +1,61 @@
+from tableauserverclient import *
+
+# mmm. why aren't these available in the tsc namespace?
+from tableauserverclient.models import (
+    DataAccelerationReportItem,
+    FavoriteItem,
+    Credentials,
+    ServerInfoItem,
+    Resource,
+    TableauItem,
+    plural_type,
+)
+
+
+def get_defined_models():
+    # not clever: copied from tsc/models/__init__.py
+    return [
+        ColumnItem,
+        ConnectionCredentials,
+        ConnectionItem,
+        DataAccelerationReportItem,
+        DataAlertItem,
+        DatabaseItem,
+        DatasourceItem,
+        DQWItem,
+        UnpopulatedPropertyError,
+        FavoriteItem,
+        FlowItem,
+        FlowRunItem,
+        GroupItem,
+        IntervalItem,
+        DailyInterval,
+        WeeklyInterval,
+        MonthlyInterval,
+        HourlyInterval,
+        JobItem,
+        BackgroundJobItem,
+        MetricItem,
+        PaginationItem,
+        PermissionsRule,
+        Permission,
+        ProjectItem,
+        RevisionItem,
+        ScheduleItem,
+        ServerInfoItem,
+        SiteItem,
+        SubscriptionItem,
+        TableItem,
+        Credentials,
+        TableauAuth,
+        PersonalAccessTokenAuth,
+        Resource,
+        TableauItem,
+        plural_type,
+        Target,
+        TaskItem,
+        UserItem,
+        ViewItem,
+        WebhookItem,
+        WorkbookItem,
+    ]