document-api-python/tableaudocumentapi/workbook.py at master · liamkelly1/document-api-python · GitHub

History

142 lines (100 loc) · 3.89 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

import weakref

from tableaudocumentapi import Datasource, xfile

from tableaudocumentapi.xfile import xml_open

class Workbook(object):

"""A class for writing Tableau workbook files."""

def __init__(self, filename):

"""Open the workbook at `filename`. This will handle packaged and unpacked

workbook files automatically. This will also parse Data Sources, Worksheets and Dashboards

for access.

"""

self._filename = filename

self._workbookTree = xml_open(self._filename, 'workbook')

self._workbookRoot = self._workbookTree.getroot()

# prepare our datasource objects

self._datasources = self._prepare_datasources(

self._workbookRoot) # self.workbookRoot.find('datasources')

self._datasource_index = self._prepare_datasource_index(self._datasources)

self._worksheets = self._prepare_worksheets(

self._workbookRoot, self._datasource_index

)

self._dashboards = self._prepare_dashboards(

self._workbookRoot

)

@property

def datasources(self):

return self._datasources

@property

def worksheets(self):

return self._worksheets

@property

def filename(self):

return self._filename

@property

def dashboards(self):

return self._dashboards

def save(self):

"""

Call finalization code and save file.

Args:

None.

Returns:

Nothing.

"""

# save the file

xfile._save_file(self._filename, self._workbookTree)

def save_as(self, new_filename):

"""

Save our file with the name provided.

Args:

new_filename: New name for the workbook file. String.

Returns:

Nothing.

"""

xfile._save_file(

self._filename, self._workbookTree, new_filename)

@staticmethod

def _prepare_datasource_index(datasources):

retval = weakref.WeakValueDictionary()

for datasource in datasources:

retval[datasource.name] = datasource

return retval

@staticmethod

def _prepare_datasources(xml_root):

datasources = []

# loop through our datasources and append

datasource_elements = xml_root.find('datasources')

if datasource_elements is None:

return []

for datasource in datasource_elements:

ds = Datasource(datasource)

datasources.append(ds)

return datasources

@staticmethod

def _prepare_worksheets(xml_root, ds_index):

worksheets = []

worksheets_element = xml_root.find('.//worksheets')

if worksheets_element is None:

return worksheets

for worksheet_element in worksheets_element:

worksheet_name = worksheet_element.attrib['name']

worksheets.append(worksheet_name) # TODO: A real worksheet object, for now, only name

dependencies = worksheet_element.findall('.//datasource-dependencies')

for dependency in dependencies:

datasource_name = dependency.attrib['datasource']

datasource = ds_index[datasource_name]

for column in dependency.findall('.//column'):

column_name = column.attrib['name']

if column_name in datasource.fields:

datasource.fields[column_name].add_used_in(worksheet_name)

return worksheets

@staticmethod

def _prepare_dashboards(xml_root):

dashboards = []

dashboard_elements = xml_root.findall('.//dashboards/dashboard')

if dashboard_elements is None:

return dashboards

for dashboard_element in dashboard_elements:

dashboard_name = dashboard_element.attrib['name']

dashboards.append(dashboard_name)

return dashboards

document-api-python/tableaudocumentapi/workbook.py at master · liamkelly1/document-api-python · GitHub

Expand file tree

Breadcrumbs

workbook.py

Latest commit

History

Breadcrumbs

workbook.py

File metadata and controls