Merge branch 'development' into bcantoni/1365-monthly-schedule

Author: bcantoni

CODEOWNERS

@@ -0,0 +1,2 @@
+#ECCN:Open Source
+#GUSINFO:Open Source,Open Source Workflow

pyproject.toml

@@ -33,8 +33,7 @@ repository = "https://github.com/tableau/server-client-python"
 
 [project.optional-dependencies]
 test = ["black==24.8", "build", "mypy==1.4", "pytest>=7.0", "pytest-cov", "pytest-subtests",
-    "requests-mock>=1.0,<2.0"]
-
+    "requests-mock>=1.0,<2.0", "types-requests>=2.32.4.20250913"]
 [tool.black]
 line-length = 120
 target-version = ['py39', 'py310', 'py311', 'py312', 'py313']

samples/create_user.py

@@ -0,0 +1,73 @@
+####
+# This script demonstrates how to create a user using the Tableau
+# Server Client.
+#
+# To run the script, you must have installed Python 3.7 or later.
+####
+
+
+import argparse
+import logging
+import os
+import sys
+from typing import Sequence
+
+import tableauserverclient as TSC
+
+
+def parse_args(args: Sequence[str] | None) -> argparse.Namespace:
+    """
+    Parse command line parameters
+    """
+    if args is None:
+        args = sys.argv[1:]
+    parser = argparse.ArgumentParser(description="Creates a sample user group.")
+    # Common options; please keep those in sync across all samples
+    parser.add_argument("--server", "-s", help="server address")
+    parser.add_argument("--site", "-S", help="site name")
+    parser.add_argument("--token-name", "-p", help="name of the personal access token used to sign into the server")
+    parser.add_argument("--token-value", "-v", help="value of the personal access token used to sign into the server")
+    parser.add_argument(
+        "--logging-level",
+        "-l",
+        choices=["debug", "info", "error"],
+        default="error",
+        help="desired logging level (set to error by default)",
+    )
+    # Options specific to this sample
+    # This sample has no additional options, yet. If you add some, please add them here
+    parser.add_argument("--role", "-r", help="Site Role for the new user", default="Unlicensed")
+    parser.add_argument(
+        "--user",
+        "-u",
+        help="Username for the new user. If using active directory, it should be in the format of SAMAccountName@FullyQualifiedDomainName",
+    )
+    parser.add_argument(
+        "--email", "-e", help="Email address of the new user. If using active directory, this field is optional."
+    )
+
+    return parser.parse_args(args)
+
+
+def main():
+    args = parse_args(None)
+
+    # Set logging level based on user input, or error by default
+    logging_level = getattr(logging, args.logging_level.upper())
+    logging.basicConfig(level=logging_level)
+
+    tableau_auth = TSC.PersonalAccessTokenAuth(args.token_name, args.token_value, site_id=args.site)
+    server = TSC.Server(args.server, use_server_version=True, http_options={"verify": False})
+    with server.auth.sign_in(tableau_auth):
+        # this code shows 2 different error codes for common mistakes
+        # 400013: Invalid site role
+        # 409000: user already exists on site
+
+        user = TSC.UserItem(args.user, args.role)
+        if args.email:
+            user.email = args.email
+        user = server.users.add(user)
+
+
+if __name__ == "__main__":
+    main()

samples/metadata_paginated_query.py

@@ -0,0 +1,87 @@
+####
+# This script demonstrates how to use the metadata API to query information on a published data source
+#
+# To run the script, you must have installed Python 3.7 or later.
+####
+
+import argparse
+import logging
+from pprint import pprint
+
+import tableauserverclient as TSC
+
+
+def main():
+    parser = argparse.ArgumentParser(description="Use the metadata API to get information on a published data source.")
+    # Common options; please keep those in sync across all samples
+    parser.add_argument("--server", "-s", help="server address")
+    parser.add_argument("--site", "-S", help="site name")
+    parser.add_argument("--token-name", "-n", help="name of the personal access token used to sign into the server")
+    parser.add_argument("--token-value", "-v", help="value of the personal access token used to sign into the server")
+    parser.add_argument(
+        "--logging-level",
+        "-l",
+        choices=["debug", "info", "error"],
+        default="error",
+        help="desired logging level (set to error by default)",
+    )
+    # Options specific to this sample
+    parser.add_argument(
+        "datasource_name",
+        nargs="?",
+        help="The name of the published datasource. If not present, we query all data sources.",
+    )
+
+    args = parser.parse_args()
+
+    # Set logging level based on user input, or error by default
+    logging_level = getattr(logging, args.logging_level.upper())
+    logging.basicConfig(level=logging_level)
+
+    # Sign in to server
+    tableau_auth = TSC.PersonalAccessTokenAuth(args.token_name, args.token_value, site_id=args.site)
+    server = TSC.Server(args.server, use_server_version=True)
+    with server.auth.sign_in(tableau_auth):
+        # Execute the query
+        result = server.metadata.query(
+            """
+            # Query must declare that it accepts first and afterToken variables
+            query paged($first:Int, $afterToken:String) {
+              workbooksConnection(first: $first, after:$afterToken) {
+                nodes {
+                  luid
+                  name
+                  projectName
+                  description
+                }
+                totalCount
+                pageInfo {
+                  endCursor
+                  hasNextPage
+                }
+              }
+            }
+            """,
+            # "first" adjusts the page size. Here we set it to 5 to demonstrate pagination.
+            # Set it to a higher number to reduce the number of pages. Including
+            # first and afterToken is optional, and if not included, TSC will
+            # use its default page size of 100.
+            variables={"first": 5, "afterToken": None},
+        )
+
+        # Multiple pages are captured in result["pages"]. Each page contains
+        # the result of one execution of the query above.
+        for page in result["pages"]:
+            # Display warnings/errors (if any)
+            if page.get("errors"):
+                print("### Errors/Warnings:")
+                pprint(result["errors"])
+
+            # Print the results
+            if result.get("data"):
+                print("### Results:")
+                pprint(result["data"]["workbooksConnection"]["nodes"])
+
+
+if __name__ == "__main__":
+    main()

