betty.model.ancestry module¶
Provide Betty’s main data model.
- class betty.model.ancestry.Ancestry[source]¶
Bases:
MultipleTypesEntityCollection[Entity]An ancestry contains all the entities of a single family tree/genealogical data set.
- add_unchecked_graph(*entities: betty.model.Entity) None[source]¶
Add entities to the ancestry but do not automatically add associates as well.
It is the caller’s responsibility to ensure all associates are added to the ancestry. If this is done, calling this method is faster than the usual entity collection methods.
- Parameters:
entities (
betty.model.Entity)- Return type:
- class betty.model.ancestry.AnonymousCitation[source]¶
Bases:
Citation- Parameters:
facts (
typing.Optional[typing.Iterable[betty.model.ancestry.HasCitations]])source (
betty.model.ancestry.Source|None)location (
betty.locale.Str|None)date (
betty.locale.Date|betty.locale.DateRange|None)files (
typing.Optional[typing.Iterable[betty.model.ancestry.File]])privacy (
betty.model.ancestry.Privacy|None)
- static __new__(*args, **kwargs)¶
- class betty.model.ancestry.AnonymousSource[source]¶
Bases:
Source- Parameters:
contained_by (
betty.model.ancestry.Source|None)contains (
typing.Optional[typing.Iterable[betty.model.ancestry.Source]])notes (
typing.Optional[typing.Iterable[betty.model.ancestry.Note]])date (
betty.locale.Date|betty.locale.DateRange|None)files (
typing.Optional[typing.Iterable[betty.model.ancestry.File]])links (
collections.abc.MutableSequence[betty.model.ancestry.Link] |None)privacy (
betty.model.ancestry.Privacy|None)
- static __new__(*args, **kwargs)¶
- class betty.model.ancestry.Attendee[source]¶
Bases:
PresenceRoleSomeone attended the event (further details unknown).
- class betty.model.ancestry.Beneficiary[source]¶
Bases:
PresenceRoleSomeone was a benificiary in the event, such as a
betty.model.event_type.Will.
- class betty.model.ancestry.Celebrant[source]¶
Bases:
PresenceRoleSomeone was the celebrant at the event.
This includes but is not limited to:
civil servant
religious leader
civilian
- class betty.model.ancestry.Citation[source]¶
Bases:
Dated,HasFiles,HasPrivacy,HasLinksEntity,UserFacingEntity,EntityA citation (a reference to a source).
- Parameters:
facts (
typing.Optional[typing.Iterable[betty.model.ancestry.HasCitations]])source (
betty.model.ancestry.Source|None)location (
betty.locale.Str|None)date (
betty.locale.Date|betty.locale.DateRange|None)files (
typing.Optional[typing.Iterable[betty.model.ancestry.File]])privacy (
betty.model.ancestry.Privacy|None)
- __init__(*, id: str | None = None, facts: Iterable[betty.model.ancestry.HasCitations] | None = None, source: betty.model.ancestry.Source | None = None, location: betty.locale.Str | None = None, date: betty.locale.Date | betty.locale.DateRange | None = None, files: Iterable[betty.model.ancestry.File] | None = None, privacy: betty.model.ancestry.Privacy | None = None, public: bool | None = None, private: bool | None = None)[source]¶
- Parameters:
facts (
typing.Optional[typing.Iterable[betty.model.ancestry.HasCitations]])source (
betty.model.ancestry.Source|None)location (
betty.locale.Str|None)date (
betty.locale.Date|betty.locale.DateRange|None)files (
typing.Optional[typing.Iterable[betty.model.ancestry.File]])privacy (
betty.model.ancestry.Privacy|None)
- async dump_linked_data(app: betty.app.App) dict[str, 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]]][source]¶
Dump this instance to JSON-LD.
- Parameters:
app (
betty.app.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() betty.locale.Str[source]¶
The human-readable entity type label, singular.
- Return type:
- classmethod entity_type_label_plural() betty.locale.Str[source]¶
The human-readable entity type label, plural.
- Return type:
- property facts: EntityCollection[AssociateT & Entity]¶
Get the associates from the given owner.
- Parameters:
owner (OwnerT & Entity)
- async classmethod linked_data_schema(app: betty.app.App) dict[str, 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]]][source]¶
Define the JSON Schema for
betty.json.linked_data.LinkedDataDumpable.dump_linked_data().- Parameters:
app (
betty.app.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¶
Get the associate from the given owner.
- Parameters:
owner (OwnerT & Entity)
- class betty.model.ancestry.Dated[source]¶
Bases:
LinkedDataDumpableA resource with date information.
- Parameters:
args (
typing.Any)date (
betty.locale.Date|betty.locale.DateRange|None)kwargs (
typing.Any)
- __init__(*args: Any, date: betty.locale.Date | betty.locale.DateRange | None = None, **kwargs: Any)[source]¶
- Parameters:
args (
typing.Any)date (
betty.locale.Date|betty.locale.DateRange|None)kwargs (
typing.Any)
- async dump_linked_data(app: betty.app.App) dict[str, 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]]][source]¶
Dump this instance to JSON-LD.
- Parameters:
app (
betty.app.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: betty.app.App) dict[str, 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]]][source]¶
Define the JSON Schema for
betty.json.linked_data.LinkedDataDumpable.dump_linked_data().- Parameters:
app (
betty.app.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[source]¶
Bases:
LinkedDataDumpableA resource with a description.
- Parameters:
args (
typing.Any)kwargs (
typing.Any)
- __init__(*args: Any, description: str | None = None, **kwargs: Any)[source]¶
- Parameters:
args (
typing.Any)kwargs (
typing.Any)
- async dump_linked_data(app: betty.app.App) dict[str, 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]]][source]¶
Dump this instance to JSON-LD.
- Parameters:
app (
betty.app.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: betty.app.App) dict[str, 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]]][source]¶
Define the JSON Schema for
betty.json.linked_data.LinkedDataDumpable.dump_linked_data().- Parameters:
app (
betty.app.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[source]¶
Bases:
Dated,HasCitations,EntityThe enclosure of one place by another.
Enclosures describe the outer (
`enclosed_by`) and inner(``encloses) places, and their relationship.- Parameters:
encloses (
betty.model.ancestry.Place|None)enclosed_by (
betty.model.ancestry.Place|None)
- __init__(encloses: betty.model.ancestry.Place | None = None, enclosed_by: betty.model.ancestry.Place | None = None)[source]¶
- Parameters:
encloses (
betty.model.ancestry.Place|None)enclosed_by (
betty.model.ancestry.Place|None)
- property enclosed_by: AssociateT & Entity | None¶
The outer place.
- Parameters:
owner (OwnerT & Entity)
- property encloses: AssociateT & Entity | None¶
The inner place.
- Parameters:
owner (OwnerT & Entity)
- classmethod entity_type_label() betty.locale.Str[source]¶
The human-readable entity type label, singular.
- Return type:
- classmethod entity_type_label_plural() betty.locale.Str[source]¶
The human-readable entity type label, plural.
- Return type:
- class betty.model.ancestry.Event[source]¶
Bases:
Dated,HasFiles,HasCitations,HasNotes,Described,HasPrivacy,HasLinksEntity,UserFacingEntity,EntityAn event that took place.
- Parameters:
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)place (
betty.model.ancestry.Place|None)
- __init__(*, id: str | None = None, event_type: type[betty.model.event_type.EventType] = <class 'betty.model.event_type.UnknownEventType'>, date: betty.locale.Date | betty.locale.DateRange | None = None, files: typing.Iterable[betty.model.ancestry.File] | None = None, citations: typing.Iterable[betty.model.ancestry.Citation] | None = None, notes: typing.Iterable[betty.model.ancestry.Note] | None = None, privacy: betty.model.ancestry.Privacy | None = None, public: bool | None = None, private: bool | None = None, place: betty.model.ancestry.Place | None = None, description: str | None = None)[source]¶
- Parameters:
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)place (
betty.model.ancestry.Place|None)
- property associated_files: Iterable[File]¶
All files directly or indirectly associated with this entity.
- async dump_linked_data(app: betty.app.App) dict[str, 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]]][source]¶
Dump this instance to JSON-LD.
- Parameters:
app (
betty.app.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() betty.locale.Str[source]¶
The human-readable entity type label, singular.
- Return type:
- classmethod entity_type_label_plural() betty.locale.Str[source]¶
The human-readable entity type label, plural.
- Return type:
- async classmethod linked_data_schema(app: betty.app.App) dict[str, 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]]][source]¶
Define the JSON Schema for
betty.json.linked_data.LinkedDataDumpable.dump_linked_data().- Parameters:
app (
betty.app.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¶
The place the event happened.
- Parameters:
owner (OwnerT & Entity)
- property presences: EntityCollection[AssociateT & Entity]¶
Get the associates from the given owner.
- Parameters:
owner (OwnerT & Entity)
- class betty.model.ancestry.File[source]¶
Bases:
Described,HasPrivacy,HasLinksEntity,HasMediaType,HasNotes,HasCitations,UserFacingEntity,EntityA file on disk.
This includes but is not limited to:
images
video
audio
PDF documents
- Parameters:
path (
pathlib.Path)media_type (
betty.media_type.MediaType|None)notes (
typing.Optional[typing.Iterable[betty.model.ancestry.Note]])citations (
typing.Optional[typing.Iterable[betty.model.ancestry.Citation]])privacy (
betty.model.ancestry.Privacy|None)links (
collections.abc.MutableSequence[betty.model.ancestry.Link] |None)
- __init__(path: pathlib.Path, *, id: str | None = None, name: str | None = None, media_type: betty.media_type.MediaType | None = None, description: str | None = None, notes: Iterable[betty.model.ancestry.Note] | None = None, citations: Iterable[betty.model.ancestry.Citation] | None = None, privacy: betty.model.ancestry.Privacy | None = None, public: bool | None = None, private: bool | None = None, links: collections.abc.MutableSequence[betty.model.ancestry.Link] | None = None)[source]¶
- Parameters:
path (
pathlib.Path)media_type (
betty.media_type.MediaType|None)notes (
typing.Optional[typing.Iterable[betty.model.ancestry.Note]])citations (
typing.Optional[typing.Iterable[betty.model.ancestry.Citation]])privacy (
betty.model.ancestry.Privacy|None)links (
collections.abc.MutableSequence[betty.model.ancestry.Link] |None)
- async dump_linked_data(app: betty.app.App) dict[str, 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]]][source]¶
Dump this instance to JSON-LD.
- Parameters:
app (
betty.app.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]¶
Get the associates from the given owner.
- Parameters:
owner (OwnerT & Entity)
- classmethod entity_type_label() betty.locale.Str[source]¶
The human-readable entity type label, singular.
- Return type:
- classmethod entity_type_label_plural() betty.locale.Str[source]¶
The human-readable entity type label, plural.
- Return type:
- async classmethod linked_data_schema(app: betty.app.App) dict[str, 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]]][source]¶
Define the JSON Schema for
betty.json.linked_data.LinkedDataDumpable.dump_linked_data().- Parameters:
app (
betty.app.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.HasCitations[source]¶
Bases:
LinkedDataDumpableAn entity with citations that support it.
- Parameters:
self (HasCitations & Entity)
args (Any)
citations (Iterable[Citation] | None)
kwargs (Any)
- __init__(*args: Any, citations: Iterable[Citation] | None = None, **kwargs: Any)[source]¶
- Parameters:
self (HasCitations & Entity)
args (Any)
citations (Iterable[Citation] | None)
kwargs (Any)
- property citations: EntityCollection[AssociateT & Entity]¶
Get the associates from the given owner.
- Parameters:
owner (OwnerT & Entity)
- async dump_linked_data(app: betty.app.App) dict[str, 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]]][source]¶
Dump this instance to JSON-LD.
- Parameters:
app (
betty.app.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: betty.app.App) dict[str, 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]]][source]¶
Define the JSON Schema for
betty.json.linked_data.LinkedDataDumpable.dump_linked_data().- Parameters:
app (
betty.app.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[source]¶
Bases:
objectAn entity that has associated
betty.model.ancestry.Fileentities.- Parameters:
self (HasFiles & Entity)
args (Any)
files (Iterable[File] | None)
kwargs (Any)
- __init__(*args: Any, files: Iterable[File] | None = None, **kwargs: Any)[source]¶
- Parameters:
self (HasFiles & Entity)
args (Any)
files (Iterable[File] | None)
kwargs (Any)
- property associated_files: Iterable[File]¶
All files directly or indirectly associated with this entity.
- property files: EntityCollection[AssociateT & Entity]¶
Get the associates from the given owner.
- Parameters:
owner (OwnerT & Entity)
- class betty.model.ancestry.HasLinks[source]¶
Bases:
LinkedDataDumpableA resource that has external links.
- Parameters:
args (
typing.Any)links (
collections.abc.MutableSequence[betty.model.ancestry.Link] |None)kwargs (
typing.Any)
- __init__(*args: Any, links: collections.abc.MutableSequence[betty.model.ancestry.Link] | None = None, **kwargs: Any)[source]¶
- Parameters:
args (
typing.Any)links (
collections.abc.MutableSequence[betty.model.ancestry.Link] |None)kwargs (
typing.Any)
- async dump_linked_data(app: betty.app.App) dict[str, 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]]][source]¶
Dump this instance to JSON-LD.
- Parameters:
app (
betty.app.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: betty.app.App) dict[str, 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]]][source]¶
Define the JSON Schema for
betty.json.linked_data.LinkedDataDumpable.dump_linked_data().- Parameters:
app (
betty.app.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]¶
The extenal links.
- class betty.model.ancestry.HasLinksEntity[source]¶
Bases:
HasLinksAn entity that has external links.
- Parameters:
args (
typing.Any)links (
collections.abc.MutableSequence[betty.model.ancestry.Link] |None)kwargs (
typing.Any)
- class betty.model.ancestry.HasMediaType[source]¶
Bases:
LinkedDataDumpableA resource with an IANA media type.
- Parameters:
args (
typing.Any)media_type (
betty.media_type.MediaType|None)kwargs (
typing.Any)
- __init__(*args: Any, media_type: betty.media_type.MediaType | None = None, **kwargs: Any)[source]¶
- Parameters:
args (
typing.Any)media_type (
betty.media_type.MediaType|None)kwargs (
typing.Any)
- async dump_linked_data(app: betty.app.App) dict[str, 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]]][source]¶
Dump this instance to JSON-LD.
- Parameters:
app (
betty.app.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: betty.app.App) dict[str, 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]]][source]¶
Define the JSON Schema for
betty.json.linked_data.LinkedDataDumpable.dump_linked_data().- Parameters:
app (
betty.app.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[source]¶
Bases:
LinkedDataDumpableAn entity that has notes associated with it.
- Parameters:
self (HasNotes & Entity)
args (Any)
notes (Iterable[Note] | None)
kwargs (Any)
- __init__(*args: Any, notes: Iterable[Note] | None = None, **kwargs: Any)[source]¶
- Parameters:
self (HasNotes & Entity)
args (Any)
notes (Iterable[Note] | None)
kwargs (Any)
- async dump_linked_data(app: betty.app.App) dict[str, 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]]][source]¶
Dump this instance to JSON-LD.
- Parameters:
app (
betty.app.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: betty.app.App) dict[str, 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]]][source]¶
Define the JSON Schema for
betty.json.linked_data.LinkedDataDumpable.dump_linked_data().- Parameters:
app (
betty.app.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]¶
Get the associates from the given owner.
- Parameters:
owner (OwnerT & Entity)
- class betty.model.ancestry.HasPrivacy[source]¶
Bases:
LinkedDataDumpableA resource that has privacy.
- Parameters:
args (
typing.Any)privacy (
betty.model.ancestry.Privacy|None)kwargs (
typing.Any)
- __init__(*args: Any, privacy: betty.model.ancestry.Privacy | None = None, public: bool | None = None, private: bool | None = None, **kwargs: Any)[source]¶
- Parameters:
args (
typing.Any)privacy (
betty.model.ancestry.Privacy|None)kwargs (
typing.Any)
- async dump_linked_data(app: betty.app.App) dict[str, 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]]][source]¶
Dump this instance to JSON-LD.
- Parameters:
app (
betty.app.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: betty.app.App) dict[str, 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]]][source]¶
Define the JSON Schema for
betty.json.linked_data.LinkedDataDumpable.dump_linked_data().- Parameters:
app (
betty.app.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¶
The resource’s own privacy.
This returns the value that was set for
betty.model.ancestry.HasPrivacy.privacyand ignores computed privacies.For access control and permissions checking, use
betty.model.ancestry.HasPrivacy.privacy.
- class betty.model.ancestry.Link[source]¶
Bases:
HasMediaType,Localized,Described,LinkedDataDumpableAn external link.
- Parameters:
- __init__(url: str, *, relationship: str | None = None, label: str | None = None, description: str | None = None, media_type: betty.media_type.MediaType | None = None, locale: str | None = None)[source]¶
- async dump_linked_data(app: betty.app.App) dict[str, 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]]][source]¶
Dump this instance to JSON-LD.
- Parameters:
app (
betty.app.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: betty.app.App) dict[str, 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]]][source]¶
Define the JSON Schema for
betty.json.linked_data.LinkedDataDumpable.dump_linked_data().- Parameters:
app (
betty.app.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:
str|None¶ The link’s IANA link relationship.
- class betty.model.ancestry.Note[source]¶
Bases:
UserFacingEntity,HasPrivacy,HasLinksEntity,EntityA note is a bit of textual information that can be associated with another entity.
- Parameters:
- __init__(text: str, *, id: str | None = None, entity: betty.model.ancestry.HasNotes | None = None, privacy: betty.model.ancestry.Privacy | None = None, public: bool | None = None, private: bool | None = None)[source]¶
- async dump_linked_data(app: betty.app.App) dict[str, 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]]][source]¶
Dump this instance to JSON-LD.
- Parameters:
app (
betty.app.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¶
The entity the note belongs to.
- Parameters:
owner (OwnerT & Entity)
- classmethod entity_type_label() betty.locale.Str[source]¶
The human-readable entity type label, singular.
- Return type:
- classmethod entity_type_label_plural() betty.locale.Str[source]¶
The human-readable entity type label, plural.
- Return type:
- async classmethod linked_data_schema(app: betty.app.App) dict[str, 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]]][source]¶
Define the JSON Schema for
betty.json.linked_data.LinkedDataDumpable.dump_linked_data().- Parameters:
app (
betty.app.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.Organizer[source]¶
Bases:
PresenceRoleSomeone organized the event.
- class betty.model.ancestry.Person[source]¶
Bases:
HasFiles,HasCitations,HasNotes,HasLinksEntity,HasPrivacy,UserFacingEntity,EntityA person.
- Parameters:
files (
typing.Optional[typing.Iterable[betty.model.ancestry.File]])citations (
typing.Optional[typing.Iterable[betty.model.ancestry.Citation]])links (
collections.abc.MutableSequence[betty.model.ancestry.Link] |None)notes (
typing.Optional[typing.Iterable[betty.model.ancestry.Note]])privacy (
betty.model.ancestry.Privacy|None)parents (
typing.Optional[typing.Iterable[betty.model.ancestry.Person]])children (
typing.Optional[typing.Iterable[betty.model.ancestry.Person]])presences (
typing.Optional[typing.Iterable[betty.model.ancestry.Presence]])names (
typing.Optional[typing.Iterable[betty.model.ancestry.PersonName]])
- __init__(*, id: str | None = None, files: Iterable[betty.model.ancestry.File] | None = None, citations: Iterable[betty.model.ancestry.Citation] | None = None, links: collections.abc.MutableSequence[betty.model.ancestry.Link] | None = None, notes: Iterable[betty.model.ancestry.Note] | None = None, privacy: betty.model.ancestry.Privacy | None = None, public: bool | None = None, private: bool | None = None, parents: Iterable[betty.model.ancestry.Person] | None = None, children: Iterable[betty.model.ancestry.Person] | None = None, presences: Iterable[betty.model.ancestry.Presence] | None = None, names: Iterable[betty.model.ancestry.PersonName] | None = None)[source]¶
- Parameters:
files (
typing.Optional[typing.Iterable[betty.model.ancestry.File]])citations (
typing.Optional[typing.Iterable[betty.model.ancestry.Citation]])links (
collections.abc.MutableSequence[betty.model.ancestry.Link] |None)notes (
typing.Optional[typing.Iterable[betty.model.ancestry.Note]])privacy (
betty.model.ancestry.Privacy|None)parents (
typing.Optional[typing.Iterable[betty.model.ancestry.Person]])children (
typing.Optional[typing.Iterable[betty.model.ancestry.Person]])presences (
typing.Optional[typing.Iterable[betty.model.ancestry.Presence]])names (
typing.Optional[typing.Iterable[betty.model.ancestry.PersonName]])
- property associated_files: Iterable[File]¶
All files directly or indirectly associated with this entity.
- property children: EntityCollection[AssociateT & Entity]¶
Get the associates from the given owner.
- Parameters:
owner (OwnerT & Entity)
- async dump_linked_data(app: betty.app.App) dict[str, 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]]][source]¶
Dump this instance to JSON-LD.
- Parameters:
app (
betty.app.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() betty.locale.Str[source]¶
The human-readable entity type label, singular.
- Return type:
- classmethod entity_type_label_plural() betty.locale.Str[source]¶
The human-readable entity type label, plural.
- Return type:
- async classmethod linked_data_schema(app: betty.app.App) dict[str, 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]]][source]¶
Define the JSON Schema for
betty.json.linked_data.LinkedDataDumpable.dump_linked_data().- Parameters:
app (
betty.app.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]¶
Get the associates from the given owner.
- Parameters:
owner (OwnerT & Entity)
- property parents: EntityCollection[AssociateT & Entity]¶
Get the associates from the given owner.
- Parameters:
owner (OwnerT & Entity)
- property presences: EntityCollection[AssociateT & Entity]¶
Get the associates from the given owner.
- Parameters:
owner (OwnerT & Entity)
- class betty.model.ancestry.PersonName[source]¶
Bases:
Localized,HasCitations,HasPrivacy,EntityA name for a
betty.model.ancestry.Person.- Parameters:
- __init__(*, id: str | None = None, person: betty.model.ancestry.Person | None = None, individual: str | None = None, affiliation: str | None = None, privacy: betty.model.ancestry.Privacy | None = None, public: bool | None = None, private: bool | None = None, locale: str | None = None)[source]¶
- property affiliation: str | None¶
The name’s affiliation, or family component.
Also known as:
last name
surname
- async dump_linked_data(app: betty.app.App) dict[str, 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]]][source]¶
Dump this instance to JSON-LD.
- Parameters:
app (
betty.app.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() betty.locale.Str[source]¶
The human-readable entity type label, singular.
- Return type:
- classmethod entity_type_label_plural() betty.locale.Str[source]¶
The human-readable entity type label, plural.
- Return type:
- property individual: str | None¶
The name’s individual component.
Also known as:
first name
given name
- async classmethod linked_data_schema(app: betty.app.App) dict[str, 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]]][source]¶
Define the JSON Schema for
betty.json.linked_data.LinkedDataDumpable.dump_linked_data().- Parameters:
app (
betty.app.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¶
The person whose name this is.
- Parameters:
owner (OwnerT & Entity)
- class betty.model.ancestry.Place[source]¶
Bases:
HasLinksEntity,HasFiles,HasNotes,HasPrivacy,UserFacingEntity,EntityA place.
A place is a physical location on earth. It may be identifiable by GPS coordinates only, or be a well-known city, with names in many languages, imagery, and its own Wikipedia page, or any type of place in between.
- Parameters:
names (
list[betty.model.ancestry.PlaceName] |None)events (
typing.Optional[typing.Iterable[betty.model.ancestry.Event]])enclosed_by (
typing.Optional[typing.Iterable[betty.model.ancestry.Enclosure]])encloses (
typing.Optional[typing.Iterable[betty.model.ancestry.Enclosure]])notes (
typing.Optional[typing.Iterable[betty.model.ancestry.Note]])coordinates (
geopy.point.Point|None)links (
collections.abc.MutableSequence[betty.model.ancestry.Link] |None)privacy (
betty.model.ancestry.Privacy|None)
- __init__(*, id: str | None = None, names: list[betty.model.ancestry.PlaceName] | None = None, events: Iterable[betty.model.ancestry.Event] | None = None, enclosed_by: Iterable[betty.model.ancestry.Enclosure] | None = None, encloses: Iterable[betty.model.ancestry.Enclosure] | None = None, notes: Iterable[betty.model.ancestry.Note] | None = None, coordinates: geopy.point.Point | None = None, links: collections.abc.MutableSequence[betty.model.ancestry.Link] | None = None, privacy: betty.model.ancestry.Privacy | None = None, public: bool | None = None, private: bool | None = None)[source]¶
- Parameters:
names (
list[betty.model.ancestry.PlaceName] |None)events (
typing.Optional[typing.Iterable[betty.model.ancestry.Event]])enclosed_by (
typing.Optional[typing.Iterable[betty.model.ancestry.Enclosure]])encloses (
typing.Optional[typing.Iterable[betty.model.ancestry.Enclosure]])notes (
typing.Optional[typing.Iterable[betty.model.ancestry.Note]])coordinates (
geopy.point.Point|None)links (
collections.abc.MutableSequence[betty.model.ancestry.Link] |None)privacy (
betty.model.ancestry.Privacy|None)
- property associated_files: Iterable[File]¶
All files directly or indirectly associated with this entity.
- async dump_linked_data(app: betty.app.App) dict[str, 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]]][source]¶
Dump this instance to JSON-LD.
- Parameters:
app (
betty.app.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]¶
Get the associates from the given owner.
- Parameters:
owner (OwnerT & Entity)
- property encloses: EntityCollection[AssociateT & Entity]¶
Get the associates from the given owner.
- Parameters:
owner (OwnerT & Entity)
- classmethod entity_type_label() betty.locale.Str[source]¶
The human-readable entity type label, singular.
- Return type:
- classmethod entity_type_label_plural() betty.locale.Str[source]¶
The human-readable entity type label, plural.
- Return type:
- property events: EntityCollection[AssociateT & Entity]¶
Get the associates from the given owner.
- Parameters:
owner (OwnerT & Entity)
- async classmethod linked_data_schema(app: betty.app.App) dict[str, 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]]][source]¶
Define the JSON Schema for
betty.json.linked_data.LinkedDataDumpable.dump_linked_data().- Parameters:
app (
betty.app.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.PlaceName[source]¶
Bases:
Localized,Dated,LinkedDataDumpableA place name.
A name has a locale and a date during which the name was in use.
- Parameters:
name (
str)date (
betty.locale.Date|betty.locale.DateRange|None)
- __init__(name: str, *, locale: str | None = None, date: betty.locale.Date | betty.locale.DateRange | None = None)[source]¶
- Parameters:
name (
str)date (
betty.locale.Date|betty.locale.DateRange|None)
- async dump_linked_data(app: betty.app.App) dict[str, 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]]][source]¶
Dump this instance to JSON-LD.
- Parameters:
app (
betty.app.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: betty.app.App) dict[str, 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]]][source]¶
Define the JSON Schema for
betty.json.linked_data.LinkedDataDumpable.dump_linked_data().- Parameters:
app (
betty.app.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.Presence[source]¶
Bases:
HasPrivacy,EntityThe presence of a
betty.model.ancestry.Personat anbetty.model.ancestry.Event.- Parameters:
person (
betty.model.ancestry.Person|None)event (
betty.model.ancestry.Event|None)
- __init__(person: betty.model.ancestry.Person | None, role: betty.model.ancestry.PresenceRole, event: betty.model.ancestry.Event | None)[source]¶
- Parameters:
person (
betty.model.ancestry.Person|None)event (
betty.model.ancestry.Event|None)
- classmethod entity_type_label() betty.locale.Str[source]¶
The human-readable entity type label, singular.
- Return type:
- classmethod entity_type_label_plural() betty.locale.Str[source]¶
The human-readable entity type label, plural.
- Return type:
- property event: AssociateT & Entity | None¶
The event the person was present at.
- Parameters:
owner (OwnerT & Entity)
- property person: AssociateT & Entity | None¶
The person whose presence is described.
- Parameters:
owner (OwnerT & Entity)
-
role:
betty.model.ancestry.PresenceRole¶ The role the person performed at the event.
- class betty.model.ancestry.Privacy[source]¶
Bases:
EnumThe available privacy modes.
- PRIVATE = 2¶
The resource is explicitly made private.
- PUBLIC = 1¶
The resource is explicitly made public.
- UNDETERMINED = 3¶
The resource has no explicit privacy. This means that:
it may be changed at will
when checking access, UNDETERMINED evaluates to PUBLIC.
- class betty.model.ancestry.Source[source]¶
Bases:
Dated,HasFiles,HasNotes,HasLinksEntity,HasPrivacy,UserFacingEntity,EntityA source of information.
- Parameters:
contained_by (
betty.model.ancestry.Source|None)contains (
typing.Optional[typing.Iterable[betty.model.ancestry.Source]])notes (
typing.Optional[typing.Iterable[betty.model.ancestry.Note]])date (
betty.locale.Date|betty.locale.DateRange|None)files (
typing.Optional[typing.Iterable[betty.model.ancestry.File]])links (
collections.abc.MutableSequence[betty.model.ancestry.Link] |None)privacy (
betty.model.ancestry.Privacy|None)
- __init__(name: str | None = None, *, id: str | None = None, author: str | None = None, publisher: str | None = None, contained_by: betty.model.ancestry.Source | None = None, contains: Iterable[betty.model.ancestry.Source] | None = None, notes: Iterable[betty.model.ancestry.Note] | None = None, date: betty.locale.Date | betty.locale.DateRange | None = None, files: Iterable[betty.model.ancestry.File] | None = None, links: collections.abc.MutableSequence[betty.model.ancestry.Link] | None = None, privacy: betty.model.ancestry.Privacy | None = None, public: bool | None = None, private: bool | None = None)[source]¶
- Parameters:
contained_by (
betty.model.ancestry.Source|None)contains (
typing.Optional[typing.Iterable[betty.model.ancestry.Source]])notes (
typing.Optional[typing.Iterable[betty.model.ancestry.Note]])date (
betty.locale.Date|betty.locale.DateRange|None)files (
typing.Optional[typing.Iterable[betty.model.ancestry.File]])links (
collections.abc.MutableSequence[betty.model.ancestry.Link] |None)privacy (
betty.model.ancestry.Privacy|None)
- property citations: EntityCollection[AssociateT & Entity]¶
Get the associates from the given owner.
- Parameters:
owner (OwnerT & Entity)
- property contained_by: AssociateT & Entity | None¶
The source this one is directly contained by.
- Parameters:
owner (OwnerT & Entity)
- property contains: EntityCollection[AssociateT & Entity]¶
Get the associates from the given owner.
- Parameters:
owner (OwnerT & Entity)
- async dump_linked_data(app: betty.app.App) dict[str, 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]]][source]¶
Dump this instance to JSON-LD.
- Parameters:
app (
betty.app.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() betty.locale.Str[source]¶
The human-readable entity type label, singular.
- Return type:
- classmethod entity_type_label_plural() betty.locale.Str[source]¶
The human-readable entity type label, plural.
- Return type:
- async classmethod linked_data_schema(app: betty.app.App) dict[str, 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]]][source]¶
Define the JSON Schema for
betty.json.linked_data.LinkedDataDumpable.dump_linked_data().- Parameters:
app (
betty.app.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:
PresenceRoleSomeone performed public speaking at the event.
- class betty.model.ancestry.Subject[source]¶
Bases:
PresenceRoleSomeone was the subject of the event.
The meaning of this role depends on the event type. For example, for
betty.model.event_type.Marriage, the subjects are the people who got married. Forbetty.model.event_type.Deathit is the person who died.
- class betty.model.ancestry.Witness[source]¶
Bases:
PresenceRoleSomeone witnessed the event.
- betty.model.ancestry.is_private(target: Any) bool[source]¶
Check if the given target is private.
- Parameters:
target (
typing.Any)- Return type:
- betty.model.ancestry.is_public(target: Any) bool[source]¶
Check if the given target is public.
- Parameters:
target (
typing.Any)- Return type:
- betty.model.ancestry.merge_privacies(*privacies: betty.model.ancestry.Privacy | betty.model.ancestry.HasPrivacy | None) betty.model.ancestry.Privacy[source]¶
Merge multiple privacies into one.
- Parameters:
privacies (
betty.model.ancestry.Privacy|betty.model.ancestry.HasPrivacy|None)- Return type:
- async betty.model.ancestry.ref_link(root_schema: dict[str, 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]]], app: betty.app.App) dict[str, 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]]][source]¶
Reference the Link schema.
- Parameters:
root_schema (
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]]]]])app (
betty.app.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: dict[str, 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]]], app: betty.app.App) dict[str, 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]]][source]¶
Reference the schema for a collection of Link instances.
- Parameters:
root_schema (
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]]]]])app (
betty.app.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: dict[str, 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]]]) dict[str, 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]]][source]¶
Reference the MediaType schema.
- Parameters:
root_schema (
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]]]]])- 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: dict[str, 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]]]) dict[str, 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]]][source]¶
Reference the PresenceRole schema.
- Parameters:
root_schema (
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]]]]])- 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: betty.model.ancestry.Privacy | betty.model.ancestry.HasPrivacy | None) betty.model.ancestry.Privacy[source]¶
Resolve the privacy of a value.
- Parameters:
privacy (
betty.model.ancestry.Privacy|betty.model.ancestry.HasPrivacy|None)- Return type: