Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
View this page
Toggle table of contents sidebar

# betty.model.presence_role module

Provide presence roles.

final class betty.model.presence_role.Attendee

  Bases: `PresenceRole`

  Someone attended the event (further details unknown).

  classmethod plugin_id() → str

    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.

  classmethod plugin_label() → Localizable

    Get the human-readable short plugin label.

final class betty.model.presence_role.Beneficiary

  Bases: `PresenceRole`

  Someone was a benificiary in the event, such as a `betty.model.event_type.Will`.

  classmethod plugin_id() → str

    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.

  classmethod plugin_label() → Localizable

    Get the human-readable short plugin label.

final class betty.model.presence_role.Celebrant

  Bases: `PresenceRole`

  Someone was the celebrant at the event.

  This includes but is not limited to:

  - civil servant

  - religious leader

  - civilian

  classmethod plugin_id() → str

    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.

  classmethod plugin_label() → Localizable

    Get the human-readable short plugin label.

final class betty.model.presence_role.Organizer

  Bases: `PresenceRole`

  Someone organized the event.

  classmethod plugin_id() → str

    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.

  classmethod plugin_label() → Localizable

    Get the human-readable short plugin label.

betty.model.presence_role.PRESENCE_ROLE_REPOSITORY: PluginRepository[PresenceRole] = <betty.plugin.entry_point.EntryPointPluginRepository object>

  The presence role plugin repository.

  Read more about Presence role plugins.

class betty.model.presence_role.PresenceRole

  Bases: `Plugin`

  A person’s role at an event.

  Read more about Presence role plugins.

final class betty.model.presence_role.Speaker

  Bases: `PresenceRole`

  Someone performed public speaking at the event.

  classmethod plugin_id() → str

    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.

  classmethod plugin_label() → Localizable

    Get the human-readable short plugin label.

final class betty.model.presence_role.Subject

  Bases: `PresenceRole`

  Someone was the subject of the event.

  The meaning of this role depends on the event type. For example, for `betty.model.event_type.Marriage`, the subjects are the people who got married. For `betty.model.event_type.Death` it is the person who died.

  classmethod plugin_id() → str

    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.

  classmethod plugin_label() → Localizable

    Get the human-readable short plugin label.

final class betty.model.presence_role.Witness

  Bases: `PresenceRole`

  Someone witnessed the event.

  classmethod plugin_id() → str

    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.

  classmethod plugin_label() → Localizable

    Get the human-readable short plugin label.

betty.model.presence_role.ref_role(root_schema: MutableMapping[str, bool | int | float | str | None | MutableSequence[bool | int | float | str | None | MutableSequence[Dump] | MutableMapping[str, Dump]] | MutableMapping[str, bool | int | float | str | None | MutableSequence[Dump] | MutableMapping[str, Dump]]]) → MutableMapping[str, bool | int | float | str | None | MutableSequence[bool | int | float | str | None | MutableSequence[Dump] | MutableMapping[str, Dump]] | MutableMapping[str, bool | int | float | str | None | MutableSequence[Dump] | MutableMapping[str, Dump]]]

  Reference the PresenceRole schema.