Skip to content

htmy.utils

as_component_sequence(comp)

Returns the given component as a component sequence.

Source code in htmy/utils.py 
52
53
54
55
def as_component_sequence(comp: Component) -> ComponentSequence:
    """Returns the given component as a component sequence."""
    # mypy doesn't understand the `is_component_sequence` type guard.
    return comp if is_component_sequence(comp) else (comp,)  # type: ignore[return-value]

as_component_type(comp)

Returns the given component as a ComponentType (not sequence).

Source code in htmy/utils.py 
58
59
60
61
62
63
def as_component_type(comp: Component) -> ComponentType:
    """Returns the given component as a `ComponentType` (not sequence)."""
    from .core import Fragment

    # mypy doesn't understand the `is_component_sequence` type guard.
    return comp if not is_component_sequence(comp) else Fragment(*comp)  # type: ignore[return-value]

is_component_sequence(comp)

Returns whether the given component is a component sequence.

Source code in htmy/utils.py 
47
48
49
def is_component_sequence(comp: Component) -> TypeGuard[ComponentSequence]:
    """Returns whether the given component is a component sequence."""
    return isinstance(comp, (list, tuple))

join(*items, separator=' ')

Joins the given strings with the given separator, skipping None values.

Source code in htmy/utils.py 
40
41
42
43
44
def join(*items: str | None, separator: str = " ") -> str:
    """
    Joins the given strings with the given separator, skipping `None` values.
    """
    return separator.join(i for i in items if i)

join_components(components, separator, pad=False)

Joins the given components using the given separator.

Parameters:

Name Type Description Default
components ComponentSequence

The components to join.

 required
separator ComponentType

The separator to use.

 required
pad bool

Whether to add a separator before the first and after the last components.

 False
Source code in htmy/utils.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
def join_components(
    components: ComponentSequence,
    separator: ComponentType,
    pad: bool = False,
) -> Generator[ComponentType, None, None]:
    """
    Joins the given components using the given separator.

    Arguments:
        components: The components to join.
        separator: The separator to use.
        pad: Whether to add a separator before the first and after the last components.
    """
    if len(components) == 0:
        return

    if pad:
        yield separator

    components_iterator = iter(components)
    yield next(components_iterator)

    for component in components_iterator:
        yield separator
        yield component

    if pad:
        yield separator