betty.extension.gramps.config module¶
Provide configuration for the betty.extension.Gramps extension.
- class betty.extension.gramps.config.FamilyTreeConfiguration[source]¶
Bases:
ConfigurationConfigure a single Gramps family tree.
- Parameters:
file_path (
pathlib.Path)
- __init__(file_path: pathlib.Path)[source]¶
- Parameters:
file_path (
pathlib.Path)
- dump() bool | int | float | str | None | Sequence[bool | int | float | str | None | Sequence[Dump] | Mapping[str, Dump]] | Mapping[str, bool | int | float | str | None | Sequence[Dump] | Mapping[str, Dump]] | type[betty.serde.dump.Void][source]¶
Dump this instance to a portable format.
- Return type:
typing.Union[bool,int,float,str,None,typing.Sequence[typing.Union[bool,int,float,str,None,typing.Sequence[Dump],typing.Mapping[str, Dump]]],typing.Mapping[str,typing.Union[bool,int,float,str,None,typing.Sequence[Dump],typing.Mapping[str, Dump]]],type[betty.serde.dump.Void]]
- class betty.extension.gramps.config.FamilyTreeConfigurationSequence[source]¶
Bases:
ConfigurationSequence[FamilyTreeConfiguration]Configure zero or more Gramps family trees.
- Parameters:
configurations (
typing.Optional[typing.Iterable[typing.TypeVar(_ConfigurationT, bound=betty.config.Configuration)]])
- load_item(dump: bool | int | float | str | None | Sequence[Dump] | Mapping[str, Dump]) betty.extension.gramps.config.FamilyTreeConfiguration[source]¶
Create and load a new item from the given dump, or raise an assertion error.
- Raises:
betty.serde.load.AssertionFailed – Raised when the dump is invalid and cannot be loaded.
- Parameters:
dump (
typing.Union[bool,int,float,str,None,typing.Sequence[Dump],typing.Mapping[str, Dump]])- Return type:
- class betty.extension.gramps.config.GrampsConfiguration[source]¶
Bases:
ConfigurationProvide configuration for the
betty.extension.gramps.Grampsextension.- Parameters:
family_trees (
typing.Optional[typing.Iterable[betty.extension.gramps.config.FamilyTreeConfiguration]])
- __init__(*, family_trees: Iterable[betty.extension.gramps.config.FamilyTreeConfiguration] | None = None)[source]¶
- Parameters:
family_trees (
typing.Optional[typing.Iterable[betty.extension.gramps.config.FamilyTreeConfiguration]])
- dump() bool | int | float | str | None | Sequence[bool | int | float | str | None | Sequence[Dump] | Mapping[str, Dump]] | Mapping[str, bool | int | float | str | None | Sequence[Dump] | Mapping[str, Dump]] | type[betty.serde.dump.Void][source]¶
Dump this instance to a portable format.
- Return type:
typing.Union[bool,int,float,str,None,typing.Sequence[typing.Union[bool,int,float,str,None,typing.Sequence[Dump],typing.Mapping[str, Dump]]],typing.Mapping[str,typing.Union[bool,int,float,str,None,typing.Sequence[Dump],typing.Mapping[str, Dump]]],type[betty.serde.dump.Void]]
- property family_trees: FamilyTreeConfigurationSequence¶
The Gramps family trees to load.