fsi.collections.course_event

Classes

CourseEventCollection	Abstract base class for generic types.
PastCourseEventCollection	This is used for past events to do the audit

Module Contents

class fsi.collections.course_event.CourseEventCollection(session: sqlalchemy.orm.Session, page: int = 0, from_date: datetime.datetime | None = None, upcoming_only: bool = False, past_only: bool = False, limit: int | None = None, show_hidden: bool = False, show_locked: bool = True, course_id: uuid.UUID | None = None, sort_desc: bool = False)

Bases: onegov.core.collection.GenericCollection[onegov.fsi.models.course_event.CourseEvent], onegov.core.collection.Pagination[onegov.fsi.models.course_event.CourseEvent]

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 = 10

page = 0

from_date = None

upcoming_only = False

past_only = False

limit = None

show_hidden = False

show_locked = True

course_id = None

sort_desc = False

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

property model_class: type[onegov.fsi.models.course_event.CourseEvent]

property course: onegov.fsi.models.course.Course | None

query() → sqlalchemy.orm.Query[onegov.fsi.models.course_event.CourseEvent]

subset() → sqlalchemy.orm.Query[onegov.fsi.models.course_event.CourseEvent]

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

property page_index: int

Returns the current page index (starting at 0).

page_by_index(index: int) → Self

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

classmethod latest(session: sqlalchemy.orm.Session, limit: int = 5) → Self

next_event() → sqlalchemy.orm.Query[onegov.fsi.models.course_event.CourseEvent]

get_past_reminder_date() → sqlalchemy.orm.Query[onegov.fsi.models.course_event.CourseEvent]

add(**kwargs: Any) → onegov.fsi.models.course_event.CourseEvent

class fsi.collections.course_event.PastCourseEventCollection(session: sqlalchemy.orm.Session, page: int = 0, show_hidden: bool = False, show_locked: bool = True, course_id: uuid.UUID | None = None)

Bases: CourseEventCollection

This is used for past events to do the audit

page_by_index(index: int) → Self

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

query() → sqlalchemy.orm.Query[onegov.fsi.models.course_event.CourseEvent]