4. 構(gòu)建C/C++擴(kuò)展?

一個CPython的C擴(kuò)展是一個共享庫(例如一個Linux上的 .so ，或者Windows上的 .pyd )，其會導(dǎo)出一個 初始化函數(shù) 。

為了可導(dǎo)入，共享庫必須在 PYTHONPATH 中有效，且必須命名遵循模塊名字，通過適當(dāng)?shù)臄U(kuò)展。當(dāng)使用distutils時，會自動生成正確的文件名。

初始化函數(shù)的聲明如下：

PyObject *PyInit_modulename(void)?

該函數(shù)返回完整初始化過的模塊，或一個 PyModuleDef 實(shí)例。查看 Initializing C modules 了解更多細(xì)節(jié)。

對于僅有ASCII編碼的模塊名，函數(shù)必須是 PyInit_<modulename> ，將 <modulename> 替換為模塊的名字。當(dāng)使用 Multi-phase initialization 時，允許使用非ASCII編碼的模塊名。此時初始化函數(shù)的名字是 PyInitU_<modulename> ，而 <modulename> 需要用Python的 punycode 編碼，連字號需替換為下劃線。在Python里:

def initfunc_name(name):
    try:
        suffix = b'_' + name.encode('ascii')
    except UnicodeEncodeError:
        suffix = b'U_' + name.encode('punycode').replace(b'-', b'_')
    return b'PyInit' + suffix

可以在一個動態(tài)庫里導(dǎo)出多個模塊，通過定義多個初始化函數(shù)。而導(dǎo)入他們需要符號鏈接或自定義導(dǎo)入器，因?yàn)槿笔r只有對應(yīng)了文件名的函數(shù)才會被發(fā)現(xiàn)。查看 "一個庫里的多模塊" 章節(jié)，在 PEP 489 了解更多細(xì)節(jié)。

4.1. 使用distutils構(gòu)建C和C++擴(kuò)展?

擴(kuò)展模塊可以用distutils來構(gòu)建，這是Python自帶的。distutils也支持創(chuàng)建二進(jìn)制包，用戶無需編譯器而distutils就能安裝擴(kuò)展。

一個distutils包包含了一個驅(qū)動腳本 setup.py 。這是個純Python文件，大多數(shù)時候也很簡單，看起來如下：

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 ，運(yùn)行如下

python setup.py build

這會編譯 demo.c ，然后產(chǎn)生一個擴(kuò)展模塊叫做 demo 在目錄 build 里。依賴于系統(tǒng)，模塊文件會放在某個子目錄形如 build/lib.system ，名字可能是 demo.so 或 demo.pyd 。

在文件 setup.py 里，所有動作的入口通過 setup 函數(shù)。該函數(shù)可以接受可變數(shù)量個關(guān)鍵字參數(shù)，上面的例子只使用了一個子集。特別需要注意的例子指定了構(gòu)建包的元信息，以及指定了包內(nèi)容。通常一個包會包括多個模塊，就像Python的源碼模塊、文檔、子包等。請參數(shù)distutils的文檔，在 分發(fā) Python 模塊（遺留版本） 來了解更多distutils的特性；本章節(jié)只解釋構(gòu)建擴(kuò)展模塊的部分。

通常預(yù)計(jì)算參數(shù)給 setup() ，想要更好的結(jié)構(gòu)化驅(qū)動腳本。有如如上例子函數(shù) setup() 的 ext_modules 參數(shù)是一列擴(kuò)展模塊，每個是一個 Extension 類的實(shí)例。例子中的實(shí)例定義了擴(kuò)展命名為 demo ，從單一源碼文件構(gòu)建 demo.c 。

更多時候，構(gòu)建一個擴(kuò)展會復(fù)雜的多，需要額外的預(yù)處理器定義和庫。如下例子展示了這些。

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 = 'martin@v.loewis.de',
       url = 'https://docs.python.org/extending/building',
       long_description = '''
This is really just a demo package.
''',
       ext_modules = [module1])

例子中函數(shù) setup() 在調(diào)用時額外傳遞了元信息，是推薦發(fā)布包構(gòu)建時的內(nèi)容。對于這個擴(kuò)展，其指定了預(yù)處理器定義，include目錄，庫目錄，庫。依賴于編譯器，distutils還會用其他方式傳遞信息給編譯器。例如在Unix上，結(jié)果是如下編譯命令

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用戶應(yīng)該相信distutils能正確調(diào)用。

4.2. 發(fā)布你的擴(kuò)展模塊?

當(dāng)一個擴(kuò)展已經(jīng)成功地被構(gòu)建時，有三種方式來使用它。

最終用戶通常想要安裝模塊，可以這么運(yùn)行

python setup.py install

模塊維護(hù)者應(yīng)該制作源碼包；要實(shí)現(xiàn)可以運(yùn)行

python setup.py sdist

有些情況下，需要在源碼發(fā)布包里包含額外的文件；這通過 MANIFEST.in 文件實(shí)現(xiàn)，查看 Specifying the files to distribute 了解細(xì)節(jié)。

如果源碼發(fā)行包被成功地構(gòu)建，維護(hù)者還可以創(chuàng)建二進(jìn)制發(fā)行包。 取決于具體平臺，以下命令中的一個可以用來完成此任務(wù)

python setup.py bdist_rpm
python setup.py bdist_dumb