reservation.models.resource

Attributes

DeadlineUnit
blocking_resources_table

Classes

Resource

A resource holds a single calendar with allocations and reservations.

Functions

extra_scheduler_arguments() → dict[str, Any]

Module Contents

type reservation.models.resource.DeadlineUnit = Literal['d', 'h']

reservation.models.resource.extra_scheduler_arguments() → dict[str, Any]

reservation.models.resource.blocking_resources_table

class reservation.models.resource.Resource

Bases: libres.db.models.base.ORMBase, onegov.core.orm.ModelBase, onegov.core.orm.mixins.ContentMixin, onegov.core.orm.mixins.TimestampMixin, onegov.file.MultiAssociatedFiles

A resource holds a single calendar with allocations and reservations.

Note that this resource is not defined on the onegov.core declarative base. Instead it is defined using the libres base. This means we can’t join data outside the libres models.

This should however not be a problem as this onegov module is self contained and does not link to other onegov modules, except for core.

If we ever want to link to other models (say link a reservation to a user), then we have to switch to a unified base. Ideally we would find a way to merge these bases somehow.

Also note that we do use the ModelBase class as a mixin to at least share the same methods as all the usual onegov.core.orm models.

__tablename__ = 'resources'

id: sqlalchemy.orm.Mapped[uuid.UUID]

name: sqlalchemy.orm.Mapped[str | None]

title: sqlalchemy.orm.Mapped[str]

timezone: sqlalchemy.orm.Mapped[str]

parsed: sqlalchemy.orm.Mapped[onegov.form.parser.ParsedForm | None]

group: sqlalchemy.orm.Mapped[str | None]

subgroup: sqlalchemy.orm.Mapped[str | None]

type: sqlalchemy.orm.Mapped[str]

payment_method: onegov.core.orm.mixins.dict_property[onegov.pay.types.PaymentMethod | None]

minimum_price_total: onegov.core.orm.mixins.dict_property[float | None]

currency: onegov.core.orm.mixins.dict_property[str | None]

pricing_method: onegov.core.orm.mixins.dict_property[str | None]

price_per_hour: onegov.core.orm.mixins.dict_property[float | None]

price_per_item: onegov.core.orm.mixins.dict_property[float | None]

pricing_scheme: onegov.core.orm.mixins.dict_property[str | None]

invoicing_party: onegov.core.orm.mixins.dict_property[str | None]

cost_object: onegov.core.orm.mixins.dict_property[str | None]

occupancy_fields: onegov.core.orm.mixins.dict_property[list[str]]

ical_fields: onegov.core.orm.mixins.dict_property[list[str]]

deadline: onegov.core.orm.mixins.dict_property[tuple[int, DeadlineUnit] | None]

lead_time: onegov.core.orm.mixins.dict_property[int | None]

enable_reservation_reminders: onegov.core.orm.mixins.dict_property[bool]

extras_pricing_method: onegov.core.orm.mixins.dict_property[str]

discount_method: onegov.core.orm.mixins.dict_property[str]

default_view: onegov.core.orm.mixins.dict_property[str | None]

zipcode_block: onegov.core.orm.mixins.dict_property[dict[str, Any] | None]

access_token: onegov.core.orm.mixins.dict_property[str | None]

pick_up: onegov.core.orm.mixins.dict_property[str | None]

allow_cancellation_requests: onegov.core.orm.mixins.dict_property[bool]

reply_to: onegov.core.orm.mixins.dict_property[str | None]

__mapper_args__

__table_args__

_allocations: sqlalchemy.orm.Mapped[list[libres.db.models.Allocation]]

_virtual_allocations: sqlalchemy.orm.Mapped[list[libres.db.models.Allocation]]

parents: sqlalchemy.orm.Mapped[list[Resource]]

children: sqlalchemy.orm.Mapped[list[Resource]]

date: datetime.date | None

highlights_min = None

highlights_max = None

view = 'dayGridMonth'

refresh_on_parents_updated(parents: list[Resource]) → None

definition() → str | None

The form as a parsable string

classmethod _definition_expression() → sqlalchemy.sql.ColumnElement[str | None]

static get_virtual_id(resource_id: uuid.UUID) → uuid.UUID

virtual_id() → uuid.UUID

The resource’s secondary virtual id.

The virtual resource can be used as a second layer with its own allocations that can overlap allocations on the first layer while reservations on these two layers properly block one another.

We generally use this to provide an internal unrestricted layer where partly-available full-day allocations get created on-demand to fit any reservations

classmethod _virtual_id_expression() → sqlalchemy.sql.ColumnElement[uuid.UUID]

highlight_allocations(allocations: collections.abc.Sequence[libres.db.models.Allocation]) → None

The allocation to jump to in the view.

blocking_resource_ids(libres_context: libres.context.core.Context | None = None) → set[uuid.UUID]

Returns a set of blocking resource ids.

This excludes virtual resource ids, which will also act as blocking entities when creating reservations.

blocking_resources() → dict[uuid.UUID, Resource]

get_scheduler(libres_context: libres.context.core.Context, *, virtual: bool = False) → _OurScheduler

property scheduler: _OurScheduler

property virtual_scheduler: _OurScheduler

bind_to_libres_context(libres_context: libres.context.core.Context) → None

property form_class: type[onegov.form.Form] | None

Parses the form definition and returns a form class.

invoice_items_for_reservation(reservations: collections.abc.Sequence[onegov.reservation.models.CustomReservation], extras: collections.abc.Sequence[onegov.pay.InvoiceItemMeta] | None = None, discounts: collections.abc.Sequence[onegov.pay.InvoiceDiscountMeta] | None = None, submission_data: dict[str, Any] | None = None, *, reduced_amount_label: str) → list[onegov.pay.InvoiceItemMeta]

store_pricing_settings(data: dict[str, Any], allocation: libres.db.models.Allocation | None) → None

Stores the resource/allocation specific pricing settings on the given reservation data, so pricing on that reservation remains stable, regardless of what changes later happen to the resource/allocation.

process_payment(price: onegov.pay.Price | None, provider: onegov.pay.PaymentProvider[Any] | None = None, payment_token: str | None = None) → onegov.pay.Payment | onegov.pay.PaymentError | Literal[True] | None

Processes the payment for the given reservation token.

is_before_lead_time(dt: datetime.datetime) → bool

is_past_deadline(dt: datetime.datetime) → bool

is_zip_blocked(date: datetime.date) → bool

is_allowed_zip_code(zipcode: int) → bool

renew_access_token() → None

__repr__() → str