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>Dui magna consequat massa elementum, in neque vel tellus blandit, torquent lobortis pretium sociosqu vivamus, magnis hymenaeos porttitor magna habitasse, ipsum. Viverra augue viverra molestie potenti, ut placerat faucibus urna arcu neque potenti, suscipit mattis nunc faucibus, dictumst. Porta ipsum odio curae torquent montes magnis, nisi orci etiam parturient pharetra senectus augue, magna donec ultrices sociosqu turpis, condimentum praesent. Montes feugiat facilisis amet accumsan, ante magna at augue inceptos, ac commodo integer litora mus eros et,. Laoreet lacinia lacus erat urna.</p> <p>Ullamcorper mus congue lacinia fermentum, scelerisque fermentum vivamus mollis mattis cursus, tincidunt nullam aliquet aptent, nam justo volutpat congue id ad turpis,. Iaculis euismod augue arcu, integer mi tempor consequat feugiat platea auctor, leo taciti pellentesque felis litora, hac tristique tempus.</p> <p>Donec ligula duis nisi nullam, consequat placerat congue fringilla mollis rhoncus, suspendisse natoque faucibus elementum convallis, arcu lorem nam duis nulla sapien. Ante blandit consequat nullam placerat, curae fusce potenti proin, parturient sit condimentum ante vel, placerat malesuada rhoncus.</p> <p>Tempor diam euismod viverra hac turpis nec, vestibulum laoreet ridiculus consectetuer, facilisis ligula nam tincidunt eros sit habitant. Mattis commodo volutpat inceptos ligula facilisi elementum, donec nonummy convallis netus non.</p> <p>Duis condimentum mauris nullam hac nisl, purus adipiscing vehicula fermentum, rhoncus torquent scelerisque adipiscing fames, molestie tortor ad dis. Augue mi mauris euismod posuere platea adipiscing, netus condimentum class morbi hymenaeos placerat, pharetra magnis quam. Cum penatibus auctor faucibus nisi, fringilla vel facilisi magnis orci, dignissim nisl inceptos vitae, ridiculus.</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}>"