v0.38 - IDP configuration (#1606)

* docs: docstrings for schedules and intervals (#1528)
* docs: Docstrings for new fields

* feat: enable retrieving only owned workbooks
* feat: Add support for multiple IDPs (jorwoods)
* feat: Add fields:_all_ support (#1563)
* feat: project support all fields
* feat: groups all fields
* feat: views support all fields
* feat: user support _all_ fields 
* feat: workbook support all fields
* feat: datasourceitem _all_ fields
* feat: add fields methods to QuerySet
* feat: add owner attribute to project
* Add SSL option for connecting to Tableau Server with a weaker DH key length
Fixes #1582
* feat: 1580 list extracts on schedule (#1604)

* chore: type hint database and table objects (#1593)
* ci: Switch Slack action to use `ubuntu-latest` like our other actions.
---------

Co-authored-by: Jordan Woods <jorwoods@users.noreply.github.com>
Co-authored-by: Jordan Woods <13803242+jorwoods@users.noreply.github.com>
Co-authored-by: Brian Cantoni <bcantoni@salesforce.com>
Co-authored-by: casey-crawford-cfa <91914995+casey-crawford-cfa@users.noreply.github.com>

Author: 4 people

.github/workflows/slack.yml

@@ -5,7 +5,7 @@ on: [push, pull_request, issues]
 jobs:
   slack-notifications:
     continue-on-error: true
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     name: Sends a message to Slack when a push, a pull request or an issue is made
     steps:
       - name: Send message to Slack API

samples/extracts.py

@@ -42,7 +42,6 @@ def main():
     server.add_http_options({"verify": False})
     server.use_server_version()
     with server.auth.sign_in(tableau_auth):
-
         wb = None
         ds = None
         if args.workbook:

tableauserverclient/__init__.py

@@ -25,6 +25,7 @@
     LinkedTaskItem,
     LinkedTaskStepItem,
     LinkedTaskFlowRunItem,
+    LocationItem,
     MetricItem,
     MonthlyInterval,
     PaginationItem,
@@ -35,6 +36,7 @@
     Resource,
     RevisionItem,
     ScheduleItem,
+    SiteAuthConfiguration,
     SiteItem,
     ServerInfoItem,
     SubscriptionItem,
@@ -101,6 +103,7 @@
     "LinkedTaskFlowRunItem",
     "LinkedTaskItem",
     "LinkedTaskStepItem",
+    "LocationItem",
     "MetricItem",
     "MissingRequiredFieldError",
     "MonthlyInterval",
@@ -121,6 +124,7 @@
     "ServerInfoItem",
     "ServerResponseError",
     "SiteItem",
+    "SiteAuthConfiguration",
     "Sort",
     "SubscriptionItem",
     "TableauAuth",

tableauserverclient/helpers/strings.py

@@ -1,6 +1,6 @@
 from defusedxml.ElementTree import fromstring, tostring
 from functools import singledispatch
-from typing import TypeVar
+from typing import TypeVar, overload
 
 
 # the redact method can handle either strings or bytes, but it can't mix them.
@@ -41,3 +41,27 @@ def _(xml: str) -> str:
 @redact_xml.register  # type: ignore[no-redef]
 def _(xml: bytes) -> bytes:
     return _redact_any_type(bytearray(xml), b"password", b"..[redacted]")
+
+
+@overload
+def nullable_str_to_int(value: None) -> None: ...
+
+
+@overload
+def nullable_str_to_int(value: str) -> int: ...
+
+
+def nullable_str_to_int(value):
+    return int(value) if value is not None else None
+
+
+@overload
+def nullable_str_to_bool(value: None) -> None: ...
+
+
+@overload
+def nullable_str_to_bool(value: str) -> bool: ...
+
+
+def nullable_str_to_bool(value):
+    return str(value).lower() == "true" if value is not None else None

tableauserverclient/models/__init__.py

@@ -28,14 +28,15 @@
     LinkedTaskStepItem,
     LinkedTaskFlowRunItem,
 )
+from tableauserverclient.models.location_item import LocationItem
 from tableauserverclient.models.metric_item import MetricItem
 from tableauserverclient.models.pagination_item import PaginationItem
 from tableauserverclient.models.permissions_item import PermissionsRule, Permission
 from tableauserverclient.models.project_item import ProjectItem
 from tableauserverclient.models.revision_item import RevisionItem
 from tableauserverclient.models.schedule_item import ScheduleItem
 from tableauserverclient.models.server_info_item import ServerInfoItem
-from tableauserverclient.models.site_item import SiteItem
+from tableauserverclient.models.site_item import SiteItem, SiteAuthConfiguration
 from tableauserverclient.models.subscription_item import SubscriptionItem
 from tableauserverclient.models.table_item import TableItem
 from tableauserverclient.models.tableau_auth import Credentials, TableauAuth, PersonalAccessTokenAuth, JWTAuth
@@ -48,6 +49,7 @@
 from tableauserverclient.models.virtual_connection_item import VirtualConnectionItem
 from tableauserverclient.models.webhook_item import WebhookItem
 from tableauserverclient.models.workbook_item import WorkbookItem
+from tableauserverclient.models.extract_item import ExtractItem
 
 __all__ = [
     "ColumnItem",
@@ -75,6 +77,7 @@
     "MonthlyInterval",
     "HourlyInterval",
     "BackgroundJobItem",
+    "LocationItem",
     "MetricItem",
     "PaginationItem",
     "Permission",
@@ -83,6 +86,7 @@
     "RevisionItem",
     "ScheduleItem",
     "ServerInfoItem",
+    "SiteAuthConfiguration",
     "SiteItem",
     "SubscriptionItem",
     "TableItem",
@@ -103,4 +107,5 @@
     "LinkedTaskItem",
     "LinkedTaskStepItem",
     "LinkedTaskFlowRunItem",
+    "ExtractItem",
 ]

tableauserverclient/models/datasource_item.py

@@ -6,16 +6,19 @@
 from defusedxml.ElementTree import fromstring
 
 from tableauserverclient.datetime_helpers import parse_datetime
+from tableauserverclient.helpers.strings import nullable_str_to_bool, nullable_str_to_int
 from tableauserverclient.models.connection_item import ConnectionItem
 from tableauserverclient.models.exceptions import UnpopulatedPropertyError
 from tableauserverclient.models.permissions_item import PermissionsRule
+from tableauserverclient.models.project_item import ProjectItem
 from tableauserverclient.models.property_decorators import (
     property_not_nullable,
     property_is_boolean,
     property_is_enum,
 )
 from tableauserverclient.models.revision_item import RevisionItem
 from tableauserverclient.models.tag_item import TagItem
+from tableauserverclient.models.user_item import UserItem
 
 
 class DatasourceItem:
@@ -40,6 +43,9 @@ class DatasourceItem:
         specified, it will default to SiteDefault. See REST API Publish
         Datasource for more information about ask_data_enablement.
 
+    connected_workbooks_count : Optional[int]
+        The number of workbooks connected to the datasource.
+
     connections : list[ConnectionItem]
         The list of data connections (ConnectionItem) for the specified data
         source. You must first call the populate_connections method to access
@@ -67,6 +73,12 @@ class DatasourceItem:
         A Boolean value to determine if a datasource should be encrypted or not.
         See Extract and Encryption Methods for more information.
 
+    favorites_total : Optional[int]
+        The number of users who have marked the data source as a favorite.
+
+    has_alert : Optional[bool]
+        A Boolean value that indicates whether the data source has an alert.
+
     has_extracts : Optional[bool]
         A Boolean value that indicates whether the datasource has extracts.
 
@@ -75,20 +87,32 @@ class DatasourceItem:
         specific data source or to delete a data source with the get_by_id and
         delete methods.
 
+    is_published : Optional[bool]
+        A Boolean value that indicates whether the data source is published.
+
     name : Optional[str]
         The name of the data source. If not specified, the name of the published
         data source file is used.
 
+    owner: Optional[UserItem]
+        The owner of the data source.
+
     owner_id : Optional[str]
         The identifier of the owner of the data source.
 
+    project : Optional[ProjectItem]
+        The project that the data source belongs to.
+
     project_id : Optional[str]
         The identifier of the project associated with the data source. You must
         provide this identifier when you create an instance of a DatasourceItem.
 
     project_name : Optional[str]
         The name of the project associated with the data source.
 
+    server_name : Optional[str]
+        The name of the server where the data source is published.
+
     tags : Optional[set[str]]
         The tags (list of strings) that have been added to the data source.
 
@@ -143,6 +167,13 @@ def __init__(self, project_id: Optional[str] = None, name: Optional[str] = None)
         self.owner_id: Optional[str] = None
         self.project_id: Optional[str] = project_id
         self.tags: set[str] = set()
+        self._connected_workbooks_count: Optional[int] = None
+        self._favorites_total: Optional[int] = None
+        self._has_alert: Optional[bool] = None
+        self._is_published: Optional[bool] = None
+        self._server_name: Optional[str] = None
+        self._project: Optional[ProjectItem] = None
+        self._owner: Optional[UserItem] = None
 
         self._permissions = None
         self._data_quality_warnings = None
@@ -274,14 +305,42 @@ def revisions(self) -> list[RevisionItem]:
     def size(self) -> Optional[int]:
         return self._size
 
+    @property
+    def connected_workbooks_count(self) -> Optional[int]:
+        return self._connected_workbooks_count
+
+    @property
+    def favorites_total(self) -> Optional[int]:
+        return self._favorites_total
+
+    @property
+    def has_alert(self) -> Optional[bool]:
+        return self._has_alert
+
+    @property
+    def is_published(self) -> Optional[bool]:
+        return self._is_published
+
+    @property
+    def server_name(self) -> Optional[str]:
+        return self._server_name
+
+    @property
+    def project(self) -> Optional[ProjectItem]:
+        return self._project
+
+    @property
+    def owner(self) -> Optional[UserItem]:
+        return self._owner
+
     def _set_connections(self, connections) -> None:
         self._connections = connections
 
     def _set_permissions(self, permissions):
         self._permissions = permissions
 
-    def _set_data_quality_warnings(self, dqws):
-        self._data_quality_warnings = dqws
+    def _set_data_quality_warnings(self, dqw):
+        self._data_quality_warnings = dqw
 
     def _set_revisions(self, revisions):
         self._revisions = revisions
@@ -310,6 +369,13 @@ def _parse_common_elements(self, datasource_xml, ns):
                 use_remote_query_agent,
                 webpage_url,
                 size,
+                connected_workbooks_count,
+                favorites_total,
+                has_alert,
+                is_published,
+                server_name,
+                project,
+                owner,
             ) = self._parse_element(datasource_xml, ns)
             self._set_values(
                 ask_data_enablement,
@@ -331,6 +397,13 @@ def _parse_common_elements(self, datasource_xml, ns):
                 use_remote_query_agent,
                 webpage_url,
                 size,
+                connected_workbooks_count,
+                favorites_total,
+                has_alert,
+                is_published,
+                server_name,
+                project,
+                owner,
             )
         return self
 
@@ -355,6 +428,13 @@ def _set_values(
         use_remote_query_agent,
         webpage_url,
         size,
+        connected_workbooks_count,
+        favorites_total,
+        has_alert,
+        is_published,
+        server_name,
+        project,
+        owner,
     ):
         if ask_data_enablement is not None:
             self._ask_data_enablement = ask_data_enablement
@@ -394,6 +474,20 @@ def _set_values(
             self._webpage_url = webpage_url
         if size is not None:
             self._size = int(size)
+        if connected_workbooks_count is not None:
+            self._connected_workbooks_count = connected_workbooks_count
+        if favorites_total is not None:
+            self._favorites_total = favorites_total
+        if has_alert is not None:
+            self._has_alert = has_alert
+        if is_published is not None:
+            self._is_published = is_published
+        if server_name is not None:
+            self._server_name = server_name
+        if project is not None:
+            self._project = project
+        if owner is not None:
+            self._owner = owner
 
     @classmethod
     def from_response(cls, resp: str, ns: dict) -> list["DatasourceItem"]:
@@ -428,6 +522,11 @@ def _parse_element(datasource_xml: ET.Element, ns: dict) -> tuple:
         use_remote_query_agent = datasource_xml.get("useRemoteQueryAgent", None)
         webpage_url = datasource_xml.get("webpageUrl", None)
         size = datasource_xml.get("size", None)
+        connected_workbooks_count = nullable_str_to_int(datasource_xml.get("connectedWorkbooksCount", None))
+        favorites_total = nullable_str_to_int(datasource_xml.get("favoritesTotal", None))
+        has_alert = nullable_str_to_bool(datasource_xml.get("hasAlert", None))
+        is_published = nullable_str_to_bool(datasource_xml.get("isPublished", None))
+        server_name = datasource_xml.get("serverName", None)
 
         tags = None
         tags_elem = datasource_xml.find(".//t:tags", namespaces=ns)
@@ -438,12 +537,14 @@ def _parse_element(datasource_xml: ET.Element, ns: dict) -> tuple:
         project_name = None
         project_elem = datasource_xml.find(".//t:project", namespaces=ns)
         if project_elem is not None:
+            project = ProjectItem.from_xml(project_elem, ns)
             project_id = project_elem.get("id", None)
             project_name = project_elem.get("name", None)
 
         owner_id = None
         owner_elem = datasource_xml.find(".//t:owner", namespaces=ns)
         if owner_elem is not None:
+            owner = UserItem.from_xml(owner_elem, ns)
             owner_id = owner_elem.get("id", None)
 
         ask_data_enablement = None
@@ -471,4 +572,11 @@ def _parse_element(datasource_xml: ET.Element, ns: dict) -> tuple:
             use_remote_query_agent,
             webpage_url,
             size,
+            connected_workbooks_count,
+            favorites_total,
+            has_alert,
+            is_published,
+            server_name,
+            project,
+            owner,
         )