Loader

loader.Loader()

Shared lifecycle for all loader families.

The root owns source tracking, the load template, convenience construction, and timeline-creation surfaces. Payload-specific state and APIs belong to subclasses such as :class:EventLoader, :class:ManifestLoader, and :class:AlignmentLoader.

Attributes

Name Description
metadata Aggregated source metadata.
sources List of loaded source paths.

Methods

Name Description
clear Clear shared source state.
create_bundle Create an alignment bundle when supported.
create_group Create a timeline group when supported.
create_timeline Create a timeline from the loaded payload.
create_timelines Create all timelines, optionally filtered by an implementation.
from_file Instantiate the loader, load paths, and return it.
load Load and accept one or more sources through the shared template.

clear

loader.Loader.clear()

Clear shared source state.

create_bundle

loader.Loader.create_bundle(**kwargs)

Create an alignment bundle when supported.

create_group

loader.Loader.create_group(**kwargs)

Create a timeline group when supported.

create_timeline

loader.Loader.create_timeline(uid=None, **kwargs)

Create a timeline from the loaded payload.

Concrete loader families implement payload-specific construction.

create_timelines

loader.Loader.create_timelines(id_pattern=None)

Create all timelines, optionally filtered by an implementation.

from_file

loader.Loader.from_file(*paths, **kwargs)

Instantiate the loader, load paths, and return it.

load

loader.Loader.load(*sources)

Load and accept one or more sources through the shared template.