From c4de0ef86e1811ddd59edaed06930780252a3be0 Mon Sep 17 00:00:00 2001
From: Louie Lu <git@louie.lu>
Date: Tue, 4 Jan 2022 09:43:25 +0800
Subject: [PATCH 1/5] Format coding style by black

---
 doc/dev_manual/resources/gen_blob_docs.py | 175 +++++++++++++++-------
 doc/dev_manual/resources/gen_toc.py       |  12 +-
 doc/dev_manual/resources/sys_graph.py     |  66 +++++---
 3 files changed, 171 insertions(+), 82 deletions(-)

diff --git a/doc/dev_manual/resources/gen_blob_docs.py b/doc/dev_manual/resources/gen_blob_docs.py
index 089e5d6eec..dc63335efa 100644
--- a/doc/dev_manual/resources/gen_blob_docs.py
+++ b/doc/dev_manual/resources/gen_blob_docs.py
@@ -11,16 +11,18 @@
 import copy
 
 dep_script = "../../src/components/cidl/calculate_dependencies.py"
-comp_base  = "../../src/components/"
+comp_base = "../../src/components/"
 components = comp_base + "implementation/*/*/doc.md"
-libraries  = comp_base + "lib/*/doc.md"
+libraries = comp_base + "lib/*/doc.md"
 interfaces = comp_base + "interface/*/doc.md"
 
+
 def readfile(p):
     with open(p) as f:
         return f.read()
     return ""
 
+
 def remove_trailing_doc(wildcard_path):
     ps = glob.glob(wildcard_path)
     removed = []
@@ -31,48 +33,68 @@ def remove_trailing_doc(wildcard_path):
         removed.append(pathified)
     return removed
 
+
 def filter_out_skel(p):
     s = re.split("/", string.rstrip(p))
-    s = filter(lambda e: e != '', s)
-    return not(s[-1] == "skel" or s[-2] == "skel") and not(s[-2] == "archives")
+    s = filter(lambda e: e != "", s)
+    return not (s[-1] == "skel" or s[-2] == "skel") and not (s[-2] == "archives")
 
-cs  = filter(filter_out_skel, remove_trailing_doc(components))
-ls  = filter(filter_out_skel, remove_trailing_doc(libraries))
+
+cs = filter(filter_out_skel, remove_trailing_doc(components))
+ls = filter(filter_out_skel, remove_trailing_doc(libraries))
 ifs = filter(filter_out_skel, remove_trailing_doc(interfaces))
 
+
 def unique(l):
     return list(set(l))
 
+
 # listify the output
 def clean_dep_output(lst):
-    return filter(lambda d: d != '', unique(re.split(" ", string.rstrip(lst))))
+    return filter(lambda d: d != "", unique(re.split(" ", string.rstrip(lst))))
+
 
 def gather_deps(path):
-    libdeps = clean_dep_output(subprocess.check_output(['python', dep_script, path, comp_base, 'shallowlibdeps']))
-    ifdeps  = clean_dep_output(subprocess.check_output(['python', dep_script, path, comp_base, 'shallowifdeps']))
-    ifexps  = clean_dep_output(subprocess.check_output(['python', dep_script, path, comp_base, 'shallowifexps']))
+    libdeps = clean_dep_output(
+        subprocess.check_output(
+            ["python", dep_script, path, comp_base, "shallowlibdeps"]
+        )
+    )
+    ifdeps = clean_dep_output(
+        subprocess.check_output(
+            ["python", dep_script, path, comp_base, "shallowifdeps"]
+        )
+    )
+    ifexps = clean_dep_output(
+        subprocess.check_output(
+            ["python", dep_script, path, comp_base, "shallowifexps"]
+        )
+    )
     return (libdeps, ifdeps, ifexps)
 
+
 def comp_name(p):
     s = re.split("/", string.rstrip(p))
-    s = filter(lambda e: e != '', s)
+    s = filter(lambda e: e != "", s)
     return s[-2] + "." + s[-1]
 
+
 def lib_or_if_name(p):
     s = re.split("/", string.rstrip(p))
