Merge pull request p12tic#74 from PeterFeicht/formatting

Preprocess: improve formatting

Author: p12tic

commands/preprocess.py

@@ -128,8 +128,8 @@ def build_rename_map(root):
             if num > 0:
                 name, ext = os.path.splitext(fn)
                 # add file with its path -> only rename that occurrence
-                result[os.path.join(dir, fn)] = "{}.{}{}".format(name, num + 1,
-                                                                 ext)
+                result[os.path.join(dir, fn)] = \
+                    "{}.{}{}".format(name, num + 1, ext)
             seen[low] += 1
 
     return result
@@ -221,8 +221,8 @@ def trasform_relative_link(rename_map, target, file):
     new_fn = rename_map.get(fn)
     if new_fn:
         # look for case conflict of the renamed file
-        abstarget = os.path.normpath(os.path.join(os.path.dirname(file),
-                                                  dir, new_fn))
+        abstarget = os.path.normpath(
+                os.path.join(os.path.dirname(file), dir, new_fn))
         new_fn = rename_map.get(abstarget, new_fn)
     else:
         # original filename unchanged, look for case conflict
@@ -240,7 +240,6 @@ def trasform_relative_link(rename_map, target, file):
 # file is the path of the file the link came from.
 # root is the path to the root of the archive.
 def transform_link(rename_map, target, file, root):
-
     if is_loader_link(target):
         return transform_loader_link(target, file, root)
 

commands/preprocess_cssless.py

@@ -163,8 +163,8 @@ def convert_span_table_to_tr_td(table_el):
     remove_css_property(table_el, 'display')
 
     for element in table_el.getchildren():
-        tag_renamed = convert_display_property_to_html_tag(element, 'tr',
-                                                           'table-row')
+        tag_renamed = convert_display_property_to_html_tag(
+                element, 'tr', 'table-row')
         if tag_renamed:
             if needs_td_wrapper(element):
                 td = etree.Element('td')
@@ -176,8 +176,8 @@ def convert_span_table_to_tr_td(table_el):
                 element.text = None
             else:
                 for child in element:
-                    convert_display_property_to_html_tag(child, 'td',
-                                                         'table-cell')
+                    convert_display_property_to_html_tag(
+                            child, 'td', 'table-cell')
 
 
 def wrap_element(el, tag_name, style):

index2ddg.py

@@ -74,11 +74,10 @@ def get_item_type(el):
         if el.get('link') == '.':
             return ITEM_TYPE_FUNCTION_INLINEMEM
         return ITEM_TYPE_FUNCTION
-
-        if el.tag == 'variable':
-            if el.get('link') == '.':
-                return ITEM_TYPE_VARIABLE_INLINEMEM
-            return ITEM_TYPE_VARIABLE
+    if el.tag == 'variable':
+        if el.get('link') == '.':
+            return ITEM_TYPE_VARIABLE_INLINEMEM
+        return ITEM_TYPE_VARIABLE
     if el.tag == 'constructor':
         if el.get('link') == '.':
             return ITEM_TYPE_CONSTRUCTOR_INLINEMEM
@@ -145,7 +144,7 @@ def process_item_hook(self, el, full_name, full_link):
 
 def get_html_files(root):
     files = []
-    for dir, dirnames, filenames in os.walk(root):
+    for dir, _, filenames in os.walk(root):
         for filename in fnmatch.filter(filenames, '*.html'):
             files.append(os.path.join(dir, filename))
     return files
