Utils

This package contains utilities shared among all Django apps

Decorators

This file contains decorators that are used in core.

integreat_cms.core.utils.decorators.disable_for_loaddata(function: Callable) → Callable

Mark a signal to not be run during the loaddata command

Parameters:

function (Callable) – The function that should not run during loaddata

Returns:

The wrapped function

Return type:

Callable

Machine Translation API Client

This module contains utilities for machine translation API clients

class integreat_cms.core.utils.machine_translation_api_client.MachineTranslationApiClient(request: HttpRequest, form_class: ModelFormMetaclass)

Bases: ABC

A base class for API clients interacting with machine translation APIs

Parameters:

• request (HttpRequest)

• form_class (ModelFormMetaclass)

__init__(request: HttpRequest, form_class: ModelFormMetaclass) → None

Constructor initializes the class variables

Parameters:

• region – The current region

• form_class (ModelFormMetaclass) – The CustomContentModelForm subclass of the current content type

• request (HttpRequest)

Return type:

None

check_usage(region: Region, source_translation: EventTranslation | PageTranslation | POITranslation) → tuple[bool, int]

This function checks if the attempted translation would exceed the region’s word limit

Parameters:

• region (Region) – region for which to check usage

• source_translation (EventTranslation | (PageTranslation | POITranslation)) – single content object

Returns:

translation would exceed limit, region budget, attempted translation word count

Return type:

tuple[bool, int]

form_class: ModelFormMetaclass

The CustomContentModelForm

region: Region

The current region

request: HttpRequest

The current request

translate_object(obj: Event | Page | POI, language_slug: str) → None

This function translates one content object

Parameters:

• obj (Event | Page | POI) – The content object

• language_slug (str) – The target language slug

Return type:

None

abstract translate_queryset(queryset: QuerySet[Event | Page | POI], language_slug: str) → None

Translate a given queryset into one specific language. Needs to be implemented by subclasses of MachineTranslationApiClient.

Parameters:

• queryset (QuerySet[Event | Page | POI]) – The QuerySet of content objects to translate

• language_slug (str) – The target language slug to translate into

Return type:

None

Machine Translation Provider

This module contains utilities for machine translations

class integreat_cms.core.utils.machine_translation_provider.MachineTranslationProvider

Bases: object

A base class for machine translation providers. It should be used as static class, without instantiating it.

__init__()

api_client: type | None = None

The API client class for this provider

bulk_only_for_staff: bool = False

Whether to require the staff permission for bulk actions

enabled: bool = True

Whether the provider is globally enabled

classmethod is_enabled(region: Region, language: Language) → bool

Whether this provider is enabled for a given region and language. Call this from the parent class.

Parameters:

• region (Region) – The given region

• language (Language) – The given language

Returns:

Wether this provider is enabled for the given region and language

Return type:

bool

is_needed(queryset: QuerySet[Event | Page | POI], target_language: Language) → list[Event | Page | POI]

Checks if a machine translation is needed, thus checking if the translation status is UP_TO_DATE or MACHINE_TRANSLATED and then returns a lit of translations which are to be updated

Parameters:

• queryset (QuerySet[Event | Page | POI]) – The content model which should be translated

• target_language (Language) – The target language

Returns:

translations which need to be translated and updated

Return type:

list[Event | Page | POI]

static is_permitted(region: Region, user: SimpleLazyObject, content_type: ModelBase) → bool

Checks if a machine translation is permitted, i.e. if for the given region, MT of the given content type is allowed and MT into the target language is enabled for the requesting user.

Parameters:

• region (Region) – The current region

• user (SimpleLazyObject) – The current user

• content_type (ModelBase) – The content model which should be translated

Returns:

Whether the translation is permitted

Return type:

bool

name: str = ''

The readable name for this provider

region_enabled_attr: str | None = None

The name of the region attribute which denotes whether the provider is enabled in a region

supported_source_languages: list[str] = []

The supported source languages

supported_target_languages: list[str] = []

The supported target languages

class integreat_cms.core.utils.machine_translation_provider.MachineTranslationProviderType

Bases: type

A meta class for machine translation providers

__init__(*args, **kwargs)

mro()

Return a type’s method resolution order.

Strtobool

General utility functions that are used by multiple modules within our project.

integreat_cms.core.utils.strtobool.strtobool(val: str) → bool

Convert a string representation of truth to true (1) or false (0). True values are ‘y’, ‘yes’, ‘t’, ‘true’, ‘on’, and ‘1’; false values are ‘n’, ‘no’, ‘f’, ‘false’, ‘off’, and ‘0’. Raises ValueError if ‘val’ is anything else.

Parameters:

val (str)

Return type:

bool

Word Count

integreat_cms.core.utils.word_count.word_count(translation: EventTranslation | PageTranslation | POITranslation) → int

This function counts the number of words in a content translation

Parameters:

translation (EventTranslation | (PageTranslation | POITranslation))

Return type:

int