参考:https://www.cnblogs.com/traditional/p/13284386.html
pxd文件类似于c、c++语言中的头文件,cimport引入的就是从pxd文件中进行属性导入。cython是不能够在pyx文件之间相互导入的。
如何有效组织cython项目
一般情况下pyx文件和py文件是等价的,但是如果需要和其他文件共享某个pyx文件中的c级结构就需要pxd文件。
pxd文件中只存放:
C类型声明--ctypedef、结构体、共同体、枚举(后续系列中介绍)
外部的C、C++库的声明(后续系列中介绍)
cdef、cpdef模块级函数的声明
cdef class扩展类的声明
扩展类的cdef属性
使用cdef、cpdef方法的声明
C级内联函数或者方法的实现
pxd文件中不能存放:
Python函数和非内联C级函数、方法的实现
Python类的定义
IF或者DEF宏的外部Python可执行代码
pxd文件是在编译时访问的,不可以放置像def这种纯python声明,会产生编译问题
在pxd中定义结构和函数等,在pyx中实现,这两个文件必须有相同的基名称,cython将他们看成同一个命名空间,这样才能找得到
有了pxd文件以后pyx文件可以被其他pyx文件导入了
涉及到多个pyx文件,所以编译方式也要格外注意
from distutils.core import Extension, setup
from Cython.Build import cythonize
# 不用管 pxd, 会自动包含, 因为它们具有相同的基名称, cython 在编译的时候会自动寻找
ext = [Extension("caller", ["caller.pyx"]),
Extension("cython_test", ["cython_test.pyx"])]
setup(ext_modules=cythonize(ext, language_level=3))
主要就是如果涉及到多个pyx,那么这些pyx都要被编译,并且如果想被导入,那该pyx文件一定要有相应的pxd文件,导入的时候使用cimport。
如何相对导入pyd文件
在pyx文件中进行相对导入,相对导入举例:
将之前的 cython_test.pxd、cython_test.pyx、caller.pyx 放在一个单独目录中
caller.pyx中的绝对导入改为相对导入
from .cython_test cimport Girl
修改编译方式:
from distutils.core import setup, Extension
from Cython.Build import cythonize
# 注意: Extension 的第一个参数, 首先我们这个文件叫做 build_ext.py, 当前的目录层级如下
"""
当前目录:
cython_relative_demo:
caller.pyx
cython_test.pxd
cython_test.pyx
build_ext.py
"""
# 所以我们的 build_ext.py 和 cython_relative_demo 是同级的
# 然后我们在编译的时候, name(Extension 的第一个参数) 不可以指定为 caller、cython_test
# 如果这么做的话, 当代码中涉及到相对导入的时候, 在编译时就会报错: relative cimport beyond main package is not allowed
# cython 编译器要求, 你在编译 pyx 文件、指定模块名的时候, 也需要把该 pyx 文件所在的目录也带上
ext = [
Extension("cython_relative_demo.caller", sources=["cython_relative_demo/caller.pyx"]),
Extension("cython_relative_demo.cython_test", sources=["cython_relative_demo/cython_test.pyx"])
]
setup(ext_modules=cythonize(ext, language_level=3))
更复杂的pyx文件路径,分别在不同目录
修改caller.py:
# 应该将导入改成这样才行
from ..cython_test_dir.cython_test cimport Girl
修改编译时的文件:
from distutils.core import setup, Extension
from Cython.Build import cythonize
# 这里也是一样的道理, 因为我们这个编译用的文件和 cython_relative_demo 是同级的
# 所以在指定模块名的时候, 要从当前目录中的 cython_relative_demo 开始定位
ext = [
Extension("cython_relative_demo.caller_dir.caller",
sources=["cython_relative_demo/caller_dir/caller.pyx"]),
Extension("cython_relative_demo.cython_test_dir.cython_test",
sources=["cython_relative_demo/cython_test_dir/cython_test.pyx"])
]
# 同理, 如果我们哪天自己也编写一个开源的第三方库(假设叫 matsuri), 要将目录里面的 pyx 文件、或者目录里面的目录里面的 pyx 文件编译成 pyd 文件时候
# 也应该从库(matsuri)所在的目录进行编译, 然后从 matsuri 这一层开始进行文件定位, 即:
"""
ext = [Extension("matsur.xx.yy", sources=["matsur/xx/yy.pyx"]),
Extension("matsur.xx.xx.yy.zz", sources=["matsur/xx/xx/yy/zz.pyx"])
编译完成之后, 再将 pyd 文件拷贝到对应的 pyx 文件所在的位置
"""
setup(ext_modules=cythonize(ext, language_level=3))
如果是在windows平台,编译出来的是pyd文件,要将pyd文件拷贝到pyx文件所在的文件夹下
还可以使用include方式组织cython源代码
# cython_test1.pyx
cdef a = 123
# cython_test2.pyx
include "./cython_test1.pyx"
cdef b = 234
print(a + b)
导入错误
如果我们使用import和cimport导入具有相同名称的不同函数,cython会引发编译错误:
from libc.math cimport sin
from math import sin
"""
Error compiling Cython file:
------------------------------------------------------------
...
from libc.math cimport sin
from math import sin ^
------------------------------------------------------------
cython_test.pyx:2:17: Assignment to non-lvalue 'sin'
"""
应写成:
from libc.math cimport sin as c_sin
from math import sin as py_sin
print(c_sin(3.1415926 / 2))
print(py_sin(3.1415926 / 2))
导入模块是可以重名的