Ticket #1684: unified_patch.patch

src/sugar/activity/i18n.py

@@ -31 +31 @@
 _MO_LITTLE_ENDIAN = 0x950412de
 
 
-def _readbin(handle, fmt, bytecount):
+def _read_bin(handle, fmt, bytecount):
     read_bytes = handle.read(bytecount)
-    retvalue = struct.unpack(fmt, read_bytes)
-    if len(retvalue) == 1:
-        return retvalue[0]
+    ret_value = struct.unpack(fmt, read_bytes)
+    if len(ret_value) == 1:
+        return ret_value[0]
     else:
-        return retvalue
+        return ret_value
 
 
 def _extract_header(filepath):
     header = ''
     handle = open(filepath, 'rb')
-    magic_number = _readbin(handle, '<I', 4)
+    magic_number = _read_bin(handle, '<I', 4)
 
     if magic_number == _MO_BIG_ENDIAN:
         fmt = '>II'
@@ -52 +52 @@
     else:
         raise IOError('File does not seem to be valid MO file')
 
-    version_, numofstrings = _readbin(handle, fmt, 8)
+    version_, num_of_strings = _read_bin(handle, fmt, 8)
 
-    msgids_hash_offset, msgstrs_hash_offset = _readbin(handle, fmt, 8)
+    msgids_hash_offset, msgstrs_hash_offset = _read_bin(handle, fmt, 8)
     handle.seek(msgids_hash_offset)
 
     msgids_index = []
-    for i in range(numofstrings):
-        msgids_index.append(_readbin(handle, fmt, 8))
+    for i in range(num_of_strings):
+        msgids_index.append(_read_bin(handle, fmt, 8))
     handle.seek(msgstrs_hash_offset)
 
     msgstrs_index = []
-    for i in range(numofstrings):
-        msgstrs_index.append(_readbin(handle, fmt, 8))
+    for i in range(num_of_strings):
+        msgstrs_index.append(_read_bin(handle, fmt, 8))
 
-    for i in range(numofstrings):
+    for i in range(num_of_strings):
         handle.seek(msgids_index[i][1])
         msgid = handle.read(msgids_index[i][0])
         if msgid == '':
@@ -86 +86 @@
     items = header.split('\n')
     for item in items:
         if item.startswith('PO-Revision-Date:'):
-            timestr = item.split(': ')[1]
-            parsedtime = dateutil.parser.parse(timestr)
-            return time.mktime(parsedtime.timetuple())
+            time_str = item.split(': ')[1]
+            parsed_time = dateutil.parser.parse(time_str)
+            return time.mktime(parsed_time.timetuple())
 
     raise ValueError('Could not find revision date')
     return -1
 
 
 def get_locale_path(bundle_id):
-    """ Gets the locale path, the directory where the preferred
+    """ Returns the locale path, which is the directory where the preferred
         MO file is located.
 
-            bundle_id -- The bundle id of the activity in question
+        The preferred MO file is the one with the latest translation.
 
-        The preferred MO file is the one with the latest
-        translation.
+        @type   bundle_id:      string
+        @param  bundle_id:      The bundle id of the activity in question
+        @rtype:                 string
+        @return:                the preferred locale path
     """
 
     # Note: We pre-assign weights to the directories so that if no translations
@@ -124 +126 @@
 
     for candidate_dir in candidate_dirs.keys():
         if os.path.exists(candidate_dir):
-            fullpath = os.path.join(candidate_dir, \
+            full_path = os.path.join(candidate_dir, \
                 locale.getdefaultlocale()[0], 'LC_MESSAGES', \
                 bundle_id + '.mo')
-            if os.path.exists(fullpath):
+            if os.path.exists(full_path):
                 try:
                     candidate_dirs[candidate_dir] = \
-                        _extract_modification_time(fullpath)
+                        _extract_modification_time(full_path)
                 except (IOError, ValueError):
                     # The mo file is damaged or has not been initialized
                     # Set lowest priority
                     candidate_dirs[candidate_dir] = -1
 
-    # Fancy way to sort the dictionary by value
-    return sorted(candidate_dirs.iteritems(), key=lambda (k, v): (v, k), \
-        reverse=True)[0][0]
+    sorted_dict = sorted(candidate_dirs.iteritems(), key=lambda (k, v): \
+        (v, k), reverse=True)
+
+    return sorted_dict[0][0]