[b4,1/2] ez: Ensure that all the info dict keys are defined

Commit Message

Louis Chauvet May 21, 2024, 2:41 p.m. UTC

In some situations, a few keys in the info dictionary were not defined,
which could lead to "KeyError" errors (for example, 'needs-auto-to-cc' and
'needs-checking' were not always defined). To prevent these errors and
simplify the code logic, I used a literal dictionary initialization for
the info dictionary.
---
 src/b4/ez.py | 74 ++++++++++++++++++++++++++----------------------------------
 1 file changed, 32 insertions(+), 42 deletions(-)

Patch

diff --git a/src/b4/ez.py b/src/b4/ez.py
index e1a4d67696ad..76121ab02d03 100644
--- a/src/b4/ez.py
+++ b/src/b4/ez.py
@@ -2401,7 +2401,8 @@  def show_info(param: str) -> None:
     prep_info = get_info(usebranch=mybranch)
     if getval == '_all':
         for key, val in prep_info.items():
-            print('%s: %s' % (key, val))
+            if val is not None:
+                print('%s: %s' % (key, val))
     elif getval in prep_info:
         print(prep_info[getval])
     else:
@@ -2411,57 +2412,46 @@  def show_info(param: str) -> None:
 
 def get_info(usebranch: str) -> Dict[str, str]:
     is_prep_branch(mustbe=True, usebranch=usebranch)
-    info = dict()
-    info['branch'] = usebranch
     cover, tracking = load_cover(usebranch=usebranch)
     csubject, cbody = get_cover_subject_body(cover)
-    info['cover-subject'] = csubject.full_subject
     ts = tracking['series']
-    if ts.get('prefixes'):
-        info['prefixes'] = ' '.join(ts.get('prefixes'))
-    info['change-id'] = ts.get('change-id')
-    revision = ts.get('revision')
-    info['revision'] = revision
-    strategy = get_cover_strategy(usebranch=usebranch)
-    info['cover-strategy'] = strategy
-    if ts.get('base-branch'):
-        info['base-branch'] = ts['base-branch']
     base_commit, start_commit, end_commit, oneline, shortlog, diffstat = get_series_details(usebranch=usebranch)
-    info['needs-editing'] = False
     todests, ccdests, tag_msg, patches = get_prep_branch_as_patches(usebranch=usebranch, expandprereqs=False)
-    if not todests and not ccdests:
-        info['needs-recipients'] = True
-    else:
-        info['needs-recipients'] = False
-    if b'EDITME' in b4.LoreMessage.get_msg_as_bytes(patches[0][1]):
-        info['needs-editing'] = True
     prereqs = tracking['series'].get('prerequisites', list())
-    info['has-prerequisites'] = len(prereqs) > 0
     tocmd, cccmd = get_auto_to_cc_cmds()
-    if tocmd or cccmd:
-        info['needs-auto-to-cc'] = True
     ppcmds, scmds = get_check_cmds()
-    if ppcmds or scmds:
-        info['needs-checking'] = True
     pf_checks = get_preflight_checks(usebranch=usebranch)
-    if pf_checks is not None:
-        if (tocmd or cccmd) and 'auto-to-cc' in pf_checks and not info['needs-recipients']:
-            info['needs-auto-to-cc'] = False
-        if (ppcmds or scmds) and 'check' in pf_checks:
-            info['needs-checking'] = False
-        if info['has-prerequisites']:
-            info['needs-checking-deps'] = 'check-deps' not in pf_checks
-        else:
-            info['needs-checking-deps'] = False
-    if info['needs-editing'] or info['needs-auto-to-cc'] or info['needs-checking'] or info['needs-checking-deps']:
-        info['preflight-checks-failing'] = True
-    else:
-        info['preflight-checks-failing'] = False
 
-    info['base-commit'] = base_commit
-    info['start-commit'] = start_commit
-    info['end-commit'] = end_commit
-    info['series-range'] = f'{start_commit}..{end_commit}'
+    info = {
+        # General information about this branch
+        'branch': usebranch,
+        'cover-subject': csubject.full_subject,
+        'base-branch': ts.get('base-branch'),
+        'base-commit': base_commit,
+        'start-commit': start_commit,
+        'end-commit': end_commit,
+        'series-range': f'{start_commit}..{end_commit}',
+
+        # General information about this branch status
+        'prefixes': ' '.join(ts.get('prefixes', [])) or None,
+        'change-id': ts.get('change-id'),
+        'revision': ts.get('revision'),
+        'cover-strategy': get_cover_strategy(usebranch=usebranch),
+
+        # General information about this branch checks
+        'needs-editing': b'EDITME' in b4.LoreMessage.get_msg_as_bytes(patches[0][1]),
+        'needs-recipients': bool(not todests and not ccdests),
+        'has-prerequisites': len(prereqs) > 0,
+        'needs-auto-to-cc': None,
+        'needs-checking': bool(ppcmds or scmds) and 'check' not in pf_checks,
+        'needs-checking-deps': len(prereqs) > 0 and 'check-deps' not in pf_checks,
+        'preflight-checks-failing': None,
+    }
+    info['needs-auto-to-cc'] = info["needs-recipients"] or (bool(tocmd or cccmd) and 'auto-to-cc' not in pf_checks)
+    info['preflight-checks-failing'] = bool(info['needs-editing'] or info['needs-auto-to-cc'] or
+                                            info['needs-checking'] or info['needs-checking-deps'])
+
+    # Add commits information
     for line in oneline:
         short, subject = line.split(maxsplit=1)
         info[f'commit-{short}'] = subject