Python add_argument详解|极客教程

Python add_argument详解

1. 什么是add_argument

add_argument是argparse库中的一个方法，主要用于解析命令行参数。我们在编写Python脚本时，有时需要从命令行接收输入参数，add_argument就是帮助我们实现这个功能的方法。

2. add_argument的基本用法

前往前，我们必须先导入argparse库。

import argparse

然后，我们需要创建一个ArgumentParser对象，它将帮助我们处理命令行参数。

parser = argparse.ArgumentParser()

接下来，我们可以开始定义我们需要的参数了，使用add_argument方法。

parser.add_argument("-n", "--name", help="Your name")

在上例中，我们定义了一个名为”name”的参数，使用了两个选项标志，”-n”和”–name”。help参数则是一个可选的帮助信息，用于命令行中显示帮助信息。

最后，我们需要调用parse_args方法，来解析命令行参数。

args = parser.parse_args()

当我们运行脚本并且传入参数时，parse_args方法将返回一个对象，它保存了我们定义的参数。

$ python script.py -n Alice

args.name  # 'Alice'

3. add_argument的常用选项

add_argument方法有很多选项，用于配置参数的行为和值的类型。以下是几个常用选项的示例：

3.1. type

type选项用于设置参数的值的类型。默认情况下，参数的值都是字符串类型。我们可以使用type选项来指定其他类型，如整数或布尔值。

parser.add_argument("-n", "--num", type=int, help="An integer")

$ python script.py -n 42

args.num  # 42, 类型为int

3.2. default

default选项指定了参数的默认值。如果用户没有在命令行中提供参数，则使用默认值。

parser.add_argument("-n", "--name", default="John", help="Your name")

$ python script.py

args.name  # 'John'

3.3. choices

choices选项用于限制参数的取值范围。当用户提供的参数不在choices列表中时，将会报错。

parser.add_argument("-f", "--fruit", choices=["apple", "banana", "orange"], help="Your favorite fruit")

$ python script.py -f pear

# 错误信息：error: argument -f/--fruit: invalid choice: 'pear' (choose from 'apple', 'banana', 'orange')

3.4. nargs

nargs选项用于指定参数接受的值的数量。

parser.add_argument("-l", "--list", nargs="+", help="A list of values")

$ python script.py -l 1 2 3

args.list  # ['1', '2', '3']

3.5. action

action选项用于指定参数的处理方式。常用的选项有”store”、”store_true”、”store_false”和”append”。

parser.add_argument("-v", "--verbose", action="store_true", help="Increase verbosity")

$ python script.py -v

args.verbose  # True

4. 完整示例

接下来，我们将结合以上内容给出一个完整的示例。

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("-n", "--name", help="Your name")
parser.add_argument("-a", "--age", type=int, default=18, help="Your age")
parser.add_argument("-g", "--gender", choices=["male", "female"], default="male", help="Your gender")
parser.add_argument("-l", "--list", nargs="+", help="A list of values")
parser.add_argument("--verbose", action="store_true", help="Increase verbosity")

args = parser.parse_args()

print("Name:", args.name)
print("Age:", args.age)
print("Gender:", args.gender)
print("List:", args.list)
print("Verbose:", args.verbose)

$ python script.py -n Alice -a 25 -g female -l 1 2 3 --verbose

Name: Alice
Age: 25
Gender: female
List: ['1', '2', '3']
Verbose: True

以上便是使用add_argument方法解析命令行参数的基本用法及常用选项的详细说明。add_argument方法是argparse库中非常重要和常用的方法之一，可以帮助我们编写更加灵活的命令行工具。

Python add_argument详解