fsi.collections.attendee

Module Contents

Classes

CourseAttendeeCollection

Abstract base class for generic types.

class fsi.collections.attendee.CourseAttendeeCollection(session: sqlalchemy.orm.Session, page: int = 0, exclude_external: bool = False, external_only: bool = False, auth_attendee: onegov.fsi.models.course_attendee.CourseAttendee | None = None, editors_only: bool = False, admins_only: bool = False)

Bases: onegov.core.collection.GenericCollection[onegov.fsi.models.course_attendee.CourseAttendee], onegov.core.collection.Pagination[onegov.fsi.models.course_attendee.CourseAttendee]

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 unfiltered: bool

property model_class: type[onegov.fsi.models.course_attendee.CourseAttendee]

property attendee_permissions: list[str]

property page_index: int

Returns the current page index (starting at 0).

__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.

query() → Query[CourseAttendee]

subset() → Query[CourseAttendee]

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.

add_from_user(user: onegov.user.User) → onegov.fsi.models.course_attendee.CourseAttendee

by_id(id: uuid.UUID) → onegov.fsi.models.course_attendee.CourseAttendee | None