使用 cython 创建包，以便用户无需安装 cython 即可安装它

我有个问题。我想分发我的 cython 支持的包，但我没有看到在 setup.py 中构建它们的简单方法。我希望 setup.py 能够：

• 最重要的是：在没有 cython 的情况下安装我的包（从预先生成的 C 文件或预先安装 cython）
• 在 sdist 上重建（运行 cythonize）包
• 不需要对我的 cython 模块的列表进行硬编码（只需使用 glob 或其他东西）
• 能够在没有 .c 文件（不应存储在 git 中）或 .pyx（可能不会分发）的情况下工作。当然，至少其中一组将始终存在。

目前在我发痒的包中，我正在使用这个相当复杂的代码：

import os
from glob import glob
from distutils.command.build_ext import build_ext as _build_ext
from distutils.command.sdist import sdist as _sdist
from distutils.core import setup
from distutils.core import Extension



def generate_extensions():
    return [
        # Compile cython-generated .c files into importable .so libraries.
        Extension(os.path.splitext(name)[0], [name])
        for name in C_FILES
    ]


# In distribution version, there are no pyx files, when you clone package from git, there will be no c files.
CYTHON_FILES = glob('itchy/*.pyx')
C_FILES = glob('itchy/*.c')
extensions = generate_extensions()


class build_ext(_build_ext):
    def run(self):
        # Compile cython files (.pyx, some of the .py) into .c files if Cython is available.
        try:
            from Cython.Build import cythonize
            if CYTHON_FILES:
                cythonize(CYTHON_FILES)

                # Update C_FILES in case they were originally missing.
                global C_FILES, extensions
                C_FILES = glob('itchy/*.c')
                extensions = generate_extensions()
            else:
                print('No .pyx files found, building extensions skipped. Pre-built versions will be used.')
        except ImportError:
            print('Cython is not installed, building extensions skipped. Pre-built versions will be used.')
            assert C_FILES, 'C files have to be present in distribution or Cython has to be installed'
        _build_ext.run(self)


class sdist(_sdist):
    def run(self):
        # Make sure the compiled Cython files in the distribution are up-to-date
        self.run_command("build_ext")
        _sdist.run(self)


setup(
    (...)
    ext_modules = extensions,
    cmdclass = {
        'build_ext': build_ext,
        'sdist': sdist,
    },
)

通常通过尝试导入 cython 并调整扩展名来完成

1. 如果 cython 存在，则使用 cython 构建 pyx 文件
2. 如果 cython 不存在，则构建 C 文件

例如：

try:
    from Cython.Distutils.extension import Extension
    from Cython.Distutils import build_ext
except ImportError:
    from setuptools import Extension
    USING_CYTHON = False
else:
    USING_CYTHON = True

ext = 'pyx' if USING_CYTHON else 'c'
sources = glob('my_module/*.%s' % (ext,))
extensions = [
    Extension(source.split('.')[0].replace(os.path.sep, '.'),
              sources=[source],
    )
for source in sources]
cmdclass = {'build_ext': build_ext} if USING_CYTHON else {}

setup(<..>, ext_modules=extensions, cmdclass=cmdclass)

The source.split需要一些东西，因为 cythonized 扩展名称需要采用以下形式my_module.ext而 glob 需要路径名，例如my_module/ext.

查看这个存储库 https://github.com/ParallelSSH/ssh2-python/blob/master/setup.py#L14-L25举一个现实世界的例子。

但是，您应该包括.cgit 存储库中的文件以及可分发的文件，否则当需要构建发行版时.c文件将被重新构建，并且可能与您计算机上构建的文件相同，也可能不同。

例如，它们可能由另一个版本的 cython 构建，或者在不同的平台上生成不同的代码。

Cython 是一个静态编译器 - 建议将其生成的文件提交到存储库。

强烈建议您分发生成的 .c 文件以及 Cython 源，以便用户无需使用 Cython 即可安装您的模块。

请参阅有关分发模块的 Cython 文档 https://cython.readthedocs.io/en/latest/src/userguide/source_files_and_compilation.html#distributing-cython-modules.