Python 命令行参数|极客笔记

Python 命令行参数

在日常的开发工作中，我们经常需要使用命令行参数来控制程序的行为。Python 提供了一个内建的模块 argparse，可以帮助我们方便地解析命令行参数。本文将详细介绍如何使用 argparse 模块来处理命令行参数，并通过示例代码来展示它的具体用法。

简介

argparse 是一个用于解析命令行参数的模块，可以帮助我们定义程序接受的参数，并解析用户在命令行中输入的参数值。通过使用 argparse，我们可以轻松地处理不同类型的参数，包括位置参数、可选参数、flag 参数等。

安装

argparse 模块是 Python 标准库的一部分，因此无需额外安装即可使用。我们可以直接在 Python 脚本中导入 argparse 模块来开始使用它。

基本用法

下面是一个简单的示例代码，演示了如何使用 argparse 模块来解析命令行参数：

import argparse

parser = argparse.ArgumentParser(description='Process some strings.')

parser.add_argument('string', type=str, help='A string to be processed')

args = parser.parse_args()

print('The input string is:', args.string)

运行上面的代码并输入一个字符串，程序将会打印出输入的字符串。例如，如果我们输入命令 python script.py deepinout.com，输出将会是：

The input string is: deepinout.com

在这个示例中，我们定义了一个位置参数 string，用户输入的值会被保存在 args.string 中，并用于后续的处理。

参数类型

argparse 模块支持多种参数类型，包括字符串、整数、浮点数等。我们可以通过指定 type 参数来设定参数的类型。下面是一个示例代码，演示了如何定义一个整数类型的参数：

import argparse

parser = argparse.ArgumentParser(description='Calculate the square of a number.')

parser.add_argument('number', type=int, help='An integer number to be squared')

args = parser.parse_args()

result = args.number ** 2

print('The square of the input number is:', result)

运行上面的代码并输入一个整数，程序将会计算出该整数的平方值。例如，如果我们输入命令 python script.py 5，输出将会是：

The square of the input number is: 25

可选参数

除了位置参数外，我们还可以定义可选参数。可选参数通常用于控制程序的行为或提供默认值。下面是一个示例代码，演示了如何定义一个可选参数：

import argparse

parser = argparse.ArgumentParser(description='Greet the user.')

parser.add_argument('--name', type=str, default='Guest', help='The name of the user')

args = parser.parse_args()

print('Hello,', args.name, '!')

运行上面的代码可以看到，如果我们不指定 --name 参数，则程序会使用默认值 Guest 来打印问候语。例如，如果我们输入命令 python script.py --name Alice，输出将会是：

Hello, Alice !

Flag 参数

有时候我们可能需要定义一种开关式的参数，即只需要指定参数名称而无需为其指定值。这种类型的参数被称为 flag 参数。下面是一个示例代码，演示了如何定义一个 flag 参数：

import argparse

parser = argparse.ArgumentParser(description='Enable or disable verbose mode.')

parser.add_argument('--verbose', action='store_true', help='Enable verbose mode')

args = parser.parse_args()

if args.verbose:
    print('Verbose mode enabled.')
else:
    print('Verbose mode disabled.')

运行上面的代码并添加 --verbose 参数，程序将会打印出 Verbose mode enabled. 消息。如果不指定 --verbose 参数，则将会打印出 Verbose mode disabled. 消息。

综合示例

下面是一个综合示例代码，演示了如何使用 argparse 模块来解析多个参数，并实现一个简单的命令行程序：

import argparse

parser = argparse.ArgumentParser(description='Generate a personalized greeting.')

parser.add_argument('--name', type=str, default='Guest', help='The name of the user')
parser.add_argument('--greeting', type=str, default='Hello', help='The greeting message')

args = parser.parse_args()

print(args.greeting + ',', args.name + '!')

运行上面的代码并指定不同的参数值，可以生成不同的个性化问候语。例如，如果我们输入命令 python script.py --name Alice --greeting Hi, 输出将会是：