election_day.utils.archive_generator
====================================

.. py:module:: election_day.utils.archive_generator


Attributes
----------

.. autoapisummary::

   election_day.utils.archive_generator.Entity


Classes
-------

.. autoapisummary::

   election_day.utils.archive_generator.ArchiveGenerator


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

.. py:type:: Entity
   :canonical: Election | ElectionCompound | Vote


.. py:class:: ArchiveGenerator(app: onegov.election_day.ElectionDayApp)

   Iterates over all Votes, Election and ElectionCompounds and runs the
   csv export function on each of them.
   This creates a bunch of csv files, which are zipped and the path to
   the zip is returned.


   .. py:attribute:: archive_dir
      :type:  fs.subfs.SubFS[fs.subfs.FS]


   .. py:attribute:: app


   .. py:attribute:: session


   .. py:attribute:: temp_fs


   .. py:attribute:: archive_parent_dir
      :value: 'zip'



   .. py:attribute:: MAX_FILENAME_LENGTH
      :value: 60



   .. py:method:: generate_csv() -> None

      Creates csv files with a directory structure like this::

          archive
          ├── elections
          │        └── 2022
          │             ├── election1.csv
          │             ├── election2.csv
          │             └── ...
          │
          └── votes
              ├── 2021
              │   └── vote1.csv
              └── 2022
                  └── vote1.csv




   .. py:method:: get_all_rows_for_votes(votes: collections.abc.Collection[onegov.election_day.models.Vote]) -> list[dict[str, Any]]


   .. py:method:: group_by_year(entities: collections.abc.Iterable[EntityT]) -> list[list[EntityT]]

      Creates a list of lists, grouped by year.

      :param entities: Iterable of entities
      :type entities: list[Vote] | list[Election] | list[ElectionCompound]

      :returns: A nested list, where each sublist contains all from one year.

      For example:

          Given a list:
          votes = [vote_1, vote_2, vote_3, ...]

          We create a new  list:
          groups = [[vote_1, vote_2], [vote_3], ...]

          where vote_1.date.year == vote_2.date.year



   .. py:method:: zip_dir(base_dir: fs.subfs.SubFS[fs.subfs.FS]) -> str | None

      Recursively zips a directory (base_dir).

      :param base_dir: is a directory in a temporary file system.
          Contains subdirectories 'votes' and 'elections', as well as various
          other files to include.

      :returns path to the zipfile or None if base_dir doesn't exist
          or is empty.



   .. py:method:: all_counted_votes_with_results() -> list[onegov.election_day.models.Vote]


   .. py:method:: all_counted_election_with_results() -> list[onegov.election_day.models.Election]


   .. py:method:: all_counted_election_compounds_with_results() -> list[onegov.election_day.models.ElectionCompound]


   .. py:method:: filter_by_final_results(all_entities: collections.abc.Iterable[EntityT]) -> list[EntityT]


   .. py:property:: archive_system_path
      :type: str | None



   .. py:method:: include_docs() -> None


   .. py:method:: export_item(item: EntityT, dir: str) -> None


   .. py:method:: generate_archive() -> str | None