@@ -207,8 +206,8 @@ def build_abstract(decls, desc, max_code_lines, split_code_lines,
         # limit the number of code snippets to be included so that total number
         # of lines is less than max_code_lines. The limit becomes active only
         # for the second and subsequent snippets.
-        first = True if i == 0 else False
-        last = True if i == len(decls)-1 else False
+        first = (i == 0)
+        last = (i == len(decls)-1)
 
         if not first:
             if last:
@@ -424,31 +423,31 @@ def process_identifier(out, redirects, root, link, item_ident, item_type,
         elif item_type in [ITEM_TYPE_FUNCTION_INLINEMEM,
                            ITEM_TYPE_CONSTRUCTOR_INLINEMEM,
                            ITEM_TYPE_DESTRUCTOR_INLINEMEM]:
-            raise DdgException("INLINEMEM")  # not implemented
             ''' Implementation notes:
                 * the declarations are possibly versioned
                 * declaration is selected from the member table
                 * the member table is found according to the identifier
                   (last part after :: is enough, hopefully)
             '''
+            raise DdgException("INLINEMEM")  # not implemented
 
         elif item_type in [ITEM_TYPE_VARIABLE,
                            ITEM_TYPE_VARIABLE_INLINEMEM,
                            ITEM_TYPE_ENUM]:
-            raise DdgException("ENUM")      # not implemented
             ''' Implementation notes:
                 * the declarations are possibly versioned
             '''
+            raise DdgException("ENUM")      # not implemented
 
         elif item_type == ITEM_TYPE_ENUM_CONST:
-            raise DdgException("ENUM_CONST")    # not implemented
             ''' Implementation notes:
                 * the abstract will come from the const -> definition table,
                   which is always put before the first heading.
                 * the declaration will come from the dcl template. We need
                   to split the content at ';' and ',', then search for the
                   name of the enum. If we find duplicates, signal an error.
             '''
+            raise DdgException("ENUM_CONST")    # not implemented
 
         if debug.enabled:
             debug.debug_abstracts_file.write("--------------\n")

preprocess.py

@@ -51,9 +51,11 @@ def main():
     file_list = preprocess.find_html_files(root)
 
     with concurrent.futures.ProcessPoolExecutor() as executor:
-        futures = [executor.submit(preprocess.preprocess_html_file, root, fn,
-                                   rename_map)
-                   for fn in file_list]
+        futures = [
+            executor.submit(preprocess.preprocess_html_file,
+                            root, fn, rename_map)
+            for fn in file_list
+        ]
 
         for future in futures:
             output = future.result()

preprocess_qch.py

@@ -53,20 +53,18 @@ def main():
                 src_path = os.path.join(root, file)
                 rel_path = os.path.relpath(src_path, source_root)
                 dst_path = os.path.join(dest_root, rel_path)
-                tuple = (src_path, dst_path)
-                paths_list.append(tuple)
+                paths_list.append((src_path, dst_path))
 
     with concurrent.futures.ProcessPoolExecutor() as executor:
         futures = [
-            (executor.submit(preprocess_cssless.preprocess_html_merge_cssless,
-                             src_path, dst_path),
-             i)
-            for i, (src_path, dst_path) in enumerate(paths_list)
+            executor.submit(preprocess_cssless.preprocess_html_merge_cssless,
+                            src_path, dst_path)
+            for src_path, dst_path in paths_list
         ]
 
-        for future, i in futures:
-            print('Processing file: {}/{}: {}'.format(i, len(paths_list),
-                                                      paths_list[i][1]))
+        for i, future in enumerate(futures):
+            print('Processing file: {}/{}: {}'.format(
+                    i, len(paths_list), paths_list[i][1]))
             output = future.result()
             if verbose:
                 print(output)

tests/test_preprocess.py

@@ -231,6 +231,10 @@ def test_transform_ranges_placeholder(self):
              '../algorithm/all_any_none_of.html'),
         ]
 
+        def msg(target, file, root):
+            return "target='{}', file='{}', root='{}'".format(
+                    target, file, root)
+
         # transform_ranges_placeholder(target, file, root)
         #  target: the placeholder link
         #  file:   path of the file that contains the link
@@ -239,14 +243,12 @@ def test_transform_ranges_placeholder(self):
         for target, file, expected in entries:
             res = transform_ranges_placeholder(target, file, root)
             self.assertEqual(expected, res,
-                             msg="target='{}', file='{}', root='{}'".format(
-                                target, file, root))
+                             msg=msg(target, file, root))
 
             target = target.replace('http://', 'https://')
             res = transform_ranges_placeholder(target, file, root)
             self.assertEqual(expected, res,
-                             msg="target='{}', file='{}', root='{}'".format(
-                                target, file, root))
+                             msg=msg(target, file, root))
 
 
 class TestPreprocessHtml(unittest.TestCase):