chore: added some typings to functions

Author: Bilb

crowdin/download_translations_from_crowdin.py

@@ -43,7 +43,7 @@ def check_error(response):
             print(f"{Fore.BLUE}Response: {json.dumps(response.json(), indent=2)}{Style.RESET_ALL}")
         sys.exit(1)
 
-def download_file(url, output_path):
+def download_file(url: str, output_path: str):
     """
     Function to download a file from Crowdin
     """
@@ -102,7 +102,7 @@ def main():
         print(f"\n{Fore.BLUE}Response: {json.dumps(source_export_response.json(), indent=2)}{Style.RESET_ALL}")
 
     # Download the exported file
-    source_download_url = source_export_response.json()['data']['url']
+    source_download_url: str = source_export_response.json()['data']['url']
     source_download_path = os.path.join(DOWNLOAD_DIRECTORY, f"{source_lang_locale}.xliff")
     print(f"\033[2K{Fore.WHITE}⏳ Downloading translations for {source_lang_locale}...{Style.RESET_ALL}", end='\r')
     try:

crowdin/generate_android_strings.py

@@ -1,5 +1,4 @@
 import os
-import json
 import xml.etree.ElementTree as ET
 import sys
 import argparse
@@ -143,7 +142,7 @@ def convert_non_translatable_strings_to_kotlin(input_file, output_path):
     if not app_name:
         raise ValueError("could not find app_name in glossary_dict")
 
-def convert_all_files(input_directory):
+def convert_all_files(input_directory: str ):
     setup_values = setup_generation(input_directory)
     source_language, rtl_languages, non_translatable_strings_file, target_languages = setup_values.values()
 

crowdin/generate_desktop_strings.py

@@ -1,5 +1,6 @@
 import os
 import json
+from typing import Dict, List
 import xml.etree.ElementTree as ET
 import sys
 import argparse
@@ -37,7 +38,6 @@
 TRANSLATIONS_OUTPUT_DIRECTORY = args.translations_output_directory
 NON_TRANSLATABLE_STRINGS_OUTPUT_PATH = args.non_translatable_strings_output_path
 
-clean_string_extra_dict = {'{count}': '#'}
 
 def parse_xliff(file_path):
     tree = ET.parse(file_path)
@@ -72,17 +72,17 @@ def parse_xliff(file_path):
     return translations
 
 
-def generate_icu_pattern(target, glossary_dict):
+def generate_icu_pattern(target, glossary_dict : Dict[str,str]):
     if isinstance(target, dict):  # It's a plural group
         pattern_parts = []
         for form, value in target.items():
             if form in ['zero', 'one', 'two', 'few', 'many', 'other', 'exact', 'fractional']:
-                value = clean_string(value, False, glossary_dict, clean_string_extra_dict)
+                value = clean_string(value, False, glossary_dict, {})
                 pattern_parts.append(f"{form} [{value}]")
 
         return "{{count, plural, {0}}}".format(" ".join(pattern_parts))
     else:  # It's a regular string
-        return clean_string(target, False, glossary_dict, clean_string_extra_dict)
+        return clean_string(target, False, glossary_dict, {})
 
 def convert_xliff_to_json(input_file, output_dir, locale, locale_two_letter_code, glossary_dict):
     if not os.path.exists(input_file):
@@ -110,7 +110,7 @@ def convert_xliff_to_json(input_file, output_dir, locale, locale_two_letter_code
 
 
 
-def convert_non_translatable_strings_to_type_script(input_file, output_path, exported_locales, rtl_languages):
+def convert_non_translatable_strings_to_type_script(input_file: str, output_path: str, exported_locales: List[str], rtl_languages: List[str]):
     glossary_dict = load_glossary_dict(input_file)
     rtl_locales = sorted([lang["twoLettersCode"] for lang in rtl_languages])
 
@@ -140,7 +140,7 @@ def convert_non_translatable_strings_to_type_script(input_file, output_path, exp
         file.write('\n')
 
 
-def convert_all_files(input_directory):
+def convert_all_files(input_directory: str):
     setup_values = setup_generation(input_directory)
     source_language, rtl_languages, non_translatable_strings_file, target_languages = setup_values.values()
 

crowdin/generate_ios_strings.py

@@ -8,6 +8,7 @@
 from colorama import Fore, Style
 from datetime import datetime
 from generate_shared import load_glossary_dict, clean_string, setup_generation
+from typing import Dict
 
 
 # It seems that Xcode uses different language codes and doesn't support all of the languages we get from Crowdin
@@ -105,7 +106,7 @@ def parse_xliff(file_path):
 
     return translations, target_language
 
-def convert_placeholders_for_plurals(translations, glossary_dict):
+def convert_placeholders_for_plurals(translations: Dict[str,str], glossary_dict: Dict[str,str]):
     # Replace {count} with %lld for iOS
     converted_translations = {}
     for form, value in translations.items():

crowdin/generate_shared.py

@@ -1,9 +1,10 @@
+from typing import Dict, List
 import html
 import json
 import os
 from colorama import Fore, Style
 
-def clean_string(text, is_android, glossary_dict, extra_replace_dict):
+def clean_string(text: str, is_android: bool, glossary_dict: Dict[str, str], extra_replace_dict :Dict[str,str]):
     if is_android:
         # Note: any changes done for all platforms needs most likely to be done on crowdin side.
         # So we don't want to replace -> with → for instance, we want the crowdin strings to not have those at all.
@@ -32,7 +33,7 @@ def clean_string(text, is_android, glossary_dict, extra_replace_dict):
     return text
 
 
-def load_glossary_dict(input_file):
+def load_glossary_dict(input_file: str) -> Dict[str, str]:
     if not os.path.exists(input_file):
         raise FileNotFoundError(f"Could not find '{input_file}' in raw translations directory")
 
@@ -50,7 +51,7 @@ def load_glossary_dict(input_file):
     return glossary_dict
 
 
-def setup_generation(input_directory):
+def setup_generation(input_directory: str):
     # Extract the project information
     print(f"\033[2K{Fore.WHITE}⏳ Processing project info...{Style.RESET_ALL}", end='\r')
     project_info_file = os.path.join(input_directory, "_project_info.json")
@@ -64,16 +65,16 @@ def setup_generation(input_directory):
     non_translatable_strings_file = os.path.join(input_directory, "_non_translatable_strings.json")
 
     # Extract the language info and sort the target languages alphabetically by locale
-    source_language = project_details['data']['sourceLanguage']
-    target_languages = project_details['data']['targetLanguages']
+    source_language: str = project_details['data']['sourceLanguage']
+    target_languages: List[str] = project_details['data']['targetLanguages']
     target_languages.sort(key=lambda x: x['locale'])
     num_languages = len(target_languages)
     print(f"\033[2K{Fore.GREEN}✅ Project info processed, {num_languages} languages will be converted{Style.RESET_ALL}")
 
     # Convert the non-translatable strings to the desired format
-    rtl_languages = [lang for lang in target_languages if lang["textDirection"] == "rtl"]
+    rtl_languages: List[str] = [lang for lang in target_languages if lang["textDirection"] == "rtl"]
 
     return {"source_language":source_language,
             "rtl_languages": rtl_languages,
             "non_translatable_strings_file":non_translatable_strings_file,
-            "target_languages": target_languages}
+            "target_languages": target_languages}