Update Replicate Workbook example to using DictReader which makes the code more readable. Also remove the unnecessary copy.copy call and import. Small refactor of parameter name for Workbook.save_as method to be more descriptive than 'value'. Manual testing on python2 and pyhon3 for example. Verified still works

t8y8 · t8y8 · commit a36337fca1a2 · 2016-05-10T18:45:03.000-07:00
diff --git a/Document API/Examples/Replicate Workbook/replicateWorkbook.py b/Document API/Examples/Replicate Workbook/replicateWorkbook.py
@@ -1,5 +1,4 @@
 import csv              # so we can work with our database list (in a CSV file)
-import copy             # to make copies
 
 ############################################################
 # Step 1)  Use Workbook object from the Document API
@@ -16,13 +15,11 @@
 #          create new .twb's with their settings
 ############################################################
 with open('databases.csv') as csvfile:
-    next(csvfile)               # Skip the first line which is our CSV header row
-    databases = csv.reader(csvfile, delimiter=',', quotechar='"')
+    databases = csv.DictReader(csvfile, delimiter=',', quotechar='"')
     for row in databases:
-        newWB = copy.copy(sourceWB)
-        
         # Set our unique values for this database
-        newWB.datasources[0].connection.server = row[1]         # Server
-        newWB.datasources[0].connection.dbname = row[2]         # Database
-        newWB.datasources[0].connection.username = row[3]       # User
-        newWB.save_as(row[0] + ' - Superstore' + '.twb')        # Save our newly created .twb with the new file name
+        sourceWB.datasources[0].connection.server = row['Server']
+        sourceWB.datasources[0].connection.dbname = row['Database']
+        sourceWB.datasources[0].connection.username = row['User']
+        # Save our newly created .twb with the new file name
+        sourceWB.save_as(row['DBFriendlyName'] + ' - Superstore' + '.twb')
diff --git a/Document API/tableaudocumentapi/workbook.py b/Document API/tableaudocumentapi/workbook.py
@@ -78,22 +78,22 @@ def save(self):
         # save the file
         self._workbookTree.write(self._filename)
 
-    def save_as(self, value):
+    def save_as(self, new_filename):
         """
         Save our file with the name provided.
 
         Args:
-            value:  New name for the workbook file. String.
+            new_filename:  New name for the workbook file. String.
 
         Returns:
             Nothing.
 
         """
 
         # We have a valid type of input file
-        if self._is_valid_file(value):
+        if self._is_valid_file(new_filename):
             # save the file
-            self._workbookTree.write(value)
+            self._workbookTree.write(new_filename)
         else:
             print('Invalid file type. Must be .twb or .tds.')
             raise Exception()
