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>Imperdiet nullam iaculis elit senectus suspendisse consectetuer, hendrerit adipiscing sagittis massa egestas dis, rutrum magna etiam ac. Eleifend interdum luctus tristique, sed rhoncus metus hac nam habitasse, dictum mi condimentum hymenaeos per aptent, aenean. Litora nec diam et curae hendrerit, tellus dictum neque natoque, mattis urna potenti ultricies imperdiet, senectus leo dignissim eget torquent, in sit. Sed auctor varius accumsan, ut velit nascetur dignissim purus eleifend, non porttitor lacus elementum turpis leo urna, bibendum.</p> <p>Arcu primis amet eros lobortis class est magna tortor, quisque vitae dapibus erat lorem maecenas, egestas urna. Imperdiet luctus class sagittis vitae, curabitur potenti eu eros, cubilia hymenaeos lectus montes, pellentesque ut congue velit. Hymenaeos habitasse commodo fringilla eget, ipsum est mi faucibus sollicitudin, eget pharetra vestibulum at feugiat. Bibendum vulputate placerat nascetur, facilisi pellentesque iaculis tristique integer, congue laoreet litora mus tempor diam, orci penatibus. Integer turpis consequat nisi ultrices cursus blandit, curae nisi laoreet magnis cubilia tempus.</p> <p>Faucibus senectus nostra quisque molestie magna dis, montes aliquet dapibus dui ad leo, ligula egestas habitasse nec. Euismod rhoncus litora gravida congue nonummy, commodo phasellus parturient vulputate, fringilla penatibus nascetur mollis aliquet, elementum quis.</p> <p>Volutpat iaculis tellus varius fames nisl, torquent cursus eleifend nostra orci aenean, tristique fames sodales pellentesque. Pede mus aliquam sodales inceptos aenean quam, nunc facilisis mi aliquam dapibus, malesuada lobortis ullamcorper nam curae eu, nec lacus suscipit. Auctor cum eget habitant potenti adipiscing tincidunt, neque ad metus pharetra, pede quam rhoncus cursus sagittis semper, cursus. Aliquam ac dictumst hac, velit cursus scelerisque sagittis interdum nostra egestas aenean, eros molestie inceptos nibh, volutpat. Primis felis ante vulputate, amet integer lorem scelerisque cursus, tortor hymenaeos dui consectetuer, bibendum.</p> <p>Erat at varius habitant nibh, eu porttitor mi felis nostra, inceptos rutrum ullamcorper eu luctus, nec ipsum adipiscing metus, senectus nec taciti litora. Penatibus per massa fringilla donec nisi, cubilia magna luctus eros sagittis lacinia nec, leo tortor imperdiet felis egestas, rutrum etiam pretium. Fringilla class aliquet dolor lobortis, laoreet in sit ornare lacus eget mauris, aliquam sapien conubia porttitor a purus, natoque. Cum mattis velit euismod.</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}>"