-
-
Notifications
You must be signed in to change notification settings - Fork 494
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added check for all translation file (#2275)
* added check for all translation file * fix falling test * fix the python style guide * made the requested changes * now the script will report for every file if there is error * revert back the double quotes to single quotes * error message will show path of file * improved the output message * used namedtuple to improve readability
- Loading branch information
Showing
3 changed files
with
169 additions
and
21 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| """ | ||
| Script to encourage more efficient coding practices. | ||
| Methodology: | ||
| Utility for comparing translations between default and other languages. | ||
| This module defines a function to compare two translations | ||
| and print any missing keys in the other language's translation. | ||
| Attributes: | ||
| FileTranslation (namedtuple): Named tuple to represent a combination of file and missing translations. | ||
| Fields: | ||
| - file (str): The file name. | ||
| - missing_translations (list): List of missing translations. | ||
| Functions: | ||
| compare_translations(default_translation, other_translation): | ||
| Compare two translations and print missing keys. | ||
| check_translations(): | ||
| Load the default translation and compare it with other translations. | ||
| Usage: | ||
| This script can be executed to check and print missing | ||
| translations in other languages based on the default English translation. | ||
| Example: | ||
| python compare_translations.py | ||
| NOTE: | ||
| This script complies with our python3 coding and documentation standards | ||
| and should be used as a reference guide. It complies with: | ||
| 1) Pylint | ||
| 2) Pydocstyle | ||
| 3) Pycodestyle | ||
| 4) Flake8 | ||
| """ | ||
| # standard imports | ||
| import json | ||
| import os | ||
| import sys | ||
| from collections import namedtuple | ||
|
|
||
| # Named tuple for file and missing translations combination | ||
| FileTranslation = namedtuple("FileTranslation", ["file", "missing_translations"]) | ||
|
|
||
|
|
||
| def compare_translations(default_translation, other_translation): | ||
| """Compare two translations and print missing keys. | ||
| Args: | ||
| default_translation: The default translation | ||
| other_translation: The other translation | ||
| Returns: | ||
| missing_translations: List of missing translations | ||
| """ | ||
| missing_translations = [] | ||
|
|
||
| for key in default_translation: | ||
| if key not in other_translation: | ||
| missing_translations.append(key) | ||
|
|
||
| return missing_translations | ||
|
|
||
|
|
||
| def load_translation(filepath): | ||
| """Load translation from a file. | ||
| Args: | ||
| filepath: Path to the translation file | ||
| Returns: | ||
| translation: Loaded translation | ||
| """ | ||
| with open(filepath, "r", encoding="utf-8") as file: | ||
| translation = json.load(file) | ||
| return translation | ||
|
|
||
|
|
||
| def check_translations(): | ||
| """Load default translation and compare with other translations.""" | ||
| default_translation = load_translation("lang/en.json") | ||
| translations_dir = "lang" | ||
| translations = os.listdir(translations_dir) | ||
| translations.remove("en.json") # Exclude default translation | ||
|
|
||
| files_with_missing_translations = [] | ||
|
|
||
| for translation_file in translations: | ||
| translation_path = os.path.join(translations_dir, translation_file) | ||
| other_translation = load_translation(translation_path) | ||
|
|
||
| # Compare translations | ||
| missing_translations = compare_translations( | ||
| default_translation, other_translation | ||
| ) | ||
| if missing_translations: | ||
| file_translation = FileTranslation(translation_file, missing_translations) | ||
| files_with_missing_translations.append(file_translation) | ||
|
|
||
| for file_translation in files_with_missing_translations: | ||
| print( | ||
| f"File {translations_dir}/{file_translation.file} has missing translations for:" | ||
| ) | ||
| for key in file_translation.missing_translations: | ||
| print(f" - {key}") | ||
|
|
||
| if files_with_missing_translations: | ||
| sys.exit(1) # Exit with an error status code | ||
| else: | ||
| print("All translations are present") | ||
| sys.exit(0) | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| check_translations() | ||
| # Exit with a success status code |
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