predraw v0.3.0 /predraw.loader
Updated
On this page

Load and resolve a predraw project from JSON files.

#predraw.loader

#predraw.loader

Load and resolve a predraw project from JSON files.

#load_scene

python
def load_scene(path: str) -> Scene

Load a scene from a file or directory.

If path is a directory, looks for main.json. If path is a file, loads it directly.

The document is validated against the strictspec scene schema before parsing (version gate + full structural validation); an invalid document raises SchemaValidationError.

#_load_json

python
def _load_json(path: Path) -> dict

Load and parse a JSON file.

#_canonicalize_aliases

python
def _canonicalize_aliases(node)

Recursively rewrite alias spellings to their canonical camelCase form.

Runs after strictspec validation, which guarantees no alias pair has both spellings present, so each rename is unambiguous. After this pass the parser reads canonical keys only.

#_parse_scene

python
def _parse_scene(data: dict, base_dir: str) -> Scene

Parse raw JSON dict into a Scene, resolving imports.

#_parse_element

python
def _parse_element(data: dict) -> Element

Parse a raw JSON dict into an Element.

#_parse_gradient

python
def _parse_gradient(data: dict) -> Gradient

Parse a gradient dict into a Gradient object.

#_resolve_imports

python
def _resolve_imports(scene: Scene, base_dir: str) -> None

Load imported component files and store in scene.defs.

#resolve_styles

python
def resolve_styles(scene: Scene, mode: str='dark') -> Scene

Resolve all $ref style tokens in the scene for the given mode.

Walks all elements, replaces any fill value starting with "$" with the resolved color from scene.styles for the given mode.

#_resolve_element_styles

python
def _resolve_element_styles(element: Element, styles: dict[str, Style], mode: str) -> None

Recursively resolve style references in an element.

#load_config

python
def load_config(path: str) -> dict

Load config.json from a directory or return defaults.

When a config.json is present it is validated against the strictspec config schema (version gate + full validation) before being returned; an invalid config raises SchemaValidationError. When absent, the in-memory default is returned as-is.

Search