swissvotes.models.file

Module Contents

Classes

HasFiles
SwissVoteFile	An attachment to a vote.
TranslatablePageFile	An attachment to a translatable content page.
FileSubCollection
LocalizedFile	A helper for localized files.
LocalizedFiles

Attributes

FileT

class swissvotes.models.file.HasFiles

Bases: Protocol[FileT]

files: sqlalchemy.orm.relationship[list[FileT]]

swissvotes.models.file.FileT

class swissvotes.models.file.SwissVoteFile

Bases: onegov.file.File

An attachment to a vote.

property locale: str

property filename: str

__mapper_args__

class swissvotes.models.file.TranslatablePageFile

Bases: onegov.file.File

An attachment to a translatable content page.

property locale: str

property filename: str

__mapper_args__

class swissvotes.models.file.FileSubCollection

__set_name__(owner: type[HasFiles[FileT]], name: str) → None

__get__(instance: HasFiles[FileT] | None, owner: type[HasFiles[FileT]]) → list[FileT]

class swissvotes.models.file.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()

__set_name__(owner: type[HasFiles[FileT]], name: str) → None

__get_localized_name__(instance: HasFilesAndSessionManager[FileT], locale: str | None = None) → str

__get_by_locale__(instance: HasFilesAndSessionManager[FileT] | None, locale: str | None = None) → FileT | None

__get__(instance: HasFilesAndSessionManager[FileT] | None, owner: type[HasFilesAndSessionManager[FileT]]) → FileT | None

__set_by_locale__(instance: HasFilesAndSessionManager[FileT], value: FileT, locale: str | None = None) → None

__set__(instance: HasFilesAndSessionManager[FileT], value: FileT) → None

__delete_by_locale__(instance: HasFilesAndSessionManager[FileT], locale: str | None = None) → None

__delete__(instance: HasFilesAndSessionManager[FileT]) → None

class swissvotes.models.file.LocalizedFiles

classmethod localized_files() → dict[str, LocalizedFile]