org.models.meeting_item

Classes

MeetingItem	Extends the default Searchable class with sensible defaults
MeetingItemCollection	Abstract base class for generic types.

Module Contents

class org.models.meeting_item.MeetingItem

Bases: onegov.core.orm.Base, onegov.search.ORMSearchable

Extends the default Searchable class with sensible defaults for SQLAlchemy orm models.

__tablename__ = 'par_meeting_items'

es_public = True

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.

es_properties

Returns the type mapping of this model. Each property in the mapping will be read from the model instance.

The returned object needs to be a dict or an object that provides a to_dict method.

Internally, onegov.search stores differing languages in different indices. It does this automatically through langauge detection, or by manually specifying a language.

Note that objects with multiple languages are not supported (each object is supposed to have exactly one language).

Onegov.search will automatically insert the right analyzer for types like these.

There’s currently only limited support for properties here, namely objects and nested mappings do not work! This is going to be added in the future though.

property es_suggestion: str

Returns suggest-as-you-type value of the document. The field used for this property should also be indexed, or the suggestion will lead to nowhere.

If a single string is returned, the completion input equals the completion output. (My Title -> My Title)

If an array of strings is returned, all values are possible inputs and the first value is the output. (My Title/Title My -> My Title)

id: sqlalchemy.Column[uuid.UUID]

title: sqlalchemy.Column[str]

number: sqlalchemy.Column[str | None]

political_business_id: sqlalchemy.Column[uuid.UUID | None]

political_business: sqlalchemy.orm.relationship[onegov.org.models.PoliticalBusiness | None]

political_business_link_id: sqlalchemy.Column[str | None]

meeting_id: sqlalchemy.Column[uuid.UUID]

meeting: sqlalchemy.orm.relationship[onegov.org.models.Meeting]

property display_name: str

__repr__() → str

class org.models.meeting_item.MeetingItemCollection(session: sqlalchemy.orm.Session, **kwargs: Any)

Bases: onegov.core.collection.GenericCollection[MeetingItem]

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as:

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
    # Etc.

This class can then be used as follows:

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
    try:
        return mapping[key]
    except KeyError:
        return default

property model_class: type[MeetingItem]

query() → sqlalchemy.orm.Query[MeetingItem]