Code Quality and Engineering Practices Questions

#!/usr/bin/env python3
import re, sys, subprocess

# pattern: TODO(#digits)
PAT = re.compile(r'TODO\(#\d+\)')

def staged_files():
    out = subprocess.check_output(['git','diff','--cached','--name-only'], text=True)
    return [f for f in out.splitlines() if f]

def file_has_bad_todo(path):
    try:
        with open(path, 'r', encoding='utf-8') as fh:
            for i,line in enumerate(fh,1):
                if 'TODO' in line and not PAT.search(line):
                    return path, i, line.strip()
    except Exception:
        pass
    return None

def main():
    bad = []
    for f in staged_files():
        r = file_has_bad_todo(f)
        if r: bad.append(r)
    if bad:
        print("Commit rejected: TODOs must include an issue number like TODO(#1234):")
        for path,ln,text in bad:
            print(f"  {path}:{ln}: {text}")
        sys.exit(1)
    return 0

if __name__ == '__main__':
    sys.exit(main())