argparse 的基本用法,会创建 parser 和子命令用前 5 天学的知识,写一个完整的命令行 Todo 任务管理器。这是你第一个真正的 Python 项目。
// Node.js CLI 工具
// npm install commander
const { program } = require('commander');
program
.command('add')
.argument('', '任务描述')
.action((task) => {
console.log('添加任务:', task);
});
program.parse();
# Python CLI 工具
# 内置 argparse,无需安装
import argparse
parser = argparse.ArgumentParser(
description='Todo 任务管理器'
)
subparsers = parser.add_subparsers(
dest='command'
)
add_parser = subparsers.add_parser('add')
add_parser.add_argument('task', help='任务描述')
args = parser.parse_args()
if args.command == 'add':
print(f'添加任务: {args.task}')
todo/
├── todo.py # 主程序
├── storage.py # 数据存储
└── tasks.json # 任务数据(自动生成)
每个任务包含:
| 字段 | 类型 | 说明 |
|---|---|---|
| id | int | 唯一标识 |
| content | str | 任务内容 |
| done | bool | 是否完成 |
| created_at | str | 创建时间 |
import json
from datetime import datetime
from pathlib import Path
DATA_FILE = Path(__file__).parent / 'tasks.json'
def load_tasks():
"""从文件加载任务列表"""
if DATA_FILE.exists():
with open(DATA_FILE, 'r', encoding='utf-8') as f:
return json.load(f)
return []
def save_tasks(tasks):
"""保存任务列表到文件"""
with open(DATA_FILE, 'w', encoding='utf-8') as f:
json.dump(tasks, f, ensure_ascii=False, indent=2)
def add_task(content):
"""添加新任务"""
tasks = load_tasks()
task = {
'id': len(tasks) + 1,
'content': content,
'done': False,
'created_at': datetime.now().strftime('%Y-%m-%d %H:%M')
}
tasks.append(task)
save_tasks(tasks)
return task
用 argparse 实现子命令:
import argparse
from storage import load_tasks, save_tasks, add_task
def main():
parser = argparse.ArgumentParser(description='Todo 任务管理器')
subparsers = parser.add_subparsers(dest='command', help='可用命令')
# add 命令
add_parser = subparsers.add_parser('add', help='添加任务')
add_parser.add_argument('content', help='任务内容')
# list 命令
subparsers.add_parser('list', help='列出所有任务')
# done 命令
done_parser = subparsers.add_parser('done', help='标记任务完成')
done_parser.add_argument('id', type=int, help='任务 ID')
# delete 命令
del_parser = subparsers.add_parser('delete', help='删除任务')
del_parser.add_argument('id', type=int, help='任务 ID')
args = parser.parse_args()
if args.command == 'add':
task = add_task(args.content)
print(f'✅ 添加任务 #{task["id"]}: {task["content"]}')
elif args.command == 'list':
tasks = load_tasks()
if not tasks:
print('📝 暂无任务')
for t in tasks:
status = '✓' if t['done'] else '○'
print(f'{status} #{t["id"]} {t["content"]} ({t["created_at"]})')
elif args.command == 'done':
tasks = load_tasks()
for t in tasks:
if t['id'] == args.id:
t['done'] = True
save_tasks(tasks)
print(f'✅ 完成任务 #{args.id}')
return
print(f'❌ 找不到任务 #{args.id}')
elif args.command == 'delete':
tasks = load_tasks()
tasks = [t for t in tasks if t['id'] != args.id]
save_tasks(tasks)
print(f'🗑️ 删除任务 #{args.id}')
else:
parser.print_help()
if __name__ == '__main__':
main()
| 功能 | Node.js (commander) | Python (argparse) |
|---|---|---|
| 定义命令 | program.command('add') | subparsers.add_parser('add') |
| 参数 | .argument(' | add_argument('task') |
| 解析 | program.parse() | parser.parse_args() |
| 取值 | action callback | args.command |
argparse 是标准库,不需要安装任何第三方包。而 JavaScript 生态需要 npm install commander 或 yargs。
给任务加 priority 字段(high/medium/low),默认 medium。
# add_task 函数修改
def add_task(content, priority='medium'):
tasks = load_tasks()
task = {
'id': len(tasks) + 1,
'content': content,
'priority': priority,
'done': False,
'created_at': datetime.now().strftime('%Y-%m-%d %H:%M')
}
tasks.append(task)
save_tasks(tasks)
return task
# argparse 加参数
add_parser.add_argument('--priority', '-p',
choices=['high', 'medium', 'low'], default='medium')
list 命令按优先级从高到低排序。
elif args.command == 'list':
tasks = load_tasks()
priority_order = {'high': 0, 'medium': 1, 'low': 2}
tasks.sort(key=lambda x: priority_order.get(x['priority'], 1))
for t in tasks:
status = '✓' if t['done'] else '○'
print(f'{status} [{t["priority"]}] #{t["id"]} {t["content"]}')
添加 search <关键词> 命令,模糊匹配任务内容。
# argparse
search_parser = subparsers.add_parser('search', help='搜索任务')
search_parser.add_argument('keyword', help='搜索关键词')
# 逻辑
elif args.command == 'search':
tasks = load_tasks()
results = [t for t in tasks if args.keyword in t['content']]
for t in results:
status = '✓' if t['done'] else '○'
print(f'{status} #{t["id"]} {t["content"]}')
添加 clear-done 命令,删除所有已完成的任务。
# argparse
subparsers.add_parser('clear-done', help='清空已完成任务')
# 逻辑
elif args.command == 'clear-done':
tasks = load_tasks()
before = len(tasks)
tasks = [t for t in tasks if not t['done']]
save_tasks(tasks)
print(f'🗑️ 清空 {before - len(tasks)} 个已完成任务')
argparse 的基本用法,会创建 parser 和子命令subparsers 实现 add、list、done、delete 四个命令json.load() 和 json.dump()commander 和 Python argparse 的差异Path 对象的优势,会用 Path(__file__).parent 定位文件