betty.model.event_type module

Provide Betty’s ancestry event types.

final class betty.model.event_type.Adoption[source]

Bases: DuringLifeEventType, _EventTypeShorthandBase

Someone was adopted.

final class betty.model.event_type.Baptism[source]

Bases: DuringLifeEventType, StartOfLifeEventType, _EventTypeShorthandBase

Someone was baptized.

final class betty.model.event_type.Birth[source]

Bases: CreatableDerivableEventType, StartOfLifeEventType, _EventTypeShorthandBase

Someone was born.

classmethod comes_before() → set[type[betty.model.event_type.EventType]][source]

Get the event types that this event type comes before.

The returned event types come after this event type.

Return type:

set[type[betty.model.event_type.EventType]]

final class betty.model.event_type.Burial[source]

Bases: FinalDispositionEventType, _EventTypeShorthandBase

Someone was buried.

final class betty.model.event_type.Conference[source]

Bases: _EventTypeShorthandBase, DuringLifeEventType

A conference between people took place.

final class betty.model.event_type.Confirmation[source]

Bases: _EventTypeShorthandBase, DuringLifeEventType

Someone’s confirmation took place.

final class betty.model.event_type.Correspondence[source]

Bases: _EventTypeShorthandBase

People corresponded with each other.

class betty.model.event_type.CreatableDerivableEventType[source]

Bases: DerivableEventType

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

classmethod may_create(person: betty.model.ancestry.Person, lifetime_threshold: int) → bool[source]

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

Parameters:
Return type:

bool

final class betty.model.event_type.Cremation[source]

Bases: FinalDispositionEventType, _EventTypeShorthandBase

Someone was cremated.

final class betty.model.event_type.Death[source]

Bases: CreatableDerivableEventType, EndOfLifeEventType, _EventTypeShorthandBase

Someone died.

classmethod comes_after() → set[type[betty.model.event_type.EventType]][source]

Get the event types that this event type comes after.

The returned event types come before this event type.

Return type:

set[type[betty.model.event_type.EventType]]

classmethod may_create(person: betty.model.ancestry.Person, lifetime_threshold: int) → bool[source]

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

Parameters:
Return type:

bool

class betty.model.event_type.DerivableEventType[source]

Bases: _EventTypeShorthandBase

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

final class betty.model.event_type.Divorce[source]

Bases: DuringLifeEventType, _EventTypeShorthandBase

People were divorced.

classmethod comes_after() → set[type[betty.model.event_type.EventType]][source]

Get the event types that this event type comes after.

The returned event types come before this event type.

Return type:

set[type[betty.model.event_type.EventType]]

final class betty.model.event_type.DivorceAnnouncement[source]

Bases: DuringLifeEventType, _EventTypeShorthandBase

People’s divorce was announced.

classmethod comes_after() → set[type[betty.model.event_type.EventType]][source]

Get the event types that this event type comes after.

The returned event types come before this event type.

Return type:

set[type[betty.model.event_type.EventType]]

classmethod comes_before() → set[type[betty.model.event_type.EventType]][source]

Get the event types that this event type comes before.

The returned event types come after this event type.

Return type:

set[type[betty.model.event_type.EventType]]

class betty.model.event_type.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[betty.model.event_type.EventType]][source]

Get the event types that this event type comes after.

The returned event types come before this event type.

Return type:

set[type[betty.model.event_type.EventType]]

classmethod comes_before() → set[type[betty.model.event_type.EventType]][source]

Get the event types that this event type comes before.

The returned event types come after this event type.

Return type:

set[type[betty.model.event_type.EventType]]

betty.model.event_type.ENTITY_TYPE_REPOSITORY: PluginRepository[EventType] = <betty.plugin.entry_point.EntryPointPluginRepository object>

The event type plugin repository.

final class betty.model.event_type.Emigration[source]

Bases: _EventTypeShorthandBase, DuringLifeEventType

Someone emigrated from a place.

class betty.model.event_type.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.model.event_type.Engagement[source]

Bases: DuringLifeEventType, _EventTypeShorthandBase

People got engaged with the intent to marry.

classmethod comes_before() → set[type[betty.model.event_type.EventType]][source]

Get the event types that this event type comes before.

The returned event types come after this event type.

Return type:

set[type[betty.model.event_type.EventType]]

class betty.model.event_type.EventType[source]

Bases: Plugin

Define an betty.model.ancestry.Event type.

classmethod comes_after() → set[type[betty.model.event_type.EventType]][source]

Get the event types that this event type comes after.

The returned event types come before this event type.

Return type:

set[type[betty.model.event_type.EventType]]

classmethod comes_before() → set[type[betty.model.event_type.EventType]][source]

Get the event types that this event type comes before.

The returned event types come after this event type.

Return type:

set[type[betty.model.event_type.EventType]]

class betty.model.event_type.FinalDispositionEventType[source]

Bases: PostDeathEventType, DerivableEventType, EndOfLifeEventType

Someone’s final disposition took place.

final class betty.model.event_type.Funeral[source]

Bases: FinalDispositionEventType, _EventTypeShorthandBase

Someone’s funeral took place.

final class betty.model.event_type.Immigration[source]

Bases: DuringLifeEventType, _EventTypeShorthandBase

Someone immigrated to a place.

final class betty.model.event_type.Marriage[source]

Bases: DuringLifeEventType, _EventTypeShorthandBase

People were married.

final class betty.model.event_type.MarriageAnnouncement[source]

Bases: DuringLifeEventType, _EventTypeShorthandBase

People’s marriage was announced.

classmethod comes_before() → set[type[betty.model.event_type.EventType]][source]

Get the event types that this event type comes before.

The returned event types come after this event type.

Return type:

set[type[betty.model.event_type.EventType]]

final class betty.model.event_type.Missing[source]

Bases: _EventTypeShorthandBase, DuringLifeEventType

Someone went missing.

final class betty.model.event_type.Occupation[source]

Bases: _EventTypeShorthandBase, DuringLifeEventType

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

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

class betty.model.event_type.PostDeathEventType[source]

Bases: EventType

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

classmethod comes_after() → set[type[betty.model.event_type.EventType]][source]

Get the event types that this event type comes after.

The returned event types come before this event type.

Return type:

set[type[betty.model.event_type.EventType]]

class betty.model.event_type.PreBirthEventType[source]

Bases: EventType

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

classmethod comes_before() → set[type[betty.model.event_type.EventType]][source]

Get the event types that this event type comes before.

The returned event types come after this event type.

Return type:

set[type[betty.model.event_type.EventType]]

final class betty.model.event_type.Residence[source]

Bases: DuringLifeEventType, _EventTypeShorthandBase

Someone resided/lived in a place.

final class betty.model.event_type.Retirement[source]

Bases: _EventTypeShorthandBase, DuringLifeEventType

Someone retired.

class betty.model.event_type.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.model.event_type.UnknownEventType[source]

Bases: _EventTypeShorthandBase

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

final class betty.model.event_type.Will[source]

Bases: PostDeathEventType, _EventTypeShorthandBase

Someone’s will and testament came into effect.