Class Dash

dash/dash.py:228–2696

Dash is a framework for building analytical web applications. No JavaScript required. If a parameter can be set by an environment variable, that is listed as: env: ``DASH_****`` Values provided here take precedence over environment variables. :param name: The name Flask sho

# pylint: disable=too-many-instance-attributes
# pylint: disable=too-many-arguments, too-many-locals
class Dash(ObsoleteChecker):
    """Dash is a framework for building analytical web applications.
    No JavaScript required.

    If a parameter can be set by an environment variable, that is listed as:
        env: ``DASH_****``
    Values provided here take precedence over environment variables.

    :param name: The name Flask should use for your app. Even if you provide
        your own ``server``, ``name`` will be used to help find assets.
        Typically ``__name__`` (the magic global var, not a string) is the
        best value to use. Default ``'__main__'``, env: ``DASH_APP_NAME``
    :type name: string

    :param server: Sets the server for your app. There are three options:
        ``True`` (default): Dash will create a new server using the specified backend
        ``False``: The server will be added later via ``app.init_app(server)``
        A server instance: Use a pre-existing server (Flask, Quart, or FastAPI)
    :type server: boolean or server instance

    :param backend: The backend to use for the Dash app. Can be a string
        (name of the backend) or a backend class. Default is None, which
        selects the Flask backend. Currently, "flask", "fastapi", and "quart" backends
        are supported.
    :type backend: string or type

    :param assets_folder: a path, relative to the current working directory,
        for extra files to be used in the browser. Default ``'assets'``.
        All .js and .css files will be loaded immediately unless excluded by
        ``assets_ignore``, and other files such as images will be served if
        requested.
    :type assets_folder: string

    :param pages_folder: a relative or absolute path for pages of a multi-page app.
        Default ``'pages'``.
    :type pages_folder: string or pathlib.Path

    :param use_pages: When True, the ``pages`` feature for multi-page apps is
        enabled. If you set a non-default ``pages_folder`` this will be inferred
        to be True. Default `None`.
    :type use_pages: boolean

    :param include_pages_meta: Include the page meta tags for twitter cards.
    :type include_pages_meta: bool

    :param assets_url_path: The local urls for assets will be:
        ``requests_pathname_prefix + assets_url_path + '/' + asset_path``
        where ``asset_path`` is the path to a file inside ``assets_folder``.
        Default ``'assets'``.
    :type asset_url_path: string

    :param assets_ignore: A regex, as a string to pass to ``re.compile``, for
        assets to omit from immediate loading. Ignored files will still be
        served if specifically requested. You cannot use this to prevent access
        to sensitive files.
    :type assets_ignore: string

    :param assets_path_ignore: A list of regex, each regex as a string to pass to ``re.compile``, for