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:

• request (HttpRequest) – The current request

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

Return type:

None

alert_exceeds_limit() → None

Add messages alerting the user that machine translation failed due to insufficient translation budget

Return type:

None

alert_failed_translations() → None

Add messages informing the user about failed translations

Return type:

None

alert_insufficient_hix_score() → None

Add messages alerting the user that machine translation failed due to insufficient HIX scores

Return type:

None

alert_no_changes_made() → None

Add messages alerting the user that machine translation failed due to missing source translations

Return type:

None

alert_no_source_translation() → None

Add messages alerting the user that machine translation failed due to missing source translations

Return type:

None

alert_successful_translations() → None

Add messages informing the user about successful translations

Return type:

None

alert_too_long_text() → None

Add messages alerting the user that machine translation failed because translation generated by MT was too long

Return type:

None

failed_because_exceeds_limit: list[str] = []

Content objects untranslatable due to insufficient translation budget

failed_because_insufficient_hix_score: list[str] = []

Content objects untranslatable due to too-low hix score

failed_because_no_changes_made: list[str] = []

Content objects untranslatable since no actual changes were made

failed_because_no_source_translation: list[str] = []

Content objects untranslatable due to missing source translations

failed_because_too_long_text: list[str] = []

Content objects untranslatable due to too long text (only applies for push notification translation)

failed_translations: list[str] = []

Translations with an attached API failure

filter_exceeds_limit(context: list[TranslationContext]) → list[TranslationContext]

This method filters out entries from the context list if translating them would exceed the translation budget.

The removed entries are stored in order to show users batched error messages after all objects have been handled.

Parameters:

context (list[TranslationContext]) – The list of translation contexts to filter

Returns:

The filtered list of translation contexts

Return type:

list[TranslationContext]

filter_insufficient_hix_score(context: list[TranslationContext]) → list[TranslationContext]

This method filters out entries from the context list if they do not have the required HIX score.

The removed entries are stored in order to show users batched error messages after all objects have been handled.

Parameters:

context (list[TranslationContext]) – The list of translation contexts to filter

Returns:

The filtered list of translation contexts

Return type:

list[TranslationContext]

filter_no_source_translation(context: list[TranslationContext]) → list[TranslationContext]

This method filters out entries from the context list if they do not have the required source translation.

The removed entries are stored in order to show users batched error messages after all objects have been handled.

Parameters:

context (list[TranslationContext]) – The list of translation contexts to filter

Returns:

The filtered list of translation contexts

Return type:

list[TranslationContext]

filter_unchanged_translations(context: list[TranslationContext]) → list[TranslationContext]

This method filters out entries from the context list if there have been no changes made to the source_translation.

The removed entries are stored in order to show users batched error messages after all objects have been handled.

Parameters:

context (list[TranslationContext]) – The list of translation contexts to filter

Returns:

The filtered list of translation contexts

Return type:

list[TranslationContext]

form_class: ModelFormMetaclass

The CustomContentModelForm

abstract static get_target_language_key(target_language: Language) → str

This function decides the correct target language key Needs to be implemented by subclasses of MachineTranslationApiClient.

Parameters:

target_language (Language) – the target language

Returns:

target_language_key which is 2 characters long for all languages except English and Portuguese where the BCP tag is transmitted

Return type:

str

abstract invoke_translation_api(context: list[TranslationContext]) → None

Translate all ctx.instance stored in context. Needs to be implemented by subclasses of MachineTranslationApiClient.

Parameters:

context (list[TranslationContext])

Return type:

None

mark_successful(ctx: TranslationContext) → None

Mark a content object as having been translated successfully

Parameters:

ctx (TranslationContext)

Return type:

None

mark_too_long(ctx: TranslationContext, errors: bool) → None

Mark a translation as too long

Parameters:

• ctx (TranslationContext)

• errors (bool)

Return type:

None

mark_unsuccessful(ctx: TranslationContext, errors: bool) → None

Mark a translation as unsuccessful (usually due to API errors)

Parameters:

• ctx (TranslationContext)

• errors (bool)

Return type:

None

max_text_length: int | None = None

Max length of “text” of Push Notification Translation

prepare_content_objects() → list[TranslationContext]

Wrap each content object in a TranslationContext and populate it with pre-computed translation metadata (source/target translations, translatable attributes, word count).

Returns:

A list of TranslationContext instances ready for filtering

Return type:

list[TranslationContext]

region: Region

The current region

request: HttpRequest

The current request

reset() → None

A single instance of a MachineTranslationApiClient may be used multiple times in succession, requiring a reset of the stored results and failures.

Forgetting to call this function will not result in additional machine translation budget use, but will produce nonsense messages shown to the user.

Return type:

None

save_translation(ctx: TranslationContext, translation_data: dict) → None

Create a translation form based on the extracted content object data, save it, and validate the translation.

Parameters:

• ctx (TranslationContext)

• translation_data (dict)

Return type:

None

successful_translations: list[TranslationContext] = []

Successful translations

translate_object(obj: AbstractContentModel, language_slug: str) → None

This function translates one content object

Parameters:

• obj (AbstractContentModel) – The content object

• language_slug (str) – The target language slug

Return type:

None

translate_queryset(queryset: list[AbstractContentModel], language_slug: str) → None

This function translates a content queryset via the configured machine translation provider.

Content objects are wrapped into TranslationContext instances, filtered for translatability, and then passed to the provider-specific translation API.

Parameters:

• queryset (list[AbstractContentModel]) – The content QuerySet

• language_slug (str) – The target language slug

Return type:

None

class integreat_cms.core.utils.machine_translation_api_client.TranslationContext(instance: 'AbstractContentModel', source_translation: 'AbstractContentTranslation | None' = None, existing_target_translation: 'AbstractContentTranslation | None' = None, translatable_attributes: 'list[tuple[str, str]]' = <factory>, word_count: 'int' = 0)

Bases: object

Parameters:

• instance (AbstractContentModel)

• source_translation (AbstractContentTranslation | None)

• existing_target_translation (AbstractContentTranslation | None)

• translatable_attributes (list[tuple[str, str]])

• word_count (int)

__init__(instance: AbstractContentModel, source_translation: AbstractContentTranslation | None = None, existing_target_translation: AbstractContentTranslation | None = None, translatable_attributes: list[tuple[str, str]] = <factory>, word_count: int = 0) → None

Parameters:

• instance (AbstractContentModel)

• source_translation (AbstractContentTranslation | None)

• existing_target_translation (AbstractContentTranslation | None)

• translatable_attributes (list[tuple[str, str]])

• word_count (int)

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.

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

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(attributes_to_translate: list[tuple[str, str]]) → int

This function counts the number of words in a content translation

Parameters:

attributes_to_translate (list[tuple[str, str]])

Return type:

int