File: commit-msg.py

package info (click to toggle)
python-tatsu 5.17.1%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,516 kB
  • sloc: python: 13,185; makefile: 127
file content (80 lines) | stat: -rwxr-xr-x 2,362 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
#!/usr/bin/env python3
# Copyright (c) 2017-2026 Juancarlo AƱez (apalala@gmail.com)
# SPDX-License-Identifier: BSD-4-Clause
from __future__ import annotations

import os
import subprocess
import sys
from collections.abc import Sequence

# by [apalala@gmail.com](https://github.com/apalala)
# by Gemini (2026-02-03)

type FileList = Sequence[str]


def get_staged_files() -> FileList:
    """
    Get files staged for commit. Still requires one external call to git.
    """
    # by [apalala@gmail.com](https://github.com/apalala)
    # by Gemini (2026-02-03)
    try:
        result = subprocess.run(
            ['git', 'diff', '--cached', '--name-only', '--diff-filter=d'],
            capture_output=True,
            text=True,
            check=True,
        )
        return result.stdout.splitlines()
    except subprocess.CalledProcessError:
        return []


def get_missing_headers(files: FileList) -> FileList:
    """
    Identify which files are missing the SPDX header.
    """
    # by [apalala@gmail.com](https://github.com/apalala)
    # by Gemini (2026-02-03)
    target = "SPDX-License-Identifier: BSD-4-Clause"
    ignored = {'.png', '.jpg', '.pdf', '.pyc', '.dot', '.ico'}
    missing = []

    for path in files:
        if any(path.endswith(ext) for ext in ignored) or not os.path.isfile(path):
            continue
        try:
            with open(path, 'r', encoding='utf-8', errors='ignore') as f:
                if target not in f.read(1024):
                    missing.append(path)
        except Exception:
            pass
    return missing


def main() -> None:
    # by [apalala@gmail.com](https://github.com/apalala)
    # by Gemini (2026-02-03)
    if len(sys.argv) < 2:
        sys.exit(0)

    commit_msg_filepath = sys.argv[1]
    staged = get_staged_files()
    missing = get_missing_headers(staged)

    if missing:
        with open(commit_msg_filepath, 'a', encoding='utf-8') as f:
            f.write("\n# --------------------------------------------------------\n")
            f.write("# LICENSE HEADER WARNING:\n")
            f.write("# The following files are missing the SPDX header:\n")
            for path in missing:
                f.write(f"#   - {path}\n")
            f.write("# --------------------------------------------------------\n")

    sys.exit(0)


if __name__ == "__main__":
    main()