API

class abgleich.Command(cmd)

Immutable.

Parameters:

cmd (List[List[str]])

class abgleich.Config(root=None, **kwargs)

Immutable.

Parameters:

• root (Optional[str])

• kwargs (ConfigFieldABC)

classmethod from_fd(fd)

Import configuration from handle on opened YAML file

Parameters:

fd (TextIO)

Return type:

ConfigABC

classmethod from_text(text)

Import configuration from YAML string

Parameters:

text (str)

Return type:

ConfigABC

group(root)

Easy access to configuration groups (aka paths)

Parameters:

root (str)

Return type:

ConfigABC

to_fd(fd)

Export configuration to handle on opened YAML file

Parameters:

fd (TextIO)

to_text()

Export configuration to YAML string

class abgleich.ConfigField(name, description, type_, validate=None, default=None, import_=None)

Mutable.

Parameters:

• name (str)

• description (str)

• type_ (Type)

• validate (Optional[Callable])

• default (Union[List[str], str, int, float, bool, None])

• import_ (Optional[Callable])

class abgleich.Dataset(name, properties, snapshots, side, config)

Immutable.

Parameters:

• name (str)

• properties (Dict[str, PropertyABC])

• snapshots (List[SnapshotABC])

• side (str)

• config (ConfigABC)

class abgleich.Property(name, value, src=None)

Immutable.

Parameters:

• name (str)

• value (Union[str, int, float, None])

• src (Union[str, int, float, None])

class abgleich.Snapshot(name, parent, properties, context, side, config)

Immutable.

Parameters:

• name (str)

• parent (str)

• properties (Dict[str, PropertyABC])

• context (List[SnapshotABC])

• side (str)

• config (ConfigABC)

class abgleich.Transaction(meta, command)

Mutable.

Parameters:

• meta (TransactionMetaABC)

• command (CommandABC)

class abgleich.TransactionList(*transactions)

Mutable.

Parameters:

transactions (TransactionABC)

class abgleich.TransactionMeta(**kwargs)

Immutable.

Parameters:

kwargs (Union[str, int, float])

class abgleich.Zpool(datasets, side, config)

Immutable.

Parameters:

• datasets (List[DatasetABC])

• side (str)

• config (ConfigABC)