【问题标题】：Error exporting symbol when building Python C Extension in Windows在 Windows 中构建 Python C 扩展时导出符号时出错
【发布时间】：2016-04-13 20:29:39
【问题描述】：

我正在将 Python 模块移植到 Windows。我有一个玩具示例如下。

文件夹结构为：

foo/
  libfoo/
    foo.c
  setup.py

setup.py

from setuptools import setup, Extension

sources = ['libfoo/foo.c']

foo = Extension('libfoo',
                 sources = sources,
                 define_macros = None,
                 include_dirs = ['./libfoo'],
                 libraries = None,
                 library_dirs = None,
                 )

setup(name          = 'foo',
      ext_modules      = [foo],
      install_requires = ['setuptools'],
)

libfoo/foo.c（为了完整性）

#include <stdio.h>

void foo() {
  printf("Hello World!");
}

当我尝试安装包时，遇到错误。

C:\Users\user\foo>python setup.py install
running install
running bdist_egg
running egg_info
creating foo.egg-info
writing requirements to foo.egg-info\requires.txt
writing foo.egg-info\PKG-INFO
writing top-level names to foo.egg-info\top_level.txt
writing dependency_links to foo.egg-info\dependency_links.txt
writing manifest file 'foo.egg-info\SOURCES.txt'
reading manifest file 'foo.egg-info\SOURCES.txt'
writing manifest file 'foo.egg-info\SOURCES.txt'
installing library code to build\bdist.win32\egg
running install_lib
running build_ext
building 'libfoo' extension
creating build
creating build\temp.win32-2.7
creating build\temp.win32-2.7\Release
creating build\temp.win32-2.7\Release\libfoo
c:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\BIN\cl.exe /c /nologo /Ox
/MD /W3 /GS- /DNDEBUG -I./libfoo -IC:\Python27\include -IC:\Python27\PC /Tclibfo
o/foo.c /Fobuild\temp.win32-2.7\Release\libfoo/foo.obj
foo.c
creating build\lib.win32-2.7
c:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\BIN\link.exe /DLL /nologo
/INCREMENTAL:NO /LIBPATH:C:\Python27\libs /LIBPATH:C:\Python27\PCbuild /EXPORT:i
nitlibfoo build\temp.win32-2.7\Release\libfoo/foo.obj /OUT:build\lib.win32-2.7\l
ibfoo.pyd /IMPLIB:build\temp.win32-2.7\Release\libfoo\libfoo.lib /MANIFESTFILE:b
uild\temp.win32-2.7\Release\libfoo\libfoo.pyd.manifest
LINK : error LNK2001: unresolved external symbol initlibfoo
build\temp.win32-2.7\Release\libfoo\libfoo.lib : fatal error LNK1120: 1 unresolv
ed externals
error: command 'c:\\Program Files (x86)\\Microsoft Visual Studio 9.0\\VC\\BIN\\l
ink.exe' failed with exit status 1120

distutils 包（在本例中为 setuputils）似乎总是会从共享扩展中导出一个符号，即“init + extension_name”[Link]。

在 Windows 链接器“EXPORT”选项[Link] 中指定，但找不到符号。

帮助？

编辑：C 代码不使用 Python C API，即“#include”。这是因为该项目的目标是采用现有的 C 库并通过 Python 扩展将其封装在 Python 包装器中。该软件包适用于 Unix/Linux。

【问题讨论】：

您是否真的在尝试构建一个“libfoo”扩展模块，该模块需要在导入扩展时定义一个由 Python 调用的 initlibfoo 函数？还是您只是使用 setuptools 来编译共享库？如果是后者，您需要为 Windows DLL 做的第一件事是使用__declspec(dllexport) 或.DEF file 定义导出的符号。
@eryksun 我相信是后者。目的是在安装包时构建“libfoo”扩展。当解释器导入包“foo”即“import foo”时，类对象将加载 DLL（或 .pyd？）。如果这没有意义，请告诉我。
一个 .pyd 只是一个 DLL。听起来这就是你想要的，即 foo.pyd 链接到 libfoo.dll 并将函数包装在 libfoo.dll 中。从让 libfoo.dll 自己工作开始，只需从命令行手动构建它（无需 Python 或 setuptools）。然后按照creating an extension module 的文档进行操作。

