election_day.models.vote.vote

Classes

Vote	A vote describes the issue being voted on. For example,

Module Contents

class election_day.models.vote.vote.Vote

Bases: onegov.core.orm.Base, onegov.core.orm.mixins.ContentMixin, onegov.election_day.models.mixins.LastModifiedMixin, onegov.election_day.models.mixins.DomainOfInfluenceMixin, onegov.election_day.models.mixins.StatusMixin, onegov.election_day.models.mixins.TitleTranslationsMixin, onegov.election_day.models.mixins.IdFromTitlesMixin, onegov.election_day.models.vote.mixins.DerivedBallotsCountMixin, onegov.election_day.models.mixins.ExplanationsPdfMixin

A vote describes the issue being voted on. For example, “Vote for Net Neutrality” or “Vote for Basic Income”.

__tablename__ = 'votes'

property polymorphic_base: type[Vote]

type: sqlalchemy.orm.Mapped[str]

__mapper_args__

id: sqlalchemy.orm.Mapped[str]

external_id: sqlalchemy.orm.Mapped[str | None]

shortcode: sqlalchemy.orm.Mapped[str | None]

title_translations: sqlalchemy.orm.Mapped[collections.abc.Mapping[str, str]]

title

short_title_translations: sqlalchemy.orm.Mapped[collections.abc.Mapping[str, str] | None]

short_title

title_observer(title_translations: collections.abc.Mapping[str, str], short_title_translations: collections.abc.Mapping[str, str]) → None

date: sqlalchemy.orm.Mapped[datetime.date]

ballots: sqlalchemy.orm.Mapped[list[onegov.election_day.models.vote.ballot.Ballot]]

ballot(ballot_type: onegov.election_day.types.BallotType) → onegov.election_day.models.vote.ballot.Ballot

Returns the given ballot if it exists, creates it if not.

property proposal: onegov.election_day.models.vote.ballot.Ballot

property counted: bool

Checks if there are results for all entities.

property has_results: bool

True if there are any results.

property answer: str | None

property yeas_percentage: float

The percentage of yeas (discounts empty/invalid ballots).

property nays_percentage: float

The percentage of nays (discounts empty/invalid ballots).

property progress: tuple[int, int]

A tuple of (counted entities, total entities).

For complex votes, it is assumed that every ballot has the same progress.

property counted_entities: list[str]

The names of the already counted entities.

Might contain an empty string in case of expats.

For complex votes, it is assumed that every ballot has the same progress.

yeas

nays

empty

invalid

eligible_voters

cast_ballots

expats

aggregate_results(attribute: str) → int

Gets the sum of the given attribute from the results.

classmethod aggregate_results_expression(attribute: str) → sqlalchemy.sql.ColumnElement[int]

Gets the sum of the given attribute from the results, as SQL expression.

last_ballot_change() → datetime.datetime | None

Returns last change of the vote, its ballots and any of its results.

classmethod _last_ballot_change_expression() → sqlalchemy.sql.ColumnElement[datetime.datetime | None]

last_modified() → datetime.datetime | None

Returns last change of the vote, its ballots and any of its results.

classmethod _last_modified_expression() → sqlalchemy.sql.ColumnElement[datetime.datetime | None]

data_sources: sqlalchemy.orm.Mapped[list[onegov.election_day.models.DataSourceItem]]

notifications: sqlalchemy.orm.DynamicMapped[onegov.election_day.models.Notification]

screens: sqlalchemy.orm.DynamicMapped[onegov.election_day.models.Screen]

related_link: onegov.core.orm.mixins.dict_property[str | None]

related_link_label: onegov.core.orm.mixins.dict_property[dict[str, str] | None]

has_expats: onegov.core.orm.mixins.dict_property[bool]

domain_segment: onegov.core.orm.mixins.dict_property[str]

tie_breaker_vocabulary: onegov.core.orm.mixins.dict_property[bool]

direct: onegov.core.orm.mixins.dict_property[bool]

clear_results(clear_all: bool = False) → None

Clear all the results.