compile_document#
Import |
|
Defined in |
|
Install |
|
Since |
0.1 |
Stability |
Public: follows semantic versioning. Below 1.0, a minor release may change it, and the CHANGELOG says how. |
- scenet.pipeline.compile_document(path, *, library=None, metrics=None)[source]#
Compile any supported file’s panels, choosing the frontend by extension.
The panels of
compile_book_file, without its pages: what to reach for when the syntax is the user’s choice and the panels are what you draw.- Parameters:
path (
Path) – A*.panel.yaml,*.scene.yamlor*.scriptfile.library (
PuppetLibrary|None) – Characters to draw from. Defaults to the two shipped puppets.metrics (
FontMetrics|None) – Font to measure lettering against. Defaults to the shipped one.
- Return type:
- Returns:
Panel name to its compiled result. A single panel is named
panel.- Raises:
SourceError – The extension is not one any frontend reads.
FileReadError – The file cannot be read: a
MissingFileError, also aFileNotFoundError, when it is not there.PanelSyntaxError – The document is malformed or invalid, or a file it names cannot be read or is not what it says.
CompositionError – An
over:names a panel that does not exist, or the chain is a cycle.UnknownPuppetError – A cast member references a puppet the library lacks.
UnknownPoseError – A cast member’s
poseis one its puppet does not declare.UnknownExpressionError – A cast member’s
expressionis one its puppet does not declare.LayoutError – The staging cannot be satisfied: a depth order that is a cycle, or a panel with no cast to place.
BalloonPlacementError – A balloon or a caption has no legal position.
SfxPlacementError – A sound effect has no legal position.
Note
Pages are compiled and dropped. Call
compile_book_fileto keep them.Example
>>> from pathlib import Path >>> from tempfile import TemporaryDirectory >>> from scenet import compile_document >>> with TemporaryDirectory() as folder: ... path = Path(folder) / "hello.panel.yaml" ... _ = path.write_text("cast: {a: {reference: alice}}", encoding="utf-8") ... panels = compile_document(path) >>> list(panels) ['panel']
See also
compile_book_file, for the pages too.