fsi.collections.subscription

Classes

SubscriptionsCollection

Abstract base class for generic types.

Module Contents

class fsi.collections.subscription.SubscriptionsCollection(session: sqlalchemy.orm.Session, attendee_id: UUID | None = None, course_event_id: UUID | None = None, external_only: bool = False, auth_attendee: onegov.fsi.models.course_attendee.CourseAttendee | None = None, page: int = 0)[source]

Bases: onegov.core.collection.GenericCollection[onegov.fsi.models.course_subscription.CourseSubscription], onegov.core.collection.Pagination[onegov.fsi.models.course_subscription.CourseSubscription]

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

batch_size = 30[source]

attendee_id = None[source]

page = 0[source]

course_event_id = None[source]

external_only = False[source]

auth_attendee = None[source]

__eq__(other: object) → bool[source]: Returns True if the current and the other Pagination instance are equal. Used to find the current page in a list of pages.

property model_class: type[onegov.fsi.models.course_subscription.CourseSubscription][source]

property course_event: onegov.fsi.models.course_event.CourseEvent | None[source]

property attendee: onegov.fsi.models.course_attendee.CourseAttendee | None[source]

property attendee_collection: onegov.fsi.collections.attendee.CourseAttendeeCollection[source]

property for_himself: bool[source]

query() → Query[CourseSubscription][source]

by_id(id: uuid.UUID) → onegov.fsi.models.course_subscription.CourseSubscription | None[source]

subset() → Query[CourseSubscription][source]: Returns an SQLAlchemy query containing all records that should be considered for pagination.

property page_index: int[source]: Returns the current page index (starting at 0).

page_by_index(index: int) → Self[source]: Returns the page at the given index. A page here means an instance of the class inheriting from the Pagination base class.