Skip to content

Utils

hypha.apply.translate.utils

get_available_translations 

get_available_translations(from_codes=None)

Get languages available for translation

Parameters:

  • from_codes (Optional[List[str]], default: None ) –

    optionally specify a list of languages to view available translations to

Returns:

  • List[Package] –

    A list of argostranslate package objects that are installed and available.

Source code in hypha/apply/translate/utils.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
def get_available_translations(
    from_codes: Optional[List[str]] = None,
) -> List[package.Package]:
    """Get languages available for translation

    Args:
        from_codes: optionally specify a list of languages to view available translations to

    Returns:
        A list of argostranslate package objects that are installed and available.
    """

    available_packages = package.get_installed_packages()

    if not from_codes:
        return available_packages

    return list(filter(lambda x: x.from_code in from_codes, available_packages))

get_translation_params 

get_translation_params(url=None, request=None)

Attempts to extract the fl (from language) & tl (to language) params from the provided URL or request object

Return values are not validated to ensure languages are valid & packages exist.

Parameters:

  • url (str, default: None ) –

    the URL to extract the params from

Returns:

  • tuple ( Tuple[str, str] | None ) –

    in the format of (\<from langauge>, \<to language>)

Raises:

  • ValueError –

    If url/request are not provided OR if both are provided

Source code in hypha/apply/translate/utils.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
def get_translation_params(
    url: str = None, request: HttpRequest = None
) -> Tuple[str, str] | None:
    r"""Attempts to extract the `fl` (from language) & `tl` (to language) params from the provided URL or request object

    Return values are *not* validated to ensure languages are valid & packages exist.

    Args:
        url: the URL to extract the params from

    Returns:
        tuple: in the format of (\<from langauge\>, \<to language\>)

    Raises:
        ValueError: If `url`/`request` are not provided OR if both are provided
    """

    # Ensure either url or request is provided but not both.
    if not (bool(url) ^ bool(request)):
        raise ValueError("Either a URL or HttpRequest must be provided.")

    if url:
        query_dict = {k: v[0] for (k, v) in parse_qs(urlparse(url).query).items()}
    else:
        query_dict = request.GET

    if (to_lang := query_dict.get("tl")) and (from_lang := query_dict.get("fl")):
        return (from_lang, to_lang)

    return None

get_lang_name 

get_lang_name(code)
Source code in hypha/apply/translate/utils.py 
60
61
62
63
64
def get_lang_name(code: str) -> str | None:
    try:
        return translate.get_language_from_code(code).name
    except AttributeError:
        return None