builtin (4)

cycler

cycler(*items: Any) -> None

Cycle through values by yield them one at a time, then restarting

Example

Jinja call:

{% set row_class = cycler("odd", "even") %}
{{ row_class.next() }}
{{ row_class.next() }}
{{ row_class.next() }}
{{ row_class.current }}

Result: odd even odd even

DocStrings

Source code in .venv/lib/python3.12/site-packages/jinja2/utils.py

class Cycler:
    """Cycle through values by yield them one at a time, then restarting
    once the end is reached. Available as ``cycler`` in templates.

    Similar to ``loop.cycle``, but can be used outside loops or across
    multiple loops. For example, render a list of folders and files in a
    list, alternating giving them "odd" and "even" classes.

    .. code-block:: html+jinja

        {% set row_class = cycler("odd", "even") %}
        <ul class="browser">
        {% for folder in folders %}
          <li class="folder {{ row_class.next() }}">{{ folder }}
        {% endfor %}
        {% for file in files %}
          <li class="file {{ row_class.next() }}">{{ file }}
        {% endfor %}
        </ul>

    :param items: Each positional argument will be yielded in the order
        given for each cycle.

    .. versionadded:: 2.1
    """

    def __init__(self, *items: t.Any) -> None:
        if not items:
            raise RuntimeError("at least one item has to be provided")
        self.items = items
        self.pos = 0

    def reset(self) -> None:
        """Resets the current item to the first item."""
        self.pos = 0

    @property
    def current(self) -> t.Any:
        """Return the current item. Equivalent to the item that will be
        returned next time :meth:`next` is called.
        """
        return self.items[self.pos]

    def next(self) -> t.Any:
        """Return the current item, then advance :attr:`current` to the
        next item.
        """
        rv = self.current
        self.pos = (self.pos + 1) % len(self.items)
        return rv

    __next__ = next

current property

current: Any

next

next() -> Any

Source code in .venv/lib/python3.12/site-packages/jinja2/utils.py

def next(self) -> t.Any:
    """Return the current item, then advance :attr:`current` to the
    next item.
    """
    rv = self.current
    self.pos = (self.pos + 1) % len(self.items)
    return rv

reset

reset() -> None

Source code in .venv/lib/python3.12/site-packages/jinja2/utils.py

def reset(self) -> None:
    """Resets the current item to the first item."""
    self.pos = 0

joiner

joiner(sep: str = ', ') -> None

A joining helper for templates.

Example

Jinja call:

{% set pipe = joiner("|") %}
"AB"
{{ pipe() }}
"AB"
{{ pipe() }}
"AB"
{{ pipe() }}

Result: `"AB"

"AB" | "AB" |`

DocStrings

Source code in .venv/lib/python3.12/site-packages/jinja2/utils.py

class Joiner:
    """A joining helper for templates."""

    def __init__(self, sep: str = ", ") -> None:
        self.sep = sep
        self.used = False

    def __call__(self) -> str:
        if not self.used:
            self.used = True
            return ""
        return self.sep

lipsum

lipsum(n: int = 5, html: bool = True, min: int = 20, max: int = 100) -> str

Generate some lorem ipsum for the template.

Example

Jinja call:

{{ lipsum() }}

