betty.model.ancestry module¶

Provide Betty’s main data model.

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

Bases: MultipleTypesEntityCollection[Entity]

An ancestry contains all the entities of a single family tree/genealogical data set.

__init__()[source]¶

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:: None

final class betty.model.ancestry.Citation[source]¶

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

A citation (a reference to a source).

Parameters:

id (str | None)
facts (typing.Optional[typing.Iterable[betty.model.ancestry.HasCitations]])
source (betty.model.ancestry.Source | None)
location (betty.locale.localizable.Localizable | None)
date (betty.locale.Date | betty.locale.DateRange | None)
files (typing.Optional[typing.Iterable[betty.model.ancestry.File]])
privacy (betty.model.ancestry.Privacy | None)
public (bool | None)
private (bool | None)

Parameters:

id (str | None)
facts (typing.Optional[typing.Iterable[betty.model.ancestry.HasCitations]])
source (betty.model.ancestry.Source | None)
location (betty.locale.localizable.Localizable | None)
date (betty.locale.Date | betty.locale.DateRange | None)
files (typing.Optional[typing.Iterable[betty.model.ancestry.File]])
privacy (betty.model.ancestry.Privacy | None)
public (bool | None)
private (bool | None)

Dump this instance to JSON-LD.

Parameters:: project (betty.project.Project)
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 facts: EntityCollection[_AssociateT & Entity]¶

Get the associates from the given owner.

Parameters:: owner (_OwnerT & Entity)

property label: Localizable¶: The entity’s human-readable label.

Define the JSON Schema for betty.json.linked_data.LinkedDataDumpable.dump_linked_data().

Parameters:: project (betty.project.Project)
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 plugin_id() → str[source]¶

Get the plugin ID.

IDs are unique per plugin type: - A plugin repository MUST at most have a single plugin for any ID. - Different plugin repositories MAY each have a plugin with the same ID.

Return type:: str

classmethod plugin_label() → betty.locale.localizable.Localizable[source]¶

Get the human-readable short plugin label.

Return type:: betty.locale.localizable.Localizable

classmethod plugin_label_plural() → betty.locale.localizable.Localizable[source]¶

The human-readable entity type label, plural.

Return type:: betty.locale.localizable.Localizable

property source: _AssociateT & Entity | None¶

Get the associate from the given owner.

Parameters:: owner (_OwnerT & Entity)

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

Bases: LinkedDataDumpable

A 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)

Dump this instance to JSON-LD.

Parameters:: project (betty.project.Project)
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]]]]]

Define the JSON Schema for betty.json.linked_data.LinkedDataDumpable.dump_linked_data().

Parameters:: project (betty.project.Project)
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: LinkedDataDumpable

A resource with a description.

Parameters:

args (typing.Any)
description (str | None)
kwargs (typing.Any)

__init__(*args: Any, description: str | None = None, **kwargs: Any)[source]¶

Parameters:

args (typing.Any)
description (str | None)
kwargs (typing.Any)

description: str | None¶: The human-readable description.

Dump this instance to JSON-LD.

Parameters:: project (betty.project.Project)
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]]]]]

Define the JSON Schema for betty.json.linked_data.LinkedDataDumpable.dump_linked_data().

Parameters:: project (betty.project.Project)
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]]]]]

final class betty.model.ancestry.Enclosure[source]¶

Bases: Dated, HasCitations, Entity

The 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 plugin_id() → str[source]¶

Get the plugin ID.

IDs are unique per plugin type: - A plugin repository MUST at most have a single plugin for any ID. - Different plugin repositories MAY each have a plugin with the same ID.

Return type:: str

classmethod plugin_label() → betty.locale.localizable.Localizable[source]¶

Get the human-readable short plugin label.

Return type:: betty.locale.localizable.Localizable

classmethod plugin_label_plural() → betty.locale.localizable.Localizable[source]¶

The human-readable entity type label, plural.

Return type:: betty.locale.localizable.Localizable

final class betty.model.ancestry.Event[source]¶

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

An event that took place.

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)

__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:

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)

Dump this instance to JSON-LD.

Parameters:: project (betty.project.Project)
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 event_type: type[EventType]¶: The type of event.

property label: Localizable¶: The entity’s human-readable label.

Define the JSON Schema for betty.json.linked_data.LinkedDataDumpable.dump_linked_data().

Parameters:: project (betty.project.Project)
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)

classmethod plugin_id() → str[source]¶

Get the plugin ID.

IDs are unique per plugin type: - A plugin repository MUST at most have a single plugin for any ID. - Different plugin repositories MAY each have a plugin with the same ID.

Return type:: str

classmethod plugin_label() → betty.locale.localizable.Localizable[source]¶

Get the human-readable short plugin label.

Return type:: betty.locale.localizable.Localizable

