activity.collections.volunteer
==============================

.. py:module:: activity.collections.volunteer


Classes
-------

.. autoapisummary::

   activity.collections.volunteer.ReportRowWithVolunteer
   activity.collections.volunteer.VolunteerCollection


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

.. py:class:: ReportRowWithVolunteer

   Bases: :py:obj:`NamedTuple`


   .. py:attribute:: activity_id
      :type:  uuid.UUID


   .. py:attribute:: activity_title
      :type:  str


   .. py:attribute:: activity_name
      :type:  str


   .. py:attribute:: need_id
      :type:  uuid.UUID


   .. py:attribute:: need_name
      :type:  str


   .. py:attribute:: min_required
      :type:  int


   .. py:attribute:: max_required
      :type:  int


   .. py:attribute:: confirmed
      :type:  int


   .. py:attribute:: occasion_id
      :type:  uuid.UUID


   .. py:attribute:: period_id
      :type:  uuid.UUID


   .. py:attribute:: occasion_number
      :type:  int


   .. py:attribute:: volunteer_id
      :type:  uuid.UUID


   .. py:attribute:: first_name
      :type:  str


   .. py:attribute:: last_name
      :type:  str


   .. py:attribute:: address
      :type:  str


   .. py:attribute:: zip_code
      :type:  str


   .. py:attribute:: place
      :type:  str


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


   .. py:attribute:: birth_date
      :type:  datetime.date


   .. py:attribute:: age
      :type:  int


   .. py:attribute:: email
      :type:  str


   .. py:attribute:: phone
      :type:  str


   .. py:attribute:: state
      :type:  onegov.activity.models.volunteer.VolunteerState


   .. py:attribute:: dates
      :type:  collections.abc.Sequence[datetime.datetime]


.. py:class:: VolunteerCollection(session: sqlalchemy.orm.Session, period: onegov.activity.models.Period | onegov.activity.models.PeriodMeta | None)

   Bases: :py:obj:`onegov.core.collection.GenericCollection`\ [\ :py:obj:`onegov.activity.models.Volunteer`\ ]


   Abstract base class for generic types.

   A generic type is typically declared by inheriting from
   this class parameterized with one or more type variables.
   For example, a generic mapping type might be defined as::

     class Mapping(Generic[KT, VT]):
         def __getitem__(self, key: KT) -> VT:
             ...
         # Etc.

   This class can then be used as follows::

     def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
         try:
             return mapping[key]
         except KeyError:
             return default


   .. py:attribute:: period


   .. py:property:: model_class
      :type: type[onegov.activity.models.Volunteer]



   .. py:property:: period_id
      :type: uuid.UUID | None



   .. py:method:: report() -> sqlalchemy.orm.Query[ReportRow]


   .. py:method:: for_period(period: onegov.activity.models.Period | onegov.activity.models.PeriodMeta | None) -> Self