election_day.utils.summaries

Attributes

`get_election_summary`(election, request[, url]) → onegov.core.types.JSONObject_ro	Returns some basic informations about the given election as a JSON
`get_election_compound_summary`(election_compound, request) → onegov.core.types.JSONObject_ro
`get_vote_summary`(vote, request[, url]) → onegov.core.types.JSONObject_ro	Returns some basic informations about the given vote as a JSON
`get_summary`(item, request) → onegov.core.types.JSONObject_ro	Returns some basic informations about the given election/vote as a JSON
`get_summaries`(items, request) → list[onegov.core.types.JSONObject_ro]	Converts the given list of election/votes to a JSON seriazable

type election_day.utils.summaries.ElectionCompoundOrPart = ElectionCompound | ElectionCompoundPart[source]

election_day.utils.summaries.get_election_summary(election: onegov.election_day.models.Election | onegov.election_day.models.ArchivedResult, request: onegov.election_day.request.ElectionDayRequest | None, url: str | None = None) → onegov.core.types.JSONObject_ro[source]: Returns some basic informations about the given election as a JSON seriazable dict.

election_day.utils.summaries.get_election_compound_summary(election_compound: ElectionCompoundOrPart | onegov.election_day.models.ArchivedResult, request: onegov.election_day.request.ElectionDayRequest | None, url: str | None = None, type_: str = 'election_compound') → onegov.core.types.JSONObject_ro[source]

election_day.utils.summaries.get_vote_summary(vote: onegov.election_day.models.Vote | onegov.election_day.models.ArchivedResult, request: onegov.election_day.request.ElectionDayRequest | None, url: str | None = None) → onegov.core.types.JSONObject_ro[source]: Returns some basic informations about the given vote as a JSON seriazable dict.

election_day.utils.summaries.get_summary(item: onegov.election_day.models.Election | onegov.election_day.models.ElectionCompound | onegov.election_day.models.Vote | onegov.election_day.models.ArchivedResult, request: onegov.election_day.request.ElectionDayRequest) → onegov.core.types.JSONObject_ro[source]: Returns some basic informations about the given election/vote as a JSON seriazable dict.

election_day.utils.summaries.get_summaries(items: collections.abc.Iterable[onegov.election_day.models.Election | onegov.election_day.models.ElectionCompound | onegov.election_day.models.Vote | onegov.election_day.models.ArchivedResult], request: onegov.election_day.request.ElectionDayRequest) → list[onegov.core.types.JSONObject_ro][source]: Converts the given list of election/votes to a JSON seriazable list of summaries.