pg.hyper.DerivedValue

Accessible via pg.hyper.DerivedValue.

class DerivedValue(reference_paths)[source]

Bases: pg.Object, pg.CustomTyping

Base class of value that references to other values in object tree.

Methods:

derive(*args)

Derive the value from referenced values.

resolve([reference_path_or_paths])

Resolve reference paths based on the location of this node.

abstract derive(*args)[source]

Derive the value from referenced values.

Return type:

Any

resolve(reference_path_or_paths=None)[source]

Resolve reference paths based on the location of this node.

Return type:

Union[Tuple[pg.Symbolic, pg.KeyPath], List[Tuple[pg.Symbolic, pg.KeyPath]]]

Parameters:

reference_path_or_paths – (Optional) a string or KeyPath as a reference path or a list of strings or KeyPath objects as a list of reference paths. If this argument is not provided, prebound reference paths of this object will be used.

Returns:

A tuple (or list of tuple) of (resolved parent, resolved full path)