betty.model.ancestry module - Betty development documentation

class betty.model.ancestry.Ancestry[source]¶

Bases: MultipleTypesEntityCollection[Entity]

add_unchecked_graph(*entities)[source]¶

Parameters:¶

*entities¶

Return type:¶

None

class betty.model.ancestry.AnonymousCitation(*, id=None, facts=None, source=None, location=None, date=None, files=None, privacy=None, public=None, private=None)[source]¶

Bases: Citation

Parameters:¶

id=None¶
facts=None¶
source=None¶
location=None¶
date=None¶
files=None¶
privacy=None¶
public=None¶
private=None¶

property location : Str¶

class betty.model.ancestry.AnonymousSource(name=None, *, id=None, author=None, publisher=None, contained_by=None, contains=None, notes=None, date=None, files=None, links=None, privacy=None, public=None, private=None)[source]¶

Bases: Source

Parameters:¶

name=None¶
id=None¶
author=None¶
publisher=None¶
contained_by=None¶
contains=None¶
notes=None¶
date=None¶
files=None¶
links=None¶
privacy=None¶
public=None¶
private=None¶

property name : str¶

class betty.model.ancestry.Attendee[source]¶

Bases: PresenceRole

property label : Str¶

classmethod name()[source]¶

Return type:¶: str

class betty.model.ancestry.Beneficiary[source]¶

Bases: PresenceRole

property label : Str¶

classmethod name()[source]¶

Return type:¶: str

class betty.model.ancestry.Celebrant[source]¶

Bases: PresenceRole

property label : Str¶

classmethod name()[source]¶

Return type:¶: str

class betty.model.ancestry.Citation(*, id=None, facts=None, source=None, location=None, date=None, files=None, privacy=None, public=None, private=None)[source]¶

Bases: Dated, HasFiles, HasPrivacy, HasLinksEntity, UserFacingEntity, Entity

Parameters:¶

id=None¶
facts=None¶
source=None¶
location=None¶
date=None¶
files=None¶
privacy=None¶
public=None¶
private=None¶

async dump_linked_data(app)[source]¶

Dump this instance to JSON-LD.

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

classmethod entity_type_label()[source]¶

Return type:¶: betty.locale.Str

classmethod entity_type_label_plural()[source]¶

Return type:¶: betty.locale.Str

property facts : EntityCollection[AssociateT & Entity]¶

Parameters:¶

owner : OwnerT & Entity

property label : Str¶

async classmethod linked_data_schema(app)[source]¶

Define the JSON Schema for self.dump_linked_data().

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

property source : AssociateT & Entity | None¶

Parameters:¶

owner : OwnerT & Entity

class betty.model.ancestry.Dated(*args, date=None, **kwargs)[source]¶

Bases: LinkedDataDumpable

Parameters:¶

*args¶
date=None¶
**kwargs¶

async dump_linked_data(app)[source]¶

Dump this instance to JSON-LD.

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

async classmethod linked_data_schema(app)[source]¶

Define the JSON Schema for self.dump_linked_data().

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

class betty.model.ancestry.Described(*args, description=None, **kwargs)[source]¶

Bases: LinkedDataDumpable

Parameters:¶

*args¶
description=None¶
**kwargs¶

async dump_linked_data(app)[source]¶

Dump this instance to JSON-LD.

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

async classmethod linked_data_schema(app)[source]¶

Define the JSON Schema for self.dump_linked_data().

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

class betty.model.ancestry.Enclosure(encloses=None, enclosed_by=None)[source]¶

Bases: Dated, HasCitations, Entity

Parameters:¶

encloses=None¶
enclosed_by=None¶

property enclosed_by : AssociateT & Entity | None¶

Parameters:¶

owner : OwnerT & Entity

property encloses : AssociateT & Entity | None¶

Parameters:¶

owner : OwnerT & Entity

classmethod entity_type_label()[source]¶

Return type:¶: betty.locale.Str

classmethod entity_type_label_plural()[source]¶

Return type:¶: betty.locale.Str

