Template Module

Template module.

class pepperpy.template.Template(name, content, context=None)[source]

Bases: BaseSerializable

Template.

Parameters:

name (str)
content (str)
context (TemplateContext | None)

name: str

content: str

context: Optional[TemplateContext] = None

serialize()[source]

Serialize template.

Return type:: Dict[str, Any]
Returns:: Serialized template

deserialize(data)[source]

Deserialize template.

Parameters:: data (Dict[str, Any]) – Serialized template
Return type:: None

class pepperpy.template.TemplateConfig(name='template_manager', metadata=<factory>)[source]

Bases: ModuleConfig

Template configuration.

Parameters:

name (str)
metadata (Dict[str, Any])

name: str = 'template_manager'

metadata: Dict[str, Any]

class pepperpy.template.TemplateContext(name, metadata=<factory>)[source]

Bases: object

Template context.

Parameters:

name (str)
metadata (Dict[str, Any])

name: str

metadata: Dict[str, Any]

exception pepperpy.template.TemplateError(message, details=None, cause=None)[source]

Bases: PepperpyError

Template error.

Parameters:

message (str)
details (Dict[str, Any] | None)
cause (Exception | None)

Return type:

None

class pepperpy.template.TemplateManager(config=None)[source]

Bases: BaseModule[TemplateConfig]

Template manager.

Parameters:: config (TemplateConfig | None)

__init__(config=None)[source]

Initialize template manager.

Parameters:: config (Optional[TemplateConfig]) – Template configuration
Return type:: None

register(template)[source]

Register template.

Parameters:: template (Template) – Template to register
Raises:: TemplateError – If template cannot be registered
Return type:: None

get(name)[source]

Get template.

Parameters:: name (str) – Template name
Return type:: Template
Returns:: Template instance
Raises:: TemplateError – If template is not found

unregister(name)[source]

Unregister template.

Parameters:: name (str) – Template name
Raises:: TemplateError – If template cannot be unregistered
Return type:: None

clear()[source]

Clear all templates.

Raises:: TemplateError – If templates cannot be cleared
Return type:: None