python setup.py sdist 仅包括来自***模块的 .py 源

Posted 2023-02-18

【中文标题】python setup.py sdist 仅包括来自***模块的 .py 源

【英文标题】：python setup.py sdist only including .py source from top level module

【发布时间】：2013-01-11 07:18:42

【问题描述】：

我有一个 setup.py：

from setuptools import setup

setup(
      ...
      packages=['mypackage'],
      test_suite='mypackage.tests',
      ...
    )

python setup.py sdist 创建一个文件，其中仅包含来自*** mypackage 的源模块，而不包含 mypackage.tests 或任何其他子模块。

我做错了什么？

使用python 2.7

【参考方案1】：

使用find_packages() function：

from setuptools import setup, find_packages

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

该函数将搜索 python 包（带有__init__.py 文件的目录）并将它们作为格式正确的列表返回。它将从与 setup.py 脚本相同的目录开始，但可以指定一个明确的起始目录，以及排除模式（如果您需要它来跳过某些内容）。

【讨论】：

当我使用这个函数时，build/lib 从不包含项目根目录中的模块。如果我使用packages=['.']，运行python setup.py 会显示警告，但它确实将项目根目录中的模块添加到build/lib。我的项目根有__init__.py 和setup.py 和example-module.py。

@CMCDragonkai：你真的不应该让你的项目根包，为什么你有一个__init__.py开始呢？你的项目根目录应该只包含非嵌套的模块和包，而不是是一个包。

是的，我后来才意识到这一点。我认为项目根也可以是一个包。

【参考方案2】：

对于使用纯 distutils 而不是 setuptools 的人：您必须在 packages 参数中传递所有包和子包的列表（但不是所有子模块，它们都会被检测到）。

【参考方案3】：

只需在包列表中包含所有子模块：

from setuptools import setup

setup(
      ...
      packages=['mypackage', 'mypackage.tests', 'mypackage.submodules'],
      ...
     )