File: check_file_header.py

package info (click to toggle)
python-playwright 1.55.0%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,728 kB
  • sloc: python: 53,655; javascript: 383; sh: 216; makefile: 6
file content (70 lines) | stat: -rwxr-xr-x 2,210 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
#!/usr/bin/env python
# Copyright (c) Microsoft Corporation.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import sys
from pathlib import Path
from typing import List

LICENSE_HEADER = """
# Copyright (c) Microsoft Corporation.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
""".strip()


def file_has_license(file_path: str) -> None:
    path = Path(file_path)
    if not path.name.endswith(".py"):
        return
    if not path.exists():
        raise Exception(f"File {file_path} does not exist")
    content = path.read_text(encoding="utf-8")
    if content.strip() == "":
        return
    if content.startswith("#!"):
        # flake8: noqa: E203
        content = content[content.find("\n") + 1 :]
    if not content.startswith(LICENSE_HEADER):
        raise Exception(f"File {file_path} does not have license header")


def main() -> None:
    errors: List[str] = []

    for file_path in sys.argv[1:]:
        try:
            file_has_license(file_path)
        except Exception as e:
            errors.append(str(e))

    if errors:
        print("Missing license header in files:")
        for error in errors:
            print("  -", error)
        sys.exit(1)


if __name__ == "__main__":
    main()