Issue 2625 - [cms] Crowdin synchronisation script

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 23 matching lines @@
 logger = logging.getLogger("cms.bin.translate")
 
 class CrowdinAPI:
   FILES_PER_REQUEST = 20
 
   def __init__(self, api_key, project_name):
     self.api_key = api_key
     self.project_name = project_name
     self.connection = urllib3.connection_from_url("https://api.crowdin.com/")
 
-  def raw_request(self, request_method, api_endpoint, query_params, **kwargs):

[Wladimir Palant, 2015/07/16 12:17:23]

Nit: Have query_params default to [] and remove it in the call from
download_translations?

[Sebastian Noack, 2015/07/16 12:23:56]

Mutable objects in default arguments are a footgun. Feel free to run following
code, to see what I mean. ;)

  def foo(x=[]):
    x.append(42)
    return x
  foo()
  foo()

However, if we make it a tuple it should be fine.

[kzar, 2015/07/16 12:49:32]

I remember that one from the interview, which is why I avoided it :p Good point
about just using a tuple though.
Done.

+  def raw_request(self, request_method, api_endpoint, query_params=(), **kwargs):
     url = "/api/project/%s/%s?%s" % (
       urllib.quote(self.project_name),
       urllib.quote(api_endpoint),
-      urllib.urlencode([("key", self.api_key)] + query_params)
+      urllib.urlencode((("key", self.api_key),) + query_params)
     )
     try:
       response = self.connection.request(
         request_method, str(url), **kwargs
       )
     except urllib3.exceptions.HTTPError:
       logger.error("Connection to API endpoint %s failed", url)
       raise
     if response.status < 200 or response.status >= 300:
       logger.error("API call to %s failed:\n%s", url, response.data)
       raise urllib3.exceptions.HTTPError(response.status)
     return response
 
   def request(self, request_method, api_endpoint, data=None, files=None):
     fields = []
     if data:
       for name, value in data.iteritems():
         if isinstance(value, basestring):
           fields.append((name, value))
         else:
           fields.extend((name + "[]", v) for v in value)
     if files:
       fields.extend(("files[%s]" % f[0], f) for f in files)
 
     response = self.raw_request(
-      request_method, api_endpoint, [("json", "1")],
+      request_method, api_endpoint, (("json", "1"),),
       fields=fields, preload_content=False
     )
 
     try:
       return json.load(response)
     except ValueError:
       logger.error("Invalid response returned by API endpoint %s", url)
       raise
 
 
@@ skipping 132 matching lines @@
     crowdin_api.request("POST", "delete-directory", data={"name": directory})
 
 def download_translations(crowdin_api, source_dir, required_locales):
   logger.info("Requesting generation of fresh translations archive...")
   result = crowdin_api.request("GET", "export")
   if result.get("success", {}).get("status") == "skipped":
     logger.warning("Archive generation skipped, either "
                    "no changes or API usage excessive")
 
   logger.info("Downloading translations archive...")
-  response = crowdin_api.raw_request("GET", "download/all.zip", [])
+  response = crowdin_api.raw_request("GET", "download/all.zip")
 
   logger.info("Extracting translations archive...")
   with zipfile.ZipFile(io.BytesIO(response.data), "r") as archive:
     locale_path = os.path.join(source_dir, "locales")
     # First clear existing translation files
     for root, dirs, files in os.walk(locale_path, topdown=True):
       if root == locale_path:
         dirs[:] = [d for d in dirs if d in required_locales]
       for f in files:
         if f.lower().endswith(".json"):
@@ skipping 53 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)