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 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
def get_available_translations(
    from_codes: Optional[List[str]] = None,
) -> List[argostranslate.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 = argostranslate.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 language>, \<to language>)

Raises:

  • ValueError –

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

Source code in hypha/apply/translate/utils.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
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 language\>, \<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 
66
67
68
69
70
def get_lang_name(code: str) -> str | None:
    try:
        return argostranslate.translate.get_language_from_code(code).name
    except AttributeError:
        return None

get_language_choices_json 

get_language_choices_json(request)

Generate a JSON output of available translation options

Utilized for populating the reactive form fields on the client side

Parameters:

  • request (HttpRequest) –

    an HttpRequest containing an "Hx-Current-Url" header to extract current translation params from

Returns:

  • str –

    A JSON string in the format of:

  • str –

    ```

  • str –

    [ { "value": "", "label": "", "to": [ { "value": "", "label": "" "selected": } ], "selected": }, ...

  • str –

    ]

  • str –

    ```

Source code in hypha/apply/translate/utils.py 
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
def get_language_choices_json(request: HttpRequest) -> str:
    """Generate a JSON output of available translation options

    Utilized for populating the reactive form fields on the client side

    Args:
        request: an `HttpRequest` containing an "Hx-Current-Url" header to extract current translation params from

    Returns:
        A JSON string in the format of:

        ```
        [
            {
                "value": "<from language code>",
                "label": "<from language name>",
                "to": [
                    {
                        "value": "<to language code>",
                        "label": "<from language name>"
                        "selected": <bool if selected by default>
                    }
                ],
                "selected": <bool if selected by default>
            },
            ...
        ]
        ```
    """
    available_translations = get_available_translations()
    from_langs = {package.from_code for package in available_translations}
    default_to_lang = settings.LANGUAGE_CODE if settings.LANGUAGE_CODE else None
    default_from_lang = None

    # If there's existing lang params, use those as the default in the form
    # ie. the user has an active translation for ar -> en, those should be selected in the form
    if (current_url := request.headers.get("Hx-Current-Url")) and (
        params := get_translation_params(current_url)
    ):
        default_from_lang, default_to_lang = params

    choices = []
    for lang in from_langs:
        to_langs = [
            package.to_code
            for package in available_translations
            if package.from_code == lang
        ]

        # Set the default selection to be the default_to_lang if it exists in the to_langs list,
        # otherwise use the first value in the list.
        selected_to = (
            default_to_lang
            if default_to_lang and default_to_lang in to_langs
            else to_langs[0]
        )

        to_choices = [
            {
                "value": to_lang,
                "label": get_lang_name(to_lang),
                "selected": to_lang == selected_to,
            }
            for to_lang in to_langs
        ]

        choices.append(
            {
                "value": lang,
                "label": get_lang_name(lang),
                "to": to_choices,
                "selected": lang == default_from_lang,
            }
        )

    return json.dumps(choices)

translate_application_form_data 

translate_application_form_data(application, from_code, to_code)

Translate the content of an application's live revision form_data. Will parse fields that contain both plaintext & HTML, extracting & replacing strings.

NOTE: Mixed formatting like <p>Hey from <strong>Hypha</strong></p> will result in a string that is stripped of text formatting (untranslated: <p>Hey from Hypha</p>). On the other hand, unmixed strings like <p><strong>Hey from Hypha</strong></p> will be replaced within formatting tags.

Parameters:

  • application –

    the application 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:

  • dict –

    The form_data with values translated (including nested HTML strings)

Source code in hypha/apply/translate/utils.py 
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
def translate_application_form_data(application, from_code: str, to_code: str) -> dict:
    """Translate the content of an application's live revision `form_data`.
    Will parse fields that contain both plaintext & HTML, extracting & replacing strings.

    NOTE: Mixed formatting like `<p>Hey from <strong>Hypha</strong></p>` will result in a
    string that is stripped of text formatting (untranslated: `<p>Hey from Hypha</p>`). On
    the other hand, unmixed strings like `<p><strong>Hey from Hypha</strong></p>` will be
    replaced within formatting tags.

    Args:
        application: the  application 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:
        The `form_data` with values translated (including nested HTML strings)

    Raises:
        ValueError if an invalid `from_code` or `to_code` is requested
    """
    form_data: dict = application.live_revision.form_data

    translated_form_data = form_data.copy()

    # Only translate content fields or the title - don't with name, email, etc.
    translated_form_data["title"] = translate.translate(
        form_data["title"], from_code, to_code
    )

    # RegEx to match wagtail's generated field UIDs - ie. "97c51cea-ab47-4a64-a64a-15d893788ef2"
    uid_regex = re.compile(r"([a-z]|\d){8}(-([a-z]|\d){4}){3}-([a-z]|\d){12}")
    fields_to_translate = [
        key
        for key in form_data
        if uid_regex.match(key) and isinstance(form_data[key], str)
    ]

    for key in fields_to_translate:
        field_html = BeautifulSoup(form_data[key], "html.parser")
        if field_html.find():  # Check if BS detected any HTML
            for field in field_html.find_all(has_valid_str):
                # Removes formatting if mixed into the tag to prioritize context in translation
                # ie. `<p>Hey <strong>y'all</strong></p>` -> `<p>Hey y'all</p>` (but translated)
                to_translate = field.string if field.string else field.text
                field.clear()
                field.string = translate.translate(to_translate, from_code, to_code)

            translated_form_data[key] = str(field_html)
        # Ensure the field value isn't empty & translate as is
        elif form_data[key].strip():
            translated_form_data[key] = translate.translate(
                form_data[key], from_code, to_code
            )

    return translated_form_data

has_valid_str 

has_valid_str(tag)

Checks that an Tag contains a valid text element and/or string.

Parameters:

  • tag (Tag) –

    a bs4.element.Tag

Source code in hypha/apply/translate/utils.py 
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
def has_valid_str(tag: element.Tag) -> bool:
    """Checks that an Tag contains a valid text element and/or string.

    Args:
        tag: a `bs4.element.Tag`
    Returns:
        bool: True if has a valid string that isn't whitespace or `-`
    """
    text_elem = tag.name in ["span", "p", "strong", "em", "td", "a"]

    try:
        # try block logic handles elements that have text directly in them
        # ie. `<p>test</p>` or `<em>yeet!</em>` would return true as string values would be contained in tag.string
        ret = bool(
            text_elem
            and tag.find(string=True, recursive=False)
            and tag.string.strip(" -\n")
        )
        return ret
    except AttributeError:
        # except block logic handles embedded tag strings where tag.string == None but the specified tag DOES contain a string
        # ie. `<p>Hypha is <strong>cool</strong></p>` contains the string "Hypha is" but due to the strong tag being mixed in will
        # have None for the tag.string value.
        # tags like `<p> <em>Hypha rocks</em> </p>` will return false as the <p> tag contains no valid strings, it's child does.
        tag_contents = "".join(tag.find_all(string=True, recursive=False))
        ret = bool(tag.text and tag.text.strip() and tag_contents.strip())
        return ret