-    s = filter(lambda e: e != '', s)
+    s = filter(lambda e: e != "", s)
     return s[-1]
 
+
 compdeps = {}
-libdeps  = {}
-ifdeps   = {}
+libdeps = {}
+ifdeps = {}
 
 for c in cs:
-    compdeps[comp_name(c)] = { "deps": gather_deps(c), "type": "component", "path":c }
+    compdeps[comp_name(c)] = {"deps": gather_deps(c), "type": "component", "path": c}
 for l in ls:
-    libdeps[lib_or_if_name(l)] = { "deps": gather_deps(l), "type": "library", "path":l }
+    libdeps[lib_or_if_name(l)] = {"deps": gather_deps(l), "type": "library", "path": l}
 for i in ifs:
-    ifdeps[lib_or_if_name(i)] = { "deps": gather_deps(i), "type": "interface", "path":i }
+    ifdeps[lib_or_if_name(i)] = {"deps": gather_deps(i), "type": "interface", "path": i}
 
 header = """digraph blob_dependencies {
 /* label = "Component Software Dependencies" ; */
@@ -88,14 +110,34 @@ def lib_or_if_name(p):
 """
 footer = "}"
 
+
 def gen_node(n, typestr):
-    fontattr = "fontname=\"Sans serif\""
-    if   typestr == "component":
-        return "\"" + n + "\" [shape=hexagon,style=filled,fillcolor=lightblue," + fontattr + "] ;\n"
+    fontattr = 'fontname="Sans serif"'
+    if typestr == "component":
+        return (
+            '"'
+            + n
+            + '" [shape=hexagon,style=filled,fillcolor=lightblue,'
+            + fontattr
+            + "] ;\n"
+        )
     elif typestr == "library":
-        return "\"" + n + "\" [shape=oval,style=filled,fillcolor=gray82," + fontattr + "] ;\n"
+        return (
+            '"'
+            + n
+            + '" [shape=oval,style=filled,fillcolor=gray82,'
+            + fontattr
+            + "] ;\n"
+        )
     elif typestr == "interface":
-        return "\"" + n + "\" [shape=rectangle,style=filled,fillcolor=lightsteelblue," + fontattr + "] ;\n"
+        return (
+            '"'
+            + n
+            + '" [shape=rectangle,style=filled,fillcolor=lightsteelblue,'
+            + fontattr
+            + "] ;\n"
+        )
+
 
 def gen_graphviz(blobs):
     for (b, d) in blobs.items():
@@ -107,25 +149,34 @@ def gen_graphviz(blobs):
         (libs, ifdeps, ifexps) = d["deps"]
         for l in libs:
             nodes.append(gen_node(l, "library"))
-            edges += "\"" + b + "\" -> \"" + l + "\" ;\n"
+            edges += '"' + b + '" -> "' + l + '" ;\n'
         for ifd in ifdeps:
             nodes.append(gen_node(ifd, "interface"))
-            edges += "\"" + b + "\" -> \"" + ifd + "\" ;\n"
+            edges += '"' + b + '" -> "' + ifd + '" ;\n'
         for ife in ifexps:
             nodes.append(gen_node(ife + "\n(export)", "interface"))
-            edges += "\"" + ife + "\n(export)\" -> \"" + b + "\" [fontname=\"Sans serif\",style=dashed] ;\n"
-
-        (gffd, gfpath) = tempfile.mkstemp(suffix=".gf", prefix="cos_docgen_" + b);
-        nodes_str = "".join(unique(nodes)) # rely on unique to simplify this logic
+            edges += (
+                '"'
+                + ife
+                + '\n(export)" -> "'
+                + b
+                + '" [fontname="Sans serif",style=dashed] ;\n'
+            )
+
+        (gffd, gfpath) = tempfile.mkstemp(suffix=".gf", prefix="cos_docgen_" + b)
+        nodes_str = "".join(unique(nodes))  # rely on unique to simplify this logic
         os.write(gffd, header + nodes_str + edges + footer)