标签： python windows linker setuptools python-extensions

【解决方案1】：

在玩了很多之后，我能够理解这个问题。

解决方案：在 Windows 中，您必须为您的扩展定义一个初始化函数，因为 setuptools 将构建一个 .pyd 文件，而不是一个 DLL

要在 Python 2 中解决此问题，请在源代码中定义 initlibfoo() 方法。

#include <Python.h>

PyMODINIT_FUNC initlibfoo(void) {
    // do stuff...
}

要在 Python 3 中解决此问题，请在源代码中定义 PyInit_libfoo() 方法。

#include <Python.h>

PyMODINIT_FUNC PyInit_libfoo(void) {
    // do stuff...
}

所以现在，foo.c 看起来像：

#include <stdio.h>
#include <Python.h>

void foo() {
  printf("Hello World!");
}

PyMODINIT_FUNC initlibfoo(void) // Python 2.7
//PyMODINIT_FUNC PyInit_libfoo(void) // Python 3.5
{
    // do stuff...
}

说明

在为 Windows 编译 Python 扩展时，Extension 类将告诉 linker to export a function 以供其他程序调用。这可以在终端输出中看到：

c:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\BIN\link.exe /DLL /nologo
/INCREMENTAL:NO /LIBPATH:C:\Python27\libs /LIBPATH:C:\Python27\PCbuild /EXPORT:i
nitlibfoo build\temp.win32-2.7\Release\libfoo/foo.obj /OUT:build\lib.win32-2.7\l
ibfoo.pyd /IMPLIB:build\temp.win32-2.7\Release\libfoo\libfoo.lib /MANIFESTFILE:b
uild\temp.win32-2.7\Release\libfoo\libfoo.pyd.manifest

（强调/EXPORT:initlibfoo）

现在这是 C/C++ 扩展的必需函数，以便它们可以作为模块导入。换句话说，当你 import libfoo Python 将调用 .pyd 上的函数 initlibfoo 作为模块初始化的一部分。这里遇到的错误是由于链接器被告知要导出函数initlibfoo，但是它在 C 目标文件中找不到该符号，因为它从未在源代码中定义！

当然，应该可以拒绝导出符号的选项，对吧？显然不是。回顾扩展类文档，有一个参数export_symbols。我尝试将None 传递给它，并且仍在使用链接器选项。似乎没有办法绕过这个链接器选项。

不推荐：如果出于某种原因，需要Python.h 困扰您，有办法解决这个问题。您仍然需要定义上面的“init”方法，但您可以这样做：

void initlibfoo() {} //Python 2.7
void PyInit_libfoo() {} //Python 3.5

但是现在，您不能通过import libfoo 使用该库。您可以使用 ctypes 模块并使用ctypes.PyDLL('/path/to/pyd') 加载它。本质上，您使用 Python 为您构建了一个 DLL，在这种情况下，它会构建一个称为 .pyd 文件的特殊 DLL。然后要使用它，你必须通过 ctypes 模块加载它。

【讨论】：

【解决方案2】：

另一种可能的解决方案：

from distutils.command.build_ext import build_ext as _du_build_ext
from unittest.mock import Mock
mockobj = _du_build_ext
mockobj.get_export_symbols = Mock(return_value=None)

【讨论】：

【解决方案3】：

只需要写一个函数，在不同的OS下将路径转换成对应的格式。（Windows 是 \\，类 Unix 是 /）。

【讨论】：

【解决方案4】：

我在这里设置了一个带有 ctypes 扩展的最小工作 python 包： https://github.com/himbeles/ctypes-example 它适用于 Windows、Mac、Linux 并且您不需要在 C/C++ 中包含 Python.h

需要approach of memeplex和of Tomasz Hemperek覆盖build_ext.get_export_symbols()。
它强制所有操作系统的库扩展名都相同 (.so)。
此外，c / c++ 源代码中的编译器指令可确保在 Windows 与 Unix 的情况下正确导出共享库符号。
作为奖励，二进制轮子由 GitHub Action 自动编译，适用于所有操作系统 :-)

【讨论】：