tableau · graysonarts · Nov 18, 2016 · Nov 16, 2016 · Nov 16, 2016 · Nov 17, 2016
diff --git a/.travis.yml b/.travis.yml
@@ -14,4 +14,4 @@ script:
   # Tests
   - python setup.py test
   # pep8 - disabled for now until we can scrub the files to make sure we pass before turning it on
-  - pycodestyle .
+  - pycodestyle tableauserverclient test
diff --git a/samples/initialize_server.py b/samples/initialize_server.py
@@ -10,6 +10,7 @@
 import logging
 import glob
 
+
 def main():
     parser = argparse.ArgumentParser(description='Initialize a server with content.')
     parser.add_argument('--server', '-s', required=True, help='server address')
@@ -47,12 +48,12 @@ def main():
         # Create the site if it doesn't exist
         if existing_site is None:
             print("Site not found: {0} Creating it...").format(args.site)
-            new_site = TSC.SiteItem(name=args.site, content_url=args.site.replace(" ", ""), admin_mode=TSC.SiteItem.AdminMode.ContentAndUsers)
+            new_site = TSC.SiteItem(name=args.site, content_url=args.site.replace(" ", ""),
+                                    admin_mode=TSC.SiteItem.AdminMode.ContentAndUsers)
             server.sites.create(new_site)
         else:
             print("Site {0} exists. Moving on...").format(args.site)
 
-
     ################################################################################
     # Step 3: Sign-in to our target site
     ################################################################################
@@ -82,6 +83,7 @@ def main():
         publish_datasources_to_site(server_upload, project, args.datasources_folder)
         publish_workbooks_to_site(server_upload, project, args.workbooks_folder)
 
+
 def publish_datasources_to_site(server_object, project, folder):
     path = folder + '/*.tds*'
 

diff --git a/samples/pagination_sample.py b/samples/pagination_sample.py
@@ -66,5 +66,6 @@ def main():
         # >>> request_options = TSC.RequestOptions(pagesize=1000)
         # >>> all_workbooks = list(TSC.Pager(server.workbooks, request_options))
 
+
 if __name__ == '__main__':
     main()
diff --git a/tableauserverclient/datetime_helpers.py b/tableauserverclient/datetime_helpers.py
@@ -0,0 +1,37 @@
+import datetime
+
+
+# This code below is from the python documentation for tzinfo: https://docs.python.org/2.3/lib/datetime-tzinfo.html
+ZERO = datetime.timedelta(0)
+HOUR = datetime.timedelta(hours=1)
+
+# A UTC class.
+
+
+class UTC(datetime.tzinfo):
+    """UTC"""
+
+    def utcoffset(self, dt):
+        return ZERO
+
+    def tzname(self, dt):
+        return "UTC"
+
+    def dst(self, dt):
+        return ZERO
+
+
+utc = UTC()
+
+TABLEAU_DATE_FORMAT = "%Y-%m-%dT%H:%M:%SZ"
+
+
+def parse_datetime(date):
+    if date is None:
+        return None
+
+    return datetime.datetime.strptime(date, TABLEAU_DATE_FORMAT).replace(tzinfo=utc)
+
+
+def format_datetime(date):
+    return date.astimezone(tz=utc).strftime(TABLEAU_DATE_FORMAT)
diff --git a/tableauserverclient/models/datasource_item.py b/tableauserverclient/models/datasource_item.py
@@ -3,6 +3,7 @@
 from .property_decorators import property_not_nullable
 from .tag_item import TagItem
 from .. import NAMESPACE
+from ..datetime_helpers import parse_datetime
 
 
 class DatasourceItem(object):
@@ -118,8 +119,8 @@ def _parse_element(datasource_xml):
         name = datasource_xml.get('name', None)
         datasource_type = datasource_xml.get('type', None)
         content_url = datasource_xml.get('contentUrl', None)
