具有多级模块的 Python console_scripts

Question

我在 setup.py 中有以下代码

from setuptools import setup
setup(
    name='raas',
    version='0.1',
    description='Program to test console_scripts\'s\n.',
    packages=['raas'],
    entry_points={
        'console_scripts': ['raas = raas.cli.entry:main',
                            'raas1 = raas.test:main']
    },
    zip_safe=True,
)

包结构是

$ --> ls -lR
total 8
drwxr-xr-x  6 noorul  wheel  192 Mar 22 01:37 raas
-rw-r--r--  1 noorul  wheel  349 Mar 22 01:37 setup.py

./raas:
total 16
-rw-r--r--  1 noorul  wheel    0 Mar 22 01:28 __init__.py
-rw-r--r--  1 noorul  wheel  103 Mar 22 01:32 __init__.pyc
drwxr-xr-x  6 noorul  wheel  192 Mar 22 01:32 cli
-rw-r--r--  1 noorul  wheel   29 Mar 22 01:37 test.py

./raas/cli:
total 24
-rw-r--r--  1 noorul  wheel    0 Mar 22 01:28 __init__.py
-rw-r--r--  1 noorul  wheel  107 Mar 22 01:32 __init__.pyc
-rw-r--r--  1 noorul  wheel   37 Mar 22 01:29 entry.py
-rw-r--r--  1 noorul  wheel  234 Mar 22 01:32 entry.pyc

entry.py和test.py的内容是

$ --> cat raas/cli/entry.py
def main():
    print "Hellow world"

$ --> cat raas/test.py
def main():
    print "Test"

但是在虚拟环境中使用 setup.py install 安装包之后。我只能运行 raas1 而不能运行 raas

$ --> ./venv/bin/raas
Traceback (most recent call last):
  File "./venv/bin/raas", line 11, in <module>
    load_entry_point('raas==0.1', 'console_scripts', 'raas')()
  File "/private/tmp/raas/venv/lib/python2.7/site-packages/pkg_resources/__init__.py", line 480, in load_entry_point
    return get_distribution(dist).load_entry_point(group, name)
  File "/private/tmp/raas/venv/lib/python2.7/site-packages/pkg_resources/__init__.py", line 2693, in load_entry_point
    return ep.load()
  File "/private/tmp/raas/venv/lib/python2.7/site-packages/pkg_resources/__init__.py", line 2324, in load
    return self.resolve()
  File "/private/tmp/raas/venv/lib/python2.7/site-packages/pkg_resources/__init__.py", line 2330, in resolve
    module = __import__(self.module_name, fromlist=['__name__'], level=0)
ImportError: No module named cli.entry

$ --> ./venv/bin/raas1
Test

我错过了什么吗？

Answer 1

问题

你错过的是行

packages=['raas'],

您可能认为这将包含 raas 及其所有子包，但事实并非如此! packages=['raas'] 将仅包含 raas/__init__.py 和 raas 目录中的每个 python 模块 - 在您的例子中是 测试.py。这就是 raas1 命令起作用的原因。

但是，不会包含raas 的任何子包，因此不会安装raas.cli 子包。您应该能够通过使用 pip 列出已安装的文件来验证它是否丢失(如果您已经使用它安装了软件包):

$ pip show -f raas
Name: raas
Version: ...
...
Files:
  ...
  raas/__init__.py
  raas/test.py

您应该不会在文件列表中看到 raas/cli/__init__.py 和 raas/cli/entry.py。

解决方案

显而易见的解决方案是将 raas.cli 包含到包列表中:

packages=['raas', 'raas.cli'],

但是，维护起来非常笨拙:当添加新包或重命名现有包时，您必须将更改包含在 setup.py 中的包列表中，否则它们将不会包含在分配。由于您已经在使用 setuptools，因此它提供了一个更好的解决方案:

from setuptools import setup, find_packages

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

find_packages() 函数将对当前目录执行递归扫描，查找 python 包，并生成将包含在分发版中的合格包名列表。 Read its doc for more details.