classmethod plugin_label_plural() → betty.locale.localizable.Localizable[source]¶

The human-readable entity type label, plural.

Return type:: betty.locale.localizable.Localizable

property presences: EntityCollection[_AssociateT & Entity]¶

Get the associates from the given owner.

Parameters:: owner (_OwnerT & Entity)

final class betty.model.ancestry.File[source]¶

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

A file on disk.

This includes but is not limited to:

images
video
audio
PDF documents

Parameters:

path (pathlib.Path)
id (str | None)
name (str | None)
media_type (betty.media_type.MediaType | None)
description (str | 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)
public (bool | None)
private (bool | 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)
id (str | None)
name (str | None)
media_type (betty.media_type.MediaType | None)
description (str | 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)
public (bool | None)
private (bool | None)
links (collections.abc.MutableSequence[betty.model.ancestry.Link] | None)

Dump this instance to JSON-LD.

Parameters:: project (betty.project.Project)
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)

property label: Localizable¶: The entity’s human-readable label.

Define the JSON Schema for betty.json.linked_data.LinkedDataDumpable.dump_linked_data().

Parameters:: project (betty.project.Project)
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¶: The file name.

property path: Path¶: The file’s path on disk.

classmethod plugin_id() → str[source]¶

Get the plugin ID.

IDs are unique per plugin type: - A plugin repository MUST at most have a single plugin for any ID. - Different plugin repositories MAY each have a plugin with the same ID.

Return type:: str

classmethod plugin_label() → betty.locale.localizable.Localizable[source]¶

Get the human-readable short plugin label.

Return type:: betty.locale.localizable.Localizable

classmethod plugin_label_plural() → betty.locale.localizable.Localizable[source]¶

The human-readable entity type label, plural.

Return type:: betty.locale.localizable.Localizable

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

Bases: LinkedDataDumpable

An 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)

Dump this instance to JSON-LD.

Parameters:: project (betty.project.Project)
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]]]]]

Define the JSON Schema for betty.json.linked_data.LinkedDataDumpable.dump_linked_data().

Parameters:: project (betty.project.Project)
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: object

An entity that has associated betty.model.ancestry.File entities.

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 files: EntityCollection[_AssociateT & Entity]¶

Get the associates from the given owner.

Parameters:: owner (_OwnerT & Entity)

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

Bases: LinkedDataDumpable

A 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)

Dump this instance to JSON-LD.

Parameters:: project (betty.project.Project)
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]]]]]

Define the JSON Schema for betty.json.linked_data.LinkedDataDumpable.dump_linked_data().

Parameters:: project (betty.project.Project)
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: HasLinks

An entity that has external links.

Parameters:

args (typing.Any)
links (collections.abc.MutableSequence[betty.model.ancestry.Link] | None)
kwargs (typing.Any)

async dump_linked_data(project: Project) → DictDump[Dump][source]¶

Dump this instance to JSON-LD.

Parameters:

self (HasLinksEntity & Entity)
project (Project)

Return type:

DictDump[Dump]

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

Bases: LinkedDataDumpable

A 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)

Dump this instance to JSON-LD.

Parameters:: project (betty.project.Project)
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]]]]]

Define the JSON Schema for betty.json.linked_data.LinkedDataDumpable.dump_linked_data().

Parameters:: project (betty.project.Project)
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: LinkedDataDumpable

An 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)

Dump this instance to JSON-LD.

Parameters:: project (betty.project.Project)
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]]]]]

Define the JSON Schema for betty.json.linked_data.LinkedDataDumpable.dump_linked_data().

Parameters:: project (betty.project.Project)
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: LinkedDataDumpable

A resource that has privacy.

Parameters:

args (typing.Any)
privacy (betty.model.ancestry.Privacy | None)
public (bool | None)
private (bool | 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)
public (bool | None)
private (bool | None)
kwargs (typing.Any)

Dump this instance to JSON-LD.

Parameters:: project (betty.project.Project)
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]]]]]

Define the JSON Schema for betty.json.linked_data.LinkedDataDumpable.dump_linked_data().

Parameters:: project (betty.project.Project)
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.privacy and ignores computed privacies.

For access control and permissions checking, use betty.model.ancestry.HasPrivacy.privacy.

property privacy: Privacy¶: The resource’s privacy.

property private: bool¶: Whether this resource is private.

property public: bool¶: Whether this resource is public.

final class betty.model.ancestry.Link[source]¶

Bases: HasMediaType, Localized, Described, LinkedDataDumpable

An external link.

Parameters:

url (str)
relationship (str | None)
label (str | None)
description (str | None)
media_type (betty.media_type.MediaType | None)
locale (str | None)

Parameters:

url (str)
relationship (str | None)
label (str | None)
description (str | None)
media_type (betty.media_type.MediaType | None)
locale (str | None)