-        d["gf"]   = gfpath;
-        d["gffd"] = gffd;
-
-        (pdffd, pdfpath) = tempfile.mkstemp(suffix=".pdf", prefix="cos_docgen_" + b.replace(".", "_"));
-        subprocess.call(['dot', '-Tpdf', gfpath], stdout=pdffd)
-        d["pdf"]   = pdfpath
+        d["gf"] = gfpath
+        d["gffd"] = gffd
+
+        (pdffd, pdfpath) = tempfile.mkstemp(
+            suffix=".pdf", prefix="cos_docgen_" + b.replace(".", "_")
+        )
+        subprocess.call(["dot", "-Tpdf", gfpath], stdout=pdffd)
+        d["pdf"] = pdfpath
         d["pdffd"] = pdffd
 
+
 gen_graphviz(compdeps)
 gen_graphviz(libdeps)
 gen_graphviz(ifdeps)
@@ -152,7 +203,7 @@ def gen_graphviz(blobs):
 #
 # This assumes and leverages the style perscribed by the CSG.
 
-library_headers   = comp_base + "lib/*/*.h"
+library_headers = comp_base + "lib/*/*.h"
 interface_headers = comp_base + "interface/*/*.h"
 ### Auto-gen the documentation for the interfaces and libraries
 def gen_doc(header):
@@ -166,8 +217,8 @@ def gen_doc(header):
     state = "scanning"
 
     def de_comment(line):
-        l = re.sub(r'^ \*', r'', line) # get rid of the leading " *"
-        if len(l) > 0 and l[0] == ' ':
+        l = re.sub(r"^ \*", r"", line)  # get rid of the leading " *"
+        if len(l) > 0 and l[0] == " ":
             return l[1:]
         return l
 
@@ -182,13 +233,13 @@ def commit_proto(proto, comment):
     in_comment = False
     for l in re.split("\n", header):
         # First, filter out # directives and comments
-        if re.match('^#.*', l) != None:
-            continue        # skip #endif/#define etc...
-        c_single = re.match(r'(.*)//.*', l) # remove text following //
+        if re.match("^#.*", l) != None:
+            continue  # skip #endif/#define etc...
+        c_single = re.match(r"(.*)//.*", l)  # remove text following //
         if c_single != None:
             l = c_single.group(0)
-        c_start  = re.match(r'(.*)/\*[^\*].*', l) # remove all after /*
-        c_end    = re.match(r'.*\*/(.*)', l)  # leave only code after */
+        c_start = re.match(r"(.*)/\*[^\*].*", l)  # remove all after /*
+        c_end = re.match(r".*\*/(.*)", l)  # leave only code after */
         if not in_comment and c_start != None:
             in_comment = True
             l = c_start.group(0)
@@ -210,13 +261,13 @@ def commit_proto(proto, comment):
             comment = ""
             state = "header comment"
         elif state == "comment":
-            if (l == " */"):
+            if l == " */":
                 state = "prototypes"
             else:
                 l = de_comment(l)
                 comment += l + "\n"
         elif state == "header comment":
-            if (l == " */"):
+            if l == " */":
                 state = "scanning"
             else:
                 l = de_comment(l)
@@ -229,7 +280,7 @@ def commit_proto(proto, comment):
                 comment = ""
                 state = "comment"
             elif p != None:
-                proto += p.group(0)  + "\n"
+                proto += p.group(0) + "\n"
             elif l == "{":
                 proto += "{ ... "
                 state = "function body"
@@ -243,23 +294,24 @@ def commit_proto(proto, comment):
         elif state == "function body":
             if l == "}":
                 proto += "}\n"
-                state  = "prototypes"
+                state = "prototypes"
 
-    doc += commit_proto(proto,comment)
+    doc += commit_proto(proto, comment)
 
     return doc_header + header_comment + doc
 
+
 for (b, d) in ifdeps.items():
-    path     = d["path"] + b + ".h"
+    path = d["path"] + b + ".h"
     contents = readfile(path)
