wtfs.models.report

Classes

`Report`	The base class for the reports.
`ReportBoxes`	A report containing all boxes from the municipalities of normal scan
`ReportBoxesAndForms`	A report containing all boxes, tax forms and single documents.
`ReportFormsByMunicipality`	A report containing all tax forms of a single municipality.
`ReportFormsAllMunicipalities`	A report containing all tax forms of all municipalities.
`ReportBoxesAndFormsByDelivery`	A report containing all boxes, tax forms and single documents of a

Functions

`sum`(→ Any)
`zero`(→ Any)

Module Contents

wtfs.models.report.sum(table: object, attribute: str) → Any[source]

wtfs.models.report.zero(attribute: str) → Any[source]

class wtfs.models.report.Report(session: sqlalchemy.orm.Session, start: datetime.date | None = None, end: datetime.date | None = None, type: str | None = None, municipality_id: UUID | None = None)[source]

The base class for the reports.

Aggregates the columns_dispatch on the dispatch date and columns_return on the return date.

Allows to filter by date range and scan job type.

session[source]

start[source]

end[source]

type[source]

municipality_id[source]

property municipality_name: str | None[source]

property columns_dispatch: list[str][source]

property columns_return: list[str][source]

property columns: list[str][source]

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

total() → Query[tuple[int, ...]][source]

class wtfs.models.report.ReportBoxes(session: sqlalchemy.orm.Session, start: datetime.date | None = None, end: datetime.date | None = None)[source]

Bases: Report

A report containing all boxes from the municipalities of normal scan jobs.

property columns_dispatch: list[str][source]

class wtfs.models.report.ReportBoxesAndForms(session: sqlalchemy.orm.Session, start: datetime.date | None = None, end: datetime.date | None = None, type: str | None = None, municipality_id: UUID | None = None)[source]

Bases: Report

A report containing all boxes, tax forms and single documents.

property columns_dispatch: list[str][source]

class wtfs.models.report.ReportFormsByMunicipality(session: sqlalchemy.orm.Session, start: datetime.date | None = None, end: datetime.date | None = None, type: str | None = None, municipality_id: UUID | None = None)[source]

Bases: Report

A report containing all tax forms of a single municipality.

property columns_dispatch: list[str][source]

class wtfs.models.report.ReportFormsAllMunicipalities(session: sqlalchemy.orm.Session, start: datetime.date | None = None, end: datetime.date | None = None, type: str | None = None, municipality_id: UUID | None = None)[source]

Bases: ReportFormsByMunicipality

A report containing all tax forms of all municipalities.

property municipality_name: str[source]

class wtfs.models.report.ReportBoxesAndFormsByDelivery(session: sqlalchemy.orm.Session, start: datetime.date, end: datetime.date, type: str, municipality_id: uuid.UUID)[source]

A report containing all boxes, tax forms and single documents of a single municipality by delivery.

session[source]

start[source]

end[source]

type[source]

municipality_id[source]

property municipality: onegov.wtfs.models.municipality.Municipality[source]

property columns: list[str][source]

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

total() → Query[tuple[int, ...]][source]