0

0

Python 插件系统的 entry_points 规范

冷炫風刃

冷炫風刃

发布时间:2026-02-18 09:41:53

|

806人浏览过

|

来源于php中文网

原创

entry_points 是 setuptools 安装包时写入 dist-info 的键值对,声明包提供的可查找入口;它不是插件框架或自动加载机制,真正调用需第三方代码读取元数据后显式导入。

python 插件系统的 entry_points 规范

entry_points 是什么,不是什么

它不是 Python 的插件“框架”,也不是运行时自动加载机制;它是 setuptools 在安装包时写入 dist-info 元数据的一组键值对,本质是声明“我这个包提供了哪些可被其他代码按名查找的入口”。真正触发调用的是第三方代码(比如 importlib.metadatapkg_resources)去读取这些声明并导入对应对象。

定义 entry_points 的两种写法及坑点

最常见错误是混淆 setup.pypyproject.toml 的语法,导致声明不生效:

  • setup.py 中必须用字典嵌套: entry_points={'console_scripts': ['mycmd = mypkg.cli:main']} —— 键名必须是标准组名(如 console_scriptspytest11),值必须是字符串列表,不能是 dict 或 tuple
  • pyproject.toml 中要用 [project.entry-points."group-name"] 表格,且等号右边必须是 module:attr 形式,不能带括号或参数:mycmd = "mypkg.cli:main",写成 mycmd = "mypkg.cli:main()" 会静默失败
  • 路径分隔符统一用英文冒号 :,不是点号;模块路径必须能被 Python 导入(即所在目录有 __init__.py 或已加进 PYTHONPATH

如何在运行时安全读取和调用

别直接依赖 pkg_resources(已弃用),优先用 importlib.metadata(Python 3.8+)或兼容层 importlib_metadata(旧版本):

from importlib import metadata
try:
    eps = metadata.entry_points(group="console_scripts")
except KeyError:
    eps = []  # group 不存在时不抛异常
for ep in eps:
    if ep.name == "mycmd":
        func = ep.load()  # 这里才真正 import 并获取函数对象
        func()

注意:ep.load() 可能抛 ImportError(模块找不到)、AttributeError(函数不存在),必须捕获;metadata.entry_points() 返回的是 EntryPoints 对象(不是 list),不能用下标访问,得用 .select() 或遍历。

善美购物商城Sunway Shop
善美购物商城Sunway Shop

系统特点:技术领先:系统基于被广泛使用的Windows平台开发,集百家之所长,技术领先、功能完备; 快速建店:只需简单设置,3分钟即可以建立一个功能完备的网上商城; 操作简便:软件操作界面由专业设计人员设计,采用人性化的布局,界面规范,操作简捷; 安装方便:只需传到您的虚拟空间即可; HTML编辑器:内置优秀的HTML在线编辑器; 可扩展性:软件构架灵活,考虑未来功能扩充之需要,具有较强的可扩展性

下载

立即学习Python免费学习笔记(深入)”;

为什么 console_scripts 自动变命令行,其他组不行

console_scriptssetuptools 硬编码支持的特殊组:安装时它会生成一个同名 shell 脚本(Linux/macOS)或 .exe 包装器(Windows),内容就是调用你指定的函数。其他组(如 myplugin)只是元数据,没有任何自动行为 —— 是否加载、何时加载、怎么用,全由你自己代码决定。

常见误区是以为定义了 myplugin 组就能“自动发现插件”,其实只是把字符串存进了 MYPROJ-*.dist-info/entry_points.txt;如果你的主程序没写逻辑去读它,那它就只是个注释。

跨平台路径处理、Windows 下脚本编码、开发期未安装时的调试——这些才是实际项目里最常卡住的地方。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

553

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

216

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1553

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

640

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

945

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

896

2024.04.29

go语言字符串相关教程
go语言字符串相关教程

本专题整合了go语言字符串相关教程,阅读专题下面的文章了解更多详细内容。

185

2025.07.29

c++字符串相关教程
c++字符串相关教程

本专题整合了c++字符串相关教程,阅读专题下面的文章了解更多详细内容。

89

2025.08.07

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

462

2026.02.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.4万人学习

Django 教程
Django 教程

共28课时 | 4.3万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.6万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号