-    doc      = gen_doc(contents)
-    d["doc"] = doc;
+    doc = gen_doc(contents)
+    d["doc"] = doc
 
 for (b, d) in libdeps.items():
-    path     = d["path"] + b + ".h"
+    path = d["path"] + b + ".h"
     contents = readfile(path)
-    doc      = gen_doc(contents)
-    d["doc"] = doc;
+    doc = gen_doc(contents)
+    d["doc"] = doc
 
 # At this point, we have all of the pdfs generated for the component
 # dependencies, and need to simply generate the markdown that links to
@@ -269,17 +321,24 @@ def gen_md(header, blobs):
     output = "\n" + copy.copy(header) + "\n\n"
     for (b, d) in blobs.items():
         output += readfile(d["path"] + "doc.md")
-        output += "\n### Dependencies and Exports\n\n![Exports and dependencies for " + b + ". Teal hexagons are *component* implementations, slate rectangles are *interfaces*, and gray ellipses are *libraries*. Dotted lines denote an *export* relation, and solid lines denote a *dependency*.](" + d["pdf"] + ")\n\n"
+        output += (
+            "\n### Dependencies and Exports\n\n![Exports and dependencies for "
+            + b
+            + ". Teal hexagons are *component* implementations, slate rectangles are *interfaces*, and gray ellipses are *libraries*. Dotted lines denote an *export* relation, and solid lines denote a *dependency*.]("
+            + d["pdf"]
+            + ")\n\n"
+        )
         if d.has_key("doc"):
             output += d["doc"] + "\n\n"
     return output
 
-comphead=readfile("./resources/component_doc.md")
-ifhead  =readfile("./resources/interface_doc.md")
-libhead =readfile("./resources/lib_doc.md")
+
+comphead = readfile("./resources/component_doc.md")
+ifhead = readfile("./resources/interface_doc.md")
+libhead = readfile("./resources/lib_doc.md")
 
 md = gen_md(comphead, compdeps) + gen_md(ifhead, ifdeps) + gen_md(libhead, libdeps)
-(mdfd, mdpath) = tempfile.mkstemp(suffix=".md", prefix="cos_docgen_per-blob");
+(mdfd, mdpath) = tempfile.mkstemp(suffix=".md", prefix="cos_docgen_per-blob")
 os.write(mdfd, md)
 
 print(mdpath)
diff --git a/doc/dev_manual/resources/gen_toc.py b/doc/dev_manual/resources/gen_toc.py
index 091fb0e561..9360d4bd0c 100644
--- a/doc/dev_manual/resources/gen_toc.py
+++ b/doc/dev_manual/resources/gen_toc.py
@@ -5,15 +5,19 @@
 import string
 
 chapters = sorted(glob.glob("[0-9][0-9]_*.md"))
-version  = glob.glob("composite_dev_manual_v*.pdf")[0]
+version = glob.glob("composite_dev_manual_v*.pdf")[0]
 
-header = "# Composite Developer Manual\n\nPlease see the [pdf](./" + version + ") for a nicely rendered version of this manual.\n\n## Table of Contents\n\n"
+header = (
+    "# Composite Developer Manual\n\nPlease see the [pdf](./"
+    + version
+    + ") for a nicely rendered version of this manual.\n\n## Table of Contents\n\n"
+)
 
 toc = ""
 for c in chapters:
     underscores = re.split("\.", string.rstrip(c))[0]
-    word_list   = re.split("_", underscores)[1:]
-    words       = " ".join(word_list)
+    word_list = re.split("_", underscores)[1:]
+    words = " ".join(word_list)
     toc += "- [" + words.capitalize() + "](./" + c + ")\n"
 
 print(header + toc)
diff --git a/doc/dev_manual/resources/sys_graph.py b/doc/dev_manual/resources/sys_graph.py
index d8c63475f4..d3336addd7 100644
--- a/doc/dev_manual/resources/sys_graph.py
+++ b/doc/dev_manual/resources/sys_graph.py
@@ -8,45 +8,57 @@
 import string
 
 dep_script = "../../src/components/cidl/calculate_dependencies.py"
