首页 › Python 实用脚本 › argparse:命令行工具

argparse:命令行工具

给脚本加上命令行参数,同一个脚本就能处理不同的输入,用起来像正式的命令行工具。

基本用法

# wc.py —— 统计文件的行数、单词数和字符数
import argparse
from pathlib import Path

parser = argparse.ArgumentParser(description="统计文本文件信息")
parser.add_argument("files", nargs="+", help="要统计的文件")
parser.add_argument("-l", "--lines", action="store_true", help="只显示行数")
parser.add_argument("-e", "--encoding", default="utf-8", help="文件编码,默认 utf-8")
args = parser.parse_args()

for name in args.files:
    text = Path(name).read_text(encoding=args.encoding)
    lines = text.count("\n")
    if args.lines:
        print(f"{lines:>8} {name}")
    else:
        print(f"{lines:>8}{len(text.split()):>8}{len(text):>8} {name}")
$ python wc.py notes.txt readme.md
$ python wc.py -l *.py
$ python wc.py --help
usage: wc.py [-h] [-l] [-e ENCODING] files [files ...]

统计文本文件信息
...

--help 的说明是 argparse 根据参数定义自动生成的。

常用参数类型

parser.add_argument("--count", type=int, default=10)                 # 整数
parser.add_argument("--mode", choices=["fast", "safe"], default="safe")  # 限定取值
parser.add_argument("--tag", action="append")                        # 可重复:--tag a --tag b
parser.add_argument("-v", "--verbose", action="count", default=0)    # -vvv 计数

子命令

像 git add、git commit 这样的子命令可以用 add_subparsers 实现:

import argparse

def cmd_add(args):
    print("添加任务:", args.title)

def cmd_list(args):
    print("列出任务,只看未完成:", args.todo)

parser = argparse.ArgumentParser(prog="todo")
sub = parser.add_subparsers(dest="command", required=True)

p_add = sub.add_parser("add", help="添加任务")
p_add.add_argument("title")
p_add.set_defaults(func=cmd_add)

p_list = sub.add_parser("list", help="列出任务")
p_list.add_argument("--todo", action="store_true")
p_list.set_defaults(func=cmd_list)

args = parser.parse_args()
args.func(args)
$ python todo.py add "写周报"
$ python todo.py list --todo

打包成命令

在 pyproject.toml 中声明入口,安装后就能在任何目录直接运行:

[project.scripts]
mywc = "mytools.wc:main"
$ pip install -e .
$ mywc notes.txt

练习题

学完本节后,试着独立完成下面的练习,再展开参考答案对照。

练习 1 编写命令行工具 greet.py:位置参数 name,可选参数 --times(默认 1)指定重复次数。

查看参考答案
import argparse

parser = argparse.ArgumentParser(description="打招呼")
parser.add_argument("name")
parser.add_argument("--times", type=int, default=1)
args = parser.parse_args(["小明", "--times", "2"])   # 实际使用时去掉参数列表
for _ in range(args.times):
    print(f"你好,{args.name}!")
参考输出:
你好,小明!
你好,小明!