#DDQ2024-12 Find a View by Name

pip install tableauserverclient

Enter the name of the Tableau view to search for: Sales Dashboard

Searching for views...

Found the following view(s):

1)
- View Name: Sales Dashboard
- View ID: e8f2a1b4-1234-5678-9abc-def012345678
- Workbook Name: Annual Sales Reports
- Project Name: Corporate Reports
- View URL: https://your-tableau-server/views/AnnualSalesReports/SalesDashboard

2)
- View Name: Regional Sales Dashboard
- View ID: f9a3b2c5-2345-6789-0bcd-ef1234567890
- Workbook Name: Regional Reports
- Project Name: Sales Team
- View URL: https://your-tableau-server/views/RegionalReports/RegionalSalesDashboard

Process completed successfully.

# Antipattern 1: Only investigating the first page
import tableauserverclient as TSC

server = TSC.Server("http://localhost", True)

# Antipattern 1: Only investigating the first page
all_views, _ = server.views.get()
target_view = None
for view in all_views:
    if view.name == "Sales Overview":
        target_view = view
        break

# Antipattern 2: Overusing list()
views = list(TSC.Pager(server.views))
views = list(filter(lambda view: view.name == "Sales Overview", views))
view = views[0]

# Antipattern 3: Searching for workbooks and views separately
def find_workbook(server: TSC.Server, workbook_name: str) -> str:
    for workbook in TSC.Pager(server.workbooks):
        if workbook.name == workbook_name:
            return workbook.id

def find_view(server: TSC.Server, workbook_name: str, view_name: str) -> str:
    workbook_id = find_workbook(server, workbook_name)
    workbook = server.workbooks.get_by_id(workbook_id)
    for view in workbook.views:
        if view.name == view_name:
            return view

# /// script
# requires-python = ">=3.10"
# dependencies = [
#   "tableauserverclient>=0.34",
#   "python-dotenv",
# ]
# ///

import argparse
from collections.abc import Sequence
from dataclasses import dataclass
import os
import sys
from typing import overload

from dotenv import load_dotenv
import tableauserverclient as TSC

load_dotenv()


@dataclass
class SearchDetails:
    name: str
    server: str
    workbook_name: str | None = None
    project_name: str | None = None
    site_url: str | None = None
    auth: TSC.TableauAuth | TSC.PersonalAccessTokenAuth


@overload
def get_auth(
    username: str, password: str, token_name: None, token_secret: None, site_url: str
) -> TSC.TableauAuth: ...


@overload
def get_auth(
    username: None, password: None, token_name: str, token_secret: str, site_url: str
) -> TSC.PersonalAccessTokenAuth: ...


def get_auth(username, password, token_name, token_secret, site_url):
    """
    From the provided credentials, return the object that will be used to
    authenticate to Tableau Server or Tableau Cloud. Preference is given to
    the provided credentials, but if they are not provided, the function will
    attempt to read the credentials from the environment variables.

    Parameters
    ----------
    username: str | None
        The username to use for authentication. Required if using username and
        password authentication. Can be read from the TABLEAU_USERNAME
        environment variable.

    password: str | None
        The password to use for authentication. Required if using username and
        password authentication. Can be read from the TABLEAU_PASSWORD
        environment variable.

    token_name: str | None
        The name of the personal access token to use for authentication. Required
        if using personal access token authentication. Can be read from the
        TABLEAU_TOKEN_NAME environment variable.

    token_secret: str | None
        The secret of the personal access token to use for authentication. Required
        if using personal access token authentication. Can be read from the
        TABLEAU_TOKEN_SECRET environment variable.

    site_url: str
        The URL of the site to authenticate to. Required. Can be read from the
        TABLEAU_SITE_URL environment variable.

    Returns
    -------
    TSC.TableauAuth | TSC.PersonalAccessTokenAuth
        The object to use for authentication.
    """
    if username and password:
        return TSC.TableauAuth(username, password, site_url)
    elif token_name and token_secret:
        return TSC.PersonalAccessTokenAuth(token_name, token_secret, site_url)
    else:
        if (username := os.getenv("TABLEAU_USERNAME")) and (
            password := os.getenv("TABLEAU_PASSWORD")
        ):
            return TSC.TableauAuth(username, password, site_url)
        elif (token_name := os.getenv("TABLEAU_TOKEN_NAME")) and (
            token_secret := os.getenv("TABLEAU_TOKEN_SECRET")
        ):
            return TSC.PersonalAccessTokenAuth(token_name, token_secret, site_url)
        raise ValueError(
            "Either username and password or token name and token secret must be provided."
        )