-comp_base  = "../../src/components/"
+comp_base = "../../src/components/"
 components = comp_base + "implementation/*/*/"
-libraries  = comp_base + "lib/*/"
+libraries = comp_base + "lib/*/"
 interfaces = comp_base + "interface/*/"
 
+
 def filter_out_skel(p):
     s = re.split("/", string.rstrip(p))
-    s = filter(lambda e: e != '', s)
-    return not(s[-1] == "skel" or s[-2] == "skel") and not(s[-2] == "archives")
+    s = filter(lambda e: e != "", s)
+    return not (s[-1] == "skel" or s[-2] == "skel") and not (s[-2] == "archives")
+
 
-cs  = filter(filter_out_skel, glob.glob(components))
-ls  = filter(filter_out_skel, glob.glob(libraries))
+cs = filter(filter_out_skel, glob.glob(components))
+ls = filter(filter_out_skel, glob.glob(libraries))
 ifs = filter(filter_out_skel, glob.glob(interfaces))
 
+
 def unique(l):
     return list(set(l))
 
+
 # listify the output
 def clean_dep_output(lst):
     return unique(re.split(" ", string.rstrip(lst)))
 
+
 def gather_deps(path):
-    libdeps = clean_dep_output(subprocess.check_output(['python', dep_script, path, comp_base, 'libdeps']))
-    ifdeps  = clean_dep_output(subprocess.check_output(['python', dep_script, path, comp_base, 'ifdeps']))
-    return filter(lambda d: d != '', unique(libdeps + ifdeps))
+    libdeps = clean_dep_output(
+        subprocess.check_output(["python", dep_script, path, comp_base, "libdeps"])
+    )
+    ifdeps = clean_dep_output(
+        subprocess.check_output(["python", dep_script, path, comp_base, "ifdeps"])
+    )
+    return filter(lambda d: d != "", unique(libdeps + ifdeps))
+
 
 def comp_name(p):
     s = re.split("/", string.rstrip(p))
-    s = filter(lambda e: e != '', s)
+    s = filter(lambda e: e != "", s)
     return s[-2] + "." + s[-1]
 
+
 def lib_or_if_name(p):
     s = re.split("/", string.rstrip(p))
-    s = filter(lambda e: e != '', s)
+    s = filter(lambda e: e != "", s)
     return s[-1]
 
+
 compdeps = {}
-libdeps  = {}
-ifdeps   = {}
+libdeps = {}
+ifdeps = {}
 
 for c in cs:
     compdeps[comp_name(c)] = gather_deps(c)
@@ -71,24 +83,38 @@ def lib_or_if_name(p):
 
 nodes = ""
 edges = ""
-fontattr = "fontname=\"Sans serif\",fontsize=\"48\""
+fontattr = 'fontname="Sans serif",fontsize="48"'
 
 for (c, ds) in compdeps.items():
-    nodes += "\"" + c + "\" [shape=hexagon,style=filled,fillcolor=lightblue," + fontattr + "] ;\n"
+    nodes += (
+        '"'
+        + c
+        + '" [shape=hexagon,style=filled,fillcolor=lightblue,'
+        + fontattr
+        + "] ;\n"
+    )
 for (l, ds) in libdeps.items():
-    nodes += "\"" + l + "\" [shape=oval,style=filled,fillcolor=gray82," + fontattr + "] ;\n"
+    nodes += (
+        '"' + l + '" [shape=oval,style=filled,fillcolor=gray82,' + fontattr + "] ;\n"
+    )
 for (i, ds) in ifdeps.items():
-    nodes += "\"" + i + "\" [shape=rectangle,style=filled,fillcolor=lightsteelblue," + fontattr + "] ;\n"
+    nodes += (
+        '"'
+        + i
+        + '" [shape=rectangle,style=filled,fillcolor=lightsteelblue,'
+        + fontattr
+        + "] ;\n"
+    )
 
 for (c, ds) in compdeps.items():
     for d in ds:
