【Python】使用Python脚本生成文件头注释

一、引言

在大家平常编写代码的过程中，可能会需要生成文件头来说明代码的作者信息、版权、联系方式、编写时间、文件名、使用的软件、代码简单概述等来说明代码文件详情。
此代码会自动化创建符合规范的Python文件头注释

二、详细代码

# -*- coding: utf-8 -*-
# @Time    : 2024/10/05 18:17
# @Author  : 哇咔咔哇咔
# @Email   : [email protected]
# @File    : file_header.py
# @Software: PyCharm
# @Brief   : 将生成文件头注释(元数据)说明文件详情

import datetime
import os


def generate_file_header(author, email, file_name):
    """
    生成文件头注释(元数据)说明文件详情

    :param author: 作者名称
    :param email: 作者邮箱
    :param file_name: 文件名
    :return: 文件头注释(元数据)
    """
    current_time = datetime.datetime.now().strftime("%Y/%m/%d %H:%M")

    header = f"""# -*- coding: utf-8 -*-
# @Time    : {current_time}
# @Author  : {author}
# @Email   : {email}
# @File    : {file_name}
# @Software: PyCharm
# @Brief   : 

"""
    return header


def get_unique_filename(base_name):
    """
    生成唯一文件名

    :param base_name: 基础文件名
    :return: 唯一文件名
    """
    if not os.path.exists(base_name):
        return base_name

    # 如果文件存在，添加后缀直到找到一个可用的文件名
    name, extension = os.path.splitext(base_name)
    counter = 1

    while True:
        new_name = f"{name}_{counter}{extension}"
        if not os.path.exists(new_name):
            return new_name
        counter += 1


if __name__ == "__main__":
    author_name = "哇咔咔哇咔"    # todo: 作者名称按需修改
    author_email = "[email protected]"    # todo: 作者邮箱按需修改
    file_name = "wkkwk.py"    # todo: 文件名按需修改

    # 获取唯一文件名
    unique_file_name = get_unique_filename(file_name)

    file_header = generate_file_header(author_name, author_email, unique_file_name)

    # 保存到文件
    with open(unique_file_name, 'w', encoding='utf-8') as file:
        file.write(file_header)

    print(f"文件头已生成并写入到 {unique_file_name}")

三、运行实例

运行代码文件后将在当前目录下生成一个包含指定文件注释的文件（其中的一些参数可在代码中的TODO位置自行修改）：

文件头已生成并写入到 wkkwk.py

进程已结束,退出代码0