class betty.model.ancestry.Event(*, id=None, event_type=<class 'betty.model.event_type.UnknownEventType'>, date=None, files=None, citations=None, notes=None, privacy=None, public=None, private=None, place=None, description=None)[source]¶

Bases: Dated, HasFiles, HasCitations, HasNotes, Described, HasPrivacy, HasLinksEntity, UserFacingEntity, Entity

Parameters:¶

id : str | None
event_type : type[betty.model.event_type.EventType]
date : betty.locale.Date | betty.locale.DateRange | None
files : typing.Optional[typing.Iterable[betty.model.ancestry.File]]
citations : typing.Optional[typing.Iterable[betty.model.ancestry.Citation]]
notes : typing.Optional[typing.Iterable[betty.model.ancestry.Note]]
privacy : betty.model.ancestry.Privacy | None
public : bool | None
private : bool | None
place : betty.model.ancestry.Place | None
description : str | None

property associated_files : Iterable[File]¶

async dump_linked_data(app)[source]¶

Dump this instance to JSON-LD.

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

classmethod entity_type_label()[source]¶

Return type:¶: betty.locale.Str

classmethod entity_type_label_plural()[source]¶

Return type:¶: betty.locale.Str

property event_type : type[EventType]¶

property label : Str¶

async classmethod linked_data_schema(app)[source]¶

Define the JSON Schema for self.dump_linked_data().

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

property place : AssociateT & Entity | None¶

Parameters:¶

owner : OwnerT & Entity

property presences : EntityCollection[AssociateT & Entity]¶

Parameters:¶

owner : OwnerT & Entity

class betty.model.ancestry.File(path, *, id=None, media_type=None, description=None, notes=None, citations=None, privacy=None, public=None, private=None, links=None)[source]¶

Bases: Described, HasPrivacy, HasLinksEntity, HasMediaType, HasNotes, HasCitations, UserFacingEntity, Entity

Parameters:¶

path¶
id=None¶
media_type=None¶
description=None¶
notes=None¶
citations=None¶
privacy=None¶
public=None¶
private=None¶
links=None¶

async dump_linked_data(app)[source]¶

Dump this instance to JSON-LD.

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

property entities : EntityCollection[AssociateT & Entity]¶

Parameters:¶

owner : OwnerT & Entity

classmethod entity_type_label()[source]¶

Return type:¶: betty.locale.Str

classmethod entity_type_label_plural()[source]¶

Return type:¶: betty.locale.Str

property label : Str¶

async classmethod linked_data_schema(app)[source]¶

Define the JSON Schema for self.dump_linked_data().

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

property path : Path¶

class betty.model.ancestry.HasCitations(*args, citations=None, **kwargs)[source]¶

Bases: LinkedDataDumpable

Parameters:¶

self : HasCitations & Entity
*args¶
citations=None¶
**kwargs¶

property citations : EntityCollection[AssociateT & Entity]¶

Parameters:¶

owner : OwnerT & Entity

async dump_linked_data(app)[source]¶

Dump this instance to JSON-LD.

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

async classmethod linked_data_schema(app)[source]¶

Define the JSON Schema for self.dump_linked_data().

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

class betty.model.ancestry.HasFiles(*args, files=None, **kwargs)[source]¶

Bases: object

Parameters:¶

self : HasFiles & Entity
*args¶
files=None¶
**kwargs¶

property associated_files : Iterable[File]¶

property files : EntityCollection[AssociateT & Entity]¶

Parameters:¶

owner : OwnerT & Entity

class betty.model.ancestry.HasLinks(*args, links=None, **kwargs)[source]¶

Bases: LinkedDataDumpable

Parameters:¶

*args¶
links=None¶
**kwargs¶

async dump_linked_data(app)[source]¶

Dump this instance to JSON-LD.

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

async classmethod linked_data_schema(app)[source]¶

Define the JSON Schema for self.dump_linked_data().

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

property links : MutableSequence[Link]¶

class betty.model.ancestry.HasLinksEntity(*args, links=None, **kwargs)[source]¶

Bases: HasLinks

Parameters:¶

*args¶
links=None¶
**kwargs¶

async dump_linked_data(app)[source]¶

Dump this instance to JSON-LD.

Parameters:¶

self : HasLinksEntity & Entity
app¶

Return type:¶

DictDump[Dump]

class betty.model.ancestry.HasMediaType(*args, media_type=None, **kwargs)[source]¶

Bases: LinkedDataDumpable

Parameters:¶

*args¶
media_type=None¶
**kwargs¶

async dump_linked_data(app)[source]¶

Dump this instance to JSON-LD.

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

async classmethod linked_data_schema(app)[source]¶

Define the JSON Schema for self.dump_linked_data().

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

class betty.model.ancestry.HasNotes(*args, notes=None, **kwargs)[source]¶

Bases: LinkedDataDumpable

Parameters:¶

self : HasNotes & Entity
*args¶
notes=None¶
**kwargs¶

async dump_linked_data(app)[source]¶

Dump this instance to JSON-LD.

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

async classmethod linked_data_schema(app)[source]¶

Define the JSON Schema for self.dump_linked_data().

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

property notes : EntityCollection[AssociateT & Entity]¶

Parameters:¶

owner : OwnerT & Entity

class betty.model.ancestry.HasPrivacy(*args, privacy=None, public=None, private=None, **kwargs)[source]¶

Bases: LinkedDataDumpable

Parameters:¶

*args¶
privacy=None¶
public=None¶
private=None¶
**kwargs¶

async dump_linked_data(app)[source]¶

Dump this instance to JSON-LD.

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

async classmethod linked_data_schema(app)[source]¶

Define the JSON Schema for self.dump_linked_data().

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

property own_privacy : Privacy¶

property privacy : Privacy¶

property private : bool¶

property public : bool¶

class betty.model.ancestry.Link(url, *, relationship=None, label=None, description=None, media_type=None, locale=None)[source]¶

Bases: HasMediaType, Localized, Described, LinkedDataDumpable

Parameters:¶

url¶
relationship=None¶
label=None¶
description=None¶
media_type=None¶
locale=None¶

async dump_linked_data(app)[source]¶

Dump this instance to JSON-LD.

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

label : --is-rst--:py:class:`str` | :py:obj:`None`¶

async classmethod linked_data_schema(app)[source]¶

Define the JSON Schema for self.dump_linked_data().

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

relationship : --is-rst--:py:class:`str` | :py:obj:`None`¶

url : --is-rst--:py:class:`str`¶

class betty.model.ancestry.Note(text, *, id=None, entity=None, privacy=None, public=None, private=None)[source]¶

Bases: UserFacingEntity, HasPrivacy, HasLinksEntity, Entity

Parameters:¶

text¶
id=None¶
entity=None¶
privacy=None¶
public=None¶
private=None¶

async dump_linked_data(app)[source]¶

Dump this instance to JSON-LD.

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

property entity : AssociateT & Entity | None¶

Parameters:¶

owner : OwnerT & Entity

classmethod entity_type_label()[source]¶

Return type:¶: betty.locale.Str

classmethod entity_type_label_plural()[source]¶

Return type:¶: betty.locale.Str

property label : Str¶

async classmethod linked_data_schema(app)[source]¶

Define the JSON Schema for self.dump_linked_data().

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

property text : str¶

class betty.model.ancestry.Organizer[source]¶

Bases: PresenceRole

property label : Str¶

classmethod name()[source]¶

Return type:¶: str

class betty.model.ancestry.Person(*, id=None, files=None, citations=None, links=None, notes=None, privacy=None, public=None, private=None, parents=None, children=None, presences=None, names=None)[source]¶

Bases: HasFiles, HasCitations, HasNotes, HasLinksEntity, HasPrivacy, UserFacingEntity, Entity

Parameters:¶

id=None¶
files=None¶
citations=None¶
links=None¶
notes=None¶
privacy=None¶
public=None¶
private=None¶
parents=None¶
children=None¶
presences=None¶
names=None¶

