有一個(gè)這樣的問題:現(xiàn)要用 setuptools 把一個(gè)項(xiàng)目打包成 whl 文件,然后 pip install 在 Windows/Linux 兩種操作系統(tǒng)上,但是該項(xiàng)目中有一些依賴庫只有 Windows 上才有(例如 pywinauto诱鞠、pywingui、pywinrm)这敬,那么問題是航夺,如何實(shí)現(xiàn)打包文件的可兼容性安裝?
從打包的角度崔涂,這個(gè)問題的關(guān)鍵還是看 setup.py 和 requirements.txt 文件阳掐。
關(guān)于 Python 的包構(gòu)建分發(fā)和 setup.py 的使用,這里有篇文章 寫得很好冷蚂,推薦閱讀缭保。另外關(guān)于 Python 依賴庫的管理(requirements.txt),這篇文章 詳細(xì)比較了 pip蝙茶、pipreqs艺骂、pigar、pip-tools 和 pipdeptree 等工具隆夯,也推薦一讀钳恕。
有一個(gè)比較笨的實(shí)現(xiàn)方法:維護(hù)兩份 requirements.txt 文件,分別用來打包蹄衷,然后分發(fā)給不同操作系統(tǒng)去使用苞尝。
但是這樣會(huì)有麻煩:維護(hù)兩份依賴文件和兩種包文件,本身就挺費(fèi)勁的,而在生成過程中,每次還得對(duì)它們改名以作區(qū)分(注意包名有一定的規(guī)范約束睛廊,亂改的話,pip 可能識(shí)別不出)抡砂,維護(hù)成本就很高。
其實(shí)恬涧,維護(hù)軟件包在不同操作系統(tǒng)的版本注益,并不少見。如果你曾留意過不同版本 Python 庫文件的話溯捆,你會(huì)注意到很多庫都會(huì)按不同操作系統(tǒng)而分發(fā)不同的版本丑搔。例如,下面是同一版本號(hào)的 Numpy 在不同操作系統(tǒng)上的分發(fā)版(https://pypi.org/simple/numpy/):
可以看出它根據(jù) macos、linux 和 win 三類操作系統(tǒng)及其位數(shù)啤月,分成了 5 個(gè)版本煮仇。維護(hù)這么多版本,肯定是一件麻煩事谎仲,但是出現(xiàn)了這樣的結(jié)果浙垫,就意味著 Numpy 官方認(rèn)為分發(fā)不同系統(tǒng)版本是利大于弊的,而且是有辦法實(shí)現(xiàn)的郑诺。
回到我們的問題夹姥,是否有必要像 Numpy 那樣設(shè)法打包成多個(gè)操作系統(tǒng)定制的包呢?
答案是否定的辙诞。主要的原因:
- Numpy 這么做是因?yàn)樗亲隹茖W(xué)計(jì)算的辙售,為了提升效率,它把編譯好的 C 拓展文件打包飞涂,從而不需要依賴環(huán)境上的 libxxx-devel 之類的庫圾亏。如果你編譯安裝過 Python,應(yīng)該有印象需要安裝 zlib-devel封拧、openssl-devel 和 libffi-devel 之類的系統(tǒng)依賴。但我們前面的問題比較簡(jiǎn)單夭问,并不是有不同的編譯依賴(系統(tǒng)級(jí))泽西,而只是三方庫依賴不同(項(xiàng)目級(jí))。
- 另一個(gè)主要的原因缰趋,Numpy 打包出的不同系統(tǒng)版本捧杉,并非簡(jiǎn)簡(jiǎn)單單地用 setuptools 之類的 Python 庫就能打包,而是要借助標(biāo)準(zhǔn)的鏡像進(jìn)行構(gòu)建秘血。例如味抖,manylinux 版本的打包,參見 Github(https://github.com/pypa/manylinux)灰粮,就需要使用官方提供的 Docker 鏡像仔涩。對(duì)于我們的問題,顯然不想做到這么麻煩粘舟。
簡(jiǎn)而言之熔脂,根據(jù)前面的分析,如果要實(shí)現(xiàn)操作系統(tǒng)兼容的打包柑肴,維護(hù)多份依賴文件霞揉、使用不同構(gòu)建包的方法、維護(hù)多系統(tǒng)專用的包晰骑,方法可行适秩,但并不是很適用。
如果沒有新的辦法,這不失為一種考慮秽荞,但是有沒有別的辦法了呢骤公?
我曾被這個(gè)問題困擾過,但是沒有深入去研究解決蚂会,直到無意中在loguru
這個(gè)用來記錄日志的庫的 setup.py 中看到:
再翻看大名鼎鼎的requests
庫文件淋样,發(fā)現(xiàn)還可以這樣寫:
兩個(gè)示例都是寫在 setup.py 文件中,其實(shí)如果我們用 requirements.txt 文件胁住,也可以按這種格式寫趁猴,然后再讀取進(jìn)來。
這種神奇的寫法是怎么回事呢彪见?
它的依據(jù)是 2015 年 11 月創(chuàng)建的 PEP-508(以及相關(guān)的但已被撤銷或拒絕了的 PEP-390儡司、PEP-426、PEP-459余指、PEP-496)捕犬,該 PEP 的主要意圖是增強(qiáng) pip 等工具查找軟件包的能力。
比較重要的部分就是跟我們的問題相關(guān)的酵镜,即對(duì)操作系統(tǒng)作區(qū)分的標(biāo)識(shí)碉碉,相關(guān)的有:
有了這樣的擴(kuò)展支持,在打包依賴項(xiàng)時(shí)淮韭,就可以解決兼容性問題了垢粮。
例如 colorama 庫,如果我們只在 win32 系統(tǒng)才需要依賴靠粪,那么在打包時(shí)就可以指定:“colorama>=0.3.4 ; sys_platform=='win32' ”蜡吧;如果不需要限定 win32 系統(tǒng),而是在 windows 環(huán)境都安裝占键,那么可以寫成“colorama>=0.3.4 ; platform_system=='Windows' ”昔善。
最終,我們解決了本文開頭的問題畔乙。這個(gè)問題可能比較小眾君仆,解決起來也沒有什么大文章可做,算是一個(gè)小小的 tips 分享給大家吧牲距。