Let black and ruff reformat and fix projcode. Minor style adjustments and

comment updates.

Author: jonasbardino

bin/addheader.py

@@ -98,8 +98,11 @@
 
 
 def check_header(path, var_dict, preamble_lines=100):
-    """Check if path already has a credible license header. Only looks inside
-    the first preamble_size bytes of the file.
+    """Check if path has a credible license header and otherwise adds one.
+
+    Only looks inside the first preamble_lines of the file and if it doesn't
+    find an existing license header there it adds a standard header populated
+    with project variables from var_dict.
     """
     module_preamble = "\n".join(read_head_lines(path, preamble_lines, None))
     return (

mig/shared/projcode.py

@@ -25,93 +25,102 @@
 
 from mig.shared.defaults import keyword_all
 
-# TODO: phase out lowercase names once all scripts switched to get_code_files
+# TODO: phase out lowercase names once all scripts switched to list_code_files
 
 # Top dir with all code
-CODE_ROOT = code_root = 'mig'
+code_root = "mig"
+CODE_ROOT = code_root
 
 # Ignore backup and dot files in wild card match
-PLAIN = '[a-zA-Z0-9]*.py'
+PLAIN = "[a-zA-Z0-9]*.py"
 py_code_files = [
     # a few scripts are in parent dir of code_root
-    '../%s' % PLAIN,
-    '../bin/%s' % PLAIN,
-    '../sbin/%s' % PLAIN,
-    '%s' % PLAIN,
-    'lib/%s' % PLAIN,
-    'cgi-bin/%s' % PLAIN,
-    'cgi-sid/%s' % PLAIN,
-    'install/%s' % PLAIN,
-    'migfs-fuse/%s' % PLAIN,
-    'resource/bin/%s' % PLAIN,
-    'resource/image-scripts/%s' % PLAIN,
-    'resource/keepalive-scripts/%s' % PLAIN,
-    'server/%s' % PLAIN,
-    'shared/%s' % PLAIN,
-    'shared/functionality/%s' % PLAIN,
-    'shared/distos/%s' % PLAIN,
-    'shared/gdp/%s' % PLAIN,
-    'shared/griddaemons/%s' % PLAIN,
-    'simulation/%s' % PLAIN,
-    'user/%s' % PLAIN,
-    'vm-proxy/%s' % PLAIN,
-    'webserver/%s' % PLAIN,
-    'wsgi-bin/%s' % PLAIN,
+    "../%s" % PLAIN,
+    "../bin/%s" % PLAIN,
+    "../sbin/%s" % PLAIN,
+    "%s" % PLAIN,
+    "lib/%s" % PLAIN,
+    "cgi-bin/%s" % PLAIN,
+    "cgi-sid/%s" % PLAIN,
+    "install/%s" % PLAIN,
+    "migfs-fuse/%s" % PLAIN,
+    "resource/bin/%s" % PLAIN,
+    "resource/image-scripts/%s" % PLAIN,
+    "resource/keepalive-scripts/%s" % PLAIN,
+    "server/%s" % PLAIN,
+    "shared/%s" % PLAIN,
+    "shared/functionality/%s" % PLAIN,
+    "shared/distos/%s" % PLAIN,
+    "shared/gdp/%s" % PLAIN,
+    "shared/griddaemons/%s" % PLAIN,
+    "simulation/%s" % PLAIN,
+    "user/%s" % PLAIN,
+    "vm-proxy/%s" % PLAIN,
+    "webserver/%s" % PLAIN,
+    "wsgi-bin/%s" % PLAIN,
+]
+py_code_files += [
+    "cgi-sid/%s" % name for name in ["requestnewjob", "putrespgid"]
 ]
-py_code_files += ['cgi-sid/%s' % name for name in ['requestnewjob',
-                                                   'putrespgid']]
 
-py_code_files += ['cgi-bin/%s' % name for name in [
-    'listdir',
-    'mkdir',
-    'put',
-    'remove',
-    'rename',
-    'rmdir',
-    'stat',
-    'walk',
-    'getrespgid',
-]]
+py_code_files += [
+    "cgi-bin/%s" % name
+    for name in [
+        "listdir",
+        "mkdir",
+        "put",
+        "remove",
+        "rename",
+        "rmdir",
+        "stat",
+        "walk",
+        "getrespgid",
+    ]
+]
 PY_CODE_FILES = py_code_files
 
 sh_code_files = [
-    'resource/frontend_script.sh',
-    'resource/master_node_script.sh',
-    'resource/leader_node_script.sh',
-    'resource/dummy_node_script.sh',
+    "resource/frontend_script.sh",
+    "resource/master_node_script.sh",
+    "resource/leader_node_script.sh",
+    "resource/dummy_node_script.sh",
 ]
 SH_CODE_FILES = sh_code_files
 
 js_code_files = [
-    'images/js/jquery.accountform.js',
-    'images/js/jquery.ajaxhelpers.js',
-    'images/js/jquery.confirm.js',
-    'images/js/jquery.filemanager.js',
-    'images/js/jquery.jobmanager.js',
-    'images/js/jquery.migtools.js',
-    'images/js/jquery.prettyprint.js',
-    'images/js/preview-caman.js',
-    'images/js/preview.js',
-    'images/js/preview-paraview.js',
-    'assets/js/shared/ui-dynamic.js',
-    'assets/js/V3/ui-global.js',
-    'assets/js/V3/ui-extra.js',
+    "images/js/jquery.accountform.js",
+    "images/js/jquery.ajaxhelpers.js",
+    "images/js/jquery.confirm.js",
+    "images/js/jquery.filemanager.js",
+    "images/js/jquery.jobmanager.js",
+    "images/js/jquery.migtools.js",
+    "images/js/jquery.prettyprint.js",
+    "images/js/preview-caman.js",
+    "images/js/preview.js",
+    "images/js/preview-paraview.js",
+    "assets/js/shared/ui-dynamic.js",
+    "assets/js/V3/ui-global.js",
+    "assets/js/V3/ui-extra.js",
 ]
 JS_CODE_FILES = js_code_files
 
 code_files = py_code_files + sh_code_files + js_code_files
 CODE_FILES = code_files
 
 PYTHON, SHELL, JAVASCRIPT = "PYTHON", "SHELL", "JAVASCRIPT"
-LANG_MAP = {keyword_all: CODE_FILES, PYTHON: PY_CODE_FILES,
-            JAVASCRIPT: JS_CODE_FILES, SHELL: SH_CODE_FILES}
+LANG_MAP = {
+    keyword_all: CODE_FILES,
+    PYTHON: PY_CODE_FILES,
+    JAVASCRIPT: JS_CODE_FILES,
+    SHELL: SH_CODE_FILES,
+}
 
 
 def list_code_files(code_langs=[keyword_all]):
     """Get list of all code files."""
     match = []
     for lang in code_langs:
-        if not lang in LANG_MAP:
+        if lang not in LANG_MAP:
             print("Warning: no such code lang: %s" % lang)
         else:
             match += LANG_MAP[lang]