Python脚本传参 -h --help

发布于:2024-04-20 ⋅ 阅读:(15) ⋅ 点赞:(0)

弄清脚本传参,你就不用纠结那么多让你困扰的 - 或 – 参数了,你也可以在你的脚本中写一些让别人一头雾水的 – 参数了。

命名变量传参

如果你想要在传递参数时给它们命名,以便在Python脚本中更容易地识别和使用这些参数,你通常会使用命令行解析库,比如argparseargparse库允许你定义参数的名称、类型、是否必需等,并提供了友好的帮助信息。

下面是一个使用argparse的示例,该示例允许你通过命令行传递命名参数:

script.py

import argparse

def main():
    parser = argparse.ArgumentParser(description='Process some integers.')
    parser.add_argument('--name', type=str, help='Your name')
    parser.add_argument('--age', type=int, help='Your age')
    args = parser.parse_args()

    print(f"Name: {args.name}")
    print(f"Age: {args.age}")

if __name__ == '__main__':
    main()

在Bash中,你可以这样运行这个脚本并传递命名参数:

python script.py --name John --age 30

输出将会是:

Name: John
Age: 30

如果你想要一个更简洁的方式来处理没有命名参数的简单情况,你仍然可以使用sys.argv,但是你可以通过约定来指定参数的顺序或格式。例如,你可以约定第一个参数是名字,第二个参数是年龄:

script.py (使用sys.argv和约定)

import sys

def main():
    if len(sys.argv) < 3:
        print("Usage: python script.py <name> <age>")
        sys.exit(1)

    name = sys.argv[1]
    age = sys.argv[2]

    print(f"Name: {name}")
    print(f"Age: {age}")

if __name__ == '__main__':
    main()

然后在Bash中运行:

python script.py John 30

输出同样是:

Name: John
Age: 30

请注意,使用sys.argv时,所有的参数都是字符串类型,如果需要其他类型(如整数或浮点数),你需要手动进行转换。而在使用argparse时,参数的类型会在解析时自动转换。

文件传参

如果您想通过命令行参数传入文件,您可以使用 argparse 库的 type=argparse.FileType 功能来自动打开文件。这样,您就不需要手动打开文件了,argparse 会为您处理。

下面是一个示例,展示了如何修改您的代码以接受一个文件作为参数,并读取该文件的内容:

import argparse

def main():
    parser = argparse.ArgumentParser(description='Process a file.')

    # 使用 argparse.FileType('r') 来自动打开文件以进行读取
    parser.add_argument('--file', type=argparse.FileType('r'), help='Path to the file you want to read')
    parser.add_argument('--name', type=str, help='Your name')
    parser.add_argument('--age', type=int, help='Your age')

    args = parser.parse_args()

    # 由于我们使用了 argparse.FileType,args.file 现在是一个打开的文件对象
    file_content = args.file.read()  # 读取文件内容
    args.file.close()  # 关闭文件,尽管在脚本结束时它通常会自动关闭,但显式关闭是一个好习惯

    print(f"Name: {args.name}")
    print(f"Age: {args.age}")
    print(f"File content:\n{file_content}")

if __name__ == '__main__':
    main()

当您运行这个脚本并传入一个文件时,您应该这样做:

python your_script.py --name "John Doe" --age 30 --file path_to_your_file.txt

这里的 path_to_your_file.txt 是您想要读取的文件的路径。argparse 会打开这个文件,并且 args.file 将是一个打开的文件对象,您可以直接从中读取内容。注意,如果文件不存在或者没有读取权限,argparse 会抛出异常。

注意:当您使用 argparse.FileType 时,argparse 会在解析完参数后立即打开文件,这意味着如果您需要额外的错误处理或者不想立即读取文件,那么可能需要采用不同的策略,例如仅接收文件路径作为字符串,然后在需要的时候手动打开文件。

配置文件传参config(.ini、yaml)

处理配置文件(通常是以某种格式存储的键值对或结构化数据的文件,如INI、YAML、JSON等)通常不是通过命令行参数直接传递文件内容来完成的。相反,您会传递配置文件的路径作为命令行参数,然后在您的脚本中读取和处理该文件。

以下是一个示例,展示如何使用 argparse 来接受一个配置文件路径,并使用Python的内置库来读取INI格式的配置文件:

import argparse
import configparser

def main():
    parser = argparse.ArgumentParser(description='Process a configuration file.')
    parser.add_argument('--config', type=str, help='Path to the configuration file')
    args = parser.parse_args()

    # 使用configparser读取INI格式的配置文件
    config = configparser.ConfigParser()
    config.read(args.config)

    # 读取具体的配置项
    name = config.get('DEFAULT', 'name')
    age = config.getint('DEFAULT', 'age')

    # 打印读取到的配置信息
    print(f"Name: {name}")
    print(f"Age: {age}")

if __name__ == '__main__':
    main()

在这个例子中,假设您的配置文件(比如config.ini)看起来像这样:

[DEFAULT]
name = John Doe
age = 30

当您运行脚本时,您需要传递配置文件的路径:

python your_script.py --config path_to_your_config.ini

configparser 会读取这个文件,并允许您通过 get 方法(以及针对特定数据类型的 getint, getfloat, getboolean 等方法)来访问配置中的值。

如果您的配置文件是YAML或JSON格式,您可以使用 PyYAMLjson 库来解析它们。这些库提供了类似的方法来读取和处理配置文件。

请确保您已经安装了必要的库(如 PyYAML),如果需要的话,可以使用 pip 来安装它们:

pip install pyyaml

然后,您可以根据配置文件的格式选择适当的解析方法。例如,对于YAML配置文件,您可以这样做:

import argparse
import yaml

def main():
    parser = argparse.ArgumentParser(description='Process a YAML configuration file.')
    parser.add_argument('--config', type=str, help='Path to the YAML configuration file')
    args = parser.parse_args()

    # 使用yaml库读取YAML格式的配置文件
    with open(args.config, 'r') as file:
        config = yaml.safe_load(file)

    # 读取具体的配置项
    name = config['name']
    age = config['age']

    # 打印读取到的配置信息
    print(f"Name: {name}")
    print(f"Age: {age}")

if __name__ == '__main__':
    main()

确保您的YAML配置文件(比如config.yaml)格式正确:

name: John Doe
age: 30

然后,您可以通过命令行传递YAML配置文件的路径来运行脚本:

python your_script.py --config path_to_your_config.yaml