notice.collections

Module Contents

Classes

OfficialNoticeCollection

Manage a list of official notices.

Functions

get_unique_notice_name(→ str)

Create a unique, URL-friendly name.

Attributes

_StrColumnLike
_N

notice.collections._StrColumnLike

notice.collections._N

notice.collections.get_unique_notice_name(name: str, session: sqlalchemy.orm.Session, model_class: type[onegov.notice.models.OfficialNotice]) → str

Create a unique, URL-friendly name.

class notice.collections.OfficialNoticeCollection(session: sqlalchemy.orm.Session, page: int = 0, state: NoticeState | None = None, term: str | None = None, order: str | None = None, direction: Literal[sqlalchemy.asc, sqlalchemy.desc] | None = None, issues: Collection[str] | None = None, categories: Collection[str] | None = None, organizations: Collection[str] | None = None, user_ids: list[uuid.UUID] | None = None, group_ids: list[uuid.UUID] | None = None)

Bases: onegov.core.collection.Pagination[_N]

Manage a list of official notices.

property page_index: int

Returns the current page index (starting at 0).

property model_class: type[_N]

property term_columns: list[_StrColumnLike]

The columns used for full text search.

__eq__(other: object) → bool

Returns True if the current and the other Pagination instance are equal. Used to find the current page in a list of pages.

subset() → Query[_N]

Returns an SQLAlchemy query containing all records that should be considered for pagination.

page_by_index(index: int) → typing_extensions.Self

Returns the page at the given index. A page here means an instance of the class inheriting from the Pagination base class.

for_state(state: onegov.notice.models.NoticeState) → typing_extensions.Self

Returns a new instance of the collection with the given state.

for_term(term: str | None) → typing_extensions.Self

Returns a new instance of the collection with the given term.

for_order(order: str, direction: Literal[sqlalchemy.asc, sqlalchemy.desc] | None = None) → typing_extensions.Self

Returns a new instance of the collection with the given ordering. Inverts the direction if the new ordering is the same as the old one and an explicit ordering is not defined.

for_organizations(organizations: Collection[str] | None) → typing_extensions.Self

Returns a new instance of the collection with the given organizations.

for_categories(categories: Collection[str] | None) → typing_extensions.Self

Returns a new instance of the collection with the given categories.

filter_query(query: Query[_N]) → Query[_N]

Filters the given query by the state of the collection.

order_query(query: Query[_N]) → Query[_N]

Orders the given query by the state of the collection.

query() → Query[_N]

Returns a filtered and sorted query.

Filters by: - notice.state matches state - notice.user_id is in user_ids - notice.group_id is in group_ids - notice.issues has any of the issues - term is in title, text, category, organization, groupname, usernames

Orders by: - any notice columns - group name (group.name) - users real name (user.realname) - username (user.username) - username or users real name (user.name)

_get_unique_name(name: str) → str

Create a unique, URL-friendly name.

add(title: str, text: str | None, **optional: Any) → _N

Add a new notice.

A unique, URL-friendly name is created automatically for this notice using the title and optionally numbers for duplicate names.

Returns the created notice.

delete(notice: onegov.notice.models.OfficialNotice) → None

Delete an notice.

by_name(name: str) → _N | None

Returns a notice by its URL-friendly name.

by_id(id: uuid.UUID) → _N | None

Returns a notice by its id.