8000 Add handling for workbooks in personal spaces which will not have pro… by bcantoni · Pull Request #875 · tableau/server-client-python · GitHub
[go: up one dir, main page]
Skip to content

Add handling for workbooks in personal spaces which will not have pro… #875

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 28, 2021
Merged

Add handling for workbooks in personal spaces which will not have pro… #875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7586ab1
Add handling for workbooks in personal spaces which will not have pro…
bcantoni Aug 23, 2021
1903d32
Improve tests to show that project_id should be set to something, but…
bcantoni Aug 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions tableauserverclient/models/workbook_item.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
from .permissions_item import PermissionsRule
from ..datetime_helpers import parse_datetime
import copy
import uuid


class WorkbookItem(object):
Expand Down Expand Up @@ -275,6 +276,10 @@ def from_response(cls, resp, ns):
data_acceleration_config,
) = cls._parse_element(workbook_xml, ns)

# workaround for Personal Space workbooks which won't have a project
if not project_id:
project_id = uuid.uuid4()

workbook_item = cls(project_id)
workbook_item._set_values(
id,
Expand Down
13 changes: 13 additions & 0 deletions test/assets/workbook_get_by_id_personal.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?xml version='1.0' encoding='UTF-8'?>
<tsResponse xmlns="http://tableau.com/api" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://tableau.com/api http://tableau.com/api/ts-api-2.3.xsd">
<workbook id="3cc6cd06-89ce-4fdc-b935-5294135d6d43" name="SafariSample" description="description for SafariSample" contentUrl="SafariSample" webpageUrl="http://tableauserver/#/workbooks/2/views" showTabs="false" size="26" createdAt="2016-07-26T20:34:56Z" updatedAt="2016-07-26T20:35:05Z">
<owner id="5de011f8-5aa9-4d5b-b991-f462c8dd6bb7" />
<tags>
<tag label="Safari" />
<tag label="Sample" />
</tags>
<views>
<view id="d79634e1-6063-4ec9-95ff-50acbf609ff5" name="ENDANGERED SAFARI" contentUrl="SafariSample/sheets/ENDANGEREDSAFARI" />
</views>
</workbook>
</tsResponse>
26 changes: 26 additions & 0 deletions test/test_workbook.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@

ADD_TAGS_XML = os.path.join(TEST_ASSET_DIR, 'workbook_add_tags.xml')
GET_BY_ID_XML = os.path.join(TEST_ASSET_DIR, 'workbook_get_by_id.xml')
GET_BY_ID_XML_PERSONAL = os.path.join(TEST_ASSET_DIR, 'workbook_get_by_id_personal.xml')
GET_EMPTY_XML = os.path.join(TEST_ASSET_DIR, 'workbook_get_empty.xml')
GET_INVALID_DATE_XML = os.path.join(TEST_ASSET_DIR, 'workbook_get_invalid_date.xml')
GET_XML = os.path.join(TEST_ASSET_DIR, 'workbook_get.xml')
Expand Down Expand Up @@ -128,6 +129,31 @@ def test_get_by_id(self):
self.assertEqual('ENDANGERED SAFARI', single_workbook.views[0].name)
self.assertEqual('SafariSample/sheets/ENDANGEREDSAFARI', single_workbook.views[0].content_url)

def test_get_by_id_personal(self):
# workbooks in personal space don't have project_id or project_name
with open(GET_BY_ID_XML_PERSONAL, 'rb') as f:
response_xml = f.read().decode('utf-8')
with requests_mock.mock() as m:
m.get(self.baseurl + '/3cc6cd06-89ce-4fdc-b935-5294135d6d43', text=response_xml)
single_workbook = self.server.workbooks.get_by_id('3cc6cd06-89ce-4fdc-b935-5294135d6d43')

self.assertEqual('3cc6cd06-89ce-4fdc-b935-5294135d6d43', single_workbook.id)
self.assertEqual('SafariSample', single_workbook.name)
self.assertEqual('SafariSample', single_workbook.content_url)
self.assertEqual('http://tableauserver/#/workbooks/2/views', single_workbook.webpage_url)
self.assertEqual(False, single_workbook.show_tabs)
self.assertEqual(26, single_workbook.size)
self.assertEqual('2016-07-26T20:34:56Z', format_datetime(single_workbook.created_at))
self.assertEqual('description for SafariSample', single_workbook.description)
self.assertEqual('2016-07-26T20:35:05Z', format_datetime(single_workbook.updated_at))
self.assertTrue(single_workbook.project_id)
self.assertIsNone(single_workbook.project_name)
self.assertEqual('5de011f8-5aa9-4d5b-b991-f462c8dd6bb7', single_workbook.owner_id)
self.assertEqual(set(['Safari', 'Sample']), single_workbook.tags)
self.assertEqual('d79634e1-6063-4ec9-95ff-50acbf609ff5', single_workbook.views[0].id)
self.assertEqual('ENDANGERED SAFARI', single_workbook.views[0].name)
self.assertEqual('SafariSample/sheets/ENDANGEREDSAFARI', single_workbook.views[0].content_url)

def test_get_by_id_missing_id(self):
self.assertRaises(ValueError, self.server.workbooks.get_by_id, '')

Expand Down
0