Deepl API

Apps

Configuration of DeepL API app

class integreat_cms.deepl_api.apps.DeepLApiClientConfig(app_name, app_module)

Bases: AppConfig

DeepL API config inheriting the django AppConfig

__init__(app_name, app_module)

classmethod create(entry)

Factory that creates an app config from an entry in INSTALLED_APPS.

default_auto_field

get_model(model_name, require_ready=True)

Return the model with the given case-insensitive model_name.

Raise LookupError if no model exists with this name.

get_models(include_auto_created=False, include_swapped=False)

Return an iterable of models.

By default, the following models aren’t included:

• auto-created models for many-to-many relations without an explicit intermediate table,

• models that have been swapped out.

Set the corresponding keyword argument to True to include such models. Keyword arguments aren’t documented; they’re a private API.

import_models()

name: Final[str] = 'integreat_cms.deepl_api'

Full Python path to the application

ready() → None

Checking if API is available

Return type:

None

supported_source_languages: list[str] = []

The supported source languages

supported_target_languages: list[str] = []

The supported target languages

verbose_name: Final[Promise] = 'DeepL API'

Human-readable name for the application

Deepl API Client

class integreat_cms.deepl_api.deepl_api_client.DeepLApiClient(request: HttpRequest, form_class: ModelFormMetaclass)

Bases: MachineTranslationApiClient

DeepL API client to automatically translate selected objects.

Parameters:

• request (HttpRequest)

• form_class (ModelFormMetaclass)

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

Initialize the DeepL client

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

static get_target_language_key(target_language: Language) → str

This function decides the correct target language key

Parameters:

target_language (Language) – the target language

Returns:

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

Return type:

str

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

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

This function translates a content queryset via DeepL

Parameters:

• queryset (list[Event] | (list[Page] | list[POI])) – The content QuerySet

• language_slug (str) – The target language slug

Return type:

None

Deepl Provider

class integreat_cms.deepl_api.deepl_provider.DeepLProvider

Bases: MachineTranslationProvider

The provider for DeepL machine translations

__init__()

api_client

The API client class for this provider

alias of DeepLApiClient

bulk_only_for_staff: bool = False

Whether to require the staff permission for bulk actions

enabled: bool = False

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 = 'DeepL'

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