pandagg.node.mappings.abstract module

class pandagg.node.mappings.abstract.ComplexField(properties: Optional[Union[Dict, Type[DocumentSource]]] = None, **body)[source]

Bases: pandagg.node.mappings.abstract.Field

is_valid_value(v: Any) → bool[source]
class pandagg.node.mappings.abstract.Field(*, multiple: Optional[bool] = None, required: bool = False, **body)[source]

Bases: pandagg.node._node.Node

is_valid_value(v: Any) → bool[source]
line_repr(depth: int, **kwargs) → Tuple[str, str][source]

Control how node is displayed in tree representation. First returned string is how node is represented on left, second string is how node is represented on right.

MyTree ├── one OneEnd │ └── two twoEnd └── three threeEnd

to_dict() → Dict[str, Any][source]
class pandagg.node.mappings.abstract.RegularField(**body)[source]

Bases: pandagg.node.mappings.abstract.Field

is_valid_value(v: Any) → bool[source]
class pandagg.node.mappings.abstract.Root(*, multiple: Optional[bool] = None, required: bool = False, **body)[source]

Bases: pandagg.node.mappings.abstract.Field

KEY = ''
line_repr(depth: int, **kwargs) → Tuple[str, str][source]

Control how node is displayed in tree representation. First returned string is how node is represented on left, second string is how node is represented on right.

MyTree ├── one OneEnd │ └── two twoEnd └── three threeEnd