Dump this instance to JSON-LD.

Parameters:: project (betty.project.Project)
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: str | None¶: The link’s human-readable label.

Define the JSON Schema for betty.json.linked_data.LinkedDataDumpable.dump_linked_data().

Parameters:: project (betty.project.Project)
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.

url: str¶: The link’s absolute URL

final class betty.model.ancestry.Note[source]¶

Bases: UserFacingEntity, HasPrivacy, HasLinksEntity, Entity

A note is a bit of textual information that can be associated with another entity.

Parameters:

text (str)
id (str | None)
entity (betty.model.ancestry.HasNotes | None)
privacy (betty.model.ancestry.Privacy | None)
public (bool | None)
private (bool | None)

Parameters:

text (str)
id (str | None)
entity (betty.model.ancestry.HasNotes | None)
privacy (betty.model.ancestry.Privacy | None)
public (bool | None)
private (bool | None)

Dump this instance to JSON-LD.

Parameters:: project (betty.project.Project)
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)

property label: Localizable¶: The entity’s human-readable label.

Define the JSON Schema for betty.json.linked_data.LinkedDataDumpable.dump_linked_data().

Parameters:: project (betty.project.Project)
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 plugin_id() → str[source]¶

Get the plugin ID.

IDs are unique per plugin type: - A plugin repository MUST at most have a single plugin for any ID. - Different plugin repositories MAY each have a plugin with the same ID.

Return type:: str

classmethod plugin_label() → betty.locale.localizable.Localizable[source]¶

Get the human-readable short plugin label.

Return type:: betty.locale.localizable.Localizable

classmethod plugin_label_plural() → betty.locale.localizable.Localizable[source]¶

The human-readable entity type label, plural.

Return type:: betty.locale.localizable.Localizable

property text: str¶: The note’s human-readable text.

final class betty.model.ancestry.Person[source]¶

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

A person.

Parameters:

id (str | None)
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)
public (bool | None)
private (bool | 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]])

Parameters:

id (str | None)
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)
public (bool | None)
private (bool | 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 ancestors: Iterator[Person]¶: All ancestors.

property children: EntityCollection[_AssociateT & Entity]¶

Get the associates from the given owner.

Parameters:: owner (_OwnerT & Entity)

property descendants: Iterator[Person]¶: All descendants.

Dump this instance to JSON-LD.

Parameters:: project (betty.project.Project)
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 label: Localizable¶: The entity’s human-readable label.

Define the JSON Schema for betty.json.linked_data.LinkedDataDumpable.dump_linked_data().

Parameters:: project (betty.project.Project)
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)

classmethod plugin_id() → str[source]¶

Get the plugin ID.

IDs are unique per plugin type: - A plugin repository MUST at most have a single plugin for any ID. - Different plugin repositories MAY each have a plugin with the same ID.

Return type:: str

classmethod plugin_label() → betty.locale.localizable.Localizable[source]¶

Get the human-readable short plugin label.

Return type:: betty.locale.localizable.Localizable

classmethod plugin_label_plural() → betty.locale.localizable.Localizable[source]¶

The human-readable entity type label, plural.

Return type:: betty.locale.localizable.Localizable

property presences: EntityCollection[_AssociateT & Entity]¶

Get the associates from the given owner.

Parameters:: owner (_OwnerT & Entity)

property siblings: list[Person]¶: All siblings.

final class betty.model.ancestry.PersonName[source]¶

Bases: Localized, HasCitations, HasPrivacy, Entity

A name for a betty.model.ancestry.Person.

Parameters:

id (str | None)
person (betty.model.ancestry.Person | None)
individual (str | None)
affiliation (str | None)
privacy (betty.model.ancestry.Privacy | None)
public (bool | None)
private (bool | None)
locale (str | None)

Parameters:

id (str | None)
person (betty.model.ancestry.Person | None)
individual (str | None)
affiliation (str | None)
privacy (betty.model.ancestry.Privacy | None)
public (bool | None)
private (bool | None)
locale (str | None)

property affiliation: str | None¶

The name’s affiliation, or family component.

Also known as:

last name
surname

Dump this instance to JSON-LD.

Parameters:: project (betty.project.Project)
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 individual: str | None¶

The name’s individual component.

Also known as:

first name
given name

property label: Localizable¶: The entity’s human-readable label.

Define the JSON Schema for betty.json.linked_data.LinkedDataDumpable.dump_linked_data().

Parameters:: project (betty.project.Project)
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)

classmethod plugin_id() → str[source]¶

Get the plugin ID.

IDs are unique per plugin type: - A plugin repository MUST at most have a single plugin for any ID. - Different plugin repositories MAY each have a plugin with the same ID.

Return type:: str

