swissvotes.models.vote ====================== .. py:module:: swissvotes.models.vote Attributes ---------- .. autoapisummary:: swissvotes.models.vote.T swissvotes.models.vote.StrT Classes ------- .. autoapisummary:: swissvotes.models.vote.Poster swissvotes.models.vote.encoded_property swissvotes.models.vote.localized_property swissvotes.models.vote.SwissVote Module Contents --------------- .. py:data:: T .. py:data:: StrT .. py:class:: Poster Bases: :py:obj:`NamedTuple` .. py:attribute:: thumbnail :type: str .. py:attribute:: image :type: str .. py:attribute:: url :type: str | None .. py:attribute:: label :type: str .. py:class:: encoded_property(nullable: bool = True) A shorthand property to return the label of an encoded value. Requires the instance the have a `codes`-lookup function. Creates the SqlAlchemy Column (with a prefixed underline). Example: class MyClass: value = encoded_property() def codes(self, attributes): return {0: 'None', 1: 'One'} .. py:attribute:: nullable :value: True .. py:method:: __set_name__(owner: type[HasCodes[T]], name: str) -> None .. py:method:: __get__(instance: HasCodes[T], owner: type[object]) -> T | None .. py:class:: localized_property Bases: :py:obj:`Generic`\ [\ :py:obj:`StrT`\ ] A shorthand property to return a localized attribute. Requires at least a `xxx_de` attribute and falls back to this. Example: class MyClass: value_de = Column(Text) value_fr = Column(Text) value = localized_property() .. py:method:: __set_name__(owner: type[HasSessionManager], name: str) -> None .. py:method:: __get__(instance: HasSessionManager, owner: type[HasSessionManager]) -> StrT .. py:class:: SwissVote Bases: :py:obj:`onegov.core.orm.Base`, :py:obj:`onegov.core.orm.mixins.TimestampMixin`, :py:obj:`onegov.swissvotes.models.file.LocalizedFiles`, :py:obj:`onegov.core.orm.mixins.ContentMixin` A single vote as defined by the code book. There are a lot of columns: * Some general, ready to be used attributes (bfs_number, ...) * Encoded attributes, where the raw integer value is stored prefixed with an underline and the attribute returns a translatable label by using the ``codes`` function, e.g. ``_legal_form``, ``legal_form`` and ``codes(' _legal_form')``. * Descriptors, easily accessible by using ``policy_areas``. * A lot of lazy loaded, cantonal results only used when importing/exporting the dataset. * Recommendations from different parties and assocciations. Internally stored as JSON and easily accessible and group by slogan with ``recommendations_parties``, ``recommendations_divergent_parties`` and ``recommendations_associations``. * Different localized attachments, some of them indexed for full text search. * Metadata from external information sources such as Museum für Gestaltung can be stored in the content or meta field provided by the ``ContentMixin``. .. py:attribute:: __tablename__ :value: 'swissvotes' .. py:attribute:: ORGANIZATION_NO_LONGER_EXISTS :value: 9999 .. py:attribute:: term :type: str | None :value: None .. py:attribute:: _legal_form :type: sqlalchemy.Column[int] .. py:method:: codes(attribute: str) -> dict[int | None, str] :staticmethod: Returns the codes for the given attribute as defined in the code book. .. py:method:: metadata_codes(attribute: str) -> dict[str, str] :staticmethod: .. py:attribute:: id :type: sqlalchemy.Column[int] .. py:attribute:: bfs_number :type: sqlalchemy.Column[decimal.Decimal] .. py:attribute:: date :type: sqlalchemy.Column[datetime.date] .. py:attribute:: title_de :type: sqlalchemy.Column[str] .. py:attribute:: title_fr :type: sqlalchemy.Column[str] .. py:attribute:: title :type: localized_property[str] .. py:attribute:: short_title_de :type: sqlalchemy.Column[str] .. py:attribute:: short_title_fr :type: sqlalchemy.Column[str] .. py:attribute:: short_title_en :type: sqlalchemy.Column[str | None] .. py:attribute:: short_title :type: localized_property[str] .. py:attribute:: brief_description_title :type: sqlalchemy.Column[str | None] .. py:attribute:: keyword :type: sqlalchemy.Column[str | None] .. py:attribute:: legal_form .. py:attribute:: parliamentary_initiated .. py:attribute:: initiator_de :type: sqlalchemy.Column[str | None] .. py:attribute:: initiator_fr :type: sqlalchemy.Column[str | None] .. py:attribute:: initiator .. py:attribute:: anneepolitique :type: sqlalchemy.Column[str | None] .. py:attribute:: bfs_map_de :type: sqlalchemy.Column[str | None] .. py:attribute:: bfs_map_fr :type: sqlalchemy.Column[str | None] .. py:attribute:: bfs_map_en :type: sqlalchemy.Column[str | None] .. py:attribute:: bfs_map .. py:attribute:: bfs_dashboard_de :type: sqlalchemy.Column[str | None] .. py:attribute:: bfs_dashboard_fr :type: sqlalchemy.Column[str | None] .. py:attribute:: bfs_dashboard_en :type: sqlalchemy.Column[str | None] .. py:attribute:: bfs_dashboard .. py:property:: bfs_map_host :type: str | None Returns the Host of the BFS Map link for CSP. .. py:attribute:: link_curia_vista_de :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_curia_vista_fr :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_curia_vista .. py:attribute:: link_bk_results_de :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_bk_results_fr :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_bk_results .. py:attribute:: link_bk_chrono_de :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_bk_chrono_fr :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_bk_chrono .. py:attribute:: link_federal_council_de :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_federal_council_fr :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_federal_council_en :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_federal_council .. py:attribute:: link_federal_departement_de :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_federal_departement_fr :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_federal_departement_en :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_federal_departement .. py:attribute:: link_federal_office_de :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_federal_office_fr :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_federal_office_en :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_federal_office .. py:attribute:: link_post_vote_poll_de :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_post_vote_poll_fr :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_post_vote_poll_en :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_post_vote_poll .. py:attribute:: link_easyvote_de :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_easyvote_fr :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_easyvote .. py:attribute:: link_campaign_yes_1_de :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_campaign_yes_1_fr :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_campaign_yes_1 .. py:attribute:: link_campaign_yes_2_de :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_campaign_yes_2_fr :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_campaign_yes_2 .. py:attribute:: link_campaign_yes_3_de :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_campaign_yes_3_fr :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_campaign_yes_3 .. py:attribute:: link_campaign_no_1_de :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_campaign_no_1_fr :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_campaign_no_1 .. py:attribute:: link_campaign_no_2_de :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_campaign_no_2_fr :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_campaign_no_2 .. py:attribute:: link_campaign_no_3_de :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_campaign_no_3_fr :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: link_campaign_no_3 .. py:property:: campaign_links :type: dict[str, list[str]] .. py:attribute:: campaign_finances_yea_total :type: sqlalchemy.Column[int | None] .. py:attribute:: campaign_finances_nay_total :type: sqlalchemy.Column[int | None] .. py:attribute:: campaign_finances_yea_donors_de :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: campaign_finances_yea_donors_fr :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: campaign_finances_yea_donors .. py:attribute:: campaign_finances_nay_donors_de :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: campaign_finances_nay_donors_fr :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: campaign_finances_nay_donors .. py:attribute:: campaign_finances_link_de :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: campaign_finances_link_fr :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: campaign_finances_link .. py:attribute:: posters_mfg_yea :type: sqlalchemy.Column[str | None] .. py:attribute:: posters_mfg_nay :type: sqlalchemy.Column[str | None] .. py:attribute:: posters_bs_yea :type: sqlalchemy.Column[str | None] .. py:attribute:: posters_bs_nay :type: sqlalchemy.Column[str | None] .. py:attribute:: posters_sa_yea :type: sqlalchemy.Column[str | None] .. py:attribute:: posters_sa_nay :type: sqlalchemy.Column[str | None] .. py:attribute:: posters_mfg_yea_imgs :type: onegov.core.orm.mixins.dict_property[dict[str, Any]] .. py:attribute:: posters_mfg_nay_imgs :type: onegov.core.orm.mixins.dict_property[dict[str, Any]] .. py:attribute:: posters_bs_yea_imgs :type: onegov.core.orm.mixins.dict_property[dict[str, Any]] .. py:attribute:: posters_bs_nay_imgs :type: onegov.core.orm.mixins.dict_property[dict[str, Any]] .. py:attribute:: posters_sa_yea_imgs :type: onegov.core.orm.mixins.dict_property[dict[str, Any]] .. py:attribute:: posters_sa_nay_imgs :type: onegov.core.orm.mixins.dict_property[dict[str, Any]] .. py:method:: posters(request: onegov.swissvotes.request.SwissvotesRequest) -> dict[str, list[Poster]] .. py:attribute:: media_ads_total :type: sqlalchemy.Column[int | None] .. py:attribute:: media_ads_yea_p :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: media_coverage_articles_total :type: sqlalchemy.Column[int | None] .. py:attribute:: media_coverage_tonality_total :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: descriptor_1_level_1 :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: descriptor_1_level_2 :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: descriptor_1_level_3 :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: descriptor_2_level_1 :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: descriptor_2_level_2 :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: descriptor_2_level_3 :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: descriptor_3_level_1 :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: descriptor_3_level_2 :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: descriptor_3_level_3 :type: sqlalchemy.Column[decimal.Decimal | None] .. py:property:: policy_areas :type: list[onegov.swissvotes.models.policy_area.PolicyArea] Returns the policy areas / descriptors of the vote. .. py:attribute:: result .. py:attribute:: result_turnout :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: result_people_accepted .. py:attribute:: result_people_yeas_p :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: result_cantons_accepted .. py:attribute:: result_cantons_yeas :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: result_cantons_nays :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: result_ag_accepted .. py:attribute:: result_ai_accepted .. py:attribute:: result_ar_accepted .. py:attribute:: result_be_accepted .. py:attribute:: result_bl_accepted .. py:attribute:: result_bs_accepted .. py:attribute:: result_fr_accepted .. py:attribute:: result_ge_accepted .. py:attribute:: result_gl_accepted .. py:attribute:: result_gr_accepted .. py:attribute:: result_ju_accepted .. py:attribute:: result_lu_accepted .. py:attribute:: result_ne_accepted .. py:attribute:: result_nw_accepted .. py:attribute:: result_ow_accepted .. py:attribute:: result_sg_accepted .. py:attribute:: result_sh_accepted .. py:attribute:: result_so_accepted .. py:attribute:: result_sz_accepted .. py:attribute:: result_tg_accepted .. py:attribute:: result_ti_accepted .. py:attribute:: result_ur_accepted .. py:attribute:: result_vd_accepted .. py:attribute:: result_vs_accepted .. py:attribute:: result_zg_accepted .. py:attribute:: result_zh_accepted .. py:property:: number_of_cantons :type: int .. py:property:: results_cantons :type: dict[str, list[onegov.swissvotes.models.region.Region]] Returns the results of all cantons. .. py:attribute:: procedure_number :type: sqlalchemy.Column[str | None] .. py:attribute:: position_federal_council .. py:attribute:: position_parliament .. py:attribute:: position_national_council .. py:attribute:: position_national_council_yeas :type: sqlalchemy.Column[int | None] .. py:attribute:: position_national_council_nays :type: sqlalchemy.Column[int | None] .. py:attribute:: position_council_of_states .. py:attribute:: position_council_of_states_yeas :type: sqlalchemy.Column[int | None] .. py:attribute:: position_council_of_states_nays :type: sqlalchemy.Column[int | None] .. py:attribute:: duration_federal_assembly :type: sqlalchemy.Column[int | None] .. py:attribute:: duration_initative_collection :type: sqlalchemy.Column[int | None] .. py:attribute:: duration_referendum_collection :type: sqlalchemy.Column[int | None] .. py:attribute:: signatures_valid :type: sqlalchemy.Column[int | None] .. py:attribute:: recommendations :type: sqlalchemy.Column[dict[str, int]] .. py:attribute:: recommendations_other_yes_de :type: sqlalchemy.Column[str | None] .. py:attribute:: recommendations_other_yes_fr :type: sqlalchemy.Column[str | None] .. py:attribute:: recommendations_other_yes .. py:attribute:: recommendations_other_no_de :type: sqlalchemy.Column[str | None] .. py:attribute:: recommendations_other_no_fr :type: sqlalchemy.Column[str | None] .. py:attribute:: recommendations_other_no .. py:attribute:: recommendations_other_counter_proposal_de :type: sqlalchemy.Column[str | None] .. py:attribute:: recommendations_other_counter_proposal_fr :type: sqlalchemy.Column[str | None] .. py:attribute:: recommendations_other_counter_proposal .. py:attribute:: recommendations_other_popular_initiative_de :type: sqlalchemy.Column[str | None] .. py:attribute:: recommendations_other_popular_initiative_fr :type: sqlalchemy.Column[str | None] .. py:attribute:: recommendations_other_popular_initiative .. py:attribute:: recommendations_other_free_de :type: sqlalchemy.Column[str | None] .. py:attribute:: recommendations_other_free_fr :type: sqlalchemy.Column[str | None] .. py:attribute:: recommendations_other_free .. py:attribute:: recommendations_divergent :type: sqlalchemy.Column[dict[str, Any]] .. py:method:: get_recommendation(name: str) -> str | None Get the recommendations by name. .. py:method:: get_recommendation_of_existing_parties() -> dict[str, int] Get only the existing parties as when this vote was conducted .. py:method:: group_recommendations(recommendations: collections.abc.Iterable[tuple[T, int | None]], ignore_unknown: bool = False) -> dict[str, list[T]] Group the given recommendations by slogan. .. py:method:: get_actors_share(actor: str) -> int .. py:property:: sorted_actors_list :type: list[str] Returns a list of actors of the current vote sorted by: 1. codes for recommendations (strength table) 2. by electoral share (descending) It filters out those parties who have no electoral share .. py:property:: recommendations_parties :type: dict[str, list[onegov.swissvotes.models.actor.Actor]] The recommendations of the parties grouped by slogans. .. py:property:: recommendations_divergent_parties :type: dict[str, list[tuple[onegov.swissvotes.models.actor.Actor, onegov.swissvotes.models.region.Region]]] The divergent recommendations of the parties grouped by slogans. .. py:property:: recommendations_associations :type: dict[str, list[onegov.swissvotes.models.actor.Actor]] The recommendations of the associations grouped by slogans. .. py:attribute:: national_council_election_year :type: sqlalchemy.Column[int | None] .. py:attribute:: national_council_share_fdp :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_cvp :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_sps :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_svp :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_lps :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_ldu :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_evp :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_csp :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_pda :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_poch :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_gps :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_sd :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_rep :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_edu :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_fps :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_lega :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_kvp :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_glp :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_bdp :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_mcg :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_mitte :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_ubrige :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_yeas :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_nays :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_none :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_empty :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_free_vote :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_neutral :type: sqlalchemy.Column[decimal.Decimal | None] .. py:attribute:: national_council_share_unknown :type: sqlalchemy.Column[decimal.Decimal | None] .. py:property:: has_national_council_share_data :type: bool Returns true, if the vote contains national council share data. Returns true, if a national council year is set and * any aggregated national council share data is present (yeas, nays, none, empty, free vote, neutral, unknown) * or any national council share data of parties with national council share and a recommendation regarding this vote is present .. py:attribute:: files :value: None .. py:attribute:: voting_text .. py:attribute:: brief_description .. py:attribute:: federal_council_message .. py:attribute:: parliamentary_initiative .. py:attribute:: parliamentary_committee_report .. py:attribute:: federal_council_opinion .. py:attribute:: parliamentary_debate .. py:attribute:: voting_booklet .. py:attribute:: easyvote_booklet .. py:attribute:: resolution .. py:attribute:: realization .. py:attribute:: ad_analysis .. py:attribute:: results_by_domain .. py:attribute:: foeg_analysis .. py:attribute:: post_vote_poll .. py:attribute:: post_vote_poll_methodology .. py:attribute:: post_vote_poll_dataset .. py:attribute:: post_vote_poll_dataset_sav .. py:attribute:: post_vote_poll_dataset_dta .. py:attribute:: post_vote_poll_codebook .. py:attribute:: post_vote_poll_codebook_xlsx .. py:attribute:: post_vote_poll_report .. py:attribute:: leewas_post_vote_poll_results .. py:attribute:: preliminary_examination .. py:attribute:: campaign_finances_xlsx .. py:attribute:: campaign_material_yea .. py:attribute:: campaign_material_nay .. py:attribute:: campaign_material_other .. py:attribute:: campaign_material_metadata :type: sqlalchemy.Column[dict[str, Any]] .. py:attribute:: searchable_text_de_CH .. py:attribute:: searchable_text_fr_CH .. py:attribute:: searchable_text_it_CH .. py:attribute:: searchable_text_en_US .. py:attribute:: indexed_files .. py:method:: reindex_files() -> None Extract the text from the localized files and the campaign material and save it together with the language. Store the text of the **indexed only** localized files and **all** campaign material in the search indexes. The language is determined as follows: * For the localized files, the language is determined by the locale, e.g. `de_CH` -> `german`. * For the campaign material, the campaign metadata is used. If a document is (amongst others) `de` --> `german`. If (amongst others,) `fr` but not `de` --> `french`. If (amongst others) `it` but not `de` or `fr` --> `italian`. In all other cases `english`. .. py:method:: files_observer(files: list[onegov.swissvotes.models.file.SwissVoteFile]) -> None .. py:method:: get_file(name: str, locale: str | None = None, fallback: bool = True) -> onegov.swissvotes.models.file.SwissVoteFile | None Returns the requested localized file. Uses the current locale if no locale is given. Falls back to the default locale if the file is not available in the requested locale. .. py:method:: search_term_expression(term: str | None) -> str :staticmethod: Returns the given search term transformed to use within Postgres ``to_tsquery`` function. Removes all unwanted characters, replaces prefix matching, joins word together using FOLLOWED BY. .. py:method:: search(term: str | None = None) -> list[onegov.swissvotes.models.file.SwissVoteFile] Searches for the given term in the indexed attachments. Returns a tuple of attribute name and locale which can be used with ``get_file``.