activity.models.period

Classes

BookingPeriodMixin
_BookinPeriodMeta
BookingPeriodMeta	Built-in immutable sequence.
BookingPeriod	Mixin providing created/modified timestamps for all records.

Module Contents

class activity.models.period.BookingPeriodMixin

timezone: ClassVar[str] = 'Europe/Zurich'

property active: sqlalchemy.Column[bool] | bool

as_local_datetime(day: datetime.date | datetime.datetime, end_of_day: bool = False) → datetime.datetime

Returns the moment of midnight in terms of the timezone it UTC

property phase: str | None

property wishlist_phase: bool

property booking_phase: bool

property payment_phase: bool

property execution_phase: bool

property archive_phase: bool

property is_prebooking_in_future: bool

property is_currently_prebooking: bool

property is_prebooking_in_past: bool

Returns true if current date is after start of booking phase or if current date is after prebooking end.

property is_booking_in_future: bool

property is_currently_booking: bool

property is_booking_in_past: bool

property is_execution_in_past: bool

property booking_limit: int | None

Returns the max_bookings_per_attendee limit if it applies.

class activity.models.period._BookinPeriodMeta

Bases: NamedTuple

id: uuid.UUID

title: str

active: bool

confirmed: bool

confirmable: bool

finalized: bool

finalizable: bool

archived: bool

prebooking_start: datetime.date

prebooking_end: datetime.date

booking_start: datetime.date

booking_end: datetime.date

execution_start: datetime.date

execution_end: datetime.date

max_bookings_per_attendee: int | None

booking_cost: decimal.Decimal | None

all_inclusive: bool

pay_organiser_directly: bool

minutes_between: int | None

alignment: str | None

deadline_days: int | None

book_finalized: bool

cancellation_date: datetime.date | None

cancellation_days: int | None

age_barrier_type: str

class activity.models.period.BookingPeriodMeta

Bases: _BookinPeriodMeta, BookingPeriodMixin

Built-in immutable sequence.

If no argument is given, the constructor returns an empty tuple. If iterable is specified the tuple is initialized from iterable’s items.

If the argument is a tuple, the return value is the same object.

materialize(session: sqlalchemy.orm.Session) → BookingPeriod

__setattr__(name: str, value: object) → NoReturn

Implement setattr(self, name, value).

class activity.models.period.BookingPeriod

Bases: onegov.core.orm.Base, BookingPeriodMixin, onegov.core.orm.mixins.TimestampMixin

Mixin providing created/modified timestamps for all records.

The columns are deferred loaded as this is primarily for logging and future forensics.

__tablename__ = 'periods'

id: sqlalchemy.Column[uuid.UUID]

title: sqlalchemy.Column[str]

active: sqlalchemy.Column[bool]

confirmed: sqlalchemy.Column[bool]

confirmable: sqlalchemy.Column[bool]

finalized: sqlalchemy.Column[bool]

finalizable: sqlalchemy.Column[bool]

archived: sqlalchemy.Column[bool]

prebooking_start: sqlalchemy.Column[datetime.date]

prebooking_end: sqlalchemy.Column[datetime.date]

booking_start: sqlalchemy.Column[datetime.date]

booking_end: sqlalchemy.Column[datetime.date]

execution_start: sqlalchemy.Column[datetime.date]

execution_end: sqlalchemy.Column[datetime.date]

data: sqlalchemy.Column[dict[str, Any]]

max_bookings_per_attendee: sqlalchemy.Column[int | None]

booking_cost: sqlalchemy.Column[decimal.Decimal | None]

all_inclusive: sqlalchemy.Column[bool]

pay_organiser_directly: sqlalchemy.Column[bool]

minutes_between: sqlalchemy.Column[int | None]

alignment: sqlalchemy.Column[str | None]

deadline_days: sqlalchemy.Column[int | None]

book_finalized: sqlalchemy.Column[bool]

cancellation_date: sqlalchemy.Column[datetime.date | None]

cancellation_days: sqlalchemy.Column[int | None]

age_barrier_type: sqlalchemy.Column[str]

__table_args__

occasions: sqlalchemy.orm.relationship[list[onegov.activity.models.occasion.Occasion]]

bookings: sqlalchemy.orm.relationship[list[onegov.activity.models.booking.Booking]]

invoices: sqlalchemy.orm.relationship[list[onegov.activity.models.BookingPeriodInvoice]]

publication_requests: sqlalchemy.orm.relationship[list[onegov.activity.models.PublicationRequest]]

validate_age_barrier_type(key: str, age_barrier_type: str) → str

property age_barrier: onegov.activity.models.age_barrier.AgeBarrier

activate() → None

Activates the current period, causing all occasions and activites to update their status and book-keeping.

It also makes sure no other period is active.

deactivate() → None

Deactivates the current period, causing all occasions and activites to update their status and book-keeping.

confirm() → None

Confirms the current period.

archive() → None

Moves all accepted activities with an occasion in this period into the archived state, unless there’s already another occasion in a period newer than the current period.

confirm_and_start_booking_phase() → None

Confirms the period and sets the booking phase to now.

This is mainly an internal convenience function to activate the previous behaviour before a specific booking phase date was introduced.

property scoring: onegov.activity.matching.score.Scoring

materialize(session: sqlalchemy.orm.Session) → BookingPeriod