成为一名 Python 命令行大师：argparse 入门指南

2024-02-11 01:31:36

踏入 Python 命令行之旅

准备踏上 Python 命令行之旅吧，这是一段令人兴奋的旅程，将带你领略脚本编写和命令行工具构建的无限可能。作为入门篇章，我们将探秘 argparse，一个简洁高效的库，旨在简化命令行参数解析。

argparse：命令行参数解析利器

argparse 库是 Python 的一款强大工具，用于处理命令行参数。它提供了直观简洁的界面，让你轻松解析用户输入的参数，从而构建出用户友好、可扩展的命令行应用程序。

解析命令行参数的艺术

让我们以一个简单的示例开始。假设你有一个名为 greet.py 的 Python 脚本，它接收两个参数：要问候的人名和问候语。使用 argparse，你可以这样解析这些参数：

import argparse

parser = argparse.ArgumentParser(description='Greet someone.')

parser.add_argument('name', help='The name of the person to greet.')
parser.add_argument('greeting', help='The greeting to use.')

args = parser.parse_args()

print(f"Hello, {args.name}! {args.greeting}")

argparse 库提供了 add_argument() 方法来定义每个参数，并指定它们的帮助文本。 parse_args() 方法随后解析命令行参数并将其存储在命名空间对象中。

创建交互式脚本

通过 argparse，你可以创建交互式脚本，提示用户输入参数。这使你能够构建定制化的命令行工具，根据用户的特定需求进行调整。

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('--verbose', action='store_true', help='Enable verbose output.')
parser.add_argument('--file', help='Input file to process.')

args = parser.parse_args()

if args.verbose:
    print('Verbose output enabled.')

if args.file:
    with open(args.file) as f:
        # Process file contents
        pass

在这个示例中，我们定义了两个可选参数：--verbose 和 --file。如果用户提供 --verbose 参数，脚本将启用详细输出；如果提供 --file 参数，脚本将处理指定文件中的内容。

构建更强大的命令行工具

argparse 还允许你定义子命令，从而创建更复杂的分层命令行工具。子命令可用于将大任务分解为更小的模块化单元，从而提高代码的可重用性和可维护性。

import argparse

parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers(help='Sub-commands')

greet_parser = subparsers.add_parser('greet', help='Greet someone.')
greet_parser.add_argument('name', help='The name of the person to greet.')

add_parser = subparsers.add_parser('add', help='Add two numbers.')
add_parser.add_argument('num1', type=int, help='The first number.')
add_parser.add_argument('num2', type=int, help='The second number.')

args = parser.parse_args()

if args.subcommand == 'greet':
    print(f"Hello, {args.name}!")
elif args.subcommand == 'add':
    print(args.num1 + args.num2)