Repolode
pallets

pallets/click

一个用于快速构建可组合命令行界面的 Python 工具包,支持嵌套命令与自动生成帮助页面。

Star
17,817
Fork
3,296
未关闭 Issue
89
最近提交
24小时前

这是什么?

Click 是一个用于编写命令行工具的 Python 包。开发者通过装饰器声明命令、选项和参数,解析、校验、交互式提示以及帮助文本生成都由 Click 自动完成。

命令可以任意嵌套,子命令还支持在运行时延迟加载。库的默认配置开箱即用,一个基本程序只需要带装饰器的函数和对命令对象的调用即可运行,选项处理还包括默认值、交互式输入提示和自动生成的帮助输出。

Click 由 Pallets 组织开发维护,采用 BSD-3-Clause 许可证。它面向希望构建命令行工具、又不想手写参数解析逻辑的 Python 开发者。

核心功能

  • 01通过装饰器定义命令、选项和参数
  • 02支持命令与子命令任意嵌套
  • 03自动生成帮助页面
  • 04支持在运行时延迟加载子命令
  • 05缺失选项值时支持交互式提示

适用场景

  • 构建包含多个子命令的 Python 命令行工具
  • 编写在缺少参数时向用户交互提问的脚本
  • 用更简洁的装饰器写法替代手写的参数解析代码

快速上手

  1. 1

    使用 pip 安装 Click

    pip install click
  2. 2

    将示例保存为 hello.py 并运行

    python hello.py --count=3

收录于专题

标签

常见问题

click 是什么?
一个用于快速构建可组合命令行界面的 Python 工具包,支持嵌套命令与自动生成帮助页面。 Click 是一个用于编写命令行工具的 Python 包。开发者通过装饰器声明命令、选项和参数,解析、校验、交互式提示以及帮助文本生成都由 Click 自动完成。
click 可以免费使用吗?用的什么许可证?
click 以 BSD-3-Clause 许可证开源。用于商业产品前,请先确认许可证条款。
click 还在维护吗?
活跃维护中。click 最近一次提交是在 2026年11月6日。
click 适合用来做什么?
构建包含多个子命令的 Python 命令行工具 编写在缺少参数时向用户交互提问的脚本 用更简洁的装饰器写法替代手写的参数解析代码
click 怎么安装和运行?
使用 pip 安装 Click: pip install click 将示例保存为 hello.py 并运行: python hello.py --count=3
在哪里获取 click?
源代码和安装说明在 GitHub 上:https://github.com/pallets/click

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目