如何在 setup.py 中引导 numpy 安装

Question

我有一个项目，它有一个 C 扩展，需要 numpy。 理想情况下，我希望下载我的项目的人能够运行python setup.py install或使用一次调用pip 。 The problem I have is that in my setup.py I need to import numpy to get the location of the headers, but I'd like numpy to be just a regular requirement in install_requires so that it will automatically be downloaded from the Python Package Index .

这是我正在尝试做的一个示例：

from setuptools import setup, Extension
import numpy as np

ext_modules = [Extension('vme', ['vme.c'], extra_link_args=['-lvme'],
                         include_dirs=[np.get_include()])]

setup(name='vme',
      version='0.1',
      description='Module for communicating over VME with CAEN digitizers.',
      ext_modules=ext_modules,
      install_requires=['numpy','pyzmq', 'Sphinx'])

显然，在安装之前，我无法在顶部import numpy 。 我已经看到一个setup_requires参数传递给setup()但找不到任何关于它的用途的文档。

这可能吗？

Answer 1

以下至少适用于 numpy1.8 和 python{2.6,2.7,3.3}：

from setuptools import setup
from setuptools.command.build_ext import build_ext as _build_ext

class build_ext(_build_ext):
    def finalize_options(self):
        _build_ext.finalize_options(self)
        # Prevent numpy from thinking it is still in its setup process:
        __builtins__.__NUMPY_SETUP__ = False
        import numpy
        self.include_dirs.append(numpy.get_include())

setup(
    ...
    cmdclass={'build_ext':build_ext},
    setup_requires=['numpy'],
    ...
)

对于一个小的解释，看看为什么它在没有“hack”的情况下会失败，请参阅这个答案。

请注意，使用setup_requires有一个微妙的缺点：numpy 不仅会在构建扩展之前编译，而且在执行python setup.py --help时也会编译，例如。 为避免这种情况，您可以检查命令行选项，如https://github.com/scipy/scipy/blob/master/setup.py#L205 中建议的那样，但另一方面，我认为这并不值得努力。

Answer 2

我在 [这篇文章][1] 中找到了一个非常简单的解决方案：

或者你可以坚持使用https://github.com/pypa/pip/issues/5761 。 在这里，您在实际安装之前使用 setuptools.dist 安装 cython 和 numpy：

from setuptools import dist
dist.Distribution().fetch_build_eggs(['Cython>=0.15.1', 'numpy>=1.10'])

对我来说效果很好！

Answer 3

这是需要使用 numpy（对于 distutils 或 get_include）的包的基本问题。 我不知道有什么方法可以使用 pip 或轻松安装来“引导”它。

但是，为您的模块制作 conda 包并提供依赖项列表很容易，这样有人就可以执行 conda install pkg-name 下载并安装所需的一切。

Conda 在 Anaconda 或 Miniconda (python + just conda) 中可用。

请参阅此网站： http : //docs.continuum.io/conda/index.html或此幻灯片以了解更多信息： https : //speakerdeck.com/teoliphant/packaging-and-deployment-with-conda

Answer 4

关键是将导入numpy推迟到安装后。 我从这个pybind11 示例中学到的一个技巧是在辅助类的__str__方法中导入numpy （下面的get_numpy_include ）。

from setuptools import setup, Extension

class get_numpy_include(object):
    """Defer numpy.get_include() until after numpy is installed."""

    def __str__(self):
        import numpy
        return numpy.get_include()


ext_modules = [Extension('vme', ['vme.c'], extra_link_args=['-lvme'],
                         include_dirs=[get_numpy_include()])]

setup(name='vme',
      version='0.1',
      description='Module for communicating over VME with CAEN digitizers.',
      ext_modules=ext_modules,
      install_requires=['numpy','pyzmq', 'Sphinx'])

Answer 5

为了让 pip 工作，你可以像 Scipy 一样做： https : //github.com/scipy/scipy/blob/master/setup.py#L205

即，需要将egg_info命令传递给标准 setuptools/distutils，但其他命令可以使用numpy.distutils 。

Answer 6

也许更实用的解决方案是只需要预先安装import numpy在函数范围内import numpy 。 @coldfix 解决方案有效，但编译 numpy 需要永远。 首先将其 pip 安装为wheels 包要快得多，尤其是现在由于manylinux 之类的努力，我们为大多数系统提供了轮子。

from __future__ import print_function

import sys
import textwrap
import pkg_resources

from setuptools import setup, Extension


def is_installed(requirement):
    try:
        pkg_resources.require(requirement)
    except pkg_resources.ResolutionError:
        return False
    else:
        return True

if not is_installed('numpy>=1.11.0'):
    print(textwrap.dedent("""
            Error: numpy needs to be installed first. You can install it via:

            $ pip install numpy
            """), file=sys.stderr)
    exit(1)

def ext_modules():
    import numpy as np

    some_extention = Extension(..., include_dirs=[np.get_include()])

    return [some_extention]

setup(
    ext_modules=ext_modules(),
)

Answer 7

@coldfix 的解决方案不适用于 Cython 扩展，如果 Cython 没有预安装在目标机器上，因为它失败并出现错误

错误：未知文件类型“.pyx”（来自“xxxxx/yyyyyy.pyx”）

失败的原因是setuptools.command.build_ext的过早导入，因为在导入时， 它会尝试使用Cython 的build_ext ：

try:
    # Attempt to use Cython for building extensions, if available
    from Cython.Distutils.build_ext import build_ext as _build_ext
    # Additionally, assert that the compiler module will load
    # also. Ref #1229.
    __import__('Cython.Compiler.Main')
except ImportError:
_build_ext = _du_build_ext

通常 setuptools 是成功的，因为导入发生在setup_requirements完成之后。 但是，通过在setup.py导入它，只能使用回退解决方案，它对 Cython 一无所知。

将Cython与 numpy 一起引导的一种可能性是在间接/代理的帮助下推迟setuptools.command.build_ext的导入：

# factory function
def my_build_ext(pars):
     # import delayed:
     from setuptools.command.build_ext import build_ext as _build_ext#

     # include_dirs adjusted: 
     class build_ext(_build_ext):
         def finalize_options(self):
             _build_ext.finalize_options(self)
             # Prevent numpy from thinking it is still in its setup process:
             __builtins__.__NUMPY_SETUP__ = False
             import numpy
             self.include_dirs.append(numpy.get_include())

    #object returned:
    return build_ext(pars)

...
setup(
    ...
    cmdclass={'build_ext' : my_build_ext},
    ...
)

还有其他可能性，例如在这个SO-question 中讨论。

Answer 8

现在（自 2018 年以来）应该通过在pyproject.toml添加 numpy 作为构建系统依赖项来解决这个问题，以便pip install在运行setup.py之前使numpy可用。

pyproject.toml文件还应指定您正在使用 Setuptools 来构建项目。 它应该是这样的：

[build-system]
requires = ["setuptools", "wheel", "numpy"]
build-backend = "setuptools.build_meta"

有关更多详细信息，请参阅 Setuptools 的构建系统支持文档。

这不包括除install之外的setup.py许多其他用途，但由于这些用途主要是为您（以及您项目的其他开发人员）准备的，因此提示安装numpy的错误消息可能会起作用。

Answer 9

您可以简单地将 numpy 添加到您的 pyproject.toml 文件中。 这对我有用。

[build-system] 
requires = [ 
    "setuptools>=42",
    "wheel", 
    "Cython", 
    "numpy" 
] 
build-backend = "setuptools.build_meta"