pas.path
========

.. py:module:: pas.path


Classes
-------

.. autoapisummary::

   pas.path.SettlementRunExport
   pas.path.SettlementRunAllExport


Functions
---------

.. autoapisummary::

   pas.path.get_attendences
   pas.path.get_attendence
   pas.path.get_changes
   pas.path.get_change
   pas.path.get_commissions
   pas.path.get_commission
   pas.path.get_commission_memberships
   pas.path.get_commission_membership
   pas.path.get_legislative_periods
   pas.path.get_legislative_period
   pas.path.get_parliamentarians
   pas.path.get_parliamentarian
   pas.path.get_parliamentarian_roles
   pas.path.get_parliamentarian_role
   pas.path.get_parliamentary_groups
   pas.path.get_parliamentary_group
   pas.path.get_parties
   pas.path.get_party
   pas.path.get_rate_sets
   pas.path.get_rate_set
   pas.path.get_settlement_runs
   pas.path.get_settlement_run
   pas.path.get_settlement_run_export
   pas.path.get_settlement_run_export_all


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

.. py:function:: get_attendences(request: onegov.town6.request.TownRequest, settlement_run_id: str | None = None, date_from: datetime.date | None = None, date_to: datetime.date | None = None, type: str | None = None, parliamentarian_id: str | None = None, commission_id: str | None = None) -> onegov.pas.collections.AttendenceCollection

.. py:function:: get_attendence(app: onegov.pas.app.PasApp, id: uuid.UUID) -> onegov.pas.models.Attendence | None

.. py:function:: get_changes(app: onegov.pas.app.PasApp) -> onegov.pas.collections.ChangeCollection

.. py:function:: get_change(app: onegov.pas.app.PasApp, id: uuid.UUID) -> onegov.pas.models.Change | None

.. py:function:: get_commissions(app: onegov.pas.app.PasApp, active: bool = True) -> onegov.pas.collections.CommissionCollection

.. py:function:: get_commission(app: onegov.pas.app.PasApp, id: uuid.UUID) -> onegov.pas.models.Commission | None

.. py:function:: get_commission_memberships(app: onegov.pas.app.PasApp) -> onegov.pas.collections.CommissionMembershipCollection

.. py:function:: get_commission_membership(app: onegov.pas.app.PasApp, id: uuid.UUID) -> onegov.pas.models.CommissionMembership | None

.. py:function:: get_legislative_periods(app: onegov.pas.app.PasApp, active: bool = True) -> onegov.pas.collections.LegislativePeriodCollection

.. py:function:: get_legislative_period(app: onegov.pas.app.PasApp, id: uuid.UUID) -> onegov.pas.models.LegislativePeriod | None

.. py:function:: get_parliamentarians(app: onegov.pas.app.PasApp, active: bool = True) -> onegov.pas.collections.ParliamentarianCollection

.. py:function:: get_parliamentarian(app: onegov.pas.app.PasApp, id: uuid.UUID) -> onegov.pas.models.Parliamentarian | None

.. py:function:: get_parliamentarian_roles(app: onegov.pas.app.PasApp) -> onegov.pas.collections.ParliamentarianRoleCollection

.. py:function:: get_parliamentarian_role(app: onegov.pas.app.PasApp, id: uuid.UUID) -> onegov.pas.models.ParliamentarianRole | None

.. py:function:: get_parliamentary_groups(app: onegov.pas.app.PasApp, active: bool = True) -> onegov.pas.collections.ParliamentaryGroupCollection

.. py:function:: get_parliamentary_group(app: onegov.pas.app.PasApp, id: uuid.UUID) -> onegov.pas.models.ParliamentaryGroup | None

.. py:function:: get_parties(app: onegov.pas.app.PasApp, active: bool = True) -> onegov.pas.collections.PartyCollection

.. py:function:: get_party(app: onegov.pas.app.PasApp, id: uuid.UUID) -> onegov.pas.models.Party | None

.. py:function:: get_rate_sets(app: onegov.pas.app.PasApp, active: bool = True) -> onegov.pas.collections.RateSetCollection

.. py:function:: get_rate_set(app: onegov.pas.app.PasApp, id: uuid.UUID) -> onegov.pas.models.RateSet | None

.. py:function:: get_settlement_runs(app: onegov.pas.app.PasApp, active: bool = True) -> onegov.pas.collections.SettlementRunCollection

.. py:function:: get_settlement_run(app: onegov.pas.app.PasApp, id: uuid.UUID) -> onegov.pas.models.SettlementRun | None

.. py:class:: SettlementRunExport(settlement_run: onegov.pas.models.SettlementRun, entity: onegov.pas.models.Party | onegov.pas.models.Commission | onegov.pas.models.Parliamentarian, category: str | None = None)

   Tiny wrapper class for easing the morepath Path Linking
   (Acts as a container to pass multiple models in the morepath link.)



   .. py:attribute:: settlement_run


   .. py:attribute:: entity


   .. py:attribute:: category
      :value: None



   .. py:attribute:: id


   .. py:attribute:: entity_id


   .. py:attribute:: literal_type


.. py:class:: SettlementRunAllExport(settlement_run: onegov.pas.models.SettlementRun, category: str)

   Special model for 'all' exports without entity 


   .. py:attribute:: settlement_run


   .. py:attribute:: category


   .. py:attribute:: id


.. py:function:: get_settlement_run_export(request: onegov.town6.request.TownRequest, id: uuid.UUID, category: str, entity_id: uuid.UUID, literal_type: str) -> SettlementRunExport | None

.. py:function:: get_settlement_run_export_all(request: onegov.town6.request.TownRequest, id: uuid.UUID, category: str) -> SettlementRunAllExport | None

   Path for 'all' exports without specific entity