azureml-assets/scripts/validation/copyright_validation.py

# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.

"""Ensure copyright header is at the top of Python scripts."""

import argparse
import sys
from pathlib import Path
from typing import List

COPYRIGHT = [
    "# Copyright (c) Microsoft Corporation.",
    "# Licensed under the MIT License."
]
COPYRIGHT_SET = set(COPYRIGHT)
HEADER_SIZE = 5


def _test(testpaths: List[Path], excludes: List[Path] = []) -> bool:
    badfiles = []
    for testpath in testpaths:
        for file in testpath.rglob("*.py"):
            # Skip ignored files
            if any([p in excludes for p in file.parents]):
                continue

            # Ignore zero-length files
            if file.stat().st_size == 0:
                continue

            with open(file, encoding="utf8") as f:
                # Read top HEADER_SIZE lines of file
                header = []
                for _ in range(0, HEADER_SIZE):
                    line = f.readline()
                    if not line:
                        # Handle EOF
                        break
                    header.append(line.rstrip())

                # Check for copyright header
                if not COPYRIGHT_SET <= set(header):
                    badfiles.append(file)

    if len(badfiles) > 0:
        print("File(s) missing copyright header:")
        for line in badfiles:
            print(line)
        return False
    return True


if __name__ == '__main__':
    # Handle command-line args
    parser = argparse.ArgumentParser()
    parser.add_argument("-i", "--input-directories", required=True, type=Path, nargs='+',
                        help="Directories to validate")
    parser.add_argument("-e", "--excludes", default=[], type=Path, nargs='+',
                        help="Directories to exclude")
    args = parser.parse_args()

    success = _test(args.input_directories, args.excludes)

    if not success:
        sys.exit(1)