如何为python代码传递命令行参数

如何为Python代码传递命令行参数：使用sys.argv、argparse模块、获取参数值。在Python中，传递命令行参数可以通过内置的sys.argv列表以及argparse模块来实现。sys.argv列表包含了命令行参数的字符串表示，argparse模块则提供了更高级的参数解析功能。使用argparse模块可以处理复杂的命令行参数传递，如类型转换、默认值、帮助信息等。

一、使用sys.argv传递命令行参数

sys.argv是一个列表，其中包含了命令行参数。列表的第一个元素是脚本名称，后续元素是传递的参数值。

import sys
def main():
    if len(sys.argv) < 2:
        print("Usage: python script.py <arg1> <arg2> ...")
        sys.exit(1)
    for i, arg in enumerate(sys.argv):
        print(f"Argument {i}: {arg}")
if __name__ == "__main__":
    main()

上面的代码中，我们首先检查传递的参数数量是否满足要求。然后，使用一个循环遍历并打印所有传递的参数。

使用示例

假设我们的脚本名称为script.py，命令行执行如下：

python script.py arg1 arg2 arg3

输出如下：

Argument 0: script.py Argument 1: arg1 Argument 2: arg2 Argument 3: arg3

二、使用argparse模块传递命令行参数

argparse模块提供了更为强大的命令行参数解析功能，支持类型转换、默认值、帮助信息等。使用argparse模块可以使得参数解析更加灵活和易用。

基本用法

import argparse
def main():
    parser = argparse.ArgumentParser(description="A simple argument parser example.")
    parser.add_argument("arg1", type=str, help="The first argument.")
    parser.add_argument("arg2", type=int, help="The second argument.")
    parser.add_argument("--optional", type=float, default=1.0, help="An optional argument with a default value.")
    args = parser.parse_args()
    print(f"arg1: {args.arg1}")
    print(f"arg2: {args.arg2}")
    print(f"optional: {args.optional}")
if __name__ == "__main__":
    main()

参数解析

在上面的代码中，我们定义了三个参数：arg1、arg2和optional。arg1和arg2是必需的参数，optional是一个可选参数，具有默认值1.0。通过调用parser.parse_args()方法来解析命令行参数，并将结果存储在args对象中。

使用示例

假设我们的脚本名称为script.py，命令行执行如下：

python script.py hello 42 --optional 3.14

输出如下：

arg1: hello arg2: 42 optional: 3.14

如果不提供可选参数，则会使用默认值：

python script.py hello 42

输出如下：

arg1: hello arg2: 42 optional: 1.0

三、处理复杂的命令行参数

argparse模块还支持处理更加复杂的命令行参数，包括互斥选项、子命令、多值参数等。

互斥选项

互斥选项用于确保命令行参数中只能出现一个选项。可以使用argparse.ArgumentParser的add_mutually_exclusive_group方法来定义互斥选项。

import argparse
def main():
    parser = argparse.ArgumentParser(description="A simple argument parser example.")
    group = parser.add_mutually_exclusive_group(required=True)
    group.add_argument("--foo", action="store_true", help="Enable foo.")
    group.add_argument("--bar", action="store_true", help="Enable bar.")
    args = parser.parse_args()
    if args.foo:
        print("Foo is enabled.")
    elif args.bar:
        print("Bar is enabled.")
if __name__ == "__main__":
    main()

在这个示例中，我们定义了两个互斥选项–foo和–bar，命令行中只能选择其中一个。

使用示例

python script.py --foo

输出如下：

Foo is enabled.

python script.py --bar

输出如下：

Bar is enabled.

如果同时指定了两个选项，则会报错：

python script.py --foo --bar

输出如下：

usage: script.py [-h] (--foo | --bar)
script.py: error: argument --bar: not allowed with argument --foo

子命令

子命令用于实现类似于git这样的命令行工具，其中不同的子命令具有不同的功能。可以使用argparse.ArgumentParser的add_subparsers方法来定义子命令。

import argparse
def foo(args):
    print("Foo command executed.")
def bar(args):
    print("Bar command executed.")
def main():
    parser = argparse.ArgumentParser(description="A simple argument parser example.")
    subparsers = parser.add_subparsers(title="subcommands", description="Available subcommands", help="Subcommand help")
    parser_foo = subparsers.add_parser("foo", help="Execute foo command.")
    parser_foo.set_defaults(func=foo)
    parser_bar = subparsers.add_parser("bar", help="Execute bar command.")
    parser_bar.set_defaults(func=bar)
    args = parser.parse_args()
    args.func(args)
if __name__ == "__main__":
    main()

在这个示例中，我们定义了两个子命令foo和bar，并且为每个子命令指定了一个处理函数。

使用示例

python script.py foo

输出如下：

Foo command executed.

python script.py bar

输出如下：

Bar command executed.

多值参数

多值参数用于接受多个值，可以使用nargs参数来指定接受值的数量或类型。

import argparse
def main():
    parser = argparse.ArgumentParser(description="A simple argument parser example.")
    parser.add_argument("--list", nargs="+", type=int, help="A list of integers.")
    args = parser.parse_args()
    if args.list:
        print(f"List: {args.list}")
if __name__ == "__main__":
    main()

在这个示例中，我们定义了一个多值参数–list，接受一个整数列表。

使用示例

python script.py --list 1 2 3 4 5

输出如下：

List: [1, 2, 3, 4, 5]

四、总结

在Python中，传递命令行参数可以通过sys.argv列表和argparse模块实现。sys.argv适用于简单的参数传递，而argparse模块则提供了更为强大的参数解析功能，包括类型转换、默认值、帮助信息、互斥选项、子命令、多值参数等。在实际开发中，推荐使用argparse模块来处理命令行参数，以便实现更加灵活和易用的参数解析。