Function modify_file_header

scripts/replace_copyright.py:167–206

(fp, file_header, rest_of_file, preserve_text_store, comment_type)

def modify_file_header(fp, file_header, rest_of_file, preserve_text_store, comment_type):
    header_text = "\n".join(file_header)
    if not (header_text.strip() == "" or header_text in preserve_text_store):
        # Unique header, need to get user input
        print("\n", DELIM, "\n")
        for idx, line in enumerate(file_header):
            print(f"{idx}: {line}")
        print("\n", DELIM, "\n")
        print("\nIndicate the FIRST line of the Header to KEEP")
        print("(shebang #! lines will be automatically processed and should not be included).")
        keep_idx = input("Enter number (or leave blank if no lines should be preserved): ")
        preserve_text_store[header_text] = file_header[int(keep_idx):] if keep_idx != "" else ""

    # Identify any shebang lines in the file
    shebang = "\n".join([l for l in file_header if l.startswith("#!")])
    if shebang != "":
        shebang += "\n"

    # Get the text we should preserve in this file and process to remove comment characters
    text_to_preserve = preserve_text_store.get(header_text, [""])
    text_to_preserve = [remove_comments(l, comment_type) for l in text_to_preserve]

    # Format the text we want to keep into a new multiline comment
    if "".join(text_to_preserve) == "":
        text_to_preserve = ""
    else:
        text_to_preserve = format_multiline_comment(text_to_preserve, comment_type)

    # Generate the copyright text we will be adding
    copyright_text = "\n".join([f"{comment_type[0]} {l}" if l != "" else l for l in NEW_COPYRIGHT])

    # Assemble the new header
    new_header = shebang + copyright_text + text_to_preserve

    # Write out the new file
    new_file_contents = new_header + "\n" + "".join(rest_of_file)
    with open(fp, "w") as f:
        f.write(new_file_contents)

    return preserve_text_store  # Return so we can reuse for future files


def main(args):