betty.event_type module

Provide Betty’s ancestry event types.

class betty.event_type.EventType

Bases: Plugin[EventTypeDefinition]

Define an betty.entities.event.Event type.

final class betty.event_type.EventTypeDefinition

Bases: CountableHumanFacingDefinition, OrderedPluginClsDefinition[EventType]

The event type plugin type.

Plugin type ID

event-type

Definition

@EventTypeDefinition(...)

Built-in event types:

adoption (Adoption)
Adoption
baptism (Baptism)
Baptism
bar-mitzvah (BarMitzvah)
Bar mitzvah
bat-mitzvah (BatMitzvah)
Bat mitzvah
birth (Birth)
Birth
burial (Burial)
Burial
conference (Conference)
Conference
confirmation (Confirmation)
Confirmation
correspondence (Correspondence)
Correspondence
cremation (Cremation)
Cremation
death (Death)
Death
divorce (Divorce)
Divorce
divorce-announcement (DivorceAnnouncement)
Announcement of divorce
emigration (Emigration)
Emigration
engagement (Engagement)
Engagement
funeral (Funeral)
Funeral
immigration (Immigration)
Immigration
marriage (Marriage)
Marriage
marriage-announcement (MarriageAnnouncement)
Announcement of marriage
missing (Missing)
Missing
occupation (Occupation)
Occupation
residence (Residence)
Residence
retirement (Retirement)
Retirement
unknown (Unknown)
Unknown
will (Will)
Will
__init__(plugin_id: ResolvableMachineName, *, label: ResolvableLocalizable, label_plural: ResolvableLocalizable, label_countable: CountableLocalizable, description: ResolvableLocalizable | None = None, after: Order[EventTypeDefinition] = (), before: Order[EventTypeDefinition] = (), indicates: ResolvablePluginId[EventTypeDefinition] | None = None, requires: Requires = ())
property indicates: MachineName | None

Return whether events of this type (approximately) indicate that an event of the retuned type has happened.

static type() PluginTypeDefinition[Self]

The plugin type definition.

final class betty.event_type.EventTypeManufacturer

Bases: PluginManufacturer[EventTypeDefinition, EventType]

The event type manufacturer.

class betty.event_type.ShouldExistEventType

Bases: EventType, ABC

An event type that controls whether at least one event of this type should exist for a person.

abstractmethod async classmethod should_exist(project: Project, person: Person) bool

Whether at least one event of this type should exist for the given person.