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 | None = None, sort_desc: bool = False)[source]

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[source]
__eq__(other: object) bool[source]

Return self==value.

property model_class: type[onegov.fsi.models.course_event.CourseEvent][source]
property course: onegov.fsi.models.course.Course | None[source]
query() Query[CourseEvent][source]
subset() Query[CourseEvent][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) typing_extensions.Self[source]

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) typing_extensions.Self[source]
next_event() Query[CourseEvent][source]
get_past_reminder_date() Query[CourseEvent][source]
add(**kwargs: Any) onegov.fsi.models.course_event.CourseEvent[source]
class fsi.collections.course_event.PastCourseEventCollection(session: sqlalchemy.orm.Session, page: int = 0, show_hidden: bool = False, show_locked: bool = True, course_id: UUID | None = None)[source]

Bases: CourseEventCollection

This is used for past events to do the audit

page_by_index(index: int) typing_extensions.Self[source]

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

query() Query[CourseEvent][source]