Python 命令行参数详解

在实际开发中，很多 Python 脚本是通过命令行运行的。你可以传入若干参数（arguments）来控制程序行为。这就需要 Python 提供的方式去解析这些参数。

Python 提供多种方式处理命令行参数，本文将一一介绍：

• sys.argv
• argparse
• click
• docopt

每种方法附带示例代码+优缺点对比，帮助您根据需求选择最适合的方法。

示例输入

python script.py example.txt -v --limit 20

在这种结构中：

• script.py 是当前执行的脚本；
• example.txt 是传入的文件；
• -v 和 --limit 20 是用于控制程序行为的可选参数。

1. 使用 sys.argv 获取参数（基础篇）

特点：

• Python 内置模块 sys 提供。
• 每一个命令行参数都保存在 sys.argv 这个列表中。
• 简单直接，适合脚本初阶段编写。

示例：

import sys

print("脚本名:", sys.argv[0])
print("所有参数:", sys.argv)

if len(sys.argv) > 1:
    print("第一个参数:", sys.argv[1])

输出示例：

$ python script.py hello world
脚本名: script.py
所有参数: ['script.py', 'hello', 'world']
第一个参数: hello

缺点：

• 无自动帮助功能。
• 不支持 --option value 或短选项 -o。
• 需手动判断和解析参数。

2. 使用 argparse（推荐方式）—— 官方高级接口

特点：

• Python 内置模块，无需安装。
• 自动处理参数类型、默认值、帮助说明。
• 支持可选参数（--verbose）、短参数（-v）、位置参数等。

示例代码：

import argparse

parser = argparse.ArgumentParser(description='一个简单的示例脚本')

# 添加位置参数（必须传）
parser.add_argument("filename", help="需要处理的文件名")

# 添加可选参数
parser.add_argument("--verbose", "-v", action="store_true", help="是否启用详细模式")
parser.add_argument("--limit", type=int, default=10, help="限制输出的条目数（默认10）")

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

print("文件名:", args.filename)
if args.verbose:
    print("详细模式已启用")
print("限制输出:", args.limit)

使用示例：

python script.py example.txt -v --limit 20

输出：

文件名: example.txt
详细模式已启用
限制输出: 20

支持：

• 自动生成 --help 支持。
• 类型检查（如 type=int）。
• 默认值设置。

3. 使用 click（装饰器风格 CLI 工具）

特点：

• 第三方库，需使用 pip install click 安装。
• 支持命名命令、函数绑定命令、子命令。
• 风格类似于 Flask，适合开发功能较完整的 CLI 工具。

示例代码：

import click

@click.command()
@click.argument('filename')
@click.option('--verbose', '-v', is_flag=True, help='启用详细模式')
@click.option('--limit', default=10, help='输出条目数（默认 10）')
def main(filename, verbose, limit):
    """一个用于处理文本文件的 CLI 程序"""
    print(f"文件名: {filename}")
    if verbose:
        print("详细模式已启用")
    print(f"限制输出: {limit}")

if __name__ == "__main__":
    main()

示例运行：

python script.py example.txt -v --limit 30

输出：

文件名: example.txt
详细模式已启用
限制输出: 30

适合场景：

• 构建 CLI 工具（如 flask、docker 风格命令系统）。
• 多命令功能支持（add、commit、push 等）。

4. 使用 docopt（基于文档说明书自动解析）

特点：

• 第三方库，需 pip install docopt。
• 基于 docstring 内容自动解析命令。
• 非常适合与文档格式对齐的脚本。

示例代码：

"""Usage:
  script.py <filename> [--verbose] [--limit=<num>]

Options:
  -h --help     显示帮助
  --verbose     详细模式
  --limit=<num> 限制输出条目数 [default: 10]
"""

from docopt import docopt

if __name__ == "__main__":
    args = docopt(__doc__)
    print(args)

示例运行：

python script.py example.txt --verbose --limit=20

输出：

{
    '<filename>': 'example.txt',
    '--verbose': True,
    '--limit': '20'
}

工具对比一览表

总结建议

拓展练习题

写一个 Python 命令行程序，实现以下功能：

• 必须传入一个文件名；
• 可选参数 --verbose 或 -v，启用输出提示信息；
• 可选参数 --lines N，读取并输出前 N 行；
• 不使用第三方库，基于 argparse 实现。