def get_args(args: Sequence[str] | None = None) -> SearchDetails:
    """
    Parse command line arguments.
    """
    # If no arguments are provided, use sys.argv[1:] to read arguments from
    # the command line. A str is also technically a sequence, so we need to
    # check for that.
    if isinstance(args, str):
        raise ValueError("args must be a sequence of strings or None.")
    args = args or sys.argv[1:]

    # If the TABLEAU_SITE_URL environment variable is set, the site argument
    # can default to that, otherwise it should be required.
    if site_url := os.getenv("TABLEAU_SITE_URL"):
        site_kwargs = {"default": site_url}
    else:
        site_kwargs = {"required": True}

    if url := os.getenv("TABLEAU_URL"):
        url_kwargs = {"default": url}
    else:
        url_kwargs = {"required": True}

    parser = argparse.ArgumentParser(description="Locate a view by name.")
    parser.add_argument(
        "-n", "--name", required=True, help="Name of the view to locate."
    )
    parser.add_argument(
        "-u",
        "--url",
        dest="server",
        help="URL of the Tableau Server or Tableau Online instance to connect to.",
        **url_kwargs,
    )
    parser.add_argument(
        "-s", "--site", dest="site_url", help="Site ID of the site to.", **site_kwargs
    )
    parser.add_argument(
        "-w",
        "--workbook",
        dest="workbook_name",
        required=False,
        help="Name of the workbook containing the view.",
    )
    parser.add_argument(
        "--project",
        dest="project_name",
        required=False,
        help="Name of the project containing the workbook.",
    )
    parser.add_argument(
        "--username",
        required=False,
        help="Username to authenticate with. Required if using username and password authentication, or can be read from the TABLEAU_USERNAME environment variable.",
    )
    parser.add_argument(
        "--password",
        required=False,
        help="Password to authenticate with. Required if using username and password authentication, or can be read from the TABLEAU_PASSWORD environment variable.",
    )
    parser.add_argument(
        "--token-name",
        required=False,
        help="Name of the personal access token to authenticate with. Required if using personal access token authentication, or can be read from the TABLEAU_TOKEN_NAME environment variable.",
    )
    parser.add_argument(
        "--token-secret",
        required=False,
        help="Secret of the personal access token to authenticate with. Required if using personal access token authentication, or can be read from the TABLEAU_TOKEN_SECRET environment variable.",
    )

    args = parser.parse_args(args)

    auth = get_auth(
        args.username, args.password, args.token_name, args.token_secret, args.site_url
    )

    return SearchDetails(
        args.name, args.workbook_name, args.project_name, args.site_url, auth
    )


def main() -> int:
    """
    Main function for the script. Return value will be used as the exit code.
    0 is considered a successful exit, any other value is considered an error.
    """

    # Parse out command line arguments
    search_details = get_args()
    # Set "use_server_version" to True to use the server's version instead of
    # the default version. This ensures that the client doesn't complain about
    # version mismatches.
    server = TSC.Server(search_details.server, use_server_version=True)

    # From the command line arguments, construct what will be used to filter
    # the objects on the server.
    filter_options = {"name": search_details.name}
    if search_details.workbook_name:
        filter_options["workbook_name"] = search_details.workbook_name
    if search_details.project_name:
        filter_options["project_name"] = search_details.project_name

    # Sign in using a context manager to ensure that the sign out is called
    # when the block is exited.
    with server.auth.sign_in(search_details.auth):
        # Get the QuerySet of views that match the filter options.
        views = server.views.filter(**filter_options)
        # Check how many results are returned. If there are multiple views with
        # the same name, we can't uniquely identify the view. Depending on the
        # use case, this may not be an error, but exactly what you are after.
        # Raise an error in this case. Raise an error if no views are found.
        if len(views) > 1:
            raise RuntimeError(f"Multiple views found with name {search_details.name}.")
        elif len(views) == 0:
            raise RuntimeError(f"No views found with name {search_details.name}.")

        # If only one view is found, print out the name and ID of the view.
        view = views[0]
        print(f"View found: {view.name} ({view.id})")

    return 0


if __name__ == "__main__":
    sys.exit(main())