Python 命令行界面 | Argparse 模块

介绍

Python 命令行界面（CLI）是一种通过在终端或命令提示符中输入命令来与计算机程序交互的方式。它允许用户执行程序并向其传递参数，同时以文本形式接收程序的输出。命令行界面对于自动化任务、运行脚本以及执行图形用户界面（GUI）难以实现或无法实现的复杂操作特别有用。

在本实验中，我们将学习如何使用 argparse 模块为 Python 程序创建命令行界面。我们将从简单的示例开始，逐步深入到更复杂的场景。通过本实验，你将深入理解如何利用 argparse 模块为 Python 程序构建强大的命令行交互功能。

成就

argparse 模块
Python 脚本

导入 Argparse 模块

使用 argparse 模块的第一步是导入它。

你需要创建一个包含代码的 Python 文件。

touch my_program.py

我们可以通过在 Python 脚本的开头添加以下代码行来实现：

import argparse

创建解析器对象

导入 argparse 模块后，我们可以通过调用 ArgumentParser() 函数来创建一个解析器对象。该函数接受几个可选参数，但目前我们只需为程序提供一个简单的描述。

parser = argparse.ArgumentParser(description="一个简单的命令行界面。")

添加参数

现在我们有了解析器对象，可以开始向其中添加参数了。我们可以添加多种类型的参数，例如位置参数和可选参数。例如，我们可以像这样添加一个位置参数：

parser.add_argument("name", help="你的名字")

以及像这样添加一个可选参数：

parser.add_argument("-n", "--number", help="消息重复的次数", type=int, default=1)

解析参数

添加完所有参数后，我们可以通过调用解析器对象的 parse_args() 函数来解析它们。该函数不接受任何参数，并返回一个包含所有参数值的对象。

args = parser.parse_args()

使用参数

现在我们已经解析了参数，可以在程序中使用它们了。例如，我们可以像这样使用 name 参数：

print("Hello, " + args.name)

可选参数的使用方式如下：

print("Hello, " + args.name * args.number)

完整代码

以下是包含上述所有步骤的完整实验代码：

import argparse

## 创建解析器对象
parser = argparse.ArgumentParser(description="一个简单的命令行界面。")

## 添加参数
parser.add_argument("name", help="你的名字")
parser.add_argument("-n", "--number", help="消息重复的次数", type=int, default=1)

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

## 使用参数
print("Hello, " + args.name * args.number)

你可以通过在命令行中导航到文件所在的目录，并输入 python my_program.py 后跟要传递给脚本的参数来运行该脚本：

python my_program.py "John" --number 3

这将在控制台输出 "Hello, JohnJohnJohn"。

总结

在本实验中，我们学习了如何使用 argparse 模块为 Python 程序创建命令行界面。我们了解了如何导入 argparse 模块、创建解析器对象、向解析器添加参数、解析参数以及在程序中使用它们。掌握这些知识后，你将能够为你的 Python 程序构建强大的命令行界面。

构建 Python 命令行程序

介绍

成就