Skip to content

translate

tr module-attribute

tr = translate

trs module-attribute

translate

translate(
    string: str,
    *,
    language: str = language,
    translation_file: str = translation_file
) -> 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

RETURNS DESCRIPTION
str

Translated string.

translate_string

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

Translate a string with patterns like <<en:Hello, zh:你好>> to the given language.

PARAMETER DESCRIPTION
string

String to translate.

TYPE: str

language

Language to translate to, by default config.language.

TYPE: str DEFAULT: language

RETURNS DESCRIPTION
str

Translated string.