feriennet.models.calendar
=========================

.. py:module:: feriennet.models.calendar


Classes
-------

.. autoapisummary::

   feriennet.models.calendar.AttendeeCalendarRow
   feriennet.models.calendar.Calendar
   feriennet.models.calendar.AttendeeCalendar


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

.. py:class:: AttendeeCalendarRow

   Bases: :py:obj:`NamedTuple`


   .. py:attribute:: uid
      :type:  str


   .. py:attribute:: period
      :type:  str


   .. py:attribute:: confirmed
      :type:  bool


   .. py:attribute:: title
      :type:  str


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: lat
      :type:  str | None


   .. py:attribute:: lon
      :type:  str | None


   .. py:attribute:: start
      :type:  datetime.datetime


   .. py:attribute:: end
      :type:  datetime.datetime


   .. py:attribute:: meeting_point
      :type:  str | None


   .. py:attribute:: note
      :type:  str | None


   .. py:attribute:: cancelled
      :type:  bool


   .. py:attribute:: attendee_id
      :type:  uuid.UUID


   .. py:attribute:: state
      :type:  onegov.activity.models.booking.BookingState


   .. py:attribute:: booking_id
      :type:  uuid.UUID


.. py:class:: Calendar

   A base for all calendars that return icalendar renderings. 


   .. py:attribute:: name
      :type:  ClassVar[str]


   .. py:attribute:: calendars
      :type:  ClassVar[dict[str, type[Calendar]]]


   .. py:method:: __init_subclass__(name: str, **kwargs: Any) -> None
      :classmethod:



   .. py:method:: from_token(session: sqlalchemy.orm.Session, token: str) -> Calendar | None
      :classmethod:

      :abstractmethod:



   .. py:method:: from_name_and_token(session: sqlalchemy.orm.Session, name: str, token: str) -> Calendar | None
      :classmethod:



   .. py:method:: calendar(request: onegov.feriennet.request.FeriennetRequest) -> bytes
      :abstractmethod:



   .. py:method:: new() -> icalendar.Calendar


.. py:class:: AttendeeCalendar(session: sqlalchemy.orm.Session, attendee: onegov.activity.Attendee)

   Bases: :py:obj:`Calendar`


   Renders all confirmed activites of the given attendee. 


   .. py:attribute:: session


   .. py:attribute:: attendee


   .. py:property:: attendee_calendar
      :type: sqlalchemy.sql.selectable.Alias



   .. py:property:: attendee_id
      :type: str



   .. py:property:: token
      :type: str



   .. py:method:: from_token(session: sqlalchemy.orm.Session, token: str) -> Self | None
      :classmethod:



   .. py:method:: calendar(request: onegov.feriennet.request.FeriennetRequest) -> bytes


   .. py:method:: events(request: onegov.feriennet.request.FeriennetRequest) -> collections.abc.Iterator[icalendar.Event]