-        edges += "\"" + c + "\" -> \"" + d + "\" ;\n"
+        edges += '"' + c + '" -> "' + d + '" ;\n'
 for (l, ds) in libdeps.items():
     for d in ds:
-        edges += "\"" + l + "\" -> \"" + d + "\" ;\n"
+        edges += '"' + l + '" -> "' + d + '" ;\n'
 for (i, ds) in ifdeps.items():
     for d in ds:
-        edges += "\"" + i + "\" -> \"" + d + "\" ;\n"
+        edges += '"' + i + '" -> "' + d + '" ;\n'
 
 
 print(header + nodes + edges + footer)

From 97d5e9f1c69d9092cae9762fe583cfe7250298c7 Mon Sep 17 00:00:00 2001
From: Louie Lu <git@louie.lu>
Date: Tue, 4 Jan 2022 09:44:47 +0800
Subject: [PATCH 2/5] Update `str.rstrip()`

---
 doc/dev_manual/resources/gen_blob_docs.py | 11 +++++------
 doc/dev_manual/resources/gen_toc.py       |  3 +--
 doc/dev_manual/resources/sys_graph.py     | 10 +++++-----
 3 files changed, 11 insertions(+), 13 deletions(-)

diff --git a/doc/dev_manual/resources/gen_blob_docs.py b/doc/dev_manual/resources/gen_blob_docs.py
index dc63335efa..1dfaed53e3 100644
--- a/doc/dev_manual/resources/gen_blob_docs.py
+++ b/doc/dev_manual/resources/gen_blob_docs.py
@@ -5,7 +5,6 @@
 import glob
 import subprocess
 import re
-import string
 import tempfile
 import os
 import copy
@@ -28,14 +27,14 @@ def remove_trailing_doc(wildcard_path):
     removed = []
     for p in ps:
         # remove the "doc.md" from the path
-        s = re.split("/", string.rstrip(p))
+        s = re.split("/", p.rstrip())
         pathified = "/".join(s[0:-1]) + "/"
         removed.append(pathified)
     return removed
 
 
 def filter_out_skel(p):
-    s = re.split("/", string.rstrip(p))
+    s = re.split("/", p.rstrip())
     s = filter(lambda e: e != "", s)
     return not (s[-1] == "skel" or s[-2] == "skel") and not (s[-2] == "archives")
 
@@ -51,7 +50,7 @@ def unique(l):
 
 # listify the output
 def clean_dep_output(lst):
-    return filter(lambda d: d != "", unique(re.split(" ", string.rstrip(lst))))
+    return filter(lambda d: d != "", unique(re.split(" ", lst.rstrip())))
 
 
 def gather_deps(path):
@@ -74,13 +73,13 @@ def gather_deps(path):
 
 
 def comp_name(p):
-    s = re.split("/", string.rstrip(p))
+    s = re.split("/", p.rstrip())
     s = filter(lambda e: e != "", s)
     return s[-2] + "." + s[-1]
 
 
 def lib_or_if_name(p):
-    s = re.split("/", string.rstrip(p))
+    s = re.split("/", p.rstrip())
     s = filter(lambda e: e != "", s)
     return s[-1]
 
diff --git a/doc/dev_manual/resources/gen_toc.py b/doc/dev_manual/resources/gen_toc.py
index 9360d4bd0c..6e52648e5f 100644
--- a/doc/dev_manual/resources/gen_toc.py
+++ b/doc/dev_manual/resources/gen_toc.py
@@ -2,7 +2,6 @@
 
 import glob
 import re
-import string
 
 chapters = sorted(glob.glob("[0-9][0-9]_*.md"))
 version = glob.glob("composite_dev_manual_v*.pdf")[0]
@@ -15,7 +14,7 @@
 
 toc = ""
 for c in chapters:
-    underscores = re.split("\.", string.rstrip(c))[0]
+    underscores = re.split("\.", c.rstrip())[0]
     word_list = re.split("_", underscores)[1:]
     words = " ".join(word_list)
     toc += "- [" + words.capitalize() + "](./" + c + ")\n"