property associated_files : Iterable[File]¶

property children : EntityCollection[AssociateT & Entity]¶

Parameters:¶

owner : OwnerT & Entity

async dump_linked_data(app)[source]¶

Dump this instance to JSON-LD.

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

classmethod entity_type_label()[source]¶

Return type:¶: betty.locale.Str

classmethod entity_type_label_plural()[source]¶

Return type:¶: betty.locale.Str

property label : Str¶

async classmethod linked_data_schema(app)[source]¶

Define the JSON Schema for self.dump_linked_data().

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

property names : EntityCollection[AssociateT & Entity]¶

Parameters:¶

owner : OwnerT & Entity

property parents : EntityCollection[AssociateT & Entity]¶

Parameters:¶

owner : OwnerT & Entity

property presences : EntityCollection[AssociateT & Entity]¶

Parameters:¶

owner : OwnerT & Entity

property siblings : list[Person]¶

class betty.model.ancestry.PersonName(*, id=None, person=None, individual=None, affiliation=None, privacy=None, public=None, private=None, locale=None)[source]¶

Bases: Localized, HasCitations, HasPrivacy, Entity

Parameters:¶

id=None¶
person=None¶
individual=None¶
affiliation=None¶
privacy=None¶
public=None¶
private=None¶
locale=None¶

property affiliation : str | None¶

async dump_linked_data(app)[source]¶

Dump this instance to JSON-LD.

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

classmethod entity_type_label()[source]¶

Return type:¶: betty.locale.Str

classmethod entity_type_label_plural()[source]¶

Return type:¶: betty.locale.Str

property individual : str | None¶

property label : Str¶

async classmethod linked_data_schema(app)[source]¶

Define the JSON Schema for self.dump_linked_data().

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

property person : AssociateT & Entity | None¶

Parameters:¶

owner : OwnerT & Entity

class betty.model.ancestry.Place(*, id=None, names=None, events=None, enclosed_by=None, encloses=None, notes=None, coordinates=None, links=None, privacy=None, public=None, private=None)[source]¶

Bases: HasLinksEntity, HasFiles, HasNotes, HasPrivacy, UserFacingEntity, Entity

Parameters:¶

id=None¶
names=None¶
events=None¶
enclosed_by=None¶
encloses=None¶
notes=None¶
coordinates=None¶
links=None¶
privacy=None¶
public=None¶
private=None¶

property associated_files : Iterable[File]¶

property coordinates : Point | None¶

async dump_linked_data(app)[source]¶

Dump this instance to JSON-LD.

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

property enclosed_by : EntityCollection[AssociateT & Entity]¶

Parameters:¶

owner : OwnerT & Entity

property encloses : EntityCollection[AssociateT & Entity]¶

Parameters:¶

owner : OwnerT & Entity

classmethod entity_type_label()[source]¶

Return type:¶: betty.locale.Str

classmethod entity_type_label_plural()[source]¶

Return type:¶: betty.locale.Str

property events : EntityCollection[AssociateT & Entity]¶

Parameters:¶

owner : OwnerT & Entity

property label : Str¶

async classmethod linked_data_schema(app)[source]¶

Define the JSON Schema for self.dump_linked_data().

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

property names : list[PlaceName]¶

class betty.model.ancestry.PlaceName(name, *, locale=None, date=None)[source]¶

Bases: Localized, Dated, LinkedDataDumpable

Parameters:¶

name¶
locale=None¶
date=None¶

async dump_linked_data(app)[source]¶

Dump this instance to JSON-LD.

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

async classmethod linked_data_schema(app)[source]¶

Define the JSON Schema for self.dump_linked_data().

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

property name : str¶

class betty.model.ancestry.Presence(person, role, event)[source]¶

Bases: HasPrivacy, Entity

Parameters:¶

person¶
role¶
event¶

classmethod entity_type_label()[source]¶

Return type:¶: betty.locale.Str

