如何通过entry points为Python包创建全局命令行CLI工具

轻瑶君_3203

轻瑶君_3203

2026-10-16

168人浏览

原创

entry_points 是 setuptools 提供的声明式插件注册机制,核心价值在于解耦:主程序不硬编码插件路径,插件也不需主动注册;它在安装时写入 entry_points.txt,运行时由 importlib.metadata 或 pkg_resources 读取,仅适用于已安装的包。

如何通过entry points为python包创建全局命令行cli工具

entry_points 是什么,为什么它能注册全局命令

entry_points 不是 Python 内置机制,而是 setuptools(或现代的 build 后端如 hatchling)在安装包时读取的配置项,用于声明“这个函数可以被当作命令行工具调用”。安装时,setuptools 会根据 console_scripts 这个 entry point 组,自动生成一个可执行脚本,放入 Python 环境的 bin/(macOS/Linux)或 Scripts\(Windows)目录,并自动添加 shebang 和模块导入逻辑。

关键点:它依赖 pip install -e . 或正式安装,不是运行时生效;不装包,mytool 命令就不存在。

setup.py vs pyproject.toml:怎么写 entry_points 才有效

现在主流用 pyproject.toml,但很多人照抄旧教程写 setup.py,结果在现代构建流程里被忽略——因为 PEP 517 规定,如果存在 pyproject.toml,setup.py 默认不被读取。

正确做法(pyproject.toml):

[project.entry-points."console_scripts"]
mytool = "mytool.cli:main"

说明:

Forge — Python Developer
Forge — Python Developer

Python开发助手 — 自动化脚本、API封装、命令行工具、数据管道、网页爬虫。经过测试的代码,包含错误处理和文档。当你需要...

下载
  • mytool 是最终生成的命令名(用户敲 mytool --help)
  • mytool.cli:main 是模块路径加函数名,格式为 <package>.<module>:<function></function></module></package>
  • 冒号前必须是 importable 的 Python 模块路径,不能带 .py 后缀
  • 函数 main() 必须接受零参数(或只处理 sys.argv),且不应有 if __name__ == "__main__": 包裹——entry point 会直接调用它

常见报错:命令找不到、ModuleNotFoundError、AttributeError

装完包却提示 command not found 或 ImportError: No module named 'mytool',通常是因为:

  • 没在当前 Python 环境中安装:确认 which mytool 或 where mytool 是否指向虚拟环境路径;检查 pip list | grep mytool
  • 模块路径写错:mytool.cli:main 要求 mytool/__init__.py 和 mytool/cli.py 都存在,且 cli.py 里定义了 def main():
  • 函数签名错误:如果 main() 带了必需参数(比如 def main(args)),调用时会报 TypeError;应改用 def main() -> None:,内部用 argparse 解析 sys.argv[1:]
  • Windows 下权限问题:某些杀毒软件会拦截 Scripts\mytool.exe 创建,可临时禁用或换用 pip install --user

如何让 CLI 支持子命令和参数解析

entry_points 只负责把 main() 函数挂到命令行,真正的 CLI 体验靠你自己实现。别指望它自动支持 --help 或子命令——你得自己写。

推荐组合:

  • 用 argparse(标准库)做基础参数解析,适合简单工具
  • 用 click 或 typer 声明式定义命令,它们天然适配 entry point:例如 typer.Typer() 实例的 command() 方法注册后,main() 直接调用 app() 即可
  • 避免在 main() 里写太多逻辑:把它当作入口胶水函数,只做初始化、参数解析、分发,业务逻辑放别处

示例(mytool/cli.py):

import argparse

def main():
    parser = argparse.ArgumentParser(prog="mytool")
    parser.add_argument("--verbose", action="store_true")
    args = parser.parse_args()
    if args.verbose:
        print("Running in verbose mode")

真正难的不是注册命令,而是让 main() 在不同平台、不同 Python 版本、不同安装方式(venv / conda / user install)下都稳定接收参数并退出正确状态码。这点容易被忽略,但直接影响工具是否“可用”。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1731

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4444

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1709

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

26057

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3167

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3187

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1183

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2463

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习