-
Notifications
You must be signed in to change notification settings - Fork 136
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #571 from lindsay-stevens/pyxform-157
Warn when some languages are missing translations
- Loading branch information
Showing
8 changed files
with
1,651 additions
and
76 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
138 changes: 138 additions & 0 deletions
138
pyxform/validators/pyxform/missing_translations_check.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| from collections import defaultdict | ||
| from typing import TYPE_CHECKING | ||
|
|
||
| from pyxform import aliases, constants | ||
| from pyxform.errors import PyXFormError | ||
|
|
||
| if TYPE_CHECKING: | ||
| from typing import Dict, List, Optional, Sequence, Union | ||
|
|
||
| SheetData = List[Dict[str, Union[str, Dict]]] | ||
|
|
||
|
|
||
| def format_missing_translations_msg( | ||
| _in: "Dict[str, Dict[str, Sequence]]", | ||
| ) -> "Optional[str]": | ||
| """ | ||
| Format the missing translations data into a warning message. | ||
| :param _in: A dict structured as Dict[survey|choices: Dict[language: (columns)]]. | ||
| In other words, for the survey or choices sheet, a dict of the language(s) and | ||
| column names for which there are missing translations. | ||
| :return: The warning message, or None if there were no missing columns. | ||
| """ | ||
|
|
||
| def get_sheet_msg(name, sheet): | ||
| if sheet is not None: | ||
| langs = sorted(sheet.keys()) | ||
| if 0 < len(langs): | ||
| lang_msgs = [] | ||
| for lang in langs: | ||
| cols = sheet[lang] | ||
| if isinstance(cols, str): | ||
| msg = f"Expected a sequence of columns, got a string for {lang}." | ||
| PyXFormError(msg) | ||
| if 1 == len(cols): | ||
| msg = f"Language '{lang}' is missing the {name} {cols[0]} column." | ||
| lang_msgs.append(msg) | ||
| if 1 < len(cols): | ||
| c = ", ".join(sorted(cols)) | ||
| msg = f"Language '{lang}' is missing the {name} columns {c}." | ||
| lang_msgs.append(msg) | ||
| return "\n".join(lang_msgs) | ||
| return None | ||
|
|
||
| survey = get_sheet_msg(name=constants.SURVEY, sheet=_in.get(constants.SURVEY)) | ||
| choices = get_sheet_msg(name=constants.CHOICES, sheet=_in.get(constants.CHOICES)) | ||
|
|
||
| messages = tuple(i for i in (survey, choices) if i is not None) | ||
| if 0 == len(messages): | ||
| return None | ||
| return "\n".join(messages) | ||
|
|
||
|
|
||
| def find_missing_translations( | ||
| sheet_data: "SheetData", | ||
| translatable_columns: "Dict[str, str]", | ||
| ) -> "Dict[str, List[str]]": | ||
| """ | ||
| Find missing translation columns in the sheet data. | ||
| For each translatable column used in the sheet, there should be a translation for | ||
| each language (including the default / unspecified language) that is used for any | ||
| other translatable column. | ||
| This checks the first row only since it is concerned with the presence of columns, not | ||
| individual cells. It therefore assumes that each row object has the same structure. | ||
| :param sheet_data: The survey or choices sheet data. | ||
| :param translatable_columns: The translatable columns for a sheet. The structure | ||
| should be Dict[internal_name, external_name]. See the aliases module. | ||
| :return: Dict[column_name, List[languages]] | ||
| """ | ||
| translations_seen = defaultdict(list) | ||
| translation_columns_seen = set() | ||
|
|
||
| def process_cell(typ, cell): | ||
| if cell is not None: | ||
| if typ in translatable_columns.keys(): | ||
| name = translatable_columns[typ] | ||
| if isinstance(cell, str): | ||
| translations_seen[constants.DEFAULT_LANGUAGE_VALUE].append(name) | ||
| translation_columns_seen.add(name) | ||
| elif isinstance(cell, dict): | ||
| for lng in cell: | ||
| translations_seen[lng].append(name) | ||
| translation_columns_seen.add(name) | ||
|
|
||
| if 0 < len(sheet_data): | ||
| # e.g. ("name", "q1"), ("label", {"en": "Hello", "fr": "Bonjour"}) | ||
| for column_type, cell_content in sheet_data[0].items(): | ||
| if column_type == constants.MEDIA: | ||
| # e.g. ("audio", {"eng": "my.mp3"}) | ||
| for media_type, media_cell in cell_content.items(): | ||
| process_cell(typ=media_type, cell=media_cell) | ||
| if column_type == constants.BIND: | ||
| # e.g. ("jr:constraintMsg", "Try again") | ||
| for bind_type, bind_cell in cell_content.items(): | ||
| process_cell(typ=bind_type, cell=bind_cell) | ||
| else: | ||
| process_cell(typ=column_type, cell=cell_content) | ||
|
|
||
| missing = defaultdict(list) | ||
| for lang, lang_trans in translations_seen.items(): | ||
| for seen_tran in translation_columns_seen: | ||
| if seen_tran not in lang_trans: | ||
| missing[lang].append(seen_tran) | ||
|
|
||
| return missing | ||
|
|
||
|
|
||
| def missing_translations_check( | ||
| survey_sheet: "SheetData", | ||
| choices_sheet: "SheetData", | ||
| warnings: "List[str]", | ||
| ): | ||
| """ | ||
| Add a warning if there are missing translation columns in the survey or choices data. | ||
| :param survey_sheet: The survey sheet data. | ||
| :param choices_sheet: The choices sheet data. | ||
| :param warnings: The warnings list, which may be empty. | ||
| :return: The warnings list, possibly with a new message, otherwise unchanged. | ||
| """ | ||
| survey_missing_trans = find_missing_translations( | ||
| sheet_data=survey_sheet, | ||
| translatable_columns=aliases.TRANSLATABLE_SURVEY_COLUMNS, | ||
| ) | ||
| choices_missing_trans = find_missing_translations( | ||
| sheet_data=choices_sheet, | ||
| translatable_columns=aliases.TRANSLATABLE_CHOICES_COLUMNS, | ||
| ) | ||
| if 0 < len(survey_missing_trans) or 0 < len(choices_missing_trans): | ||
| msg = format_missing_translations_msg( | ||
| _in={"survey": survey_missing_trans, "choices": choices_missing_trans} | ||
| ) | ||
| if msg is not None: | ||
| warnings.append(msg) | ||
| return warnings |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.