百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术文章 > 正文

使用 Typer 快速构建 Python 命令行工具(CLI):日程管理应用实例

itomcoil 2025-05-03 14:46 5 浏览

本教程将指导你如何使用 Typer 来构建一个命令行界面(CLI)。Typer 是一个 Python 库,它可以帮助你快速简单地创建 CLI,并充分利用 Python 的类型提示(type hints)。

我们将以构建一个日程追踪工具为例,具体步骤包括:

  • 安装并配置 Typer
  • 添加命令
  • 正确处理任务(task)、时间(time)和优先级(priority)的输入与数据类型

现在我们正式开始吧!


第一步:安装 Typer

首先,我们安装 Typer:

$ pip3 install typer

安装 Typer 时会自动安装所需的全部依赖项,以支持 CLI 功能。建议你在项目的虚拟环境中安装 Typer。

你也可以访问这个示例项目的 GitHub 仓库。


第二步:创建基本的 CLI 工具

我们先创建一个简单的 CLI,能够添加带有正确时间格式的任务。

新建一个名为 schedule_tracker.py 的 Python 文件。

引入必要的库和模块,并实例化一个 typer.Typer() 对象(app),用于管理 CLI 命令。

import typer
from datetime import datetime
import json
from typing import List

app = typer.Typer()

我们定义一些辅助函数,用于从 JSON 文件加载和保存日程数据:

SCHEDULE_FILE = "schedule.json"

def load_schedule() -> List[dict]:
    try:
        with open(SCHEDULE_FILE, "r") as f:
            return json.load(f)
    except (FileNotFoundError, json.JSONDecodeError):
        return []

def save_schedule(schedule: List[dict]):
    with open(SCHEDULE_FILE, "w") as f:
        json.dump(schedule, f, default=str, indent=4)

因为每个任务都有相关的时间,我们创建一个辅助函数,将字符串解析为合法的时间对象:

def parse_time(t: str) -> datetime.time:
    try:
        return datetime.strptime(t, "%H:%M").time()
    except ValueError:
        typer.echo("无效的时间格式,请使用 HH:MM 格式。")
        raise typer.Exit()

创建基本的 add_task 命令。每个任务项目包括任务描述、时间和优先级:

@app.command()
def add_task(
    task: str,
    time: str = typer.Option(..., help="任务时间,格式为 HH:MM"),
    priority: int = typer.Option(1, help="任务优先级")
):
    schedule = load_schedule()
    task_time = parse_time(time)
    schedule.append({"task": task, "time": task_time.strftime("%H:%M"), "priority": priority})
    save_schedule(schedule)
    typer.echo(f"任务 '{task}' 已添加,时间为 {task_time.strftime('%H:%M')},优先级为 {priority}")

if __name__ == "__main__":
    app()

第三步:运行 CLI 工具

现在运行 schedule_tracker.py,添加一个任务:

$ python3 schedule_tracker.py add-task "团队会议" --time "14:00" --priority 2

输出如下:

任务 '团队会议' 已添加,时间为 14:00,优先级为 2

现在你就拥有了一个可以接收任务、时间和优先级的 CLI 工具。


第四步:添加更多命令功能

我们再给日程管理工具添加更多功能,比如查看任务列表和删除任务。

首先,增加一个按时间排序查看任务的命令:

@app.command()
def list_tasks():
    """列出所有已安排的任务"""
    schedule = load_schedule()
    if not schedule:
        typer.echo("未找到任何任务。")
        return
    for i, task in enumerate(sorted(schedule, key=lambda x: x["time"]), start=1):
        print(f"任务 {i}: {task['task']}")
        print(f"  时间: {task['time']}")
        print(f"  优先级: {task['priority']}")
        print("-" * 40)  # 添加分隔线提高可读性

你也可以根据需要修改函数,以按优先级排序任务。

再增加一个通过任务编号删除任务的命令:

@app.command()
def remove_task(task_number: int):
    """通过编号删除任务"""
    schedule = load_schedule()
    if 0 < task_number <= len(schedule):
        removed_task = schedule.pop(task_number - 1)
        save_schedule(schedule)  # 保存更新后的日程
        typer.echo(f"已删除任务 '{removed_task['task']}', 原定时间为 {removed_task['time']}") 
    else: 
        typer.echo(f"无效的任务编号,请选择介于 1 和 {len(schedule)} 之间的数字。")

第五步:测试改进版 CLI 工具

现在测试一下我们刚添加的新命令。

添加多个任务:

$ python3 schedule_tracker.py add-task "代码审查" --time "10:30" --priority 1
$ python3 schedule_tracker.py add-task "客户会议" --time "12:00" --priority 3

输出:

任务 '代码审查' 已添加,时间为 10:30,优先级为 1
任务 '客户会议' 已添加,时间为 12:00,优先级为 3

查看所有任务:

$ python3 schedule_tracker.py list-tasks

输出:

任务 1: 代码审查
  时间: 10:30
  优先级: 1
----------------------------------------
任务 2: 客户会议
  时间: 12:00
  优先级: 3
----------------------------------------
任务 3: 团队会议
  时间: 14:00
  优先级: 2
----------------------------------------

删除任务:

$ python3 schedule_tracker.py remove-task 3

输出:

已删除任务 '团队会议', 原定时间为 14:00

再次查看更新后的任务列表:

$ python3 schedule_tracker.py list-tasks

输出为:

任务 1: 代码审查
  时间: 10:30
  优先级: 1
----------------------------------------
任务 2: 客户会议
  时间: 12:00
  优先级: 3
