org.views.form_export
=====================

.. py:module:: org.views.form_export


Classes
-------

.. autoapisummary::

   org.views.form_export.FormSubmissionRow


Functions
---------

.. autoapisummary::

   org.views.form_export.handle_form_submissions_export
   org.views.form_export.subset_by_date
   org.views.form_export.subset_by_window
   org.views.form_export.configure_subset
   org.views.form_export.run_export


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

.. py:class:: FormSubmissionRow

   Bases: :py:obj:`NamedTuple`


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


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


   .. py:attribute:: received
      :type:  datetime.datetime


   .. py:attribute:: payment_method
      :type:  onegov.pay.types.PaymentMethod | None


   .. py:attribute:: data
      :type:  dict[str, Any]


   .. py:attribute:: ticket_number
      :type:  str


   .. py:attribute:: registration_state
      :type:  onegov.form.types.RegistrationState | None


   .. py:attribute:: registration_window_start
      :type:  datetime.date


   .. py:attribute:: registration_window_end
      :type:  datetime.date


.. py:function:: handle_form_submissions_export(self: onegov.form.FormDefinition, request: onegov.org.request.OrgRequest, form: onegov.org.forms.FormSubmissionsExport, layout: onegov.org.layout.FormSubmissionLayout | None = None) -> onegov.core.types.RenderData | webob.Response

.. py:function:: subset_by_date(submissions: onegov.form.FormSubmissionCollection, start: sedate.types.DateLike, end: sedate.types.DateLike, timezone: sedate.types.TzInfoOrName) -> sqlalchemy.orm.Query[onegov.form.FormSubmission]

.. py:function:: subset_by_window(submissions: onegov.form.FormSubmissionCollection, window_ids: collections.abc.Collection[onegov.core.orm.types.UUID]) -> sqlalchemy.orm.Query[onegov.form.FormSubmission]

.. py:function:: configure_subset(subset: sqlalchemy.orm.Query[onegov.form.FormSubmission]) -> sqlalchemy.orm.Query[FormSubmissionRow]

.. py:function:: run_export(subset: sqlalchemy.orm.Query[FormSubmissionRow], nested: bool, formatter: collections.abc.Callable[[object], Any]) -> tuple[collections.abc.Callable[[str], tuple[int, str]], collections.abc.Sequence[dict[str, Any]]]