setuptools麻烦 - 不包括包,包括数据文件

问题描述 投票:21回答:5

我对setuptools很新。我已经看到了一些类似的问题,它有点疯狂,我似乎遵循我看到的建议,但setuptools仍然做了一些不同于我想要的东西。

这是我的项目的结构:

.
..
package1/
    __init__.py
    abc.py
    ...
tests/
    __init__.py
    test_package1.py
LICENSE
README.md
RELEASE
setup.py

这是我的setup.py的内容:

#!/usr/bin/env python
import os
#from distutils.core import setup
from setuptools import setup, find_packages

setup(
    name='package1',
    version='1.1',
    test_suite="tests",
    packages=find_packages(exclude=['tests']),    
    include_package_data=True,
    package_data = {
        '': ['LICENSE', 'README.md5', 'RELEASE']
    },   
)

另外,在我的清单文件中,我有:

include LICENSE
include RELEASE
include README.md

我用以下内容构建tar:

python setup.py sdist

我想要:

  1. 从源代码分发中排除tests目录;
  2. 在site-packages目录中有LICENSE,README.md,RELEASE文件,可以在顶层,也可以在package1目录中(此时我同意)。

相反,这是发生的事情:

  1. tests目录仍然在创建的tar存档中,并安装到site-packages;
  2. 文件将复制到存档,但不会安装到程序包的site-packages目录中。

我没有想法,有人可以向我解释我做错了什么以及如何解决它?

python configuration setuptools
5个回答
17
投票

您应该在包的根级别创建一个名为MANIFEST.in的新文件,然后按照以下说明操作:

  1. 要控制哪些文件最终出现在tar文件中,请在包的根级别创建一个名为MANIFEST.in的新文件。例如,您可以使用recursive-exclude文件中的MANIFEST.in从分发中排除整个目录。在您的情况下,您需要您的MANIFEST.in文件包含: recursive-exclude tests *
  2. 在site-packages目录中包含README和其他文件并不常见,但是如果你真的想要,那就进入package1并创建你想要包含的文件的符号链接: cd package1 ln -s ../LICENSE ln -s ../README.md ln -s ../RELEASE 然后在setup.py中更改以下行: package_data = { '': ['LICENSE', 'README.md', 'RELEASE'] 至: package_data = { 'package1': ['LICENSE', 'README.md', 'RELEASE']

21
投票

find_packages使用fnmatchcase进行排除过滤。您可以测试排除模式是否与包名称匹配,如下所示:

>>> from fnmatch import fnmatchcase
>>> fnmatchcase('my.package.name.tests', 'tests')
False

假设项目中的所有测试都存在于以tests结尾的包名或这些包的子包中,以下内容应足以排除所有测试代码:

setup(
    name='package1',
    version='1.1',
    packages=find_packages(exclude=['tests', '*.tests', '*.tests.*']),    
)

要从源分发中排除tests文件夹,请将以下内容添加到MANIFEST.in:

recursive-exclude tests *

0
投票

如果你的结构是真的:

  1. tests文件夹不是包(它没有init.py文件),所以find_package不排除它。
  2. include_package_data = True表示如果未明确排除,将包含所有版本化文件。

所以:在你的MANIFEST.in中尝试排除测试/ *

我希望它有所帮助


0
投票

MANIFEST.in会照顾它。

prune tests/
include LICENSE  README.md RELEASE

如果要添加静态文件,请添加它们

...
recursive-include package1/static *

0
投票

我正在尝试一切,似乎没有任何工作,直到我删除了build目录(看到another answer mentioning *.egg-info/ directory后),它终于奏效了。 python setup.py clean --all也应该做这个工作。

© www.soinside.com 2019 - 2024. All rights reserved.