swissvotes.models.column_mapper
===============================

.. py:module:: swissvotes.models.column_mapper


Attributes
----------

.. autoapisummary::

   swissvotes.models.column_mapper.ColumnItem


Classes
-------

.. autoapisummary::

   swissvotes.models.column_mapper.ColumnMapperDataset
   swissvotes.models.column_mapper.ColumnMapperMetadata


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

.. py:type:: ColumnItem
   :canonical: tuple[str, str, str | None, bool, int | None, int | None]


.. py:class:: ColumnMapperDataset

   Defines the columns used in the dataset and provides helper functions.

   Typically, you want to iterate over all attributes of a vote (``columns``,
   ``items``, ``get_values``, ``get_items``) and set/get them (``set_value``,
   ``get_value``).



   .. py:property:: columns
      :type: dict[str, str]


      The SwissVote attribute name and its column in the dataset.

      Attribute names starting with an ``!`` are used to indicate JSON
      attributes.



   .. py:method:: set_value(vote: onegov.swissvotes.models.vote.SwissVote, attribute: str, value: Any) -> None

      Set the given value of a vote. 



   .. py:method:: get_value(vote: onegov.swissvotes.models.vote.SwissVote, attribute: str) -> Any

      Get the given value of a vote. 



   .. py:method:: get_values(vote: onegov.swissvotes.models.vote.SwissVote) -> collections.abc.Iterator[Any]

      Get all values of a vote in order. 



   .. py:method:: get_items(vote: onegov.swissvotes.models.vote.SwissVote) -> collections.abc.Iterator[tuple[str, Any]]

      Get all names and values of a vote in order. 



   .. py:method:: items() -> collections.abc.Iterator[ColumnItem]

      Returns the attributes and column names together with additional
      information (type, nullable, precision, scale).




.. py:class:: ColumnMapperMetadata

   Defines the columns used for the metadata and provides helper
   functions.

   Typically, you want to iterate over all attributes of a vote (``columns``,
   ``items``, ``get_values``, ``get_items``) and set/get them (``set_value``,
   ``get_value``).



   .. py:property:: columns
      :type: dict[str, str]


      The SwissVote attribute name and its column in the metadata file.

      Each line contains a type hint, a nullable hint, an attribute and
      optionally a key for list items.




   .. py:method:: set_value(data: dict[str, Any], attribute: str, value: Any) -> None

      Set the given value to the metadata dict of a single line. 



   .. py:method:: items() -> collections.abc.Iterator[ColumnItem]

      Returns the attributes and column names together with additional
      information (type, nullable, precision, scale).