Module `textual.layouts.factory`

Expand source code

from __future__ import annotations

from .._layout import Layout
from .horizontal import HorizontalLayout
from .grid import GridLayout
from .vertical import VerticalLayout

LAYOUT_MAP: dict[str, type[Layout]] = {
    "horizontal": HorizontalLayout,
    "grid": GridLayout,
    "vertical": VerticalLayout,
}


class MissingLayout(Exception):
    pass


def get_layout(name: str) -> Layout:
    """Get a named layout object.

    Args:
        name (str): Name of the layout.

    Raises:
        MissingLayout: If the named layout doesn't exist.

    Returns:
        Layout: A layout object.
    """

    layout_class = LAYOUT_MAP.get(name)
    if layout_class is None:
        raise MissingLayout(f"no layout called {name!r}, valid layouts")
    return layout_class()

Functions

def get_layout(name: str) ‑> textual._layout.Layout

Get a named layout object.

Args

name : str: Name of the layout.

Raises

MissingLayout: If the named layout doesn't exist.

Returns

Layout: A layout object.

Expand source code

def get_layout(name: str) -> Layout:
    """Get a named layout object.

    Args:
        name (str): Name of the layout.

    Raises:
        MissingLayout: If the named layout doesn't exist.

    Returns:
        Layout: A layout object.
    """

    layout_class = LAYOUT_MAP.get(name)
    if layout_class is None:
        raise MissingLayout(f"no layout called {name!r}, valid layouts")
    return layout_class()

Classes

class MissingLayout (*args, **kwargs)

Common base class for all non-exit exceptions.

Expand source code

class MissingLayout(Exception):
    pass

Ancestors

builtins.Exception
builtins.BaseException