Function get_app

dash/_get_app.py:44–71

Return the current Dash app instance. Useful in multi-page apps when Python files within the `pages/` folder need to reference the `app` object but importing it directly would cause a circular import error.

()

def get_app():
    """
    Return the current Dash app instance.

    Useful in multi-page apps when Python files within the `pages/` folder
    need to reference the `app` object but importing it directly would cause
    a circular import error.
    """
    try:
        ctx_app = app_context.get()
        if ctx_app is not None:
            return ctx_app
    except LookupError:
        pass

    if APP is None:
        raise AppNotFoundError(
            dedent(
                """
                App object is not yet defined.  `app = dash.Dash()` needs to be run
                before `dash.get_app()`.

                `dash.get_app()` is used to get around circular import issues when Python files
                within the pages/` folder need to reference the `app` object.
                """
            )
        )
    return APP