reservation.collection

Attributes

_R

any_type_t

any_type

Classes

_Marker

Create a collection of name/value pairs.

ResourceCollection

Manages a list of resources.

Module Contents

reservation.collection._R[source]
class reservation.collection._Marker(*args, **kwds)[source]

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

  • attribute access:

>>> Color.RED
<Color.RED: 1>
  • value lookup:

>>> Color(1)
<Color.RED: 1>
  • name lookup:

>>> Color['RED']
<Color.RED: 1>

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3
>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

any_type[source]
reservation.collection.any_type_t: typing_extensions.TypeAlias[source]
reservation.collection.any_type: any_type_t[source]
class reservation.collection.ResourceCollection(libres_context: libres.context.core.Context)[source]

Manages a list of resources.

query() Query[Resource][source]
add(title: str, timezone: str, type: str | None = None, name: str | None = None, meta: dict[str, Any] | None = None, content: dict[str, Any] | None = None, definition: str | None = None, group: str | None = None) onegov.reservation.models.Resource[source]
bind(resource: _R) _R[source]
bind(resource: None) None
by_id(id: uuid.UUID, ensure_type: str | any_type_t = any_type) onegov.reservation.models.Resource | None[source]
by_name(name: str, ensure_type: str | any_type_t = any_type) onegov.reservation.models.Resource | None[source]
by_allocation(allocation: libres.db.models.Allocation) onegov.reservation.models.Resource | None[source]
by_reservation(reservation: libres.db.models.Reservation) onegov.reservation.models.Resource | None[source]
delete(resource: onegov.reservation.models.Resource, including_reservations: bool = False, handle_reservation: Callable[[Reservation], Any] | None = None) None[source]