当前位置:首页 > 技术 > 正文内容

使用 Typer 快速开发命令行工具

访客 技术 2026年7月9日 2

快速构建现代化 CLI 应用

Typer 是一个基于 Python 的命令行接口开发库,它利用 clickPydantic 的强大能力,让开发者能够以极简方式创建功能丰富的命令行程序。

安装方法

pip install "typer[all]"

基础示例:打印问候语

只需两行代码即可启动一个可执行的命令行应用:

import typer

app = typer.Typer()

@app.command()
def greet(name: str):
    typer.echo(f"欢迎,{name}!")

if __name__ == "__main__":
    app()

自动帮助文档生成

运行命令后,自动生成清晰的使用说明:

$ python main.py --help
Usage: main.py [OPTIONS] NAME

Options:
  --help  Show this message and exit.

多命令支持

通过装饰器为每个函数添加命令标识,即可扩展多个子命令:

@app.command()
def say_hello(name: str):
    typer.echo(f"你好,{name}!")

@app.command()
def calculate_age(birth_year: int):
    current_year = 2024
    age = current_year - birth_year
    typer.echo(f"你今年 {age} 岁。")

参数与类型自动推断

函数参数直接映射为命令行选项,支持类型校验、默认值和范围限制:

@app.command()
def process_data(
    input_file: str,
    output_dir: str = "./output",
    verbose: bool = False,
    count: int = 1,
    threshold: float = 0.5
):
    if count < 1:
        raise typer.BadParameter("计数必须大于等于 1")
    typer.echo(f"处理文件:{input_file}")
    typer.echo(f"输出路径:{output_dir}")
    typer.echo(f"详细模式:{verbose}")
    typer.echo(f"阈值:{threshold}")

子命令结构化设计

支持嵌套命令,模拟 Git 风格的层级结构:

app = typer.Typer()
sub_app = typer.Typer()

app.add_typer(sub_app, name="manage")

@sub_app.command()
def add_user(username: str, role: str = "user"):
    typer.echo(f"添加用户:{username}(角色:{role})")

@sub_app.command()
def remove_user(username: str):
    typer.echo(f"移除用户:{username}")

调用方式:

$ python main.py manage add-user alice --role=admin

高级特性

  • 交互式输入:支持用户在终端中逐项填写信息
  • 彩色输出:使用 rich 实现高亮文本展示
  • 进度条:内置对长任务的可视化进度反馈
  • 错误提示优化:提供精准的参数校验错误提示

所有功能均无需额外配置,开箱即用,极大提升开发效率与用户体验。

相关文章

Linux crontab 详解

1) crontab 是什么cron 是 Linux 的定时任务守护进程;crontab 是用来编辑/查看“按时间周期执行命令”的表(cron table)。常见两类:用户 crontab:每个用户一份(crontab -e 编辑)系统级 crontab / cron.d:可指定执行用户(/etc/crontab、/etc/cron.d/*)2) crontab 时间...

富文本里可以允许的 HTML 属性

一、所有标签默认允许的安全属性(极少)class        (可选)id           (通常建议禁用)title️ 注意:id 容易被滥用做锚点注入,很多系统直接禁用class 允许的话最好只允许固定前缀(如 editor-*)二、a 标签允许属性<a href="" t...

Mac 安装 Node.js 指南

方法一:通过官网安装包(最简单,适合初学者)如果你只是想快速安装并开始使用,这是最直接的方法。访问 Node.js 官网。页面会显示两个版本:LTS (Recommended For Most Users):长期支持版,最稳定。建议选这个。Current:最新特性版,包含最新功能但可能不够稳定。下载 .pkg 安装包并运行。按照安装向导点击“下一步”即可完成。方法二:使用 Homebrew 安装(...

Dom\HTML_NO_DEFAULT_NS 的副作用:自动加闭合标签

在使用Dom\HTMLDocument时,Dom\HTML_NO_DEFAULT_NS 将禁止在解析过程中设置元素的命名空间, 此设置是为了与DOMDocument向后兼容而存在的。当使用它时,已知的一个副作用就是:自动加闭合标签例如 </img> 为什么会这样?当你使用:Dom\HTML_NO_DEFAULT_NS文档会变成 无命名空间模式,此时内部更接近 XML...

Laravel 事件和监听器创建

在 Laravel 中,使用 Artisan 命令创建 Events(事件) 和 Listeners(监听器) 是非常高效的。你可以通过以下几种方式来实现:1. 手动创建单个 Event如果你只想创建一个事件类,可以使用 make:event 命令:Bashphp artisan make:event UserRegistered执行后,文件将生成在 app/Even...

自定义域名解析神器 dnsmasq

什么是 dnsmasq?dnsmasq 是一个轻量级、功能强大的网络服务工具,专为小型和中等规模网络设计。它是一个综合的网络基础设施解决方案[1]。dnsmasq 能做什么?功能说明应用场景DNS 转发与缓存将 DNS 查询转发到上游服务器(ISP、Google DNS 等),并在本地缓存结果加快 DNS 查询速度,减少外部 DNS 流量本地 DNS解析本地网络设备的主机名,无需编辑&n...

发表评论

访客

◎欢迎参与讨论,请在这里发表您的看法和观点。