Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 23 additions & 0 deletions tableauserverclient/server/endpoint/views_endpoint.py
Original file line number Diff line number Diff line change
Expand Up @@ -371,6 +371,29 @@ def update(self, view_item: ViewItem) -> ViewItem:
# Returning view item to stay consistent with datasource/view update functions
return view_item

@api(version="3.27")
def delete(self, view: ViewItem | str) -> None:
"""
Deletes a view in a workbook. If you delete the only view in a workbook,
the workbook is deleted. Can be used to remove hidden views when
republishing or migrating to a different environment.

REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooks_and_views.htm#delete_view

Parameters
----------
view: ViewItem | str
The ViewItem or the luid for the view to be deleted.

Returns
-------
None
"""
id_ = getattr(view, "id", view)
self.delete_request(f"{self.baseurl}/{id_}")
logger.info(f"View({id_}) deleted.")
return None

@api(version="1.0")
def add_tags(self, item: Union[ViewItem, str], tags: Union[Iterable[str], str]) -> set[str]:
"""
Expand Down
17 changes: 17 additions & 0 deletions test/test_view.py
Original file line number Diff line number Diff line change
Expand Up @@ -520,3 +520,20 @@ def test_view_get_all_fields(server: TSC.Server) -> None:
assert isinstance(views[2].location, TSC.LocationItem)
assert views[2].location.id == "669ca36b-492e-4ccf-bca1-3614fe6a9d7a"
assert views[2].location.type == "Project"


def make_view() -> TSC.ViewItem:
view = TSC.ViewItem()
view._id = "1234"
return view


@pytest.mark.parametrize("view", [make_view, "1234"])
def test_delete_view(server: TSC.Server, view: TSC.ViewItem | str) -> None:
server.version = "3.27"
id_ = getattr(view, "id", view)
with requests_mock.mock() as m:
m.delete(f"{server.views.baseurl}/{id_}")
server.views.delete(view)
assert m.called
assert m.call_count == 1
Loading