core.elements

Elements are mini chameleon macros, usually used to render a single element. Sometimes it is useful to not just apply a macro, but to have an actual object representing that code snippet. The prime example being links.

Elements are rendered in chameleon templates by calling them with the layout object:

<tal:b replace="structure element(layout)" />

Note that no matter how quick the elements rendering is, using chameleon templates directly is faster.

This module should eventually replace the elements.py module.

Module Contents

Classes

Element	Provides a way to define elements trough multiple variables. These
AccessMixin	Hidden links point to views which are not available to the public
Link	A generic link.
LinkGroup	Represents a list of links.
Trait	Base class for all traits.
Confirm	Links with a confirm link will only be triggered after a question has
Block	A block trait is a confirm variation with no way to say yes.
Intercooler	Turns the link into an intercooler request. As a result, the link

class core.elements.Element(text: str | None = None, attrs: dict[str, Any] | None = None, traits: Iterable[Trait] | Trait = (), **props: Any)

Provides a way to define elements trough multiple variables. These elements may then be rendered by the elements.pt templates.

Elements are simple, they render whatever text and attributes the get. They also carry a dictionary with properties on them, so any kind of value may be attached to an element. For example this works:

user = object()
element = Element(model=user)
assert element.user == user

Since we might use a complex set of attributes which need to be set in a certain way we use a traits system to avoid having to rely too heavily on class inheritance.

Basically traits are callables called with attributes which they may manipulate. For example, a trait might turn a simple argument into a set of attributes:

Element(traits=[Editor(buttons=['new', 'edit', 'delete'])])

See the link traits further down to see examples.

id: ClassVar[str | None]

__slots__ = ('text', 'attrs', 'props')

normalize_attrs(attrs: dict[str, Any] | None) → dict[str, Any]

Before we do anything with attributes we make sure we can easily add/remove classes from them, so we use a set.

__eq__(other: object) → bool

Return self==value.

__getattr__(name: str) → Any

__call__(layout: core.layout.ChameleonLayout, extra_classes: Iterable[str] | None = None) → str

class core.elements.AccessMixin

Hidden links point to views which are not available to the public (usually through a publication mechanism).

We mark those links with an icon. This mixin automatically does that for links which bear a model property.

property access: str

Wraps model.access, ensuring it is always available, even if the model does not use it.

__slots__ = ()

class core.elements.Link(text: str | None, url: str = '#', attrs: dict[str, Any] | None = None, traits: Iterable[Trait] | Trait = (), **props: Any)

Bases: Element, AccessMixin

A generic link.

id = 'link'

__slots__ = ()

__repr__() → str

Return repr(self).

class core.elements.LinkGroup(title: str, links: Sequence[Link], model: Any | None = None, right_side: bool = True, classes: Collection[str] | None = None, attributes: dict[str, Any] | None = None)

Bases: AccessMixin

Represents a list of links.

__slots__ = ['title', 'links', 'model', 'right_side', 'classes', 'attributes']

class core.elements.Trait

Base class for all traits.

__slots__ = ('apply',)

apply: Callable[[dict[str, Any]], dict[str, Any]]

__call__(attrs: dict[str, Any], **ignored: Any) → dict[str, Any]

class core.elements.Confirm(confirm: str, extra: str | None = None, yes: str | None = 'Yes', no: str = 'Cancel', **ignored: Any)

Bases: Trait

Links with a confirm link will only be triggered after a question has been answered with a yes:

link = Link(_("Continue"), '/last-step', traits=(
    Confirm(
        _("Do you really want to continue?"),
        _("This cannot be undone"),
        _("Yes"), _("No")
    ),
))

__slots__ = ()

class core.elements.Block(message: str, extra: str | None = None, no: str = 'Cancel', **ignored: Any)

Bases: Confirm

A block trait is a confirm variation with no way to say yes.

__slots__ = ()

class core.elements.Intercooler(request_method: Literal[GET, POST, DELETE], target: str | None = None, redirect_after: str | None = None, **ignored: Any)

Bases: Trait

Turns the link into an intercooler request. As a result, the link will be exeucted as an ajax request.

See http://intercoolerjs.org.

__slots__ = ()