diff --git a/doc/dev_manual/resources/sys_graph.py b/doc/dev_manual/resources/sys_graph.py
index d3336addd7..9ae41ca69b 100644
--- a/doc/dev_manual/resources/sys_graph.py
+++ b/doc/dev_manual/resources/sys_graph.py
@@ -5,7 +5,7 @@
 import glob
 import subprocess
 import re
-import string
+
 
 dep_script = "../../src/components/cidl/calculate_dependencies.py"
 comp_base = "../../src/components/"
@@ -15,7 +15,7 @@
 
 
 def filter_out_skel(p):
-    s = re.split("/", string.rstrip(p))
+    s = re.split("/", p.rstrip())
     s = filter(lambda e: e != "", s)
     return not (s[-1] == "skel" or s[-2] == "skel") and not (s[-2] == "archives")
 
@@ -31,7 +31,7 @@ def unique(l):
 
 # listify the output
 def clean_dep_output(lst):
-    return unique(re.split(" ", string.rstrip(lst)))
+    return unique(re.split(" ", lst.rstrip()))
 
 
 def gather_deps(path):
@@ -45,13 +45,13 @@ def gather_deps(path):
 
 
 def comp_name(p):
-    s = re.split("/", string.rstrip(p))
+    s = re.split("/", p.rstrip())
     s = filter(lambda e: e != "", s)
     return s[-2] + "." + s[-1]
 
 
 def lib_or_if_name(p):
-    s = re.split("/", string.rstrip(p))
+    s = re.split("/", p.rstrip())
     s = filter(lambda e: e != "", s)
     return s[-1]
 

From 4c079dfc6825eb894a219352d33d8c93b2727f4e Mon Sep 17 00:00:00 2001
From: Louie Lu <git@louie.lu>
Date: Tue, 4 Jan 2022 09:55:43 +0800
Subject: [PATCH 3/5] Add `list()` to filter for Python 3 compatible

---
 doc/dev_manual/resources/gen_blob_docs.py | 6 +++---
 doc/dev_manual/resources/sys_graph.py     | 6 +++---
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/doc/dev_manual/resources/gen_blob_docs.py b/doc/dev_manual/resources/gen_blob_docs.py
index 1dfaed53e3..9bca5e62b4 100644
--- a/doc/dev_manual/resources/gen_blob_docs.py
+++ b/doc/dev_manual/resources/gen_blob_docs.py
@@ -35,7 +35,7 @@ def remove_trailing_doc(wildcard_path):
 
 def filter_out_skel(p):
     s = re.split("/", p.rstrip())
-    s = filter(lambda e: e != "", s)
+    s = list(filter(lambda e: e != "", s))
     return not (s[-1] == "skel" or s[-2] == "skel") and not (s[-2] == "archives")
 
 
@@ -74,13 +74,13 @@ def gather_deps(path):
 
 def comp_name(p):
     s = re.split("/", p.rstrip())
-    s = filter(lambda e: e != "", s)
+    s = list(filter(lambda e: e != "", s))
     return s[-2] + "." + s[-1]
 
 
 def lib_or_if_name(p):
     s = re.split("/", p.rstrip())
-    s = filter(lambda e: e != "", s)
+    s = list(filter(lambda e: e != "", s))
     return s[-1]
 
 
diff --git a/doc/dev_manual/resources/sys_graph.py b/doc/dev_manual/resources/sys_graph.py
index 9ae41ca69b..c514502505 100644
--- a/doc/dev_manual/resources/sys_graph.py
+++ b/doc/dev_manual/resources/sys_graph.py
@@ -16,7 +16,7 @@
 
 def filter_out_skel(p):
     s = re.split("/", p.rstrip())
-    s = filter(lambda e: e != "", s)
+    s = list(filter(lambda e: e != "", s))
     return not (s[-1] == "skel" or s[-2] == "skel") and not (s[-2] == "archives")
 
 
@@ -46,13 +46,13 @@ def gather_deps(path):
 
 def comp_name(p):
     s = re.split("/", p.rstrip())