tableauserverclient/models/data_freshness_policy_item.py

@@ -66,7 +66,7 @@ def interval_item(self) -> Optional[list[str]]:
             return self._interval_item
 
         @interval_item.setter
-        def interval_item(self, value: list[str]):
+        def interval_item(self, value: Optional[list[str]]):
             self._interval_item = value
 
         @property
@@ -127,15 +127,15 @@ def fresh_every_schedule(self) -> Optional[FreshEvery]:
         return self._fresh_every_schedule
 
     @fresh_every_schedule.setter
-    def fresh_every_schedule(self, value: FreshEvery):
+    def fresh_every_schedule(self, value: Optional[FreshEvery]):
         self._fresh_every_schedule = value
 
     @property
     def fresh_at_schedule(self) -> Optional[FreshAt]:
         return self._fresh_at_schedule
 
     @fresh_at_schedule.setter
-    def fresh_at_schedule(self, value: FreshAt):
+    def fresh_at_schedule(self, value: Optional[FreshAt]):
         self._fresh_at_schedule = value
 
     @classmethod

tableauserverclient/models/datasource_item.py

@@ -535,13 +535,15 @@ def _parse_element(datasource_xml: ET.Element, ns: dict) -> tuple:
 
         project_id = None
         project_name = None
+        project = 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 = None
         owner_elem = datasource_xml.find(".//t:owner", namespaces=ns)
         if owner_elem is not None:
             owner = UserItem.from_xml(owner_elem, ns)

tableauserverclient/models/flow_item.py

@@ -129,7 +129,7 @@ def description(self) -> Optional[str]:
         return self._description
 
     @description.setter
-    def description(self, value: str) -> None:
+    def description(self, value: Optional[str]) -> None:
         self._description = value
 
     @property

tableauserverclient/models/group_item.py

@@ -1,6 +1,7 @@
 from typing import Callable, Optional, TYPE_CHECKING
 
 from defusedxml.ElementTree import fromstring
+from typing_extensions import Self
 
 from .exceptions import UnpopulatedPropertyError
 from .property_decorators import property_not_empty, property_is_enum
@@ -92,7 +93,7 @@ def name(self) -> Optional[str]:
         return self._name
 
     @name.setter
-    def name(self, value: str) -> None:
+    def name(self, value: Optional[str]) -> None:
         self._name = value
 
     @property
@@ -157,3 +158,8 @@ def from_response(cls, resp, ns) -> list["GroupItem"]:
     @staticmethod
     def as_reference(id_: str) -> ResourceReference:
         return ResourceReference(id_, GroupItem.tag_name)
+
+    def to_reference(self: Self) -> ResourceReference:
+        if self.id is None:
+            raise ValueError(f"{self.__class__.__qualname__} must have id to be converted to reference")
+        return ResourceReference(self.id, self.tag_name)

tableauserverclient/models/groupset_item.py

@@ -2,6 +2,7 @@
 import xml.etree.ElementTree as ET
 
 from defusedxml.ElementTree import fromstring
+from typing_extensions import Self
 
 from tableauserverclient.models.group_item import GroupItem
 from tableauserverclient.models.reference_item import ResourceReference
@@ -24,6 +25,14 @@ def __str__(self) -> str:
     def __repr__(self) -> str:
         return self.__str__()
 
+    @property
+    def name(self) -> Optional[str]:
+        return self._name
+
+    @name.setter
+    def name(self, value: Optional[str]) -> None:
+        self._name = value
+
     @classmethod
     def from_response(cls, response: bytes, ns: dict[str, str]) -> list["GroupSetItem"]:
         parsed_response = fromstring(response)
@@ -51,3 +60,8 @@ def get_group(group_xml: ET.Element) -> GroupItem:
     @staticmethod
     def as_reference(id_: str) -> ResourceReference:
         return ResourceReference(id_, GroupSetItem.tag_name)
+
+    def to_reference(self: Self) -> ResourceReference:
+        if self.id is None:
+            raise ValueError(f"{self.__class__.__qualname__} must have id to be converted to reference")
+        return ResourceReference(self.id, self.tag_name)

tableauserverclient/models/permissions_item.py

@@ -43,6 +43,7 @@ class Capability:
         CreateRefreshMetrics = "CreateRefreshMetrics"
         SaveAs = "SaveAs"
         PulseMetricDefine = "PulseMetricDefine"
+        ExtractRefresh = "ExtractRefresh"
         WebAuthoringForFlows = "WebAuthoringForFlows"
 
         def __repr__(self):