Function build_report

python-client/src/datapane/processors/api.py:33–74

Build an (static) app with a directory structure, which can be served by a local http server !!! note This outputs compressed assets into the dir as well, may be an issue if self-hosting Args: blocks: The `Blocks` object or a list of Blocks name: The name of the app

(
    blocks: BlocksT,
    name: str = "Report",
    dest: t.Optional[NPath] = None,
    formatting: t.Optional[Formatting] = None,
    overwrite: bool = False,
)

################################################################################
# exported public API
def build_report(
    blocks: BlocksT,
    name: str = "Report",
    dest: t.Optional[NPath] = None,
    formatting: t.Optional[Formatting] = None,
    overwrite: bool = False,
) -> None:
    """Build an (static) app with a directory structure, which can be served by a local http server

    !!! note
        This outputs compressed assets into the dir as well, may be an issue if self-hosting

    Args:
        blocks: The `Blocks` object or a list of Blocks
        name: The name of the app directory to be created
        dest: File path to store the app directory
        formatting: Sets the basic app styling
        overwrite: Replace existing app with the same name and destination if already exists (default: False)
    """
    # TODO(product) - unknown if we should keep this...

    # build the dest dir
    app_dir: Path = Path(dest or os.getcwd()) / name
    app_exists = app_dir.is_dir()

    if app_exists and overwrite:
        rmtree(app_dir)
    elif app_exists and not overwrite:
        raise DPClientError(f"Report exists at given path {str(app_dir)} -- set `overwrite=True` to allow overwrite")

    assets_dir = app_dir / "assets"
    assets_dir.mkdir(parents=True)

    # write the app html and assets
    s = ViewState(blocks=Blocks.wrap_blocks(blocks), file_entry_klass=GzipTmpFileEntry, dir_path=assets_dir)
    _: str = (
        Pipeline(s)
        .pipe(PreProcessView(is_finalised=True))
        .pipe(ConvertXML())
        .pipe(ExportHTMLFileAssets(app_dir=app_dir, name=name, formatting=formatting))
        .result
    )


def save_report(