如何在 Cython 中指定“.pxd”文件的路径

Question

我的项目目录结构如下：

.
├── Makefile
├── pxd
├── pyx
│   ├── Landscaping.pyx
│   ├── Shrubbing.pxd
│   └── Shrubbing.pyx
└── setup.py

但是，如果我将Shrubbing.pxd 移动到其他任何地方，例如，移动到pxd/，我会收到以下错误：

Error compiling Cython file:
------------------------------------------------------------
...
import pyx.Shrubbing
cimport Shrubbing
       ^
------------------------------------------------------------

pyx/Landscaping.pyx:2:8: 'Shrubbing.pxd' not found

Error compiling Cython file:
------------------------------------------------------------
...
import pyx.Shrubbing
cimport Shrubbing

cdef Shrubbing.Shrubbery sh
    ^
------------------------------------------------------------

这很奇怪，因为在 setup.py 我有：

from distutils.core import setup, Extension
from Cython.Build import cythonize
setup(ext_modules=cythonize([
    Extension(
        'pyx.Landscaping',
        sources=["pyx/Landscaping.pyx"],
        include_dirs=['pxd']), # <-- HERE
    Extension('pyx.Shrubbing', sources=["pyx/Shrubbing.pyx"])
]))

明确指定Shrubbing.pxd 的新目录。

源文件都很短，但为了避免这篇文章混乱，我将发布一个存储库的链接：https://github.com/lobachevzky/landscaping

感谢您的帮助。

Answer 1

include_dirs 用于 C/C++ 标头，而不是 Cython pxd 文件。

一般情况下最好将相关的pyx/pxd文件放在同一个目录下，即Shrubbing.pyx和Shrubbing.pxd应该在同一个目录下。

然后要从其他模块中使用它，请通过扩展中使用的名称包括__init__.pxd 和cimport，例如pyx.Shrubbing，就像使用Python 模块一样。

如果在 python 中导入（不是cimport），__init__.py 也应该包含在内。

当在同一个模块中使用时，OTOH，.pxd 需要在该模块的运行时可用，这意味着将其包含在 Python 搜索路径中。

如果您想将 pxd 文件组织到单独的目录中，则将它们符号链接到模块目录中以使它们可用于模块，该目录包含 __init__.pxd 或 .py 文件。

这有点混乱，因为 Cython 目前不支持相对导入，因此当想要从另一个目录导入时需要链接。

见documentation for more details。

Answer 2

严格来说，这个答案比您提出的具体问题更广泛。更多的是“如何在包之间共享pxd 定义”。

为了自己解决这个问题，我创建了一个cython_example 存储库。这并不令人满意，因为它使用旧的distutils 工具而不是setuptools 来防止zip/egg 封装底层文件，但在这里可能会有所启发。我正在积极寻找一种改进，可以自动从egg 文件中提取代码，以便可以使用setuptools。

核心思想是使用os.path.dirname(from_package.__file__) 来添加到包含路径中。请参阅setup.py 文件。

更新：

cythonemail list 提示使用zip_unsafe 安装时使用setuptools 将使一切正常。请参阅updated working example 和update I added 到documentation。