Python教程：一文了解如何让Python代码变成命令行工具
目录
1.什么是 argparse？
2.基本用法
1. 创建 ArgumentParser 对象
2. 添加参数
3. 解析参数
4. 使用解析后的参数
5.一个简单的用户信息打印工具
5.1示例代码
5.2运行示例
3.高级用法
1. 子命令
2. 互斥参数
3. 自定义类型和动作
4. 嵌套解析器
4.复杂示例：数据库管理工具
CLI，全称为 Command-Line Interface，即命令行界面。它是一种与计算机程序进行交互的方式，用户通过输入命令文本来操作计算机系统或软件。CLI 是与图形用户界面（GUI）相对的一种用户界面形式
CLI 的特点
-
文本为主：CLI 主要通过文本输入和输出进行交互，用户需要输入特定的命令来执行操作。
-
高效：对于熟悉命令的用户来说，CLI 通常比 GUI 更加高效。用户可以通过键盘快捷键和命令组合快速完成复杂的任务。
-
灵活性：CLI 提供了极高的灵活性。用户可以通过组合不同的命令和参数来完成各种自定义任务。
-
资源占用低：与 GUI 相比，CLI 通常占用的系统资源更少，因为它不需要渲染图形界面。
-
脚本化：CLI 命令可以写入脚本文件，实现自动化任务和批处理操作，这在系统管理和开发中非常实用。
在构建命令行工具时，解析传入的命令行参数是一个非常重要的环节。Python的 argparse 库就是为此目的而设计的，它可以轻松地处理命令行参数并生成帮助和使用信息。本文将深入剖析 argparse 库的使用方法，并通过多个具体的示例来展示其强大功能。
1.什么是 argparse？
argparse 是Python的标准库，用于解析命令行参数。它可以让你定义预期的参数，并自动生成帮助信息。通过使用 argparse，你可以轻松地对命令行参数进行解析和验证。
2.基本用法
1. 创建 ArgumentParser 对象
首先，需要创建一个 ArgumentParser 对象。这个对象用于存储参数的相关信息，并负责解析命令行输入。
import argparse
parser = argparse.ArgumentParser(description="这是一个简单的命令行工具示例")
description 参数用于描述这个命令行工具的用途。
2. 添加参数
使用 add_argument 方法来定义命令行工具需要接收的参数。
parser.add_argument('name', help='用户的名字')
parser.add_argument('-a', '--age', type=int, help='用户的年龄')
parser.add_argument('-v', '--verbose', action='store_true', help='是否启用详细输出')
上面的代码定义了三个参数：
name是一个位置参数，表示必须提供的参数。-a或--age是一个可选参数，并且它的值应该是一个整数。-v或--verbose是一个布尔开关，启用了详细输出。
3. 解析参数
调用 parse_args 方法解析命令行参数。
args = parser.parse_args()
4. 使用解析后的参数
解析后的参数可以通过 args 对象来访问。
if args.verbose:
print(f"详细输出: 用户名为 {args.name}，年龄为 {args.age}")
else:
print(f"用户名为 {args.name}")
5.一个简单的用户信息打印工具
接下来，我们将通过一个示例来演示如何使用 argparse 解析命令行参数，并进行相应的处理。
5.1示例代码
import argparse
def main():
# 创建 ArgumentParser 对象
parser = argparse.ArgumentParser(description="用户信息打印工具")
# 添加参数
parser.add_argument('name', help='用户的名字')
parser.add_argument('-a', '--age', type=int, help='用户的年龄')
parser.add_argument('-v', '--verbose', action='store_true', help='是否启用详细输出')
# 解析参数
args = parser.parse_args()
# 使用解析后的参数
if args.verbose:
if args.age:
print(f"详细输出: 用户名为 {args.name}，年龄为 {args.age}")
else:
print(f"详细输出: 用户名为 {args.name}")
else:
print(f"用户名为 {args.name}")
if __name__ == "__main__":
main()
5.2运行示例
保存上述代码到一个文件（例如 user_info.py），然后通过命令行运行：
python user_info.py Alice
输出：
用户名为 Alice
启用详细输出并提供年龄：
python user_info.py Alice -a 30 -v
输出：
详细输出: 用户名为 Alice，年龄为 30
3.高级用法
前面我们已经介绍了 argparse 库的基本用法，并提供了一个简单的示例。然而，在实际开发中，我们常常会遇到更复杂的命令行参数解析需求。本文将进一步探讨 argparse 库的高级功能，并通过一些复杂的示例来展示其强大的灵活性和扩展性。
1. 子命令
在许多命令行工具中，我们经常会看到类似 git commit 或 docker run 这样的子命令。argparse 库通过 add_subparsers 方法支持子命令的定义。
import argparse
def main():
parser = argparse.ArgumentParser(description="高级命令行工具示例")
# 创建子命令解析器
subparsers = parser.add_subparsers(title="子命令", dest="command")
# 定义 'add' 子命令
add_parser = subparsers.add_parser('add', help='添加两个数')
add_parser.add_argument('num1', type=int, help='第一个数')
add_parser.add_argument('num2', type=int, help='第二个数')
# 定义 'subtract' 子命令
subtract_parser = subparsers.add_parser('subtract', help='减去两个数')
subtract_parser.add_argument('num1', type=int, help='第一个数')
subtract_parser.add_argument('num2', type=int, help='第二个数')
args = parser.parse_args()
if args.command == 'add':
print(f"结果: {args.num1 + args.num2}")
elif args.command == 'subtract':
print(f"结果: {args.num1 - args.num2}")
if __name__ == "__main__":
main()
2. 互斥参数
有时候，某些参数是互斥的，不能同时出现。argparse 库通过 add_mutually_exclusive_group 方法来实现这一点。
import argparse
def main():
parser = argparse.ArgumentParser(description="互斥参数示例")
group = parser.add_mutually_exclusive_group()
group.add_argument('-a', action='store_true', help='选项A')
group.add_argument('-b', action='store_true', help='选项B')
args = parser.parse_args()
if args.a:
print("选择了选项A")
elif args.b:
print("选择了选项B")
else:
print("没有选择任何选项")
if __name__ == "__main__":
main()
3. 自定义类型和动作
argparse 库允许你自定义参数的类型和动作。例如，你可以定义一个自定义类型来验证输入。
import argparse
def positive_int(value):
ivalue = int(value)
if ivalue <= 0:
raise argparse.ArgumentTypeError(f"{value} 不是正整数")
return ivalue
def main():
parser = argparse.ArgumentParser(description="自定义类型示例")
parser.add_argument('num', type=positive_int, help='正整数')
args = parser.parse_args()
print(f"输入的正整数是: {args.num}")
if __name__ == "__main__":
main()
4. 嵌套解析器
在更复杂的命令行工具中，你可能需要嵌套的解析器来处理更复杂的参数结构。
import argparse
def main():
parser = argparse.ArgumentParser(description="嵌套解析器示例")
subparsers = parser.add_subparsers(title="子命令", dest="command")
# 定义 'config' 子命令
config_parser = subparsers.add_parser('config', help='配置管理')
config_subparsers = config_parser.add_subparsers(title="配置子命令", dest="config_command")
# 定义 'set' 子命令
set_parser = config_subparsers.add_parser('set', help='设置配置')
set_parser.add_argument('key', help='配置键')
set_parser.add_argument('value', help='配置值')
# 定义 'get' 子命令
get_parser = config_subparsers.add_parser('get', help='获取配置')
get_parser.add_argument('key', help='配置键')
args = parser.parse_args()
if args.command == 'config':
if args.config_command == 'set':
print(f"设置配置: {args.key} = {args.value}")
elif args.config_command == 'get':
print(f"获取配置: {args.key}")
if __name__ == "__main__":
main()
4.复杂示例：数据库管理工具
假设我们正在开发一个数据库管理工具，它支持多种操作，如创建表、插入数据、查询数据等。我们可以使用 argparse 库来处理这些复杂的命令行参数。
import argparse
def main():
parser = argparse.ArgumentParser(description="数据库管理工具")
subparsers = parser.add_subparsers(title="操作", dest="operation")
# 定义 'create' 操作
create_parser = subparsers.add_parser('create', help='创建表')
create_parser.add_argument('table_name', help='表名')
create_parser.add_argument('columns', nargs='+', help='列定义')
# 定义 'insert' 操作
insert_parser = subparsers.add_parser('insert', help='插入数据')
insert_parser.add_argument('table_name', help='表名')
insert_parser.add_argument('values', nargs='+', help='插入的值')
# 定义 'query' 操作
query_parser = subparsers.add_parser('query', help='查询数据')
query_parser.add_argument('table_name', help='表名')
query_parser.add_argument('-c', '--columns', nargs='+', help='查询的列')
args = parser.parse_args()
if args.operation == 'create':
print(f"创建表: {args.table_name}, 列: {args.columns}")
elif args.operation == 'insert':
print(f"插入数据到表: {args.table_name}, 值: {args.values}")
elif args.operation == 'query':
if args.columns:
print(f"查询表: {args.table_name}, 列: {args.columns}")
else:
print(f"查询表: {args.table_name}")
if __name__ == "__main__":
main()
运行示例
保存上述代码到一个文件（例如 db_tool.py），然后通过命令行运行：
python db_tool.py create users id name age
输出：
创建表: users, 列: ['id', 'name', 'age']
插入数据：
python db_tool.py insert users 1 Alice 30
输出：
插入数据到表: users, 值: ['1', 'Alice', '30']
查询数据：
python db_tool.py query users -c id name
输出：
查询表: users, 列: ['id', 'name']