winterthur.collections.mission_report

Module Contents

Classes

MissionReportFileCollection	Manages files.
MissionReportCollection	Abstract base class for generic types.
MissionReportVehicleCollection	Abstract base class for generic types.

Attributes

T

winterthur.collections.mission_report.T

class winterthur.collections.mission_report.MissionReportFileCollection(session: sqlalchemy.orm.Session, report: onegov.winterthur.models.MissionReport)

Bases: onegov.org.models.file.BaseImageFileCollection[onegov.winterthur.models.MissionReportFile]

Manages files.

Parameters:

• session – The SQLAlchemy db session to use.

• type – The polymorphic type to use and to filter for, or ‘*’ for all.

• allow_duplicates –

  Prevents duplicates if set to false. Duplicates are detected before pre-processing, so already stored files may be downloaded and added again, as they might have changed during the upload.

  Note that this does not change existing files. It only prevents new duplicates from being added.

property id: uuid.UUID

property association: onegov.core.orm.abstract.associable.RegisteredLink

query() → Query[MissionReportFile]

class winterthur.collections.mission_report.MissionReportCollection(session: sqlalchemy.orm.Session, page: int = 0, include_hidden: bool = False, year: int | None = None)

Bases: onegov.core.collection.GenericCollection[onegov.winterthur.models.MissionReport], onegov.core.collection.Pagination[onegov.winterthur.models.MissionReport]

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 model_class: type[onegov.winterthur.models.MissionReport]

property page_index: int

Returns the current page index (starting at 0).

__eq__(other: object) → bool

Return self==value.

by_id(id: uuid.UUID) → onegov.winterthur.models.MissionReport | None

query() → Query[MissionReport]

subset() → Query[MissionReport]

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.

filter_by_year(query: Query[T]) → Query[T]

mission_count() → int | None

The mission count, including hidden missions.

class winterthur.collections.mission_report.MissionReportVehicleCollection(session: sqlalchemy.orm.Session, **kwargs: Any)

Bases: onegov.core.collection.GenericCollection[onegov.winterthur.models.MissionReportVehicle]

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 model_class: type[onegov.winterthur.models.MissionReportVehicle]

query() → Query[MissionReportVehicle]