activity.models.occasion
========================

.. py:module:: activity.models.occasion


Classes
-------

.. autoapisummary::

   activity.models.occasion.Occasion


Module Contents
---------------

.. py:class:: Occasion

   Bases: :py:obj:`onegov.core.orm.Base`, :py:obj:`onegov.core.orm.mixins.TimestampMixin`


   Describes a single occurrence of an Activity. "Occurence" would have
   been a good word for it too, but that's used by onegov.event.

   So occasion it is.



   .. py:attribute:: __tablename__
      :value: 'occasions'



   .. py:method:: __hash__() -> int


   .. py:attribute:: id
      :type:  sqlalchemy.Column[uuid.UUID]


   .. py:attribute:: meeting_point
      :type:  sqlalchemy.Column[str | None]


   .. py:attribute:: age
      :type:  sqlalchemy.Column[onegov.activity.types.BoundedIntegerRange]


   .. py:attribute:: spots
      :type:  sqlalchemy.Column[onegov.activity.types.BoundedIntegerRange]


   .. py:attribute:: note
      :type:  sqlalchemy.Column[str | None]


   .. py:attribute:: cost
      :type:  sqlalchemy.Column[decimal.Decimal | None]


   .. py:attribute:: booking_cost
      :type:  sqlalchemy.Column[decimal.Decimal | None]


   .. py:attribute:: activity_id
      :type:  sqlalchemy.Column[uuid.UUID]


   .. py:attribute:: activity
      :type:  sqlalchemy.orm.relationship[activity.models.activity.Activity]


   .. py:attribute:: accepted
      :type:  sqlalchemy.orm.relationship[collections.abc.Sequence[activity.models.booking.Booking]]


   .. py:attribute:: period_id
      :type:  sqlalchemy.Column[uuid.UUID]


   .. py:attribute:: period
      :type:  sqlalchemy.orm.relationship[activity.models.period.Period]


   .. py:attribute:: cancelled
      :type:  sqlalchemy.Column[bool]


   .. py:attribute:: duration
      :type:  sqlalchemy.Column[int | None]


   .. py:attribute:: order
      :type:  sqlalchemy.Column[int | None]


   .. py:attribute:: exclude_from_overlap_check
      :type:  sqlalchemy.Column[bool]


   .. py:attribute:: exempt_from_booking_limit
      :type:  sqlalchemy.Column[bool]


   .. py:attribute:: active_days
      :type:  sqlalchemy.Column[list[int]]


   .. py:attribute:: weekdays
      :type:  sqlalchemy.Column[list[int]]


   .. py:attribute:: seeking_volunteers
      :type:  sqlalchemy.Column[bool]


   .. py:method:: attendee_count() -> sqlalchemy.sql.ColumnElement[int]


   .. py:attribute:: bookings
      :type:  sqlalchemy.orm.relationship[list[activity.models.booking.Booking]]


   .. py:attribute:: dates
      :type:  sqlalchemy.orm.relationship[list[activity.models.occasion_date.OccasionDate]]


   .. py:attribute:: needs
      :type:  sqlalchemy.orm.relationship[list[activity.models.occasion_need.OccasionNeed]]


   .. py:method:: on_date_change() -> None

      Date changes are not properly propagated to the observer for
      some reason, so we do this manually with a hook.

      It's a bit of a hack, but multiple dates per occasion had to be
      added at the last minute..




   .. py:property:: anti_affinity_group
      :type: tuple[str, str]


      Uses the activity_id/period_id as an anti-affinity group to ensure
      that an attendee is never given two occasions of the same activity
      in a single period.

      If that is wanted, the attendee is meant to do this after the
      matching has been done, with a direct booking.




   .. py:attribute:: total_cost
      :type:  sqlalchemy.Column[decimal.Decimal]


   .. py:method:: compute_duration(dates: collections.abc.Collection[activity.models.occasion_date.OccasionDate] | None) -> int


   .. py:method:: compute_order(dates: collections.abc.Collection[activity.models.occasion_date.OccasionDate] | None) -> int


   .. py:method:: compute_active_days(dates: collections.abc.Collection[activity.models.occasion_date.OccasionDate] | None) -> list[int]


   .. py:method:: compute_weekdays(dates: collections.abc.Collection[activity.models.occasion_date.OccasionDate] | None) -> list[int]


   .. py:method:: observe_dates(dates: collections.abc.Collection[activity.models.occasion_date.OccasionDate] | None) -> None


   .. py:method:: validate_dates(key: str, date: activity.models.occasion_date.OccasionDate) -> activity.models.occasion_date.OccasionDate


   .. py:method:: observe_needs(needs: collections.abc.Collection[activity.models.occasion_need.OccasionNeed] | None) -> None


   .. py:attribute:: operable
      :type:  sqlalchemy.Column[bool]


   .. py:method:: full() -> bool


   .. py:method:: available_spots() -> int


   .. py:property:: max_spots
      :type: int



   .. py:method:: is_past_deadline(now: datetime.datetime) -> bool


   .. py:method:: is_past_cancellation(date: Occasion.is_past_cancellation.date) -> bool


   .. py:property:: deadline
      :type: datetime.date


      The date until which this occasion may be booked (inclusive). 



   .. py:property:: cancellation_deadline
      :type: datetime.date | None


      The date until which bookings of this occasion may be cancelled
      by a mere member (inclusive).

      If mere members are not allowed to do that, the deadline returns None.




   .. py:method:: cancel() -> None


   .. py:method:: is_too_young(birth_date: datetime.date | datetime.datetime) -> bool


   .. py:method:: is_too_old(birth_date: datetime.date | datetime.datetime) -> bool