swissvotes.models.file
======================

.. py:module:: swissvotes.models.file


Attributes
----------

.. autoapisummary::

   swissvotes.models.file.FileT


Classes
-------

.. autoapisummary::

   swissvotes.models.file.SwissVoteFile
   swissvotes.models.file.TranslatablePageFile
   swissvotes.models.file.FileSubCollection
   swissvotes.models.file.LocalizedFile
   swissvotes.models.file.LocalizedFiles


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

.. py:data:: FileT

.. py:class:: SwissVoteFile

   Bases: :py:obj:`onegov.file.File`


   An attachment to a vote. 


   .. py:attribute:: __mapper_args__


   .. py:attribute:: linked_swissvotes
      :type:  sqlalchemy.orm.relationship[list[onegov.swissvotes.models.SwissVote]]


   .. py:property:: locale
      :type: str



   .. py:property:: filename
      :type: str



.. py:class:: TranslatablePageFile

   Bases: :py:obj:`onegov.file.File`


   An attachment to a translatable content page. 


   .. py:attribute:: __mapper_args__


   .. py:attribute:: linked_swissvotes_page
      :type:  sqlalchemy.orm.relationship[list[onegov.swissvotes.models.TranslatablePage]]


   .. py:property:: locale
      :type: str



   .. py:property:: filename
      :type: str



.. py:class:: FileSubCollection

   A subset of files prefixed by the descriptor's name. 


   .. py:method:: __set_name__(owner: type[HasFiles[FileT]], name: str) -> None


   .. py:method:: __get__(instance: HasFiles[FileT] | None, owner: type[HasFiles[FileT]]) -> list[FileT]


.. py:class:: LocalizedFile(extension: str, label: str, static_views: dict[str, str])

   A helper for localized files.

   Automatically choses the file according to the currently used locale. The
   files are internally stored as normal files using the filename to identify
   the wanted file.

   Example:

       class MyModel(Base, AssociatedFiles):
           pdf = LocalizedFile()



   .. py:attribute:: extension


   .. py:attribute:: label


   .. py:attribute:: static_views


   .. py:method:: __set_name__(owner: type[HasFiles[FileT]], name: str) -> None


   .. py:method:: __get_localized_name__(instance: HasFilesAndSessionManager[FileT], locale: str | None = None) -> str


   .. py:method:: __get_by_locale__(instance: HasFilesAndSessionManager[FileT] | None, locale: str | None = None) -> FileT | None


   .. py:method:: __get__(instance: HasFilesAndSessionManager[FileT] | None, owner: type[HasFilesAndSessionManager[FileT]]) -> FileT | None


   .. py:method:: __set_by_locale__(instance: HasFilesAndSessionManager[FileT], value: FileT, locale: str | None = None) -> None


   .. py:method:: __set__(instance: HasFilesAndSessionManager[FileT], value: FileT) -> None


   .. py:method:: __delete_by_locale__(instance: HasFilesAndSessionManager[FileT], locale: str | None = None) -> None


   .. py:method:: __delete__(instance: HasFilesAndSessionManager[FileT]) -> None


.. py:class:: LocalizedFiles

   .. py:method:: localized_files() -> dict[str, LocalizedFile]
      :classmethod: