betty.render module¶
Provide the Render API.
- class betty.render.Renderer[source]¶
Bases:
object
Define a (file) content renderer.
Renderers can be implemented for a variety of purposes: - invoking templating engines - file conversions
- async render_file(file_path: pathlib._local.Path, *, job_context: betty.job.Context | None = None, localizer: betty.locale.Localizer | None = None) pathlib._local.Path [source]¶
Render a single file.
- Return type:
pathlib._local.Path
- Returns:
The file’s new path, which may have been changed, e.g. a renderer-specific extension may have been stripped from the end.
- Parameters:
file_path (
pathlib._local.Path
)job_context (
betty.job.Context
|None
)localizer (
betty.locale.Localizer
|None
)
- class betty.render.SequentialRenderer[source]¶
Bases:
Renderer
Render using a sequence of other renderers.
- Parameters:
renderers (
list
[betty.render.Renderer
])
- __init__(renderers: list[betty.render.Renderer])[source]¶
- Parameters:
renderers (
list
[betty.render.Renderer
])
- async render_file(file_path: pathlib._local.Path, *, job_context: betty.job.Context | None = None, localizer: betty.locale.Localizer | None = None) pathlib._local.Path [source]¶
Render a single file.
- Return type:
pathlib._local.Path
- Returns:
The file’s new path, which may have been changed, e.g. a renderer-specific extension may have been stripped from the end.
- Parameters:
file_path (
pathlib._local.Path
)job_context (
betty.job.Context
|None
)localizer (
betty.locale.Localizer
|None
)