classmethod entity_type_label_plural()[source]¶

Return type:¶: betty.locale.Str

property event : AssociateT & Entity | None¶

Parameters:¶

owner : OwnerT & Entity

property label : Str¶

property person : AssociateT & Entity | None¶

Parameters:¶

owner : OwnerT & Entity

role : --is-rst--:py:class:`betty.model.ancestry.PresenceRole`¶

class betty.model.ancestry.PresenceRole[source]¶

Bases: object

property label : Str¶

classmethod name()[source]¶

Return type:¶: str

class betty.model.ancestry.Privacy(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: Enum

PRIVATE = 2¶

PUBLIC = 1¶

UNDETERMINED = 3¶

class betty.model.ancestry.Source(name=None, *, id=None, author=None, publisher=None, contained_by=None, contains=None, notes=None, date=None, files=None, links=None, privacy=None, public=None, private=None)[source]¶

Bases: Dated, HasFiles, HasNotes, HasLinksEntity, HasPrivacy, UserFacingEntity, Entity

Parameters:¶

name=None¶
id=None¶
author=None¶
publisher=None¶
contained_by=None¶
contains=None¶
notes=None¶
date=None¶
files=None¶
links=None¶
privacy=None¶
public=None¶
private=None¶

property citations : EntityCollection[AssociateT & Entity]¶

Parameters:¶

owner : OwnerT & Entity

property contained_by : AssociateT & Entity | None¶

Parameters:¶

owner : OwnerT & Entity

property contains : EntityCollection[AssociateT & Entity]¶

Parameters:¶

owner : OwnerT & Entity

async dump_linked_data(app)[source]¶

Dump this instance to JSON-LD.

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

classmethod entity_type_label()[source]¶

Return type:¶: betty.locale.Str

classmethod entity_type_label_plural()[source]¶

Return type:¶: betty.locale.Str

property label : Str¶

async classmethod linked_data_schema(app)[source]¶

Define the JSON Schema for self.dump_linked_data().

Parameters:¶

app¶

Return type:¶

dict[str, 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]]]]]

class betty.model.ancestry.Speaker[source]¶

Bases: PresenceRole

property label : Str¶

classmethod name()[source]¶

Return type:¶: str

class betty.model.ancestry.Subject[source]¶

Bases: PresenceRole

property label : Str¶

classmethod name()[source]¶

Return type:¶: str

class betty.model.ancestry.Witness[source]¶

Bases: PresenceRole

property label : Str¶

classmethod name()[source]¶

Return type:¶: str

betty.model.ancestry.is_private(target)[source]¶

Check if the given target is private.

Parameters:¶

target¶

Return type:¶

bool

betty.model.ancestry.is_public(target)[source]¶

Check if the given target is public.

Parameters:¶

target¶

Return type:¶

bool

betty.model.ancestry.merge_privacies(*privacies)[source]¶

Merge multiple privacies into one.

Parameters:¶

*privacies¶

Return type:¶

betty.model.ancestry.Privacy

async betty.model.ancestry.ref_link(root_schema, app)[source]¶

Reference the Link schema.

Parameters:¶

root_schema¶
app¶

Return type:¶

dict[str, 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]]]]]

async betty.model.ancestry.ref_link_collection(root_schema, app)[source]¶

Reference the schema for a collection of Link instances.

Parameters:¶

root_schema¶
app¶

Return type:¶

dict[str, 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]]]]]

betty.model.ancestry.ref_media_type(root_schema)[source]¶

Reference the MediaType schema.

Parameters:¶

root_schema¶

Return type:¶

dict[str, 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]]]]]

betty.model.ancestry.ref_role(root_schema)[source]¶

Reference the PresenceRole schema.

Parameters:¶

root_schema¶

Return type:¶

dict[str, 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]]]]]

betty.model.ancestry.resolve_privacy(privacy)[source]¶

Resolve the privacy of a value.

Parameters:¶

privacy¶

Return type:¶

betty.model.ancestry.Privacy

betty.model.ancestry module¶