Result: <p>Cursus per diam elit ad egestas, volutpat mauris conubia nulla sapien amet urna, ultrices dapibus vivamus. Sollicitudin scelerisque justo hymenaeos tempor diam vulputate, vel morbi ipsum feugiat scelerisque neque, tellus integer dictum felis nulla. Fringilla etiam venenatis lorem, hendrerit primis enim.</p> <p>Commodo dis venenatis in massa dapibus lobortis leo, etiam sodales dignissim ad, hymenaeos pede id rutrum torquent. Semper purus potenti penatibus maecenas, elit habitasse posuere netus vitae.</p> <p>Bibendum convallis dui volutpat cubilia nulla habitasse, integer duis quis arcu senectus pretium dis fusce, ligula. Vulputate nisl cum risus, leo porttitor in vel hendrerit.</p> <p>Blandit penatibus netus proin donec dignissim, eleifend proin ultricies justo auctor, morbi eget ante dolor iaculis mauris, eleifend lectus dolor sodales, felis. Facilisi volutpat turpis vehicula dictumst, tortor mollis etiam mauris vestibulum senectus, platea ornare viverra pulvinar vitae aliquet vestibulum, odio justo. Mattis porttitor ad sagittis erat diam purus, hac etiam suscipit amet sollicitudin, sociosqu diam blandit vivamus elit ac, quis. Odio pretium enim orci purus, aliquam pulvinar fermentum nulla, velit ultrices ridiculus senectus convallis, nisi vulputate rutrum amet, habitant erat risus nulla, morbi eu. Nostra tincidunt.</p> <p>Cubilia blandit congue suspendisse augue lectus sociosqu vitae, enim facilisi bibendum montes mi, nulla nunc ornare ligula. Penatibus sit egestas non dolor justo pretium, senectus odio dictum donec tortor nunc suscipit, felis luctus dictum. Et etiam eros fusce risus a, cubilia fringilla dictum mus quisque, habitant mus amet porta massa. Velit habitasse dictum lectus risus natoque, in dictumst interdum lorem, hac vehicula facilisis aptent arcu, donec vestibulum. Est lacus nonummy natoque quisque, elit venenatis felis rhoncus arcu risus, amet egestas porta condimentum eleifend, rhoncus aliquam gravida. Class gravida aliquet nascetur facilisi.</p>

DocStrings

Source code in .venv/lib/python3.12/site-packages/jinja2/utils.py

def generate_lorem_ipsum(
    n: int = 5, html: bool = True, min: int = 20, max: int = 100
) -> str:
    """Generate some lorem ipsum for the template."""
    from .constants import LOREM_IPSUM_WORDS

    words = LOREM_IPSUM_WORDS.split()
    result = []

    for _ in range(n):
        next_capitalized = True
        last_comma = last_fullstop = 0
        word = None
        last = None
        p = []

        # each paragraph contains out of 20 to 100 words.
        for idx, _ in enumerate(range(randrange(min, max))):
            while True:
                word = choice(words)
                if word != last:
                    last = word
                    break
            if next_capitalized:
                word = word.capitalize()
                next_capitalized = False
            # add commas
            if idx - randrange(3, 8) > last_comma:
                last_comma = idx
                last_fullstop += 2
                word += ","
            # add end of sentences
            if idx - randrange(10, 20) > last_fullstop:
                last_comma = last_fullstop = idx
                word += "."
                next_capitalized = True
            p.append(word)

        # ensure that the paragraph ends with a dot.
        p_str = " ".join(p)

        if p_str.endswith(","):
            p_str = p_str[:-1] + "."
        elif not p_str.endswith("."):
            p_str += "."

        result.append(p_str)

    if not html:
        return "\n\n".join(result)
    return markupsafe.Markup(
        "\n".join(f"<p>{markupsafe.escape(x)}</p>" for x in result)
    )

namespace

namespace(*args: Any, **kwargs: Any) -> None

A namespace object that can hold arbitrary attributes. It may be

Example

Jinja call:

{% set ns = namespace() %}
{% set ns.foo = 'bar' %}
{{ ns.foo }}

Result: bar

DocStrings

Source code in .venv/lib/python3.12/site-packages/jinja2/utils.py

class Namespace:
    """A namespace object that can hold arbitrary attributes.  It may be
    initialized from a dictionary or with keyword arguments."""

    def __init__(*args: t.Any, **kwargs: t.Any) -> None:  # noqa: B902
        self, args = args[0], args[1:]
        self.__attrs = dict(*args, **kwargs)

    def __getattribute__(self, name: str) -> t.Any:
        # __class__ is needed for the awaitable check in async mode
        if name in {"_Namespace__attrs", "__class__"}:
            return object.__getattribute__(self, name)
        try:
            return self.__attrs[name]
        except KeyError:
            raise AttributeError(name) from None

    def __setitem__(self, name: str, value: t.Any) -> None:
        self.__attrs[name] = value

    def __repr__(self) -> str:
        return f"<Namespace {self.__attrs!r}>"