org.forms.allocation

Module Contents

Classes

DateContainer	Base class for protocol classes.
AllocationFormHelpers
AllocationRuleForm	Base form form allocation rules.
AllocationForm	Baseform for all allocation forms. Allocation forms are expected
AllocationEditForm	Baseform for edit forms. Edit forms differ from the base allocation
Daypasses
DaypassAllocationForm	Baseform for all allocation forms. Allocation forms are expected
DaypassAllocationEditForm	Baseform for edit forms. Edit forms differ from the base allocation
RoomAllocationForm	Baseform for all allocation forms. Allocation forms are expected
DailyItemFields
DailyItemAllocationForm	Baseform for all allocation forms. Allocation forms are expected
DailyItemAllocationEditForm	Baseform for edit forms. Edit forms differ from the base allocation
RoomAllocationEditForm	Baseform for edit forms. Edit forms differ from the base allocation

Functions

choices_as_integer(→ list[int] | None)

class org.forms.allocation.DateContainer

Bases: Protocol

Base class for protocol classes.

Protocol classes are defined as:

class Proto(Protocol):
    def meth(self) -> int:
        ...

Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing), for example:

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures. Protocol classes can be generic, they are defined as:

class GenProto(Protocol[T]):
    def meth(self) -> T:
        ...

__contains__(dt: datetime.date | datetime.datetime, /) → bool

org.forms.allocation.choices_as_integer(choices: Iterable[str] | None) → list[int] | None

class org.forms.allocation.AllocationFormHelpers

generate_dates(start: datetime.date | None, end: datetime.date | None, start_time: datetime.time | None = None, end_time: datetime.time | None = None, weekdays: Iterable[int] | None = None) → list[tuple[datetime.datetime, datetime.datetime]]

Takes the given dates and generates the date tuples.

The except_for field will be considered if present, as will the on_holidays setting.

combine_datetime(field: str, time_field: str) → datetime.datetime | None

Takes the given date field and combines it with the given time field.

is_excluded(dt: datetime.datetime) → bool

class org.forms.allocation.AllocationRuleForm(formdata: MultiDict[str, Any] | None = None, obj: object | None = None, prefix: str = '', data: dict[str, Any] | None = None, meta: dict[str, Any] | None = None, *, extra_filters: Mapping[str, Sequence[Any]] | None = None, **kwargs: Any)

Bases: onegov.form.Form

Base form form allocation rules.

property rule: dict[str, Any]

property options: dict[str, Any]

title

extend

rule_id() → str

iteration() → int

last_run() → datetime.datetime | None

apply(resource: onegov.reservation.Resource) → int

class org.forms.allocation.AllocationForm(formdata: MultiDict[str, Any] | None = None, obj: object | None = None, prefix: str = '', data: dict[str, Any] | None = None, meta: dict[str, Any] | None = None, *, extra_filters: Mapping[str, Sequence[Any]] | None = None, **kwargs: Any)

Bases: onegov.form.Form, AllocationFormHelpers

Baseform for all allocation forms. Allocation forms are expected to implement the methods above (which contain a NotImplementedException).

Have a look at libres.db.scheduler.Scheduler.allocate() to find out more about those values.

property weekdays: list[int]

The rrule weekdays derived from the except_for field.

abstract property dates: SequenceOrScalar[tuple[datetime, datetime]]

Passed to libres.db.scheduler.Scheduler.allocate().

abstract property whole_day: bool

Passed to libres.db.scheduler.Scheduler.allocate().

abstract property partly_available: bool

Passed to libres.db.scheduler.Scheduler.allocate().

abstract property quota: int

Passed to libres.db.scheduler.Scheduler.allocate().

abstract property quota_limit: int

Passed to libres.db.scheduler.Scheduler.allocate().

property data: dict[str, Any]

Passed to libres.db.scheduler.Scheduler.allocate().

start

end

except_for

on_holidays

during_school_holidays

access

on_request() → None

ensure_start_before_end() → bool | None

exceptions() → DateContainer

ranged_exceptions() → Sequence[tuple[date, date]]

is_excluded(dt: datetime.datetime) → bool

class org.forms.allocation.AllocationEditForm(formdata: MultiDict[str, Any] | None = None, obj: object | None = None, prefix: str = '', data: dict[str, Any] | None = None, meta: dict[str, Any] | None = None, *, extra_filters: Mapping[str, Sequence[Any]] | None = None, **kwargs: Any)

Bases: onegov.form.Form, AllocationFormHelpers

Baseform for edit forms. Edit forms differ from the base allocation form somewhat, since they don’t offer a way to generate more than one allocation at a time.

The dates property is therefore expected to return a single start, end dates tuple.

property data: dict[str, Any]

Passed to libres.db.scheduler.Scheduler.allocate().

date

access

apply_data(data: dict[str, Any] | None) → None

class org.forms.allocation.Daypasses

daypasses

daypasses_limit

class org.forms.allocation.DaypassAllocationForm(formdata: MultiDict[str, Any] | None = None, obj: object | None = None, prefix: str = '', data: dict[str, Any] | None = None, meta: dict[str, Any] | None = None, *, extra_filters: Mapping[str, Sequence[Any]] | None = None, **kwargs: Any)

