betty.ancestry.event_type.event_types module

Provide Betty’s ancestry event types.

final class betty.ancestry.event_type.event_types.Adoption[source]

Bases: DuringLifeEventType, ShorthandPluginBase

Someone was adopted.

final class betty.ancestry.event_type.event_types.Baptism[source]

Bases: DuringLifeEventType, StartOfLifeEventType, ShorthandPluginBase

Someone was baptized.

final class betty.ancestry.event_type.event_types.BarMitzvah[source]

Bases: DuringLifeEventType, StartOfLifeEventType, ShorthandPluginBase

Someone’s bar mitzvah took place.

final class betty.ancestry.event_type.event_types.BatMitzvah[source]

Bases: DuringLifeEventType, StartOfLifeEventType, ShorthandPluginBase

Someone’s bat mitzvah took place.

final class betty.ancestry.event_type.event_types.Birth[source]

Bases: CreatableDerivableEventType, StartOfLifeEventType, ShorthandPluginBase

Someone was born.

classmethod comes_before() set[type[EventType] | str][source]

Get the plugins that this plugin comes before.

The returned plugins come after this plugin.

final class betty.ancestry.event_type.event_types.Burial[source]

Bases: FinalDispositionEventType, ShorthandPluginBase

Someone was buried.

final class betty.ancestry.event_type.event_types.Conference[source]

Bases: ShorthandPluginBase, DuringLifeEventType

A conference between people took place.

final class betty.ancestry.event_type.event_types.Confirmation[source]

Bases: ShorthandPluginBase, DuringLifeEventType

Someone’s confirmation took place.

final class betty.ancestry.event_type.event_types.Correspondence[source]

Bases: ShorthandPluginBase, EventType

People corresponded with each other.

class betty.ancestry.event_type.event_types.CreatableDerivableEventType[source]

Bases: DerivableEventType

Any event type of which the deriver API may create new instances.

classmethod may_create(person: Person, lifetime_threshold: int) bool[source]

Whether a new event of this type may be created for the given person.

final class betty.ancestry.event_type.event_types.Cremation[source]

Bases: FinalDispositionEventType, ShorthandPluginBase

Someone was cremated.

final class betty.ancestry.event_type.event_types.Death[source]

Bases: CreatableDerivableEventType, EndOfLifeEventType, ShorthandPluginBase

Someone died.

classmethod comes_after() set[type[EventType] | str][source]

Get the plugins that this plugin comes after.

The returned plugins come before this plugin.

classmethod may_create(person: Person, lifetime_threshold: int) bool[source]

Whether a new event of this type may be created for the given person.

class betty.ancestry.event_type.event_types.DerivableEventType[source]

Bases: EventType

Any event that that may be updated by the deriver API.

final class betty.ancestry.event_type.event_types.Divorce[source]

Bases: DuringLifeEventType, ShorthandPluginBase

People were divorced.

classmethod comes_after() set[type[EventType] | str][source]

Get the plugins that this plugin comes after.

The returned plugins come before this plugin.

final class betty.ancestry.event_type.event_types.DivorceAnnouncement[source]

Bases: DuringLifeEventType, ShorthandPluginBase

People’s divorce was announced.

classmethod comes_after() set[type[EventType] | str][source]

Get the plugins that this plugin comes after.

The returned plugins come before this plugin.

classmethod comes_before() set[type[EventType] | str][source]

Get the plugins that this plugin comes before.

The returned plugins come after this plugin.

class betty.ancestry.event_type.event_types.DuringLifeEventType[source]

Bases: EventType

Any event that only ever takes place during someone’s life, e.g. after their birth and before their death.

classmethod comes_after() set[type[EventType] | str][source]

Get the plugins that this plugin comes after.

The returned plugins come before this plugin.

classmethod comes_before() set[type[EventType] | str][source]

Get the plugins that this plugin comes before.

The returned plugins come after this plugin.

final class betty.ancestry.event_type.event_types.Emigration[source]

Bases: ShorthandPluginBase, DuringLifeEventType

Someone emigrated from a place.

class betty.ancestry.event_type.event_types.EndOfLifeEventType[source]

Bases: EventType

An event that indicates the end of someone’s life.

This includes someone’s actual death, but also other types of events that take place close to someone’s death and as such are indicators that that person died around the time of the end-of-life event.

final class betty.ancestry.event_type.event_types.Engagement[source]

Bases: DuringLifeEventType, ShorthandPluginBase

People got engaged with the intent to marry.

classmethod comes_before() set[type[EventType] | str][source]

Get the plugins that this plugin comes before.

The returned plugins come after this plugin.

class betty.ancestry.event_type.event_types.FinalDispositionEventType[source]

Bases: PostDeathEventType, DerivableEventType, EndOfLifeEventType

Someone’s final disposition took place.

final class betty.ancestry.event_type.event_types.Funeral[source]

Bases: FinalDispositionEventType, ShorthandPluginBase

Someone’s funeral took place.

final class betty.ancestry.event_type.event_types.Immigration[source]

Bases: DuringLifeEventType, ShorthandPluginBase

Someone immigrated to a place.

final class betty.ancestry.event_type.event_types.Marriage[source]

Bases: DuringLifeEventType, ShorthandPluginBase

People were married.

final class betty.ancestry.event_type.event_types.MarriageAnnouncement[source]

Bases: DuringLifeEventType, ShorthandPluginBase

People’s marriage was announced.

classmethod comes_before() set[type[EventType] | str][source]

Get the plugins that this plugin comes before.

The returned plugins come after this plugin.

final class betty.ancestry.event_type.event_types.Missing[source]

Bases: ShorthandPluginBase, DuringLifeEventType

Someone went missing.

final class betty.ancestry.event_type.event_types.Occupation[source]

Bases: ShorthandPluginBase, DuringLifeEventType

Someone’s occupation, e.g. their main recurring activity.

This may include employment, education, stay at home parent, etc.

class betty.ancestry.event_type.event_types.PostDeathEventType[source]

Bases: EventType

An event that only ever happens after someone’s death.

classmethod comes_after() set[type[EventType] | str][source]

Get the plugins that this plugin comes after.

The returned plugins come before this plugin.

class betty.ancestry.event_type.event_types.PreBirthEventType[source]

Bases: EventType

Any event that only ever takes place before someone’s birth.

classmethod comes_before() set[type[EventType] | str][source]

Get the plugins that this plugin comes before.

The returned plugins come after this plugin.

final class betty.ancestry.event_type.event_types.Residence[source]

Bases: DuringLifeEventType, ShorthandPluginBase

Someone resided/lived in a place.

final class betty.ancestry.event_type.event_types.Retirement[source]

Bases: ShorthandPluginBase, DuringLifeEventType

Someone retired.

class betty.ancestry.event_type.event_types.StartOfLifeEventType[source]

Bases: EventType

An event that indicates the start of someone’s life.

This includes someone’s actual birth, but also other types of events that take place close to someone’s birth and as such are indicators that that person was born around the time of the start-of-life event.

final class betty.ancestry.event_type.event_types.Unknown[source]

Bases: ShorthandPluginBase, EventType

Describe an event for which no more specific type is known.

final class betty.ancestry.event_type.event_types.Will[source]

Bases: PostDeathEventType, ShorthandPluginBase

Someone’s will and testament came into effect.