Python实现自动添加脚本头信息的示例代码

下面是Python实现自动添加脚本头信息的完整攻略：

1. 确定脚本头信息格式

在编写自动添加脚本头信息的代码前，需要先确定脚本头信息的格式。一般来说，脚本头信息应包含以下内容：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @Author: yourname
# @Date:   2021-07-01 20:09:53
# @Last Modified by:   yourname
# @Last Modified time: 2021-07-01 20:10:21

其中第一行为Shebang，指定了解析器的路径；第二行指定了文件编码；接下来的几行为作者和修改时间等信息，可以根据实际需要增加或修改。

2. 定义自动添加脚本头信息的函数

定义一个函数，通过读取脚本文件的第一行来判断是否已经添加了脚本头信息，若已经添加，则直接返回；否则，在脚本文件的第一行添加脚本头信息。

def add_script_header(script_path):
    """
    自动添加脚本头信息
    :param script_path: 脚本文件路径
    """
    header = '''#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @Author: yourname
# @Date:   2021-07-01 20:09:53
# @Last Modified by:   yourname
# @Last Modified time: 2021-07-01 20:10:21\n'''

    with open(script_path, 'r+') as f:
        first_line = f.readline()
        if first_line.strip() == '#!/usr/bin/env python':
            return
        content = f.read()
        f.seek(0, 0)
        f.write(header + content)

上述代码中，首先读取文件的第一行，判断是否已经添加了脚本头信息，若已经添加，则直接返回。否则，读取文件的其他内容，将新的脚本头信息与文件的其他内容一起写入文件。

3. 使用自动添加脚本头信息的函数

使用上述函数可以轻松地实现批量添加脚本头信息的操作。比如，在一个目录下包含多个Python脚本文件，可以使用以下代码来批量添加脚本头信息：

import os

dir_path = '/path/to/scripts'

for file_name in os.listdir(dir_path):
    script_path = os.path.join(dir_path, file_name)
    if script_path.endswith('.py'):
        add_script_header(script_path)

这段代码遍历了目录中的所有文件，如果文件名以“.py”结尾，就调用定义好的add_script_header函数添加脚本头信息。

示例说明

示例一

为了演示自动添加脚本头信息的功能，我们假设有一个Python脚本文件test.py，它的第一行并没有包含脚本头信息。我们在该文件的同级目录下创建一个名为add_header.py的Python脚本，代码内容如下所示：

def add_script_header(script_path):
    """
    自动添加脚本头信息
    :param script_path: 脚本文件路径
    """
    header = '''#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @Author: yourname
# @Date:   2021-07-01 20:09:53
# @Last Modified by:   yourname
# @Last Modified time: 2021-07-01 20:10:21\n'''

    with open(script_path, 'r+') as f:
        first_line = f.readline()
        if first_line.strip() == '#!/usr/bin/env python':
            return
        content = f.read()
        f.seek(0, 0)
        f.write(header + content)

if __name__ == '__main__':
    add_script_header('test.py')

运行add_header.py脚本之后，再次打开test.py文件，发现它的第一行已经包含了脚本头信息。

示例二

假设我们有一个Python脚本文件夹，里面包含多个Python脚本文件，我们需要将它们的第一行都添加上相同的脚本头信息。我们需要完成以下操作：

1. 新建一个名为add_header.py的Python脚本，代码如下：

import os


def add_script_header(script_path):
    """
    自动添加脚本头信息
    :param script_path: 脚本文件路径
    """
    header = '''#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @Author: yourname
# @Date:   2021-07-01 20:09:53
# @Last Modified by:   yourname
# @Last Modified time: 2021-07-01 20:10:21\n'''

    with open(script_path, 'r+') as f:
        first_line = f.readline()
        if first_line.strip() == '#!/usr/bin/env python':
            return
        content = f.read()
        f.seek(0, 0)
        f.write(header + content)


if __name__ == '__main__':
    dir_path = '/path/to/scripts'
    for file_name in os.listdir(dir_path):
        script_path = os.path.join(dir_path, file_name)
        if script_path.endswith('.py'):
            add_script_header(script_path)

1. 将代码中的dir_path修改为Python脚本所在文件夹的路径。
2. 运行add_header.py脚本，即可将Python脚本文件夹中所有的Python脚本文件的第一行都添加上相同的脚本头信息。

通过上述操作，我们就可以快速地实现批量添加脚本头信息的操作。