为什么我需要在setup.py中包含子包

时间:2018-04-29 05:02:08

标签: python setup.py

我有一个名为mltester的python包,它包含两个子包(actionsdialogs)和一个主脚本ml_tester.py,结构如下:

+ <ProjectFolder>
+---+ <mltester>
|   +---- <actions>
|   +---- <dialogs>
|   +---- ml_tester.py
|   +---- __init__.py
+---- setup.py

我的__init__.py如下所示:

import actions
import dialogs
import ml_tester

ml_tester.py我做了类似的事情:

from actions import *
from dialogs import *

从eclipse运行时一切正常。执行pip install时,以下setup.py可以正常工作:

from setuptools import setup
setup(
    name="MLTester",
    version="1.0",
    packages=["mltester",
              "mltester.actions",
              "mltester.dialogs"],
    install_requires=[
        "matplotlib",
    ],
    entry_points='''
        [console_scripts]
        ml_tester_gui=mltester.ml_tester:main
    '''
)

但是,当我从包列表中删除"mltester.actions""mltester.dialogs"时,我现在收到如下错误:

File "/usr/local/lib/python2.7/dist-packages/mltester/__init__.py", line 1, in <module>
    import actions
ImportError: No module named actions

我不明白为什么只列出包含mltester包的内容是不够的。当然,我可以简单地添加包,但现在我认为我在这里缺少更具概念性的东西。

1 个答案:

答案 0 :(得分:4)

因为packages不在子树中执行任何包查找。将包添加到packages只会包含包本身和所有直接子模块,但不包括任何子包。

例如,如果您的源树包含spam包,其中包含模块eggs和子包bacon

src
└── spam
    ├── __init__.py
    ├── eggs.py
    └── bacon
        └── __init__.py

指定packages=['spam']仅包含spamspam.eggs,但不包括spam.bacon,因此不会安装spam.bacon。您必须单独添加它以包含完整的源代码库:packages=['spam', 'spam.bacon']

要自动构建packages列表,setuptools offers a handy function find_packages

from setuptools import find_packages, setup

setup(
    packages=find_packages(),
    ...
)