Python 命令行输入参数详解|极客笔记

Python 命令行输入参数详解

在编写 Python 脚本时，经常需要从命令行中接收用户输入的参数。这些参数可以让我们在运行脚本时灵活地传入不同的数值或设置，从而增强脚本的功能性和通用性。本文将深入探讨如何在 Python 中处理命令行输入参数。

sys 模块

在 Python 中，可以使用 sys 模块来访问命令行参数。该模块提供了 sys.argv 这个列表，其中包含了命令行参数的值。sys.argv[0] 是脚本的文件名，而 sys.argv[1:] 则包含了用户传入的参数。我们可以通过引入 sys 模块并访问 sys.argv 来获取命令行参数。

示例代码如下：

import sys

# 输出脚本的文件名
print("脚本文件名:", sys.argv[0])

# 输出传入的参数
print("传入的参数:", sys.argv[1:])

假设我们将上述代码保存为 args_demo.py，并在命令行中执行以下命令：

python args_demo.py hello world 123

运行结果将是：

脚本文件名: args_demo.py
传入的参数: ['hello', 'world', '123']

argparse 模块

虽然 sys.argv 可以帮助我们获取命令行参数，但在实际开发中，通常会使用更方便的 argparse 模块来解析命令行参数。argparse 模块允许我们定义参数的类型、默认值、帮助信息等，让命令行参数处理更加简单和易读。

下面是一个使用 argparse 模块的示例代码：

import argparse

# 创建 ArgumentParser 对象
parser = argparse.ArgumentParser(description='一个简单的命令行参数示例')

# 添加位置参数
parser.add_argument('name', type=str, help='你的名字')
parser.add_argument('age', type=int, help='你的年龄')

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

# 输出解析得到的参数
print('你好，我叫{}，今年{}岁。'.format(args.name, args.age))

在上述代码中，我们首先创建了一个 ArgumentParser 对象，并使用 add_argument 方法添加了两个位置参数：name 和 age。然后，通过 parse_args() 方法解析命令行参数，并使用得到的参数值打印了一条问候语。

假设我们将上述代码保存为 argparse_demo.py，并在命令行中执行以下命令：

python argparse_demo.py Alice 25

运行结果将是：

你好，我叫Alice，今年25岁。

除了位置参数，argparse 还支持可选参数、互斥参数、子命令等功能，使得命令行参数处理更加灵活和强大。

环境变量

除了命令行参数，Python 脚本还可以从环境变量中读取需要的配置信息。通过 os 模块中的 environ 字典，我们可以轻松地访问当前系统的环境变量。

示例代码如下：

import os

# 获取环境变量中的 HOME 值
home_dir = os.environ.get('HOME')

print('当前用户的 HOME 目录是:', home_dir)

在上述代码中，我们使用 os.environ.get('HOME') 来获取系统环境变量中 HOME 的值，并将其打印出来。

Click 模块

除了 argparse 外，还有一个流行的命令行参数解析库是 Click。Click 是一个简单而强大的 Python 模块，用来创建命令行接口。它提供了声明式的方式定义命令和参数，让命令行编程变得更加方便和优雅。

下面是一个使用 Click 模块的示例代码：

import click

@click.command()
@click.option('--name', prompt='请输入你的名字', help='你的名字')
@click.option('--age', prompt='请输入你的年龄', help='你的年龄', type=int)
def greet(name, age):
    click.echo(f'你好，我叫{name}，今年{age}岁。')

if __name__ == '__main__':
    greet()

在上述代码中，我们使用 @click.command() 装饰器定义了一个命令行接口，并通过 @click.option() 装饰器添加了两个选项：name 和 age。启动该脚本后，会依次提示用户输入名字和年龄，并输出一条问候语。

假设我们将上述代码保存为 click_demo.py，并在命令行中执行该脚本，运行结果将如下所示：

$ python click_demo.py
请输入你的名字: Alice
请输入你的年龄: 30
你好，我叫Alice，今年30岁。

通过 Click 模块，我们可以轻松定义出清晰明了的命令行接口，提供更优秀的用户体验。

总结

本文详细介绍了在 Python 中处理命令行输入参数的方法，从原生的 sys 模块到功能强大的 argparse、Click 模块，每一种方式都有其独特的使用场景和优势。开发者可以根据项目需求选择适合的方式来处理命令行参数，让 Python 脚本更加灵活和易用。

Python 命令行输入参数详解