Skip to content

Translate

hypha.apply.translate.translate

translate 

translate(string, from_code, to_code)

Translate a string from one language to another

Requires the request language's argostranslate package to be installed first

Parameters:

  • string (str) –

    the string to translate

  • from_code (str) –

    the ISO 639 code of the original language

  • to_code (str) –

    the ISO 639 code of the language to translate to

Returns:

  • str ( str ) –

    the translated string

Raises:

  • ValueError –

    if the requested language translation package is not installed or request is invalid

Source code in hypha/apply/translate/translate.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
def translate(string: str, from_code: str, to_code: str) -> str:
    """Translate a string from one language to another

    Requires the request language's argostranslate package to be installed first

    Args:
        string: the string to translate
        from_code: the ISO 639 code of the original language
        to_code: the ISO 639 code of the language to translate to

    Returns:
        str: the translated string

    Raises:
        ValueError: if the requested language translation package is not installed or request is invalid
    """

    if from_code == to_code:
        raise ValueError("Translation from_code cannot match to_code")

    available_translations = utils.get_available_translations([from_code])

    if not available_translations or to_code not in [
        package.to_code for package in available_translations
    ]:
        raise ValueError(f"Package {from_code} -> {to_code} is not installed")

    translated_text = argostranslate.translate.translate(string, from_code, to_code)

    return translated_text