betty.model.event_type module

Provide Betty’s ancestry event types.

class betty.model.event_type.Adoption[source]

Bases: DuringLifeEventType

Someone was adopted.

classmethod label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

classmethod name() str[source]

Get the machine name.

Return type:

str

class betty.model.event_type.Baptism[source]

Bases: DuringLifeEventType, StartOfLifeEventType

Someone was baptized.

classmethod label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

classmethod name() str[source]

Get the machine name.

Return type:

str

class betty.model.event_type.Birth[source]

Bases: CreatableDerivableEventType, StartOfLifeEventType

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]]

classmethod label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

classmethod name() str[source]

Get the machine name.

Return type:

str

class betty.model.event_type.Burial[source]

Bases: FinalDispositionEventType

Someone was buried.

classmethod label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

classmethod name() str[source]

Get the machine name.

Return type:

str

class betty.model.event_type.Conference[source]

Bases: DuringLifeEventType

A conference between people took place.

classmethod label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

classmethod name() str[source]

Get the machine name.

Return type:

str

class betty.model.event_type.Confirmation[source]

Bases: DuringLifeEventType

Someone’s confirmation took place.

classmethod label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

classmethod name() str[source]

Get the machine name.

Return type:

str

class betty.model.event_type.Correspondence[source]

Bases: EventType

People corresponded with each other.

classmethod label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

classmethod name() str[source]

Get the machine name.

Return type:

str

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

class betty.model.event_type.Cremation[source]

Bases: FinalDispositionEventType

Someone was cremated.

classmethod label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

classmethod name() str[source]

Get the machine name.

Return type:

str

class betty.model.event_type.Death[source]

Bases: CreatableDerivableEventType, EndOfLifeEventType

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 label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

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

classmethod name() str[source]

Get the machine name.

Return type:

str

class betty.model.event_type.DerivableEventType[source]

Bases: EventType

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

class betty.model.event_type.Divorce[source]

Bases: DuringLifeEventType

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]]

classmethod label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

classmethod name() str[source]

Get the machine name.

Return type:

str

class betty.model.event_type.DivorceAnnouncement[source]

Bases: DuringLifeEventType

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]]

classmethod label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

classmethod name() str[source]

Get the machine name.

Return type:

str

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]]

class betty.model.event_type.Emigration[source]

Bases: DuringLifeEventType

Someone emigrated from a place.

classmethod label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

classmethod name() str[source]

Get the machine name.

Return type:

str

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.

class betty.model.event_type.Engagement[source]

Bases: DuringLifeEventType

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]]

classmethod label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

classmethod name() str[source]

Get the machine name.

Return type:

str

class betty.model.event_type.EventType[source]

Bases: object

Define an betty.model.ancestry.Event type.

static __new__(cls)[source]
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]]

classmethod label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

classmethod name() str[source]

Get the machine name.

Return type:

str

class betty.model.event_type.EventTypeProvider[source]

Bases: object

Provide additional event types.

property entity_types: set[type[EventType]]

The event types.

class betty.model.event_type.FinalDispositionEventType[source]

Bases: PostDeathEventType, DerivableEventType, EndOfLifeEventType

Someone’s final disposition took place.

class betty.model.event_type.Funeral[source]

Bases: FinalDispositionEventType

Someone’s funeral took place.

classmethod label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

classmethod name() str[source]

Get the machine name.

Return type:

str

class betty.model.event_type.Immigration[source]

Bases: DuringLifeEventType

Someone immigrated to a place.

classmethod label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

classmethod name() str[source]

Get the machine name.

Return type:

str

class betty.model.event_type.Marriage[source]

Bases: DuringLifeEventType

People were married.

classmethod label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

classmethod name() str[source]

Get the machine name.

Return type:

str

class betty.model.event_type.MarriageAnnouncement[source]

Bases: DuringLifeEventType

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]]

classmethod label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

classmethod name() str[source]

Get the machine name.

Return type:

str

class betty.model.event_type.Missing[source]

Bases: DuringLifeEventType

Someone went missing.

classmethod label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

classmethod name() str[source]

Get the machine name.

Return type:

str

class betty.model.event_type.Occupation[source]

Bases: DuringLifeEventType

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

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

classmethod label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

classmethod name() str[source]

Get the machine name.

Return type:

str

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]]

class betty.model.event_type.Residence[source]

Bases: DuringLifeEventType

Someone resided/lived in a place.

classmethod label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

classmethod name() str[source]

Get the machine name.

Return type:

str

class betty.model.event_type.Retirement[source]

Bases: DuringLifeEventType

Someone retired.

classmethod label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

classmethod name() str[source]

Get the machine name.

Return type:

str

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.

class betty.model.event_type.UnknownEventType[source]

Bases: EventType

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

classmethod label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

classmethod name() str[source]

Get the machine name.

Return type:

str

class betty.model.event_type.Will[source]

Bases: PostDeathEventType

Someone’s will and testament came into effect.

classmethod label() betty.locale.Str[source]

Get the human-readable label.

Return type:

betty.locale.Str

classmethod name() str[source]

Get the machine name.

Return type:

str