lscl.renderer – LSCL renderer definition

lscl.renderer.LsclRenderable = LsclRenderable

Renderable entities.

lscl.renderer.render_as_lscl(content: LsclRenderable, /, *, escapes_supported: bool = False, field_reference_escape_style: Literal['percent', 'ampersand', 'none'] = 'none') → str

Render content as LSCL.

Parameters:

• content (LsclRenderable) – Content to render as LSCL.

• escapes_supported (bool) – Whether config.support_escapes is defined as true in the configuration of the target environment.

• field_reference_escape_style (Literal['percent', 'ampersand', 'none']) – The config.field_reference.escape_style value in the configuration of the target environment.

Returns:

Rendered content.

Raises:

• StringRenderingError – A string could not be rendered due to invalid characters being present.

• SelectorElementRenderingError – A selector could not be rendered due to invalid characters being in one of its elements.

Return type:

str