Python如何给包添加命令行工具快捷指令_在entry_points中定义console_scripts

星宇小哥_1812

星宇小哥_1812

2026-05-07

678人浏览

原创

console_scripts必须写为entry_points={"console_scripts": ["name=package.module:func"]}或[project.entry-points."console_scripts"]下name = "package.module:func",确保模块可导入、func是函数对象且包结构正确。

python如何给包添加命令行工具快捷指令_在entry_points中定义console_scripts

entry_points里console_scripts怎么写才生效

不写对格式,安装后 pip install -e . 也没法在终端直接敲命令。核心是:键必须是 console_scripts,值必须是 name=package.module:func 这种字符串列表,不能是字典、不能缩进、不能拼错冒号。

  • name 是你希望用户在终端输入的命令名,比如 mytool
  • package.module 必须是可 import 的路径(注意不是文件路径),且该模块得在 sys.path 里 —— 通常意味着它得在项目根目录或 src/ 下,并在 setup.py 或 pyproject.toml 中正确声明包结构
  • func 必须是函数对象,不能是字符串,也不能带括号;它最好接受 sys.argv[1:] 或用 argparse 解析参数
  • 如果用 pyproject.toml,要写在 [project.entry-points."console_scripts"] 下,注意双引号不能省

setup.py 和 pyproject.toml 两种写法差异在哪

旧写法用 setup.py,新写法用 pyproject.toml,但底层都走 setuptools 的 entry point 机制。区别主要在配置位置和语法容错性:

  • setup.py:在 setup() 调用里传 entry_points={"console_scripts": ["mycmd=myapp.cli:main"]} —— 注意外层是字典,内层是字符串列表
  • pyproject.toml:必须用 TOML 表语法,写成 [project.entry-points."console_scripts"],然后换行写 mycmd = "myapp.cli:main";等号前后空格可选,但值必须是双引号包裹的字符串
  • 如果同时存在 setup.py 和 pyproject.toml,现代 pip(≥21.3)优先读 pyproject.toml,setup.py 会被忽略 —— 别以为改了 setup.py 就生效

为什么装完命令找不到,或者报 ImportError

最常见原因不是 entry_points 写错,而是模块导入链断了。执行 mycmd 时,Python 实际是在新进程里做 import myapp.cli,所以任何 import 失败都会表现为 ModuleNotFoundError 或 ImportError。

361SCAN security check your skill python scripts
361SCAN security check your skill python scripts

扫描并分析已安装技能,用于查看指定技能目录的名称、描述和详情,或列出所有已安装的技能。

下载
  • 检查 myapp/__init__.py 是否缺失(尤其在 src/ 结构下,src/myapp/ 需配 packages=find_packages(where="src") 和 package_dir={"": "src"})
  • 运行 python -c "import myapp.cli; print(myapp.cli.main)" 看能否成功 import 并拿到函数对象
  • 确认 myapp/cli.py 没有顶层代码触发异常(比如误写了 requests.get(...) 却没装 requests)
  • 虚拟环境里装包后,别忘了关掉旧 shell 再新开一个——zsh/bash 的命令哈希缓存可能记着“没这个命令”

如何调试 console_scripts 生成的 wrapper 脚本

pip 安装时会在 venv/bin/(Linux/macOS)或 venv/Scripts/(Windows)下生成一个纯 Python 的 wrapper 脚本,名字就是你定义的 name。它不复杂,但能帮你定位问题。

  • 用 which mycmd 找到脚本路径,直接 cat 或 less 查看内容,你会看到类似 from myapp.cli import main; main() 的调用
  • 把里面那行 main() 改成 print("argv:", sys.argv); main(),再运行,就能确认参数是否透传进来
  • 如果 wrapper 脚本根本没生成,说明 pip install 没识别到 entry_points —— 检查 pyproject.toml 的表头拼写,或 setup.py 是否被正确加载(比如用了 PEP 517 构建但没配 build-backend)

真正卡住的地方往往不在 entry_points 语法本身,而在包结构和 import 可见性。写完先确保 python -m myapp.cli 能跑通,再指望终端命令可用。

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

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.07.20

1791

4

python能做什么
python能做什么

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

2023.07.25

4684

7

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

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

2023.07.31

1749

3

python教程
python教程

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

2023.08.03

27737

23

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

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

2023.08.04

3347

5

python eval
python eval

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

2023.08.04

3347

5

scratch和python区别
scratch和python区别

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

2023.08.11

1203

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2603

5

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习