Issue 3076 - [CMS] Map locale names to match Crowdin's expectations

cms/bin/translate.py

 # coding: utf-8
 
 # This file is part of the Adblock Plus web scripts,
 # Copyright (C) 2006-2015 Eyeo GmbH
 #
 # Adblock Plus is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3 as
 # published by the Free Software Foundation.
 #
 # Adblock Plus is distributed in the hope that it will be useful,
@@ skipping 110 matching lines @@
 def configure_locales(crowdin_api, local_locales, enabled_locales,
                       defaultlocale):
   logger.info("Checking which locales are supported by Crowdin...")
   response = crowdin_api.request("GET", "supported-languages")
 
   supported_locales = {l["crowdin_code"] for l in response}
 
   # We need to map the locale names we use to the ones that Crowdin is expecting
   # and at the same time ensure that they are supported.
   required_locales = {}
-  skipped_locales = []
   for locale in local_locales:
     if "_" in locale:
       crowdin_locale = locale.replace("_", "-")
     elif locale in supported_locales:
       crowdin_locale = locale
     else:
       crowdin_locale = "%s-%s" % (locale, locale.upper())
 
     if crowdin_locale in supported_locales:
       required_locales[locale] = crowdin_locale
     else:
-      skipped_locales.append(locale)

[Sebastian Noack, 2015/09/17 11:03:24]

This code past hasn't been tested, obviously. ;)

Hint: set object have no "append" method.

[Sebastian Noack, 2015/09/17 12:42:15]

Never mind. I just realized you turned it into a list. But why don't you just
log the warning here, instead adding additional complexity to accumulate them?

[kzar, 2015/09/17 14:43:55]

Done.

-
-  if skipped_locales:
-    logger.warning("Ignoring locales that Crowdin doesn't support: %s",
-                   ", ".join(skipped_locales))
+      logger.warning("Ignoring locale '%s', which Crowdin doesn't support",
+                     locale)
 
   required_crowdin_locales = set(required_locales.values())
   if not required_crowdin_locales.issubset(enabled_locales):
     logger.info("Enabling the required locales for the Crowdin project...")
     crowdin_api.request(
       "POST", "edit-project",
       data={"languages": enabled_locales | required_crowdin_locales}
     )
 
   return required_locales
@@ skipping 101 matching lines @@
     for member in archive.namelist():
       path, file_name = posixpath.split(member)
       ext = posixpath.splitext(file_name)[1]
       path_parts = path.split(posixpath.sep)
       locale, file_path = path_parts[0], path_parts[1:]
       if ext.lower() == ".json" and locale in inverted_required_locales:
         output_path = os.path.join(
           locale_path, inverted_required_locales[locale],
           *file_path + [file_name]
         )
-        with archive.open(member) as f, open(output_path, "wb") as f_target:

[Sebastian Noack, 2015/09/17 11:03:24]

Nit: Please use consistent and more descriptive variable names, source_file and
target_file seems reasonable.

[kzar, 2015/09/17 14:43:55]

Done.

-          shutil.copyfileobj(f, f_target)
+        with archive.open(member) as source_file, \
+             open(output_path, "wb") as target_file:
+          shutil.copyfileobj(source_file, target_file)
 
 def crowdin_sync(source_dir, crowdin_api_key):
   with FileSource(source_dir) as source:
     config = source.read_config()
     defaultlocale = config.get("general", "defaultlocale")
     crowdin_project_name = config.get("general", "crowdin-project-name")
 
     crowdin_api = CrowdinAPI(crowdin_api_key, crowdin_project_name)
 
     logger.info("Requesting project information...")
@@ skipping 35 matching lines @@
 if __name__ == "__main__":
   if len(sys.argv) < 3:
     print >>sys.stderr, "Usage: python -m cms.bin.translate www_directory crowdin_project_api_key [logging_level]"
     sys.exit(1)
 
   logging.basicConfig()
   logger.setLevel(sys.argv[3] if len(sys.argv) > 3 else logging.INFO)
 
   source_dir, crowdin_api_key = sys.argv[1:3]
   crowdin_sync(source_dir, crowdin_api_key)