在 setuptools 安装中包含一个目录

Question

我制作了一个基于插件的程序，它从不同的目录加载插件，其中一个是模块所在的目录（为了方便在源存储库中运行以进行测试）。

我希望源存储库中当前的插件与模块一起安装，以便在任何安装时默认加载它们。这最好存储在 setup() 创建的鸡蛋中。

目前源码仓库的重要部分如下：

/path/to/repo/
    plugins/
        example.py
    myprog.py # the module
    myprog    # the script
    setup.py

setup.py 看起来像这样：

from setuptools import setup

setup(
    name = 'myprog',
    version = '1.0',
    scripts = ['myprog'],
    py_modules = ['myprog'],

    package_data = {
        '': ['plugins/']
    }
)

但是，plugins 目录不以任何方式包含在安装中。

我怎样才能包含它，以便该行

os.path.join(os.path.dirname(os.path.realpath(__file__)), 'plugins')

运行python3 setup.py install后会正确找到该目录吗？

Answer 1

您的设置会通过创建一个每个人都可以导入的全局plugins 模块来破坏事情，或者每个人都会错误地导入。不要那样做。相反，请这样做：

• 将您的myprog.py 文件打包。最简单的方法：mkdir myprog; mv myprog.py myprog/__init__.py
• 然后，您可以将插件移动到子包中。 touch plugins/__init__.py; mv plugins myprog/
• 使用子包，您根本不必使用包数据。
• 要访问您的插件，只需对名为 foo.py 的插件执行 import myprog.plugins.foo。
• 另外：不要碰__file__，改用pkg_resources。
• 奖励积分：use entry points 用于您的脚本。