-        created_at = datasource_xml.get('createdAt', None)
-        updated_at = datasource_xml.get('updatedAt', None)
+        created_at = parse_datetime(datasource_xml.get('createdAt', None))
+        updated_at = parse_datetime(datasource_xml.get('updatedAt', None))
 
         tags = None
         tags_elem = datasource_xml.find('.//t:tags', namespaces=NAMESPACE)

diff --git a/tableauserverclient/models/property_decorators.py b/tableauserverclient/models/property_decorators.py
@@ -1,5 +1,12 @@
+import datetime
 import re
 from functools import wraps
+from ..datetime_helpers import parse_datetime
+try:
+    basestring
+except NameError:
+    # In case we are in python 3 the string check is different
+    basestring = str
 
 
 def property_is_enum(enum_type):
@@ -99,3 +106,25 @@ def validate_regex_decorator(self, value):
             return func(self, value)
         return validate_regex_decorator
     return wrapper
+
+
+def property_is_datetime(func):
+    """ Takes the following datetime format and turns it into a datetime object:
+
+    2016-08-18T18:25:36Z
+
+    Because we return everything with Z as the timezone, we assume everything is in UTC and create
+    a timezone aware datetime.
+    """
+
+    @wraps(func)
+    def wrapper(self, value):
+        if isinstance(value, datetime.datetime):
+            return func(self, value)
+        if not isinstance(value, basestring):
+            raise ValueError("Cannot convert {} into a datetime, cannot update {}".format(value.__class__.__name__,
+                                                                                          func.__name__))
+
+        dt = parse_datetime(value)
+        return func(self, dt)
+    return wrapper
diff --git a/tableauserverclient/models/schedule_item.py b/tableauserverclient/models/schedule_item.py
@@ -4,6 +4,7 @@
 from .interval_item import IntervalItem, HourlyInterval, DailyInterval, WeeklyInterval, MonthlyInterval
 from .property_decorators import property_is_enum, property_not_nullable, property_is_int
 from .. import NAMESPACE
+from ..datetime_helpers import parse_datetime
 
 
 class ScheduleItem(object):
@@ -208,12 +209,12 @@ def _parse_element(schedule_xml):
         id = schedule_xml.get('id', None)
         name = schedule_xml.get('name', None)
         state = schedule_xml.get('state', None)
-        created_at = schedule_xml.get('createdAt', None)
-        updated_at = schedule_xml.get('updatedAt', None)
+        created_at = parse_datetime(schedule_xml.get('createdAt', None))
+        updated_at = parse_datetime(schedule_xml.get('updatedAt', None))
         schedule_type = schedule_xml.get('type', None)
         frequency = schedule_xml.get('frequency', None)
-        next_run_at = schedule_xml.get('nextRunAt', None)
-        end_schedule_at = schedule_xml.get('endScheduleAt', None)
+        next_run_at = parse_datetime(schedule_xml.get('nextRunAt', None))
+        end_schedule_at = parse_datetime(schedule_xml.get('endScheduleAt', None))
         execution_order = schedule_xml.get('executionOrder', None)
 
         priority = schedule_xml.get('priority', None)

diff --git a/tableauserverclient/models/user_item.py b/tableauserverclient/models/user_item.py
@@ -2,6 +2,7 @@
 from .exceptions import UnpopulatedPropertyError
 from .property_decorators import property_is_enum, property_not_empty, property_not_nullable
 from .. import NAMESPACE
+from ..datetime_helpers import parse_datetime
 
 
 class UserItem(object):
@@ -135,7 +136,7 @@ def _parse_element(user_xml):
         id = user_xml.get('id', None)
         name = user_xml.get('name', None)
         site_role = user_xml.get('siteRole', None)
-        last_login = user_xml.get('lastLogin', None)
+        last_login = parse_datetime(user_xml.get('lastLogin', None))
         external_auth_user_id = user_xml.get('externalAuthUserId', None)
         fullname = user_xml.get('fullName', None)
         email = user_xml.get('email', None)

diff --git a/tableauserverclient/models/workbook_item.py b/tableauserverclient/models/workbook_item.py
@@ -4,6 +4,7 @@
 from .tag_item import TagItem
 from .view_item import ViewItem
 from .. import NAMESPACE
+from ..datetime_helpers import parse_datetime
 import copy
 
 
@@ -163,8 +164,8 @@ def _parse_element(workbook_xml):
         id = workbook_xml.get('id', None)
         name = workbook_xml.get('name', None)
         content_url = workbook_xml.get('contentUrl', None)
-        created_at = workbook_xml.get('createdAt', None)
-        updated_at = workbook_xml.get('updatedAt', None)
+        created_at = parse_datetime(workbook_xml.get('createdAt', None))
+        updated_at = parse_datetime(workbook_xml.get('updatedAt', None))
 
         size = workbook_xml.get('size', None)
         if size:

diff --git a/tableauserverclient/server/request_factory.py b/tableauserverclient/server/request_factory.py
@@ -1,3 +1,4 @@
+from ..datetime_helpers import format_datetime
 import xml.etree.ElementTree as ET
 
 from requests.packages.urllib3.fields import RequestField

diff --git a/test/test_datasource.py b/test/test_datasource.py
@@ -2,6 +2,7 @@
 import os
 import requests_mock
 import tableauserverclient as TSC
+from tableauserverclient.datetime_helpers import format_datetime
 
 TEST_ASSET_DIR = os.path.join(os.path.dirname(__file__), 'assets')
 
@@ -33,8 +34,8 @@ def test_get(self):
         self.assertEqual('e76a1461-3b1d-4588-bf1b-17551a879ad9', all_datasources[0].id)
         self.assertEqual('dataengine', all_datasources[0].datasource_type)
         self.assertEqual('SampleDS', all_datasources[0].content_url)
-        self.assertEqual('2016-08-11T21:22:40Z', all_datasources[0].created_at)
-        self.assertEqual('2016-08-11T21:34:17Z', all_datasources[0].updated_at)
+        self.assertEqual('2016-08-11T21:22:40Z', format_datetime(all_datasources[0].created_at))
+        self.assertEqual('2016-08-11T21:34:17Z', format_datetime(all_datasources[0].updated_at))
         self.assertEqual('default', all_datasources[0].project_name)
         self.assertEqual('SampleDS', all_datasources[0].name)
         self.assertEqual('ee8c6e70-43b6-11e6-af4f-f7b0d8e20760', all_datasources[0].project_id)
@@ -43,8 +44,8 @@ def test_get(self):
         self.assertEqual('9dbd2263-16b5-46e1-9c43-a76bb8ab65fb', all_datasources[1].id)
         self.assertEqual('dataengine', all_datasources[1].datasource_type)
         self.assertEqual('Sampledatasource', all_datasources[1].content_url)
-        self.assertEqual('2016-08-04T21:31:55Z', all_datasources[1].created_at)
-        self.assertEqual('2016-08-04T21:31:55Z', all_datasources[1].updated_at)
+        self.assertEqual('2016-08-04T21:31:55Z', format_datetime(all_datasources[1].created_at))
+        self.assertEqual('2016-08-04T21:31:55Z', format_datetime(all_datasources[1].updated_at))
         self.assertEqual('default', all_datasources[1].project_name)
         self.assertEqual('Sample datasource', all_datasources[1].name)
         self.assertEqual('ee8c6e70-43b6-11e6-af4f-f7b0d8e20760', all_datasources[1].project_id)
@@ -75,8 +76,8 @@ def test_get_by_id(self):
         self.assertEqual('9dbd2263-16b5-46e1-9c43-a76bb8ab65fb', single_datasource.id)
         self.assertEqual('dataengine', single_datasource.datasource_type)
         self.assertEqual('Sampledatasource', single_datasource.content_url)
