#72 Add description to the field object (#73) · esbenbm/document-api-python@202acea · GitHub

esbenbm / document-api-python Public

forked from tableau/document-api-python

• Notifications You must be signed in to change notification settings
• Fork 0
• Star 0

• Code
• Pull requests
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit 202acea

Browse filesBrowse the repository at this point in the historyBrowse files

Russell Hay

authored

tableau#72 Add description to the field object (tableau#73)

* Add description to the field object Pull in the description if it exists on a `<column>` tag. This change returns the entire `<desc>` tag including all subtags. e.g.: ``` <desc> <formatted-text> <run>Total number of people in a country</run> </formatted-text> </desc> ``` * improving the test code to use 'in'

1 parent 8b8f351 commit 202acea
Copy full SHA for 202acea

4 files changed

+31-1Lines changed: 31 additions & 1 deletion

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• Examples/GetFields
  • show_fields.py
• tableaudocumentapi
  • field.py
• test
  • assets
    • datasource_test.tds
  • test_datasource.py

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎Examples/GetFields/show_fields.py‎

Copy file name to clipboardExpand all lines: Examples/GetFields/show_fields.py

+2Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -23,6 +23,8 @@
23	23	if field.default_aggregation:
24	24	print(' the default aggregation is {}'.format(field.default_aggregation))
25	25	blank_line = True
	26	+ if field.description:
	27	+ print(' the description is {}'.format(field.description))
26	28
27	29	if blank_line:
28	30	print('')

Collapse file

‎tableaudocumentapi/field.py‎

Copy file name to clipboardExpand all lines: tableaudocumentapi/field.py

+16Lines changed: 16 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -1,4 +1,6 @@
1	1	import functools
	2	+ import xml.etree.ElementTree as ET
	3	+
2	4
3	5	_ATTRIBUTES = [
4	6	'id', # Name of the field as specified in the file, usually surrounded by [ ]
@@ -8,6 +10,7 @@
8	10	'type', # three possible values: quantitative, ordinal, or nominal
9	11	'alias', # Name of the field as displayed in Tableau if the default name isn't wanted
10	12	'calculation', # If this field is a calculated field, this will be the formula
	13	+ 'description', # If this field has a description, this will be the description (including formatting tags)
11	14	]
12	15
13	16	_METADATA_ATTRIBUTES = [
@@ -164,6 +167,11 @@ def default_aggregation(self):
164	167	""" The default type of aggregation on the field (e.g Sum, Avg)"""
165	168	return self._aggregation
166	169
	170	+ @property
	171	+ def description(self):
	172	+ """ The contents of the <desc> tag on a field """
	173	+ return self._description
	174	+
167	175	@property
168	176	def worksheets(self):
169	177	return list(self._worksheets)
@@ -184,3 +192,11 @@ def _read_calculation(xmldata):
184	192	return None
185	193
186	194	return calc.attrib.get('formula', None)
	195	+
	196	+ @staticmethod
	197	+ def _read_description(xmldata):
	198	+ description = xmldata.find('.//desc')
	199	+ if description is None:
	200	+ return None
	201	+
	202	+ return u'{}'.format(ET.tostring(description, encoding='utf-8')) # This is necessary for py3 support

Collapse file

‎test/assets/datasource_test.tds‎

Copy file name to clipboardExpand all lines: test/assets/datasource_test.tds

+8-1Lines changed: 8 additions & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -75,7 +75,14 @@
75	75	<column datatype='integer' name='[Number of Records]' role='measure' type='quantitative' user:auto-column='numrec'>
76	76	<calculation class='tableau' formula='1' />
77	77	</column>
78		- <column caption='A' datatype='string' name='[a]' role='dimension' type='nominal' />
	78	+ <column caption='A' datatype='string' name='[a]' role='dimension' type='nominal'>
	79	+ <desc>
	80	+ <formatted-text>
	81	+ <run bold='true' fontsize='96'>A thing</run>
	82	+ <run fontcolor='#686868'>&#10;Something will go here too, in a muted gray</run>
	83	+ </formatted-text>
	84	+ </desc>
	85	+ </column>
79	86	<column caption='Today&apos;s Date' datatype='string' name='[Today&apos;s Date]' role='dimension' type='nominal' />
80	87	<column caption='X' datatype='integer' name='[x]' role='measure' type='ordinal' />
81	88	<column caption='Y' datatype='integer' name='[y]' role='measure' type='quantitative' />

Collapse file

‎test/test_datasource.py‎

Copy file name to clipboardExpand all lines: test/test_datasource.py

+5Lines changed: 5 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -58,6 +58,11 @@ def test_datasource_field_datatype(self):
58	58	def test_datasource_field_role(self):
59	59	self.assertEqual(self.ds.fields['[x]'].role, 'measure')
60	60
	61	+ def test_datasource_field_description(self):
	62	+ actual = self.ds.fields['[a]'].description
	63	+ self.assertIsNotNone(actual)
	64	+ self.assertTrue(u'muted gray' in actual)
	65	+
61	66
62	67	class DataSourceFieldsTWB(unittest.TestCase):
63	68

0 commit comments

Comments

0 (0)