PEP8-ify some files so future editors will be happy. Also add a test file and add some test cases for a help method I plan to update in the next commit. I made _is_valid_file a static method since it's just a helper and it makes it easier to test

Author: t8y8

Document API/tableaudocumentapi/connection.py

@@ -3,6 +3,8 @@
 # Connection - A class for writing connections to Tableau files
 #
 ###############################################################################
+
+
 class Connection(object):
     """
     A class for writing connections to Tableau files.
@@ -36,13 +38,13 @@ def dbname(self):
     def dbname(self, value):
         """
         Set the connection's database name property.
-        
+
         Args:
             value:  New name of the database. String.
-            
+
         Returns:
             Nothing.
-            
+
         """
         self._dbname = value
         self._connectionXML.set('dbname', value)
@@ -58,17 +60,17 @@ def server(self):
     def server(self, value):
         """
         Set the connection's server property.
-        
+
         Args:
             value:  New server. String.
-            
+
         Returns:
             Nothing.
-            
+
         """
         self._server = value
         self._connectionXML.set('server', value)
-        
+
     ###########
     # username
     ###########
@@ -80,13 +82,13 @@ def username(self):
     def username(self, value):
         """
         Set the connection's username property.
-        
+
         Args:
             value:  New username value. String.
-            
+
         Returns:
             Nothing.
-            
+
         """
         self._username = value
         self._connectionXML.set('username', value)

Document API/tableaudocumentapi/datasource.py

@@ -6,6 +6,7 @@
 import xml.etree.ElementTree as ET
 from tableaudocumentapi import Connection
 
+
 class Datasource(object):
     """
     A class for writing datasources to Tableau files.
@@ -26,20 +27,20 @@ def __init__(self, dsxml):
         self._name = self._datasourceXML.get('name')
         self._version = self._datasourceXML.get('version')
         self._connection = Connection(self._datasourceXML.find('connection'))
-    
+
     @classmethod
     def from_file(cls, filename):
         "Initialize datasource from file (.tds)"
         dsxml = ET.parse(filename).getroot()
         return cls(dsxml)
-        
+
     ###########
     # name
     ###########
     @property
     def name(self):
         return self._name
-        
+
     ###########
     # version
     ###########

Document API/tableaudocumentapi/workbook.py

@@ -7,6 +7,7 @@
 import xml.etree.ElementTree as ET
 from tableaudocumentapi import Datasource
 
+
 class Workbook(object):
     """
     A class for writing Tableau workbook files.
@@ -29,13 +30,14 @@ def __init__(self, filename):
             self._filename = filename
             self._workbookTree = ET.parse(filename)
             self._workbookRoot = self._workbookTree.getroot()
-            
+
             # prepare our datasource objects
-            self._datasources = self._prepare_datasources(self._workbookRoot)  #self.workbookRoot.find('datasources')
+            self._datasources = self._prepare_datasources(
+                self._workbookRoot)  # self.workbookRoot.find('datasources')
         else:
             print('Invalid file type. Must be .twb or .tds.')
             raise Exception()
-            
+
     @classmethod
     def from_file(cls, filename):
         "Initialize datasource from file (.tds)"
@@ -46,14 +48,14 @@ def from_file(cls, filename):
         else:
             print('Invalid file type. Must be .twb or .tds.')
             raise Exception()
-            
+
     ###########
     # datasources
     ###########
     @property
     def datasources(self):
         return self._datasources
-    
+
     ###########
     # filename
     ###########
@@ -72,10 +74,10 @@ def save(self):
             Nothing.
 
         """
-        
+
         # save the file
         self._workbookTree.write(self._filename)
-        
+
     def save_as(self, value):
         """
         Save our file with the name provided.
@@ -87,7 +89,7 @@ def save_as(self, value):
             Nothing.
 
         """
-        
+
         # We have a valid type of input file
         if self._is_valid_file(value):
             # save the file
@@ -103,21 +105,20 @@ def save_as(self, value):
     ###########################################################################
     def _prepare_datasources(self, xmlRoot):
         datasources = []
-        
+
         # loop through our datasources and append
         for datasource in xmlRoot.find('datasources'):
             ds = Datasource(datasource)
             datasources.append(ds)
-        
+
         return datasources
-        
-    def _is_valid_file(self, filename):
+
+    @staticmethod
+    def _is_valid_file(filename):
         valid = 0
         fileExtension = os.path.splitext(filename)[-1].lower()
-        
         if fileExtension == ".twb":
             valid = 1
         elif fileExtension == ".tds":
             valid = 1
-            
         return valid

Document API/test.py

@@ -0,0 +1,16 @@
+import unittest
+
+from tableaudocumentapi import Workbook
+
+class HelperMethodTests(unittest.TestCase):
+
+    def test_valid_file_with_valid_inputs(self):
+        self.assertTrue(Workbook._is_valid_file('file1.tds'))
+        self.assertTrue(Workbook._is_valid_file('file2.twb'))
+
+    def test_valid_file_with_invalid_inputs(self):
+        self.assertFalse(Workbook._is_valid_file('file1.tds2'))
+        self.assertFalse(Workbook._is_valid_file('file2.twb3'))
+
+if __name__ == '__main__':
+    unittest.main()