swissvotes.models.file

Classes

HasFiles	Base class for protocol classes.
SwissVoteFile	An attachment to a vote.
TranslatablePageFile	An attachment to a translatable content page.
FileSubCollection	A subset of files prefixed by the descriptor's name.
LocalizedFile	A helper for localized files.
LocalizedFiles

Module Contents

class swissvotes.models.file.HasFiles[T: onegov.file.File]

Bases: Protocol

Base class for protocol classes.

Protocol classes are defined as:

class Proto(Protocol):
    def meth(self) -> int:
        ...

Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing).

For example:

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures. Protocol classes can be generic, they are defined as:

class GenProto[T](Protocol):
    def meth(self) -> T:
        ...

files: list[T]

class swissvotes.models.file.SwissVoteFile

Bases: onegov.file.File

An attachment to a vote.

__mapper_args__

linked_swissvotes: sqlalchemy.orm.Mapped[list[onegov.swissvotes.models.SwissVote]]

property locale: str

property filename: str

class swissvotes.models.file.TranslatablePageFile

Bases: onegov.file.File

An attachment to a translatable content page.

__mapper_args__

linked_swissvotes_page: sqlalchemy.orm.Mapped[list[onegov.swissvotes.models.TranslatablePage]]

property locale: str

property filename: str

class swissvotes.models.file.FileSubCollection

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

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

__get__[T: onegov.file.File](instance: HasFiles[T] | None, owner: type[object]) → list[T]

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()

extension

label

static_views

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

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

__get_by_locale__[T: onegov.file.File](instance: HasFilesAndSessionManager[T] | None, locale: str | None = None) → T | None

__get__[T: onegov.file.File](instance: HasFilesAndSessionManager[T] | None, owner: type[object]) → T | None

__set_by_locale__[T: onegov.file.File](instance: HasFilesAndSessionManager[T], value: T, locale: str | None = None) → None

__set__[T: onegov.file.File](instance: HasFilesAndSessionManager[T], value: T) → None

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

__delete__(instance: HasFilesAndSessionManager[Any]) → None

class swissvotes.models.file.LocalizedFiles

classmethod localized_files() → dict[str, LocalizedFile]