core.render.abstract

Classes

AbstractRenderer

Helper class that provides a standard way to create an ABC using

Module Contents

class core.render.abstract.AbstractRenderer(parent=None)

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

Parameters:

parent (viur.core.module.Module)

parent: viur.core.module.Module | None = None
property kind: str
Abstractmethod:

Return type:

str

Renderer type specifier

abstractmethod list(skellist, action='list', params=None, **kwargs)

Renders a response with a list of entries.

Parameters:

  • skellist (viur.core.skeleton.SkelList) – List of Skeletons with entries to display.

  • action (str) – The name of the action, which is passed into the result.

  • params (Any) – Optional data that will be passed unmodified to the template

Return type:

str

abstractmethod view(skel, action='view', params=None, **kwargs)

Renders a response for viewing an entry.

Parameters:

  • skel (viur.core.skeleton.SkeletonInstance)

  • action (str)

  • params (Any)

Return type:

str

add(skel, action='add', params=None, **kwargs)

Renders a response for adding an entry.

Parameters:

  • skel (viur.core.skeleton.SkeletonInstance)

  • action (str)

  • params (Any)

Return type:

str

edit(skel, action='edit', params=None, **kwargs)

Renders a response for modifying an entry.

Parameters:

  • skel (viur.core.skeleton.SkeletonInstance)

  • action (str)

  • params (Any)

Return type:

str