-        self.assertEqual('2016-08-04T21:31:55Z', single_datasource.created_at)
-        self.assertEqual('2016-08-04T21:31:55Z', single_datasource.updated_at)
+        self.assertEqual('2016-08-04T21:31:55Z', format_datetime(single_datasource.created_at))
+        self.assertEqual('2016-08-04T21:31:55Z', format_datetime(single_datasource.updated_at))
         self.assertEqual('default', single_datasource.project_name)
         self.assertEqual('Sample datasource', single_datasource.name)
         self.assertEqual('ee8c6e70-43b6-11e6-af4f-f7b0d8e20760', single_datasource.project_id)
@@ -125,8 +126,8 @@ def test_publish(self):
         self.assertEqual('SampleDS', new_datasource.name)
         self.assertEqual('SampleDS', new_datasource.content_url)
         self.assertEqual('dataengine', new_datasource.datasource_type)
-        self.assertEqual('2016-08-11T21:22:40Z', new_datasource.created_at)
-        self.assertEqual('2016-08-17T23:37:08Z', new_datasource.updated_at)
+        self.assertEqual('2016-08-11T21:22:40Z', format_datetime(new_datasource.created_at))
+        self.assertEqual('2016-08-17T23:37:08Z', format_datetime(new_datasource.updated_at))
         self.assertEqual('ee8c6e70-43b6-11e6-af4f-f7b0d8e20760', new_datasource.project_id)
         self.assertEqual('default', new_datasource.project_name)
         self.assertEqual('5de011f8-5aa9-4d5b-b991-f462c8dd6bb7', new_datasource.owner_id)

diff --git a/test/test_datasource_model.py b/test/test_datasource_model.py
@@ -1,3 +1,4 @@
+import datetime
 import unittest
 import tableauserverclient as TSC
 

diff --git a/test/test_group.py b/test/test_group.py
@@ -3,6 +3,7 @@
 import os
 import requests_mock
 import tableauserverclient as TSC
+from tableauserverclient.datetime_helpers import format_datetime
 
 TEST_ASSET_DIR = os.path.join(os.path.dirname(__file__), 'assets')
 
@@ -61,7 +62,7 @@ def test_populate_users(self):
         self.assertEqual('dd2239f6-ddf1-4107-981a-4cf94e415794', user.id)
         self.assertEqual('alice', user.name)
         self.assertEqual('Publisher', user.site_role)
-        self.assertEqual('2016-08-16T23:17:06Z', user.last_login)
+        self.assertEqual('2016-08-16T23:17:06Z', format_datetime(user.last_login))
 
     def test_delete(self):
         with requests_mock.mock() as m:

diff --git a/test/test_requests.py b/test/test_requests.py
@@ -28,9 +28,9 @@ def test_make_get_request(self):
                                                        auth_token='j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM',
                                                        content_type='text/xml')
 
-            self.assertEquals(resp.request.query, 'pagenumber=13&pagesize=13')
-            self.assertEquals(resp.request.headers['x-tableau-auth'], 'j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM')
-            self.assertEquals(resp.request.headers['content-type'], 'text/xml')
+            self.assertEqual(resp.request.query, 'pagenumber=13&pagesize=13')
+            self.assertEqual(resp.request.headers['x-tableau-auth'], 'j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM')
+            self.assertEqual(resp.request.headers['content-type'], 'text/xml')
 
     def test_make_post_request(self):
         with requests_mock.mock() as m:
@@ -42,6 +42,6 @@ def test_make_post_request(self):
                                                        request_object=None,
                                                        auth_token='j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM',
                                                        content_type='multipart/mixed')
-            self.assertEquals(resp.request.headers['x-tableau-auth'], 'j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM')
-            self.assertEquals(resp.request.headers['content-type'], 'multipart/mixed')
-            self.assertEquals(resp.request.body, b'1337')
+            self.assertEqual(resp.request.headers['x-tableau-auth'], 'j80k54ll2lfMZ0tv97mlPvvSCRyD0DOM')
+            self.assertEqual(resp.request.headers['content-type'], 'multipart/mixed')
+            self.assertEqual(resp.request.body, b'1337')