tableau · jacalata · May 26, 2022 · May 7, 2022 · May 7, 2022 · May 8, 2022
diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
@@ -8,7 +8,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ['3.6', '3.7', '3.8', '3.9', '3.10']
+        python-version: ['3.7', '3.8', '3.9', '3.10']
 
     runs-on: ${{ matrix.os }}
 

diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ Use the Tableau Server Client (TSC) library to increase your productivity as you
 * Create users and groups.
 * Query projects, sites, and more.
 
-This repository contains Python source code for the library and sample files showing how to use it. Python versions 3.6 and up are supported.
+This repository contains Python source code for the library and sample files showing how to use it. As of May 2022, Python versions 3.7 and up are supported.
 
 To see sample code that works directly with the REST API (in Java, Python, or Postman), visit the [REST API Samples](https://github.com/tableau/rest-api-samples) repo.
 

diff --git a/out.pdf b/out.pdf
diff --git a/samples/add_default_permission.py b/samples/add_default_permission.py
@@ -1,6 +1,6 @@
 ####
 # This script demonstrates how to add default permissions using TSC
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 #
 # In order to demonstrate adding a new default permission, this sample will create
 # a new project and add a new capability to the new project, for the default "All users" group.

diff --git a/samples/create_group.py b/samples/create_group.py
@@ -2,7 +2,7 @@
 # This script demonstrates how to create a group using the Tableau
 # Server Client.
 #
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 ####
 
 

diff --git a/samples/create_project.py b/samples/create_project.py
@@ -4,7 +4,7 @@
 # parent_id.
 #
 #
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 ####
 
 import argparse

diff --git a/samples/create_schedules.py b/samples/create_schedules.py
@@ -2,7 +2,7 @@
 # This script demonstrates how to create schedules using the Tableau
 # Server Client.
 #
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 ####
 
 

diff --git a/samples/export.py b/samples/export.py
@@ -2,7 +2,7 @@
 # This script demonstrates how to export a view using the Tableau
 # Server Client.
 #
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 ####
 
 import argparse

diff --git a/samples/filter_sort_groups.py b/samples/filter_sort_groups.py
@@ -2,7 +2,7 @@
 # This script demonstrates how to filter and sort groups using the Tableau
 # Server Client.
 #
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 ####
 
 

diff --git a/samples/filter_sort_projects.py b/samples/filter_sort_projects.py
@@ -2,7 +2,7 @@
 # This script demonstrates how to use the Tableau Server Client
 # to filter and sort on the name of the projects present on site.
 #
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 ####
 
 import argparse

diff --git a/samples/kill_all_jobs.py b/samples/kill_all_jobs.py
@@ -1,7 +1,7 @@
 ####
 # This script demonstrates how to kill all of the running jobs
 #
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 ####
 
 import argparse

diff --git a/samples/list.py b/samples/list.py
@@ -1,7 +1,7 @@
 ####
 # This script demonstrates how to list all of the workbooks or datasources
 #
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 ####
 
 import argparse

diff --git a/samples/login.py b/samples/login.py
@@ -1,7 +1,7 @@
 ####
 # This script demonstrates how to log in to Tableau Server Client.
 #
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 ####
 
 import argparse

diff --git a/samples/metadata_query.py b/samples/metadata_query.py
@@ -1,7 +1,7 @@
 ####
 # 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.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 ####
 
 import argparse

diff --git a/samples/move_workbook_projects.py b/samples/move_workbook_projects.py
@@ -4,7 +4,7 @@
 # a workbook that matches a given name and update it to be in
 # the desired project.
 #
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 ####
 
 import argparse

diff --git a/samples/move_workbook_sites.py b/samples/move_workbook_sites.py
@@ -4,7 +4,7 @@
 # a workbook that matches a given name, download the workbook,
 # and then publish it to the destination site.
 #
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 ####
 
 import argparse

diff --git a/samples/publish_datasource.py b/samples/publish_datasource.py
@@ -15,7 +15,7 @@
 # more information on personal access tokens, refer to the documentations:
 # (https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm)
 #
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 ####
 
 import argparse

diff --git a/samples/publish_workbook.py b/samples/publish_workbook.py
@@ -11,7 +11,7 @@
 # For more information, refer to the documentations on 'Publish Workbook'
 # (https://onlinehelp.tableau.com/current/api/rest_api/en-us/help.htm)
 #
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 ####
 
 import argparse

diff --git a/samples/query_permissions.py b/samples/query_permissions.py
@@ -1,6 +1,6 @@
 ####
 # This script demonstrates how to query for permissions using TSC
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 #
 # Example usage: 'python query_permissions.py -s https://10ax.online.tableau.com --site
 #       devSite123 -u tabby@tableau.com workbook b4065286-80f0-11ea-af1b-cb7191f48e45'

diff --git a/samples/refresh.py b/samples/refresh.py
@@ -1,7 +1,7 @@
 ####
 # This script demonstrates how to use trigger a refresh on a datasource or workbook
 #
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 ####
 
 import argparse

diff --git a/samples/refresh_tasks.py b/samples/refresh_tasks.py
@@ -2,7 +2,7 @@
 # This script demonstrates how to use the Tableau Server Client
 # to query extract refresh tasks and run them as needed.
 #
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 ####
 
 import argparse

diff --git a/samples/set_refresh_schedule.py b/samples/set_refresh_schedule.py
@@ -2,7 +2,7 @@
 # This script demonstrates how to set the refresh schedule for
 # a workbook or datasource.
 #
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 ####
 
 

diff --git a/samples/update_connection.py b/samples/update_connection.py
@@ -1,7 +1,7 @@
 ####
 # This script demonstrates how to update a connections credentials on a server to embed the credentials
 #
-# To run the script, you must have installed Python 3.6 or later.
+# To run the script, you must have installed Python 3.7 or later.
 ####
 
 import argparse

diff --git a/setup.py b/setup.py
@@ -15,7 +15,7 @@
 # This makes work easier for offline installs or low bandwidth machines
 needs_pytest = {'pytest', 'test', 'ptr'}.intersection(sys.argv)
 pytest_runner = ['pytest-runner'] if needs_pytest else []
-test_requirements = ['black', 'mock', 'pytest', 'requests-mock>=1.0,<2.0', 'mypy==0.910']
+test_requirements = ['black', 'mock', 'pytest', 'requests-mock>=1.0,<2.0', 'mypy>=0.920']
 
 setup(
     name='tableauserverclient',
@@ -25,7 +25,10 @@
     author_email='github@tableau.com',
     url='https://github.com/tableau/server-client-python',
     package_data={'tableauserverclient':['py.typed']},
-    packages=['tableauserverclient', 'tableauserverclient.models', 'tableauserverclient.server',
+    packages=['tableauserverclient',
+              'tableauserverclient.helpers',
+              'tableauserverclient.models',
+              'tableauserverclient.server',
               'tableauserverclient.server.endpoint'],
     license='MIT',
     description='A Python module for working with the Tableau Server REST API.',
@@ -37,6 +40,7 @@
         'defusedxml>=0.7.1',
         'requests>=2.11,<3.0',
     ],
+    python_requires='>3.7.0',
     tests_require=test_requirements,
     extras_require={
         'test': test_requirements

diff --git a/tableauserverclient/__init__.py b/tableauserverclient/__init__.py
@@ -52,6 +52,7 @@
     NotSignedInError,
     Pager,
 )
+from .helpers import *
 
 __version__ = get_versions()["version"]
 __VERSION__ = __version__

diff --git a/tableauserverclient/helpers/__init__.py b/tableauserverclient/helpers/__init__.py
@@ -0,0 +1 @@
+from .strings import *
diff --git a/tableauserverclient/helpers/strings.py b/tableauserverclient/helpers/strings.py
@@ -0,0 +1,65 @@
+import requests
+
+from defusedxml.ElementTree import fromstring, tostring
+from functools import singledispatch
+from typing import TypeVar
+
+
+# the redact method can handle either strings or bytes, but it can't mix them.
+# Generic type so we can write the actual logic once, then use singledispatch to
+# create the replacement text with the correct type
+T = TypeVar("T", str, bytes)
+
+
+# TODO: ideally this would be in the logging config
+def safe_to_log(server_response: requests.Response) -> str:
+    """Checks if the server_response content is not xml (eg binary image or zip)
+    and replaces it with a constant"""
+    ALLOWED_CONTENT_TYPES = ("application/xml", "application/xml;charset=utf-8")
+    if server_response.headers.get("Content-Type", None) not in ALLOWED_CONTENT_TYPES:
+        return "[Truncated File Contents]"
+
+    """ Check to determine if the response is a text response (xml or otherwise)
+        so that we do not attempt to log bytes and other binary data. """
+    if not server_response.content or not server_response.encoding:
+        return ""
+    # max length 1000
+    loggable_response: str = server_response.content.decode(server_response.encoding)[:1000]
+    redacted_response: str = redact_xml(loggable_response)
+    return redacted_response
+
+
+# usage: _redact_any_type("<xml workbook password= cooliothesecond>")
+# -> b"<xml workbook password =***************">
+def _redact_any_type(xml: T, sensitive_word: T, replacement: T, encoding=None) -> T:
+    try:
+        root = fromstring(xml)
+        matches = root.findall(".//*[@password]")
+        for item in matches:
+            item.attrib["password"] = "********"
+        matches = root.findall(".//password")
+        for item in matches:
+            item.text = "********"
+        # tostring returns bytes unless an encoding value is passed
+        return tostring(root, encoding=encoding)
+    except Exception:
+        # something about the xml handling failed. Just cut off the text at the first occurrence of "password"
+        location = xml.find(sensitive_word)
+        return xml[:location] + replacement
+
+
+@singledispatch
+def redact_xml(content):
+    # this will only be called if it didn't get directed to the str or bytes overloads
+    raise TypeError("Redaction only works on xml saved as str or bytes")
+
+
+@redact_xml.register
+def _(xml: str) -> str:
+    out = _redact_any_type(xml, "password", "...[redacted]", encoding="unicode")
+    return out
+
+
+@redact_xml.register  # type: ignore[no-redef]
+def _(xml: bytes) -> bytes:
+    return _redact_any_type(bytearray(xml), b"password", b"..[redacted]")
diff --git a/tableauserverclient/server/__init__.py b/tableauserverclient/server/__init__.py
@@ -59,3 +59,4 @@
 from .server import Server
 from .pager import Pager
 from .exceptions import NotSignedInError
+from ..helpers import *