Bases: AllocationForm, Daypasses

Baseform for all allocation forms. Allocation forms are expected to implement the methods above (which contain a NotImplementedException).

Have a look at libres.db.scheduler.Scheduler.allocate() to find out more about those values.

property quota: int

Passed to libres.db.scheduler.Scheduler.allocate().

property quota_limit: int

Passed to libres.db.scheduler.Scheduler.allocate().

property dates: Sequence[tuple[datetime, datetime]]

Passed to libres.db.scheduler.Scheduler.allocate().

whole_day = True

partly_available = False

class org.forms.allocation.DaypassAllocationEditForm(formdata: MultiDict[str, Any] | None = None, obj: object | None = None, prefix: str = '', data: dict[str, Any] | None = None, meta: dict[str, Any] | None = None, *, extra_filters: Mapping[str, Sequence[Any]] | None = None, **kwargs: Any)

Bases: AllocationEditForm, Daypasses

Baseform for edit forms. Edit forms differ from the base allocation form somewhat, since they don’t offer a way to generate more than one allocation at a time.

The dates property is therefore expected to return a single start, end dates tuple.

property quota: int

property quota_limit: int

property dates: tuple[datetime.datetime, datetime.datetime]

whole_day = True

partly_available = False

apply_dates(start: datetime.datetime, end: datetime.datetime) → None

apply_model(model: onegov.reservation.Allocation) → None

class org.forms.allocation.RoomAllocationForm(formdata: MultiDict[str, Any] | None = None, obj: object | None = None, prefix: str = '', data: dict[str, Any] | None = None, meta: dict[str, Any] | None = None, *, extra_filters: Mapping[str, Sequence[Any]] | None = None, **kwargs: Any)

Bases: AllocationForm

Baseform for all allocation forms. Allocation forms are expected to implement the methods above (which contain a NotImplementedException).

Have a look at libres.db.scheduler.Scheduler.allocate() to find out more about those values.

property quota: int

Passed to libres.db.scheduler.Scheduler.allocate().

property whole_day: bool

Passed to libres.db.scheduler.Scheduler.allocate().

property partly_available: bool

Passed to libres.db.scheduler.Scheduler.allocate().

property dates: Sequence[tuple[datetime, datetime]]

Passed to libres.db.scheduler.Scheduler.allocate().

as_whole_day

start_time

end_time

is_partly_available

per_time_slot

quota_limit = 1

class org.forms.allocation.DailyItemFields

items

item_limit

class org.forms.allocation.DailyItemAllocationForm(formdata: MultiDict[str, Any] | None = None, obj: object | None = None, prefix: str = '', data: dict[str, Any] | None = None, meta: dict[str, Any] | None = None, *, extra_filters: Mapping[str, Sequence[Any]] | None = None, **kwargs: Any)

Bases: AllocationForm, DailyItemFields

Baseform for all allocation forms. Allocation forms are expected to implement the methods above (which contain a NotImplementedException).

Have a look at libres.db.scheduler.Scheduler.allocate() to find out more about those values.

property quota: int

Passed to libres.db.scheduler.Scheduler.allocate().

property quota_limit: int

Passed to libres.db.scheduler.Scheduler.allocate().

property dates: Sequence[tuple[datetime, datetime]]

Passed to libres.db.scheduler.Scheduler.allocate().

whole_day = True

partly_available = False

class org.forms.allocation.DailyItemAllocationEditForm(formdata: MultiDict[str, Any] | None = None, obj: object | None = None, prefix: str = '', data: dict[str, Any] | None = None, meta: dict[str, Any] | None = None, *, extra_filters: Mapping[str, Sequence[Any]] | None = None, **kwargs: Any)

Bases: AllocationEditForm, DailyItemFields

Baseform for edit forms. Edit forms differ from the base allocation form somewhat, since they don’t offer a way to generate more than one allocation at a time.

The dates property is therefore expected to return a single start, end dates tuple.

property quota: int

property quota_limit: int

property dates: tuple[datetime.datetime, datetime.datetime]

whole_day = True

partly_available = False

apply_dates(start: datetime.datetime, end: datetime.datetime) → None

apply_model(model: onegov.reservation.Allocation) → None

class org.forms.allocation.RoomAllocationEditForm(formdata: MultiDict[str, Any] | None = None, obj: object | None = None, prefix: str = '', data: dict[str, Any] | None = None, meta: dict[str, Any] | None = None, *, extra_filters: Mapping[str, Sequence[Any]] | None = None, **kwargs: Any)

Bases: AllocationEditForm

Baseform for edit forms. Edit forms differ from the base allocation form somewhat, since they don’t offer a way to generate more than one allocation at a time.

The dates property is therefore expected to return a single start, end dates tuple.

property quota: int

property whole_day: bool

property partly_available: bool

property dates: tuple[datetime.datetime, datetime.datetime]

as_whole_day

start_time

end_time

per_time_slot

quota_limit = 1

ensure_start_before_end() → bool | None

apply_dates(start: datetime.datetime, end: datetime.datetime) → None

apply_model(model: onegov.reservation.Allocation) → None

on_request() → None