----------------------------------------

总结与后续扩展

本教程到此结束。通过本教程的介绍,你已看到使用 Typer 可以在几分钟内轻松地构建简单而实用的 CLI 工具。本次我们构建了一个日程管理工具,能够高效地处理任务和时间输入验证。

你可以继续优化我们本次构建的版本,扩展添加更多功能,比如循环任务、提醒通知、日程导出等。你也可以尝试构建其他类似的 CLI 工具,比如费用追踪器。

祝你编程顺利!

相关推荐

PS小技巧 调整命令,让人物肤色变得更加白皙 #后期修图

我们来看一下如何去将人物的皮肤变得更加的白皙。·首先选中图层,Ctrl键加J键复制一层。·打开这里的属性面板,选择快速操作删除背景,这样就会将人物进行单独的抠取。·接下来在上方去添加一个黑白调整图层,...

把人物肤色提亮的方法和技巧

PS后期调白肤色提亮照片的方法。一白遮百丑,所以对于Photoshop后期来说把人物肤色调白是一项非常重要的任务。就拿这张素材图片来说,这张素材图片人脸的肤色主要偏红、偏黄,也不够白皙,该怎样对它进行...

《Photoshop教程》把美女图片调成清爽色彩及润肤技巧

关注PS精品教程,每天不断更新~~室内人物图片一般会偏暗,人物脸部、肤色及背景会出现一些杂点。处理之前需要认真的给人物磨皮及美白,然后再整体润色。最终效果原图一、用修补工具及图章工具简单去除大一点的黑...

PS后期对皮肤进行美白的技巧

PS后期进行皮肤美白的技巧。PS后期对皮肤进行美白的技巧:·打开素材图片之后直接复制原图。·接下来直接点击上方的图像,选择应用图像命令。·在通道这里直接选择红通道,混合这里直接选择柔光,然后点击确定。...

493 [PS调色]调模特通透肤色

效果对比:效果图吧:1、光位图:2、拍摄参数:·快门:160;光圈:8;ISO:1003、步骤分解图:用曲线调整图层调出基本色调。用可选颜色调整图层调整红色、黄色、白色和灰色4种颜色的混合比例。用色彩...

先选肤色再涂面部,卡戴珊的摄影师透露:为明星拍完照后怎么修图

据英国媒体12月17日报道,真人秀明星金·卡戴珊终于承认,她把女儿小北P进了家族的圣诞贺卡,怪不得粉丝们都表示这张贺卡照得非常失败。上周,这位39岁的女星遭到了一些粉丝针对这张照片的批评,她于当地时间...

如何在PS中运用曲线复制另一张照片的色调

怎样把另一张作品的外观感觉,套用到自己的照片上?单靠肉眼来猜,可能很不容易,而来自BenSecret的教学,关键是在PS使用了两个工具,让你可以准确比较两张照片的曝光、色调与饱和度,方便你调整及复制...

PS在LAB模式下调出水嫩肤色的美女

本PS教程主要使用Photoshop使用LAB模式调出水嫩肤色的美女,教程调色比较独特。作者比较注重图片高光部分的颜色,增加质感及肤色调红润等都是在高光区域完成。尤其在Lab模式下,用高光选区调色后图...

在Photoshop图像后期处理中如何将人物皮肤处理得白皙通透

我们在人像后期处理中,需要将人物皮肤处理的白皙通透,处理方法很多,大多数都喜欢使用曲线、磨皮等进行调整,可以达到亮但是不透,最终效果往往不是很好,今天就教大家一种如何将任务皮肤处理得白皙通透,希望能帮...

PS调色自学教程:宝宝照片快速调通透,简单实用!

PS调色自学教程:宝宝照片快速调通透。·首先复制图层,然后选择进入ACR滤镜,选择曲线锁定照片的亮部,也就高光位置,其他部位补亮一点,尤其是阴影的部位补亮多一些,让画面的层次均匀一点。·然后回到基本项...

【干货】如何利用PS进行人物美化

人物图像美化在Photoshop中非常常用,Photoshop作为一款功能强大的图像处理软件,不仅可以对人像进行基本的调色、美化和修复等处理,还可以改变人物的线条和幅度,如调整脸部器官和脸型的大小、调...

教大家一种可以快速把肤色处理均匀的方法@抖音短视频

快速把肤色处理均匀的方法。今天教大家一种可以快速把肤色处理均匀的方法。像这张照片整体肤色走紫红色,但是局部偏黄缘处理起来非常的麻烦。其实我们只需要新建空白图层,图层混合模式更改为颜色,再选择画笔工具把...

PS调色教程 利用RAW调出干净通透的肤色

要么不发,要么干货。后期教程来噜~用RAW调出干净通透的肤色。这次终于不会原片比PS后好看了吧。如果你依然这么觉得,请不要残忍的告诉我这个事实,泪谢TAT)附送拍摄花絮,感谢各位的支持更多风格请关注m...

photoshop后期皮肤变白的技巧

PS后期皮肤变白的技巧。1.PS后期让皮肤变白的方法有很多种,接下来教你一种非常简单容易上手的方法。2.打开素材图片之后,直接在小太极下拉框的位置添加一个纯色调整图层,颜色设置一个纯白色,点击...

Photoshop调出人物的淡雅粉嫩肤色教程

本教程主要使用Photoshop调出人物的淡雅粉嫩肤色教程,最终的效果非常的通透迷人,下面让我们一起来学习.出自:86ps效果图:原图:1、打开原图复制一层。2、用Topaz滤镜磨皮(点此下载)。3、...