election_day.utils.vote.ballot
==============================

.. py:module:: election_day.utils.vote.ballot


Classes
-------

.. autoapisummary::

   election_day.utils.vote.ballot.EntityData


Functions
---------

.. autoapisummary::

   election_day.utils.vote.ballot.get_ballot_data_by_entity
   election_day.utils.vote.ballot.get_ballot_data_by_district


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

.. py:class:: EntityData

   Bases: :py:obj:`typing_extensions.TypedDict`


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)


   .. py:attribute:: counted
      :type:  bool


   .. py:attribute:: percentage
      :type:  NotRequired[float]


.. py:function:: get_ballot_data_by_entity(ballot: onegov.election_day.models.Ballot) -> dict[int, EntityData]

   Returns the yeas/nays percentage by entity_id. 


.. py:function:: get_ballot_data_by_district(ballot: onegov.election_day.models.Ballot) -> dict[str, DistrictData]

   Returns the yeas/nays percentage grouped and keyed by district.