directory.models.directory

Attributes

InheritType
INHERIT

Classes

_Sentinel	Create a collection of name/value pairs.
DirectoryFile	A general file (image, document, pdf, etc), referenced in the database.
Directory	A directory of entries that share a common data structure. For example,
EntryRecipient	Represents a single recipient.
EntrySubscription	Adds subscription management to a recipient.

Module Contents

type directory.models.directory.InheritType = 'Literal[_Sentinel.INHERIT]'

class directory.models.directory._Sentinel(*args, **kwds)

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

• attribute access:

>>> Color.RED
<Color.RED: 1>

• value lookup:

>>> Color(1)
<Color.RED: 1>

• name lookup:

>>> Color['RED']
<Color.RED: 1>

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

INHERIT

directory.models.directory.INHERIT

class directory.models.directory.DirectoryFile

Bases: onegov.file.File

A general file (image, document, pdf, etc), referenced in the database.

Thanks to the use of Depot files can be seemingly stored in the database (with transaction guarantees), without actually storing it in the database.

__mapper_args__

linked_directory_entries: sqlalchemy.orm.relationship[list[directory.models.directory_entry.DirectoryEntry]]

property directory_entry: directory.models.directory_entry.DirectoryEntry | None

property access: str

class directory.models.directory.Directory

Bases: onegov.core.orm.Base, onegov.core.orm.mixins.ContentMixin, onegov.core.orm.mixins.TimestampMixin, onegov.search.SearchableContent, onegov.file.MultiAssociatedFiles

A directory of entries that share a common data structure. For example, a directory of people, of emergency services or playgrounds.

__tablename__ = 'directories'

fts_properties

property fts_public: bool

Returns True if the model is available to be found by the public. If false, only editors/admins will see this object in the search results.

id: sqlalchemy.Column[uuid.UUID]

name: sqlalchemy.Column[str]

title: sqlalchemy.Column[str]

lead: sqlalchemy.Column[str | None]

order: sqlalchemy.Column[str]

type: sqlalchemy.Column[str]

structure: sqlalchemy.Column[str]

configuration: sqlalchemy.Column[directory.types.DirectoryConfiguration]

count() → sqlalchemy.sql.ColumnElement[int]

__mapper_args__

entries: sqlalchemy.orm.relationship[list[directory.models.directory_entry.DirectoryEntry]]

property entry_cls_name: str

property entry_cls: type[directory.models.directory_entry.DirectoryEntry]

add(values: dict[str, Any], type: str | InheritType = INHERIT) → directory.models.directory_entry.DirectoryEntry

add_by_form(form: DirectoryEntryForm, type: str | InheritType = INHERIT) → directory.models.directory_entry.DirectoryEntry

update(entry: directory.models.directory_entry.DirectoryEntry, values: collections.abc.Mapping[str, Any], set_name: bool = False, force_update: bool = False) → directory.models.directory_entry.DirectoryEntry

title_observer(title: str) → None

structure_configuration_observer(structure: str, configuration: directory.types.DirectoryConfiguration) → None

entry_with_name_exists(name: str) → bool

migration(new_structure: str, new_configuration: directory.types.DirectoryConfiguration | None) → onegov.directory.migration.DirectoryMigration

property fields: collections.abc.Sequence[onegov.form.parser.core.ParsedField]

static fields_from_structure(structure: str) → collections.abc.Sequence[onegov.form.parser.core.ParsedField]

property basic_fields: collections.abc.Sequence[onegov.form.parser.core.BasicParsedField]

property file_fields: collections.abc.Sequence[onegov.form.parser.core.FileParsedField]

field_by_id(id: str) → onegov.form.parser.core.ParsedField | None

property form_obj: DirectoryEntryForm

property form_class: type[DirectoryEntryForm]

form_obj_from_structure(structure: str) → DirectoryEntryForm

form_class_from_structure(structure: str) → type[Directory.form_class_from_structure.DirectoryEntryForm]

class directory.models.directory.EntryRecipient

Bases: onegov.core.orm.Base, onegov.core.orm.mixins.TimestampMixin, onegov.core.orm.mixins.ContentMixin

Represents a single recipient.

__tablename__ = 'entry_recipients'

id: sqlalchemy.Column[uuid.UUID]

address: sqlalchemy.Column[str]

validate_address(key: str, address: str) → str

token: sqlalchemy.Column[str]

confirmed: sqlalchemy.Column[bool]

property subscription: EntrySubscription

directory_id: sqlalchemy.Column[uuid.UUID]

property is_inactive: bool

Checks if the directory entry recipient’s email address is marked as inactive.

Returns:

bool: True if the email address is marked as inactive, False otherwise.

mark_inactive() → None

Marks the recipient’s email address as inactive.

This method sets the ‘inactive’ flag in the recipient’s metadata to True. It is typically used when a bounce event causes the email address to be deactivated by Postmark.

reactivate() → None

Marks a previously inactive recipient as active again.

class directory.models.directory.EntrySubscription(recipient: EntryRecipient, token: str)

Adds subscription management to a recipient.

recipient

token

property recipient_id: uuid.UUID

confirm() → bool

unsubscribe() → bool