Jac/client version header (#1075)

* add client version/debug header

Author: jacalata

tableauserverclient/__init__.py

@@ -1,62 +1,52 @@
-from ._version import get_versions
+from .namespace import NEW_NAMESPACE as DEFAULT_NAMESPACE
 from .models import (
+    BackgroundJobItem,
+    ColumnItem,
     ConnectionCredentials,
     ConnectionItem,
+    DQWItem,
+    DailyInterval,
     DataAlertItem,
+    DatabaseItem,
     DatasourceItem,
-    DQWItem,
+    FlowItem,
+    FlowRunItem,
     GroupItem,
+    HourlyInterval,
+    IntervalItem,
     JobItem,
-    BackgroundJobItem,
+    MetricItem,
+    MonthlyInterval,
     PaginationItem,
+    Permission,
+    PermissionsRule,
+    PersonalAccessTokenAuth,
     ProjectItem,
+    RevisionItem,
     ScheduleItem,
     SiteItem,
+    SubscriptionItem,
+    TableItem,
     TableauAuth,
-    PersonalAccessTokenAuth,
+    Target,
+    TaskItem,
+    UnpopulatedPropertyError,
     UserItem,
     ViewItem,
-    WorkbookItem,
-    UnpopulatedPropertyError,
-    HourlyInterval,
-    DailyInterval,
-    WeeklyInterval,
-    MonthlyInterval,
-    IntervalItem,
-    TaskItem,
-    SubscriptionItem,
-    Target,
-    PermissionsRule,
-    Permission,
-    DatabaseItem,
-    TableItem,
-    ColumnItem,
-    FlowItem,
     WebhookItem,
-    PersonalAccessTokenAuth,
-    FlowRunItem,
-    RevisionItem,
-    MetricItem,
-    TableauItem,
-    Resource,
-    plural_type,
+    WeeklyInterval,
+    WorkbookItem,
 )
-from .namespace import NEW_NAMESPACE as DEFAULT_NAMESPACE
 from .server import (
-    RequestOptions,
     CSVRequestOptions,
     ImageRequestOptions,
     PDFRequestOptions,
-    Filter,
-    Sort,
-    Server,
-    ServerResponseError,
+    RequestOptions,
     MissingRequiredFieldError,
     NotSignedInError,
+    ServerResponseError,
+    Filter,
     Pager,
+    Server,
+    Sort,
 )
-from .helpers import *
-
-__version__ = get_versions()["version"]
-__VERSION__ = __version__
-del get_versions

tableauserverclient/server/server.py

@@ -1,7 +1,8 @@
-from distutils.version import LooseVersion as Version
+import requests
 import urllib3
-from defusedxml.ElementTree import fromstring
 
+from defusedxml.ElementTree import fromstring
+from distutils.version import LooseVersion as Version
 from .endpoint import (
     Sites,
     Views,
@@ -35,9 +36,10 @@
 from .exceptions import NotSignedInError
 from ..namespace import Namespace
 
-import requests
+from .._version import get_versions
 
-from distutils.version import LooseVersion as Version
+__TSC_VERSION__ = get_versions()["version"]
+del get_versions
 
 _PRODUCT_TO_REST_VERSION = {
     "10.0": "2.3",
@@ -46,6 +48,9 @@
     "9.1": "2.0",
     "9.0": "2.0",
 }
+minimum_supported_server_version = "2.3"
+default_server_version = "2.3"
+client_version_header = "X-TableauServerClient-Version"
 
 
 class Server(object):
@@ -62,7 +67,7 @@ def __init__(self, server_address, use_server_version=False, http_options=None):
         self._session = requests.Session()
         self._http_options = dict()
 
-        self.version = "2.3"
+        self.version = default_server_version
         self.auth = Auth(self)
         self.views = Views(self)
         self.users = Users(self)
@@ -89,8 +94,10 @@ def __init__(self, server_address, use_server_version=False, http_options=None):
         self.flow_runs = FlowRuns(self)
         self.metrics = Metrics(self)
 
+        # must set this before calling use_server_version, because that's a server call
         if http_options:
             self.add_http_options(http_options)
+            self.add_http_version_header()
 
         if use_server_version:
             self.use_server_version()
@@ -100,8 +107,13 @@ def add_http_options(self, options_dict):
         if options_dict.get("verify") == False:
             urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
 
+    def add_http_version_header(self):
+        if not self._http_options[client_version_header]:
+            self._http_options.update({client_version_header: __TSC_VERSION__})
+
     def clear_http_options(self):
         self._http_options = dict()
+        self.add_http_version_header()
 
     def _clear_auth(self):
         self._site_id = None