compile_scene_file#
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_scene_file(path, *, library=None, metrics=None)[source]#
Compile every panel in a multi-panel file.
- Parameters:
path (
Path) – A*.scene.yamldocument. A single-panel document also works and comes back as one entry namedpanel.library (
PuppetLibrary|None) – Characters to draw from. Defaults to the two shipped puppets.metrics (
FontMetrics|None) – Font to measure lettering against.
- Return type:
- Returns:
Panel name to compiled panel, in declaration order – which is reading order.
- Raises:
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
Files the document names are read from the folder it is in. Its pages are not laid out:
compile_book_filedoes that.Example
>>> from pathlib import Path >>> from tempfile import TemporaryDirectory >>> from scenet import compile_scene_file >>> with TemporaryDirectory() as folder: ... path = Path(folder) / "two.scene.yaml" ... _ = path.write_text( ... "cast: {a: {reference: alice}}\npanels: {one: {}, two: {}}", encoding="utf-8" ... ) ... panels = compile_scene_file(path) >>> list(panels) ['one', 'two']
See also
compile_scene, for text.compile_book_file, for its pages too.