Python命令行参数|极客教程

Python命令行参数

在编写Python程序时，有时需要从命令行传入参数来影响程序的行为。通过命令行参数，我们可以在程序运行时灵活地指定一些选项，从而实现不同的功能。本文将详细介绍Python中命令行参数的使用方法及示例。

sys模块

Python中的sys模块提供了访问与Python解释器关联的变量和功能的访问，其中也包括命令行参数。可以通过sys.argv来获取在命令行中传入的参数列表。

import sys

# 获取命令行参数列表
args = sys.argv

# 打印参数列表
print(args)

运行以上代码并在命令行中输入python example.py arg1 arg2，将会输出['example.py', 'arg1', 'arg2']，其中包含了文件名和传入的两个参数。

argparse模块

虽然可以通过sys.argv来获取命令行参数，但通常情况下我们会使用argparse模块来更加方便地解析命令行参数。argparse模块可以帮助我们定义程序需要的参数以及参数的格式，同时自动生成帮助信息，使得程序更加易于使用。

添加参数

使用argparse模块的步骤1是创建一个ArgumentParser对象，并使用add_argument()方法来添加参数。

import argparse

# 创建ArgumentParser对象
parser = argparse.ArgumentParser(description='An example program with command line arguments')

# 添加参数
parser.add_argument('input', type=str, help='input file path')
parser.add_argument('-o', '--output', type=str, help='output file path')

# 解析命令行参数
args = parser.parse_args()

# 输出参数值
print(args.input)
print(args.output)

在以上代码中，我们定义了两个参数，一个位置参数input和一个可选参数output。通过调用parse_args()方法，可以解析命令行参数，并将参数的值保存在args对象中。

运行示例

假设以上代码保存在example.py文件中，我们可以在命令行中运行该程序：

python example.py path/to/input.txt -o path/to/output.txt

运行结果将会输出输入文件路径和输出文件路径。

添加更多参数

除了基本的参数，argparse还支持添加更多参数选项，如布尔型参数、位置参数等。以下为一个完整示例，包含多种参数类型：

import argparse

# 创建ArgumentParser对象
parser = argparse.ArgumentParser(description='An example program with different types of command line arguments')

# 添加布尔型参数
parser.add_argument('--verbose', action='store_true', help='print verbose output')

# 添加位置参数
parser.add_argument('input', type=str, help='input file path')

# 添加可选参数
parser.add_argument('-o', '--output', type=str, help='output file path')

# 解析命令行参数
args = parser.parse_args()

# 输出参数值
print(args.verbose)
print(args.input)
print(args.output)

在以上示例中，我们添加了一个布尔型参数--verbose，一个位置参数input和一个可选参数output，分别代表是否输出详细信息、输入文件路径和输出文件路径。根据传入的参数不同，程序将会以不同的方式运行。