classmethod plugin_label() → betty.locale.localizable.Localizable[source]¶

Get the human-readable short plugin label.

Return type:: betty.locale.localizable.Localizable

classmethod plugin_label_plural() → betty.locale.localizable.Localizable[source]¶

The human-readable entity type label, plural.

Return type:: betty.locale.localizable.Localizable

final class betty.model.ancestry.Place[source]¶

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

A 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:

id (str | None)
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)
public (bool | None)
private (bool | 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:

id (str | None)
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)
public (bool | None)
private (bool | None)

property coordinates: Point | None¶: The place’s coordinates.

Dump this instance to JSON-LD.

Parameters:: project (betty.project.Project)
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)

property events: EntityCollection[_AssociateT & Entity]¶

Get the associates from the given owner.

Parameters:: owner (_OwnerT & Entity)

property label: Localizable¶: The entity’s human-readable label.

Define the JSON Schema for betty.json.linked_data.LinkedDataDumpable.dump_linked_data().

Parameters:: project (betty.project.Project)
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]¶: The place’s names.

classmethod plugin_id() → str[source]¶

Get the plugin ID.

IDs are unique per plugin type: - A plugin repository MUST at most have a single plugin for any ID. - Different plugin repositories MAY each have a plugin with the same ID.

Return type:: str

classmethod plugin_label() → betty.locale.localizable.Localizable[source]¶

Get the human-readable short plugin label.

Return type:: betty.locale.localizable.Localizable

classmethod plugin_label_plural() → betty.locale.localizable.Localizable[source]¶

The human-readable entity type label, plural.

Return type:: betty.locale.localizable.Localizable

property walk_encloses: Iterator[Enclosure]¶: All enclosed places.

final class betty.model.ancestry.PlaceName[source]¶

Bases: Localized, Dated, LinkedDataDumpable

A place name.

A name has a locale and a date during which the name was in use.

Parameters:

name (str)
locale (str | None)
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)
locale (str | None)
date (betty.locale.Date | betty.locale.DateRange | None)

Dump this instance to JSON-LD.

Parameters:: project (betty.project.Project)
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]]]]]

Define the JSON Schema for betty.json.linked_data.LinkedDataDumpable.dump_linked_data().

Parameters:: project (betty.project.Project)
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¶: The human-readable name.

final class betty.model.ancestry.Presence[source]¶

Bases: HasPrivacy, Entity

The presence of a betty.model.ancestry.Person at an betty.model.ancestry.Event.

Parameters:

person (betty.model.ancestry.Person | None)
role (betty.model.presence_role.PresenceRole)
event (betty.model.ancestry.Event | None)

__init__(person: betty.model.ancestry.Person | None, role: betty.model.presence_role.PresenceRole, event: betty.model.ancestry.Event | None)[source]¶

Parameters:

person (betty.model.ancestry.Person | None)
role (betty.model.presence_role.PresenceRole)
event (betty.model.ancestry.Event | None)

property event: _AssociateT & Entity | None¶

The event the person was present at.

Parameters:: owner (_OwnerT & Entity)

property label: Localizable¶: The entity’s human-readable label.

property person: _AssociateT & Entity | None¶

The person whose presence is described.

Parameters:: owner (_OwnerT & Entity)

classmethod plugin_id() → str[source]¶

Get the plugin ID.

IDs are unique per plugin type: - A plugin repository MUST at most have a single plugin for any ID. - Different plugin repositories MAY each have a plugin with the same ID.

Return type:: str

classmethod plugin_label() → betty.locale.localizable.Localizable[source]¶

Get the human-readable short plugin label.

Return type:: betty.locale.localizable.Localizable

classmethod plugin_label_plural() → betty.locale.localizable.Localizable[source]¶

The human-readable entity type label, plural.

Return type:: betty.locale.localizable.Localizable

role: betty.model.presence_role.PresenceRole¶: The role the person performed at the event.

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

Bases: Enum

The 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.

final class betty.model.ancestry.Source[source]¶

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

A source of information.

Parameters:

name (str | None)
id (str | None)
author (str | None)
publisher (str | None)
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)
public (bool | None)
private (bool | None)

Parameters:

name (str | None)
id (str | None)
author (str | None)
publisher (str | None)
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)
public (bool | None)
private (bool | 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)

Dump this instance to JSON-LD.

Parameters:: project (betty.project.Project)
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 label: Localizable¶: The entity’s human-readable label.

Define the JSON Schema for betty.json.linked_data.LinkedDataDumpable.dump_linked_data().

Parameters:: project (betty.project.Project)
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 plugin_id() → str[source]¶

Get the plugin ID.

IDs are unique per plugin type: - A plugin repository MUST at most have a single plugin for any ID. - Different plugin repositories MAY each have a plugin with the same ID.