3. 使用 distutils 构建 C 和 C 扩展

从 Python 1.4 开始,Python 在 Unix 上提供了一个特殊的 make 文件,用于构建 make 文件,以构建动态链接的 extensions 和自定义解释器。从 Python 2.0 开始,不再支持该机制(与 Makefile.pre.in 和 Setup 文件相关)。很少使用构建自定义解释器,并且可以使用 distutils 来构建扩展模块。

使用 distutils 构建扩展模块需要将 distutils 安装在构建机器上,该机器包含在 Python 2.x 中,并且可单独用于 Python 1.5. 由于 distutils 也支持创建二进制软件包,因此用户不一定需要编译器和 distutils 来安装扩展。

distutils 软件包包含驱动程序脚本setup.py。这是一个普通的 Python 文件,在最简单的情况下,它可能如下所示:

from distutils.core import setup, Extension

module1 = Extension('demo',
                    sources = ['demo.c'])

setup (name = 'PackageName',
       version = '1.0',
       description = 'This is a demo package',
       ext_modules = [module1])

使用此setup.py和文件demo.c运行

python setup.py build

将编译demo.c,并在build目录中生成一个名为demo的扩展模块。根据系统的不同,模块文件finally将位于子目录build/lib.system中,并且名称可能类似于demo.sodemo.pyd

setup.py中,所有执行都pass调用setup函数执行。这需要可变数量的关键字参数,上面的示例仅使用其中一个子集。具体而言,该示例指定了用于构建程序包的元信息,并指定了程序包的内容。通常,一个软件包将包含其他模块,例如 Python 源模块,文档,子软件包等。请参阅分发 Python 模块(旧版)中的 distutils 文档,以了解有关 distutils Function的更多信息;本节仅说明构建扩展模块。

通常会预先计算setup()的参数,以更好地构建驱动程序脚本。在上面的示例中,setup()ext_modules参数是扩展模块的列表,每个扩展模块都是Extension的实例。在示例中,实例定义了一个名为demo的 extensions,该 extensions 是pass编译单个源文件demo.c来构建的。

在许多情况下,构建扩展更为复杂,因为可能需要其他预处理器定义和库。在下面的示例中对此进行了演示。

from distutils.core import setup, Extension

module1 = Extension('demo',
                    define_macros = [('MAJOR_VERSION', '1'),
                                     ('MINOR_VERSION', '0')],
                    include_dirs = ['/usr/local/include'],
                    libraries = ['tcl83'],
                    library_dirs = ['/usr/local/lib'],
                    sources = ['demo.c'])

setup (name = 'PackageName',
       version = '1.0',
       description = 'This is a demo package',
       author = 'Martin v. Loewis',
       author_email = '[email protected]',
       url = 'https://docs.python.org/extending/building',
       long_description = '''
This is really just a demo package.
''',
       ext_modules = [module1])

在此示例中,使用其他元信息调用setup(),这在必须构建分发程序包时建议使用。对于扩展本身,它指定了预处理程序定义,包括目录,库目录和库。根据编译器的不同,distutils 会将这些信息以不同的方式传递给编译器。例如,在 Unix 上,这可能会导致编译命令

gcc -DNDEBUG -g -O3 -Wall -Wstrict-prototypes -fPIC -DMAJOR_VERSION=1 -DMINOR_VERSION=0 -I/usr/local/include -I/usr/local/include/python2.2 -c demo.c -o build/temp.linux-i686-2.2/demo.o

gcc -shared build/temp.linux-i686-2.2/demo.o -L/usr/local/lib -ltcl83 -o build/lib.linux-i686-2.2/demo.so

这些行仅用于演示目的; distutils 用户应该相信 distutils 可以正确调用。

3.1. 分发扩展模块

成功构建扩展后,有三种使用方式。

finally用户通常希望pass运行以下命令来安装模块

python setup.py install

模块维护者应产生源程序包;为此,他们运行

python setup.py sdist

在某些情况下,其他文件需要包含在源分发中。这是passMANIFEST.in文件完成的;有关详细信息,请参见 distutils 文档。

如果已成功构建源分发,则维护者还可以创建二进制分发。根据平台的不同,可以使用以下命令之一。

python setup.py bdist_wininst
python setup.py bdist_rpm
python setup.py bdist_dumb