0.34 development merge

* Feature: export custom views #999 (#1506)
* feat(exceptions): separate failed signin error (#1478)
* refactor request_options, add language param (#1481)
* Set FILESIZE_LIMIT_MB via environment variables (#1466)
* added PulseMetricDefine cap (#1490)
* Adding project permissions handling for databases, tables and virtual connections (#1482)
* fix: queryset support for flowruns (#1460)
* fix: set unknown size to sys.maxsize
* fix: handle 0 item response in querysets (#1501)
* chore: support VizqlDataApiAccess capability (#1504)
* refactor(test): extract error factory to _utils
* chore(typing): flowruns.cancel can also accept a FlowRunItem
* chore: type hint default permissions endpoints (#1493)
* chore(versions): update remaining f-strings (#1477)
* Make urllib3 dependency more flexible (#1468)
* Update requests library for CVE CVE-2024-35195 (#1507)

* chore(versions): Upgrade minimum python version (#1465)
* ci: cache dependencies for faster builds (#1497)
* ci: build on python 3.13 (#1492)
* Update samples for Python 3.x compatibility (#1479)
* chore: remove  py2 holdover code (#1496)
* #Add 'description' to datasource sample code (#1475)
* Remove sample code showing group name encoding (#1486)
* chore(typing): include samples in type checks (#1455)

* fix: docstring on QuerySet
* docs: add docstrings to auth objects and endpoints (#1484)
* docs: docstrings for Server and ServerInfo (#1494)
* docs: docstrings for user item and endpoint (#1485)
* docs: docstrings for site item and endpoint (#1495)
* docs: workbook docstrings (#1488)
* #1464 - docs update for filtering on boolean values (#1471)

---------
Co-authored-by: Brian Cantoni <[email protected]>
Co-authored-by: Jordan Woods <[email protected]>
Co-authored-by: Jordan Woods <[email protected]>
Co-authored-by: Jac <[email protected]>
Co-authored-by: Henning Merklinger <[email protected]>
Co-authored-by: AlbertWangXu <[email protected]>
Co-authored-by: TrimPeachu <[email protected]>

Author: 7 people

.github/workflows/meta-checks.yml

@@ -13,6 +13,20 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
+    - name: Get pip cache dir
+      id: pip-cache
+      shell: bash
+      run: |
+        echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
+
+    - name: cache
+      uses: actions/cache@v4
+      with:
+        path: ${{ steps.pip-cache.outputs.dir }}
+        key: ${{ runner.os }}-${{ matrix.python-version }}-pip-${{ hashFiles('pyproject.toml') }}
+        restore-keys: |
+          ${{ runner.os }}-${{ matrix.python-version }}-pip-
+
     - uses: actions/checkout@v4
 
     - name: Set up Python ${{ matrix.python-version }} on ${{ matrix.os }}

.github/workflows/run-tests.yml

@@ -13,11 +13,25 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
 
     runs-on: ${{ matrix.os }}
 
     steps:
+    - name: Get pip cache dir
+      id: pip-cache
+      shell: bash
+      run: |
+        echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
+
+    - name: cache
+      uses: actions/cache@v4
+      with:
+        path: ${{ steps.pip-cache.outputs.dir }}
+        key: ${{ runner.os }}-${{ matrix.python-version }}-pip-${{ hashFiles('pyproject.toml') }}
+        restore-keys: |
+          ${{ runner.os }}-${{ matrix.python-version }}-pip-
+
     - uses: actions/checkout@v4
 
     - name: Set up Python ${{ matrix.python-version }} on ${{ matrix.os }}

pyproject.toml

@@ -14,42 +14,42 @@ readme = "README.md"
 dependencies = [
     'defusedxml>=0.7.1',  # latest as at 7/31/23
     'packaging>=23.1',   # latest as at 7/31/23
-    'requests>=2.31',  # latest as at 7/31/23
-    'urllib3==2.2.2',  # dependabot
+    'requests>=2.32',  # latest as at 7/31/23
+    'urllib3>=2.2.2,<3',
     'typing_extensions>=4.0.1',
 ]
-requires-python = ">=3.7"
+requires-python = ">=3.9"
 classifiers = [
   "Programming Language :: Python",
   "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3.8",
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
-  "Programming Language :: Python :: 3.12"
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13"
 ]
 [project.urls]
 repository = "https://github.com/tableau/server-client-python"
 
 [project.optional-dependencies]
-test = ["black==23.7", "build", "mypy==1.4", "pytest>=7.0", "pytest-cov", "pytest-subtests",
+test = ["black==24.8", "build", "mypy==1.4", "pytest>=7.0", "pytest-cov", "pytest-subtests",
     "requests-mock>=1.0,<2.0"]
 
 [tool.black]
 line-length = 120
-target-version = ['py37', 'py38', 'py39', 'py310', 'py311', 'py312']
+target-version = ['py39', 'py310', 'py311', 'py312', 'py313']
 
 [tool.mypy]
 check_untyped_defs = false
 disable_error_code = [
     'misc',
-    # 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
+implicit_optional = true
 
 [tool.pytest.ini_options]
 testpaths = ["test"]

samples/add_default_permission.py

@@ -63,10 +63,10 @@ def main():
             for permission in new_default_permissions:
                 grantee = permission.grantee
                 capabilities = permission.capabilities
-                print("\nCapabilities for {0} {1}:".format(grantee.tag_name, grantee.id))
+                print(f"\nCapabilities for {grantee.tag_name} {grantee.id}:")
 
                 for capability in capabilities:
-                    print("\t{0} - {1}".format(capability, capabilities[capability]))
+                    print(f"\t{capability} - {capabilities[capability]}")
 
         # Uncomment lines below to DELETE the new capability and the new project
         # rules_to_delete = TSC.PermissionsRule(

samples/create_group.py

@@ -11,7 +11,6 @@
 import os
 
 from datetime import time
-from typing import List
 
 import tableauserverclient as TSC
 from tableauserverclient import ServerResponseError
@@ -63,23 +62,23 @@ def main():
 
         if args.file:
             filepath = os.path.abspath(args.file)
-            print("Add users to site from file {}:".format(filepath))
-            added: List[TSC.UserItem]
-            failed: List[TSC.UserItem, TSC.ServerResponseError]
+            print(f"Add users to site from file {filepath}:")
+            added: list[TSC.UserItem]
+            failed: list[TSC.UserItem, TSC.ServerResponseError]
             added, failed = server.users.create_from_file(filepath)
             for user, error in failed:
                 print(user, error.code)
                 if error.code == "409017":
                     user = server.users.filter(name=user.name)[0]
                     added.append(user)
-            print("Adding users to group:{}".format(added))
+            print(f"Adding users to group:{added}")
             for user in added:
-                print("Adding user {}".format(user))
+                print(f"Adding user {user}")
                 try:
                     server.groups.add_user(group, user.id)
                 except ServerResponseError as serverError:
                     if serverError.code == "409011":
-                        print("user {} is already a member of group {}".format(user.name, group.name))
+                        print(f"user {user.name} is already a member of group {group.name}")
                     else:
                         raise rError
 

samples/create_project.py

@@ -84,7 +84,7 @@ def main():
         server.projects.populate_datasource_default_permissions(changed_project),
         server.projects.populate_permissions(changed_project)
         # Projects have default permissions set for the object types they contain
-        print("Permissions from project {}:".format(changed_project.id))
+        print(f"Permissions from project {changed_project.id}:")
         print(changed_project.permissions)
         print(
             changed_project.default_workbook_permissions,

samples/create_schedules.py

@@ -55,7 +55,7 @@ def main():
         )
         try:
             hourly_schedule = server.schedules.create(hourly_schedule)
-            print("Hourly schedule created (ID: {}).".format(hourly_schedule.id))
+            print(f"Hourly schedule created (ID: {hourly_schedule.id}).")
         except Exception as e:
             print(e)
 
@@ -71,7 +71,7 @@ def main():
         )
         try:
             daily_schedule = server.schedules.create(daily_schedule)
-            print("Daily schedule created (ID: {}).".format(daily_schedule.id))
+            print(f"Daily schedule created (ID: {daily_schedule.id}).")
         except Exception as e:
             print(e)
 
@@ -89,7 +89,7 @@ def main():
         )
         try:
             weekly_schedule = server.schedules.create(weekly_schedule)
-            print("Weekly schedule created (ID: {}).".format(weekly_schedule.id))
+            print(f"Weekly schedule created (ID: {weekly_schedule.id}).")
         except Exception as e:
             print(e)
             options = TSC.RequestOptions()
@@ -112,7 +112,7 @@ def main():
         )
         try:
             monthly_schedule = server.schedules.create(monthly_schedule)
-            print("Monthly schedule created (ID: {}).".format(monthly_schedule.id))
+            print(f"Monthly schedule created (ID: {monthly_schedule.id}).")
         except Exception as e:
             print(e)
 

samples/explore_datasource.py

@@ -51,16 +51,17 @@ def main():
         if args.publish:
             if default_project is not None:
                 new_datasource = TSC.DatasourceItem(default_project.id)
+                new_datasource.description = "Published with a description"
                 new_datasource = server.datasources.publish(
                     new_datasource, args.publish, TSC.Server.PublishMode.Overwrite
                 )
-                print("Datasource published. ID: {}".format(new_datasource.id))
+                print(f"Datasource published. ID: {new_datasource.id}")
             else:
                 print("Publish failed. Could not find the default project.")
 
         # Gets all datasource items
         all_datasources, pagination_item = server.datasources.get()
-        print("\nThere are {} datasources on site: ".format(pagination_item.total_available))
+        print(f"\nThere are {pagination_item.total_available} datasources on site: ")
         print([datasource.name for datasource in all_datasources])
 
         if all_datasources:
@@ -69,20 +70,19 @@ def main():
 
             # Populate connections
             server.datasources.populate_connections(sample_datasource)
-            print("\nConnections for {}: ".format(sample_datasource.name))
-            print(
-                [
-                    "{0}({1})".format(connection.id, connection.datasource_name)
-                    for connection in sample_datasource.connections
-                ]
-            )
+            print(f"\nConnections for {sample_datasource.name}: ")
+            print([f"{connection.id}({connection.datasource_name})" for connection in sample_datasource.connections])
+
+            # Demonstrate that description is editable
+            sample_datasource.description = "Description updated by TSC"
+            server.datasources.update(sample_datasource)
 
             # Add some tags to the datasource
             original_tag_set = set(sample_datasource.tags)
             sample_datasource.tags.update("a", "b", "c", "d")
             server.datasources.update(sample_datasource)
-            print("\nOld tag set: {}".format(original_tag_set))
-            print("New tag set: {}".format(sample_datasource.tags))
+            print(f"\nOld tag set: {original_tag_set}")
+            print(f"New tag set: {sample_datasource.tags}")
 
             # Delete all tags that were added by setting tags to original
             sample_datasource.tags = original_tag_set

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():
@@ -39,15 +39,15 @@ def main():
         # get all favorites on site for the logged on user
         user: TSC.UserItem = TSC.UserItem()
         user.id = server.user_id
-        print("Favorites for user: {}".format(user.id))
+        print(f"Favorites for user: {user.id}")
         server.favorites.get(user)
         print(user.favorites)
 
         # 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
@@ -57,7 +57,7 @@ def main():
             if views is not None and len(views) > 0:
                 my_view = views[0]
                 server.favorites.add_favorite_view(user, my_view)
-                print("View added to favorites. View Name: {}, View ID: {}".format(my_view.name, my_view.id))
+                print(f"View added to favorites. View Name: {my_view.name}, View ID: {my_view.id}")
 
         all_datasource_items, pagination_item = server.datasources.get()
         if all_datasource_items:
@@ -70,12 +70,10 @@ def main():
         )
 
     server.favorites.delete_favorite_workbook(user, my_workbook)
-    print(
-        "Workbook deleted from favorites. Workbook Name: {}, Workbook ID: {}".format(my_workbook.name, my_workbook.id)
-    )
+    print(f"Workbook deleted from favorites. Workbook Name: {my_workbook.name}, Workbook ID: {my_workbook.id}")
 
     server.favorites.delete_favorite_view(user, my_view)
-    print("View deleted from favorites. View Name: {}, View ID: {}".format(my_view.name, my_view.id))
+    print(f"View deleted from favorites. View Name: {my_view.name}, View ID: {my_view.id}")
 
     server.favorites.delete_favorite_datasource(user, my_datasource)
     print(

samples/explore_site.py

@@ -49,7 +49,7 @@ def main():
 
         if args.delete:
             print("You can only delete the site you are currently in")
-            print("Delete site `{}`?".format(current_site.name))
+            print(f"Delete site `{current_site.name}`?")
             # server.sites.delete(server.site_id)
 
         elif args.create: