check_spdx_header.py 1.51 KB
Newer Older
1
# SPDX-License-Identifier: Apache-2.0
2
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
3
4
5

import sys

6
7
8
SPDX_HEADER = (
    "# SPDX-License-Identifier: Apache-2.0\n"
    "# SPDX-FileCopyrightText: Copyright contributors to the vLLM project")
9
10
11
12
13
14
15
SPDX_HEADER_PREFIX = "# SPDX-License-Identifier:"


def check_spdx_header(file_path):
    with open(file_path, encoding='UTF-8') as file:
        lines = file.readlines()
        if not lines:
16
            # Empty file like __init__.py
17
            return True
18
19
20
21
        for line in lines:
            if line.strip().startswith(SPDX_HEADER_PREFIX):
                return True
    return False
22
23
24
25
26
27


def add_header(file_path):
    with open(file_path, 'r+', encoding='UTF-8') as file:
        lines = file.readlines()
        file.seek(0, 0)
28
29
30
31
32
33
34
        if lines and lines[0].startswith("#!"):
            file.write(lines[0])
            file.write(SPDX_HEADER + '\n')
            file.writelines(lines[1:])
        else:
            file.write(SPDX_HEADER + '\n')
            file.writelines(lines)
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53


def main():
    files_with_missing_header = []
    for file_path in sys.argv[1:]:
        if not check_spdx_header(file_path):
            files_with_missing_header.append(file_path)

    if files_with_missing_header:
        print("The following files are missing the SPDX header:")
        for file_path in files_with_missing_header:
            print(f"  {file_path}")
            add_header(file_path)

    sys.exit(1 if files_with_missing_header else 0)


if __name__ == "__main__":
    main()