具有多级模块的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安装软件包之后，在虚拟env中安装。我只能运行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模块--在您的例子中是test.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包，并生成将包含在发行版中的限定包名称的列表。有关更多细节，请阅读其文档。