-    s = filter(lambda e: e != "", s)
+    s = list(filter(lambda e: e != "", s))
     return s[-2] + "." + s[-1]
 
 
 def lib_or_if_name(p):
     s = re.split("/", p.rstrip())
-    s = filter(lambda e: e != "", s)
+    s = list(filter(lambda e: e != "", s))
     return s[-1]
 
 

From 5b640657de8ba61dd125952f2f63f38d53873b3c Mon Sep 17 00:00:00 2001
From: Louie Lu <git@louie.lu>
Date: Wed, 5 Jan 2022 22:10:05 +0800
Subject: [PATCH 4/5] Add str compatible for Python 3

---
 doc/dev_manual/resources/gen_blob_docs.py | 9 ++++++++-
 doc/dev_manual/resources/sys_graph.py     | 2 ++
 2 files changed, 10 insertions(+), 1 deletion(-)

diff --git a/doc/dev_manual/resources/gen_blob_docs.py b/doc/dev_manual/resources/gen_blob_docs.py
index 9bca5e62b4..0a04cdb92d 100644
--- a/doc/dev_manual/resources/gen_blob_docs.py
+++ b/doc/dev_manual/resources/gen_blob_docs.py
@@ -50,6 +50,8 @@ def unique(l):
 
 # listify the output
 def clean_dep_output(lst):
+    if isinstance(lst, bytes):
+        lst = lst.decode("utf-8")
     return filter(lambda d: d != "", unique(re.split(" ", lst.rstrip())))
 
 
@@ -164,7 +166,10 @@ def gen_graphviz(blobs):
 
         (gffd, gfpath) = tempfile.mkstemp(suffix=".gf", prefix="cos_docgen_" + b)
         nodes_str = "".join(unique(nodes))  # rely on unique to simplify this logic
-        os.write(gffd, header + nodes_str + edges + footer)
+        content = header + nodes_str + edges + footer
+        if isinstance(content, str):
+            content = content.encode("utf-8")
+        os.write(gffd, content)
         d["gf"] = gfpath
         d["gffd"] = gffd
 
@@ -337,6 +342,8 @@ def gen_md(header, blobs):
 libhead = readfile("./resources/lib_doc.md")
 
 md = gen_md(comphead, compdeps) + gen_md(ifhead, ifdeps) + gen_md(libhead, libdeps)
+if isinstance(md, str):
+    md = md.encode("utf-8")
 (mdfd, mdpath) = tempfile.mkstemp(suffix=".md", prefix="cos_docgen_per-blob")
 os.write(mdfd, md)
 
diff --git a/doc/dev_manual/resources/sys_graph.py b/doc/dev_manual/resources/sys_graph.py
index c514502505..4576c0e0a8 100644
--- a/doc/dev_manual/resources/sys_graph.py
+++ b/doc/dev_manual/resources/sys_graph.py
@@ -31,6 +31,8 @@ def unique(l):
 
 # listify the output
 def clean_dep_output(lst):
+    if isinstance(lst, bytes):
+        lst = lst.decode("utf-8")
     return unique(re.split(" ", lst.rstrip()))
 
 

From 21678efc39dfa8e28d3c055b0553d0cda82429cb Mon Sep 17 00:00:00 2001
From: Louie Lu <git@louie.lu>
Date: Wed, 5 Jan 2022 22:14:43 +0800
Subject: [PATCH 5/5] Use `in` to test key in dict

---
 doc/dev_manual/resources/gen_blob_docs.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/dev_manual/resources/gen_blob_docs.py b/doc/dev_manual/resources/gen_blob_docs.py
index 0a04cdb92d..4bdd25379d 100644
--- a/doc/dev_manual/resources/gen_blob_docs.py
+++ b/doc/dev_manual/resources/gen_blob_docs.py
@@ -332,7 +332,7 @@ def gen_md(header, blobs):
             + d["pdf"]
             + ")\n\n"
         )
-        if d.has_key("doc"):
+        if "doc" in d:
             output += d["doc"] + "\n\n"
     return output