translate

tr module-attribute

tr = translate

trs module-attribute

trs = translate_string

load_translations

load_translations(
    translation_file: str = translation_file, **kwargs: str
) -> dict[str, dict[str, str]]

Load translations.

PARAMETER	DESCRIPTION
translation_file	Translation file, by default config.translation_file. TYPE: str DEFAULT: translation_file
kwargs	Translations can be provided as keyword arguments. TYPE: dict[str, str] DEFAULT: {}

RETURNS	DESCRIPTION
dict[str, dict[str, str]]	Translations, a dictionary in the format of dict[string, dict[language_id, translated_string]].

translate

translate(
    string: str,
    *,
    language: str = language,
    translation_file: str = translation_file,
    update_translations: bool = True,
    **kwargs: str
) -> str

Translate a string to the given language, translations are stored in translation_file.

PARAMETER	DESCRIPTION
string	String to translate. TYPE: str
language	Language to translate to, by default config.language. TYPE: str DEFAULT: language
translation_file	Translation file, by default config.translation_file. TYPE: str DEFAULT: translation_file
update_translations	Whether to update the translations file. TYPE: bool DEFAULT: True
kwargs	Translations can be provided as keyword arguments. TYPE: dict[str, str] DEFAULT: {}

RETURNS	DESCRIPTION
str	Translated string.

translate_string

translate_string(
    string: str, *, language: str = language, **kwargs: str
) -> str

Translate a string with patterns like <<en:Hello, zh:你好>> to the given language. The string can also be a plain string, in which case the translate function will be called.

PARAMETER	DESCRIPTION
string	String to translate. TYPE: str
language	Language to translate to, by default config.language. TYPE: str DEFAULT: language
kwargs	Translations can be provided as keyword arguments in the form of language="translation". TYPE: dict[str, str] DEFAULT: {}

RETURNS	DESCRIPTION
str	Translated string.