Python 的 setup.py 详解
1. 為什么需要對項目分發(fā)打包？
平常我們習慣了使用 pip 來安裝一些第三方模塊，這個安裝過程之所以簡單，是因為模塊開發(fā)者為我們默默地為我們做了所有繁雜的工作，而這個過程就是 打包。
打包，就是將你的源代碼進一步封裝，并且將所有的項目部署工作都事先安排好，這樣使用者拿到后即裝即用，不用再操心如何部署的問題（如果你不想對照著一堆部署文檔手工操作的話）。
不管你是在工作中，還是業(yè)余準備自己寫一個可以上傳到 PyPI 的項目，你都要學會如何打包你的項目。
Python 發(fā)展了這么些年了，項目打包工具也已經很成熟了。他們都有哪些呢？
你可能聽過 disutils、 distutils 、distutils2、setuptools等等，好像很熟悉，卻又很陌生，他們都是什么關系呢？
2. 包分發(fā)的始祖：distutils
distutils 是 Python 的一個標準庫，從命名上很容易看出它是一個分發(fā)（distribute）工具（utlis），它是 Python 官方開發(fā)的一個分發(fā)打包工具，所有后續(xù)的打包工具，全部都是基于它進行開發(fā)的。
distutils 的精髓在于編寫 setup.py，它是模塊分發(fā)與安裝的指導文件。
那么如何編寫 setup.py 呢？這里面的內容非常多，我會在后面進行詳細的解析，請你耐心往下看。
你有可能沒寫過 setup.py ，但你絕對使用過 setup.py 來做一些事情，比如下面這條命令，我們經常用它來進行模塊的安裝。
python setup.py install這樣的安裝方法是通過源碼安裝，與之對應的是通過二進制軟件包的安裝，同樣我也會在后面進行介紹。
3. 分發(fā)工具升級：setuptools
setuptools 是 distutils 增強版，不包括在標準庫中。其擴展了很多功能，能夠幫助開發(fā)者更好的創(chuàng)建和分發(fā) Python 包。大部分 Python 用戶都會使用更先進的 setuptools 模塊。
distribute，或許你在其他地方也見過它，這里也提一下。
distribute 是 setuptools 有一個分支版本，分支的原因可能是有一部分開發(fā)者認為 setuptools 開發(fā)太慢了。但現在，distribute 又合并回了 setuptools 中。因此，我們可以認為它們是同一個東西。
還有一個大包分發(fā)工具是 distutils2，其試圖嘗試充分利用distutils，setuptools 和 distribute 并成為 Python 標準庫中的標準工具。但該計劃并沒有達到預期的目的，且已經是一個廢棄的項目。
因此，setuptools 是一個優(yōu)秀的，可靠的 Python 包安裝與分發(fā)工具。
那么如何在一個干凈的環(huán)境中安裝 setuptools 呢？
主要有兩種方法：
- 源碼安裝：在 https://pypi.org/project/setuptools/#files 中下載 zip 包 解壓執(zhí)行 python setup.py install安裝。
- 通過引導程序安裝：下載引導程序，它可以用來下載或者更新最新版本的 setuptools：
4. easy_install 使用指南
當你安裝完 setuptools 后，就擁有了一個叫做 easy_install 的第三方管理工具，這也是它區(qū)分于 distutils 的一大改進。
這里簡單介紹一下它的用法，雖然它已經用得非常少了。
先是包的安裝
# 通過包名，從PyPI尋找最新版本，自動下載、編譯、安裝 $ easy_install pkg_name# 通過包名從指定下載頁尋找鏈接來安裝或升級包 $ easy_install -f http://pythonpaste.org/package_index.html # 指定線上的包地址安裝 $ easy_install http://example.com/path/to/MyPackage-1.2.3.tgz# 從本地的 .egg 文件安裝 $ easy_install xxx.egg# 在安裝時你可以添加額外的參數 指定安裝目錄：--install-dir=DIR, -d DIR 指定用戶安裝：--user再是包的升級
# 從 pypi 中搜索并升級包 $ easy_install --upgrade pkg_name# 指定版本進行升級 $ easy_install "SomePackage==2.0"最后是包的刪除：
$ easy_install -m pkg_name需要注意的是，這樣的刪除，僅是在 easy-install.pth 文件中刪除，使其不能在 python 中使用 這個模塊，但實際的包還在你的電腦中，若要刪除徹底，需要你手動刪除相關的 .egg 及 其他文件。
默認情況下，easy_install 只會從 pypi 上下載相關軟件包，由于這個源在國外，下載包的速度并不理想，使用過pip的朋友自然會想，easy_install 是否能指定源進行安裝呢？
答案是，可以的。
編輯配置文件 /root/.pydistutils.cfg
[easy_install] index-url=http://mirrors.aliyun.com/pypi/simple/ find-links=http://mirrors.aliyun.com/pypi/simple/以上僅介紹了 easy_install 的一些常用的方法，想要了解更多，你可以點擊官方文檔：https://setuptools.readthedocs.io/en/latest/easy_install.html
總結一句：setuptools 是官方提供的一個專業(yè)用于包分發(fā)的工具，若只從安裝的角度來看，它的功能確實簡單。它更大的意義是對包的分發(fā)很有用，定制化程序非常高，我們現在也還在用它進行版本包的發(fā)布。
5. 源碼包與二進制包有什么區(qū)別？
Python 包的分發(fā)可以分為兩種：
源碼包安裝的過程，是先解壓，再編譯，最后才安裝，所以它是跨平臺的，由于每次安裝都要進行編譯，相對二進包安裝方式來說安裝速度較慢。
源碼包的本質是一個壓縮包，其常見的格式有：
| zip | .zip |
| gztar | .tar.gz |
| bztar | .tar.bz2 |
| ztar | .tar.Z |
| tar | .tar |
二進制包的安裝過程省去了編譯的過程，直接進行解壓安裝，所以安裝速度較源碼包來說更快。
由于不同平臺的編譯出來的包無法通用，所以在發(fā)布時，需事先編譯好多個平臺的包。
二進制包的常見格式有：
| egg | .egg |
| wheel | .whl |
6. eggs 和 wheels 有什么區(qū)別？
Egg 格式是由 setuptools 在 2004 年引入，而 Wheel 格式是由 PEP427 在 2012 年定義。Wheel 的出現是為了替代 Egg，它的本質是一個zip包，其現在被認為是 Python 的二進制包的標準格式。
以下是 Wheel 和 Egg 的主要區(qū)別：
-
Wheel 有一個官方的 PEP427 來定義，而 Egg 沒有 PEP 定義
-
Wheel 是一種分發(fā)格式，即打包格式。而 Egg 既是一種分發(fā)格式，也是一種運行時安裝的格式，并且是可以被直接 import
-
Wheel 文件不會包含 .pyc 文件
-
Wheel 使用和 PEP376 兼容的 .dist-info 目錄，而 Egg 使用 .egg-info 目錄
-
Wheel 有著更豐富的命名規(guī)則。
-
Wheel 是有版本的。每個 Wheel 文件都包含 wheel 規(guī)范的版本和打包的實現
-
Wheel 在內部被 sysconfig path type 管理，因此轉向其他格式也更容易
wheel 包可以通過 pip 來安裝，只不過需要先安裝 wheel 模塊，然后再使用 pip 的命令。
$ pip install wheel $ pip wheel --wheel-dir=/local/wheels pkg7. 詳解 setup.py 的編寫
打包分發(fā)最關鍵的一步是編寫 setup.py文件。
以下是一個 setup.py 簡單的使用示例：
from setuptools import setup, find_packagessetup(name="mytest",version="1.0",author="wangbm",author_email="wongbingming@163.com",description="Learn to Pack Python Module -->公眾號：Python編程時光",# 項目主頁url="http://iswbm.com/", # 你要安裝的包，通過 setuptools.find_packages 找到當前目錄下有哪些包packages=find_packages() )接下來，我將慢慢擴充這個setup函數，增加更多的參數，以便你能理解setup函數能做哪些事情。
程序分類信息
classifiers參數說明包的分類信息。所有支持的分類列表見：https://pypi.org/pypi?%3Aaction=list_classifiers
示例：
from setuptools import setup, find_packagessetup(classifiers = [# 發(fā)展時期,常見的如下# 3 - Alpha# 4 - Beta# 5 - Production/Stable'Development Status :: 3 - Alpha',# 開發(fā)的目標用戶'Intended Audience :: Developers',# 屬于什么類型'Topic :: Software Development :: Build Tools',# 許可證信息'License :: OSI Approved :: MIT License',# 目標 Python 版本'Programming Language :: Python :: 2','Programming Language :: Python :: 2.7','Programming Language :: Python :: 3','Programming Language :: Python :: 3.3','Programming Language :: Python :: 3.4','Programming Language :: Python :: 3.5',] )關于文件的分發(fā)
from setuptools import setup, find_packagessetup(name="mytest",version="1.0",author="wangbm",author_email="wongbingming@163.com",description="Learn to Pack Python Module",url="http://iswbm.com/", packages=find_packages(),# 安裝過程中，需要安裝的靜態(tài)文件，如配置文件、service文件、圖片等data_files=[('', ['conf/*.conf']),('/usr/lib/systemd/system/', ['bin/*.service']),],# 希望被打包的文件package_data={'':['*.txt'],'bandwidth_reporter':['*.txt']},# 不打包某些文件exclude_package_data={'bandwidth_reporter':['*.txt']} )除了以上的參數配置之外，還可以使用一個叫做 MANIFEST.in的文件，來控制文件的分發(fā)。
如下這是一個 MANIFEST.in的樣例：
include *.txt recursive-include examples *.txt *.py prune examples/sample?/build這些配置，規(guī)定了如下幾點：
-
所有根目錄下的以 txt 為后綴名的文件，都會分發(fā)
-
根目錄下的 examples 目錄 和 txt、py文件都會分發(fā)
-
路徑匹配上 examples/sample?/build 不會分發(fā)
MANIFEST.in需要放在和 setup.py 同級的頂級目錄下，setuptools 會自動讀取該文件。
關于依賴包下載安裝
from setuptools import setup, find_packagessetup(...# 表明當前模塊依賴哪些包，若環(huán)境中沒有，則會從pypi中下載安裝install_requires=['docutils>=0.3'],# setup.py 本身要依賴的包，這通常是為一些setuptools的插件準備的配置# 這里列出的包，不會自動安裝。setup_requires=['pbr'],# 僅在測試時需要使用的依賴，在正常發(fā)布的代碼中是沒有用的。# 在執(zhí)行python setup.py test時，可以自動安裝這三個庫，確保測試的正常運行。tests_require=['pytest>=3.3.1','pytest-cov>=2.5.1',],# 用于安裝setup_requires或tests_require里的軟件包# 這些信息會寫入egg的 metadata 信息中dependency_links=["http://example2.com/p/foobar-1.0.tar.gz",],# install_requires 在安裝模塊時會自動安裝依賴包# 而 extras_require 不會，這里僅表示該模塊會依賴這些包# 但是這些包通常不會使用到，只有當你深度使用模塊時，才會用到，這里需要你手動安裝extras_require={'PDF': ["ReportLab>=1.2", "RXP"],'reST': ["docutils>=0.3"],} )關于 install_requires， 有以下五種常用的表示方法：
-'argparse'，只包含包名。這種形式只檢查包的存在性，不檢查版本。方便，但不利于控制風險。
-
'setuptools==38.2.4'，指定版本。這種形式把風險降到了最低，確保了開發(fā)、測試與部署的版本一致，不會出現意外。缺點是不利于更新，每次更新都需要改動代碼。
-
'docutils >= 0.3'，這是比較常用的形式。當對某個庫比較信任時，這種形式可以自動保持版本為最新。
-
'Django >= 1.11, != 1.11.1, <= 2'，這是比較復雜的形式。如這個例子，保證了Django的大版本在1.11和2之間，也即1.11.x；并且，排除了已知有問題的版本1.11.1（僅舉例）。對于一些大型、復雜的庫，這種形式是最合適的。
-
'requests[security, socks] >= 2.18.4'，這是包含了額外的可選依賴的形式。正常安裝requests會自動安裝它的install_requires中指定的依賴，而不會安裝security和socks這兩組依賴。這兩組依賴是定義在它的extras_require中。這種形式，用在深度使用某些庫時。
關于安裝環(huán)境的限制
有些庫并不是在所有的 Python 版本中都適用的，若一個庫安裝在一個未兼容的 Python 環(huán)境中，理論上不應該在使用時才報錯，而應該在安裝過程就使其失敗，提示禁止安裝。
這樣的功能，可以使用 python_requires來實現。
setup(...python_requires='>=2.7, <=3', )生成可執(zhí)行文件的分發(fā)
from setuptools import setup, find_packagessetup(name="mytest",version="1.0",author="wangbm",author_email="wongbingming@163.com",description="Learn to Pack Python Module",url="http://iswbm.com/", packages=find_packages(),# 用來支持自動生成腳本，安裝后會自動生成 /usr/bin/foo 的可執(zhí)行文件# 該文件入口指向 foo/main.py 的main 函數entry_points={'console_scripts': ['foo = foo.main:main']},# 將 bin/foo.sh 和 bar.py 腳本，生成到系統(tǒng) PATH中# 執(zhí)行 python setup.py install 后# 會生成 如 /usr/bin/foo.sh 和 如 /usr/bin/bar.pyscripts=['bin/foo.sh', 'bar.py'] )上面的 scripts 里有的腳本中有 sh和 py后綴，那么安裝后，setuptools 會原封不動的移動到 /usr/bin 中，并添加可執(zhí)行權限。
若你想對這些文件再作一些更改，比如去掉多余的后綴，可以這樣做
from setuptools.command.install_scripts import install_scriptsclass InstallScripts(install_scripts):def run(self):setuptools.command.install_scripts.install_scripts.run(self)# Rename some script filesfor script in self.get_outputs():if basename.endswith(".py") or basename.endswith(".sh"):dest = script[:-3]else:continueprint("moving %s to %s" % (script, dest))shutil.move(script, dest)setup(...scripts=['bin/foo.sh', 'bar.py'],cmdclass={"install_scripts": InstallScripts} )ext_modules
ext_modules參數用于構建 C 和 C++ 擴展擴展包。其是 Extension 實例的列表，每一個 Extension 實例描述了一個獨立的擴展模塊，擴展模塊可以設置擴展包名，頭文件、源文件、鏈接庫及其路徑、宏定義和編輯參數等。如：
setup(# other arguments here...ext_modules=[Extension('foo',glob(path.join(here, 'src', '*.c')),libraries = [ 'rt' ],include_dirs=[numpy.get_include()])] )詳細了解可參考：https://docs.python.org/3.6/distutils/setupscript.html#preprocessor-options
指定 release
setup.py 里只能指定 version，而不能指定 release，如果你需要變更版本號，可以使用 --release參數進行指定
python setup.py bdist_rpm --release=20200617setup.py 的參數非常多，能夠不借助文檔寫好一個setup.py好像沒那么簡單。為了備忘，我整理了 setup 函數常用的一些參數：
更多參數可見：https://setuptools.readthedocs.io/en/latest/setuptools.html
8. 打包輔助器 PBR
pbr是 setuptools 的輔助工具，最初是為 OpenStack 開發(fā)(https://launchpad.net/pbr)，基于d2to1。
pbr會讀取和過濾setup.cfg中的數據，然后將解析后的數據提供給 setup.py作為參數。包含如下功能：
這里需要注意，在 requirements.txt文件的頭部可以使用：--index https://pypi.python.org/simple/，這一行把一個抽象的依賴聲明如 requests==1.2.0 轉變?yōu)橐粋€具體的依賴聲明 requests 1.2.0 from pypi.python.org/simple/
使用pbr很簡單：
from setuptools import setupsetup(setup_requires=['pbr'],pbr=True, )使用pbr時，setup.cfg中有一些配置。在[files]中，有三個key：
- packages: 指定需要包含的包，行為類似于setuptools.find_packages。
- namespace_packages: 指定namespace packages。
- data_files: 指定目的目錄和源文件路徑。
一個示例：
[files] data_files =etc/pbr = etc/pbr/*etc/neutron =etc/api-paste.inietc/dhcp-agent.inietc/init.d = neutron.init[entry_points]段跟 setuptools 的方式相同。
到此，我講了三種編寫使用 setup.py 的方法
-
使用命令行參數指定，一個一個將參數傳遞進去（極不推薦）
-
在 setup.py 中的setup函數中指定（推薦使用）
-
使用 pbr ，在 setup.cfg 中指定（易于管理，更推薦
9. 使用 setup.py 構建包
構建源碼發(fā)布包
用于發(fā)布一個 Python 模塊或項目，將源碼打包成 tar.gz （用于 Linux 環(huán)境中）或者 zip 壓縮包（用于 Windows 環(huán)境中）。
$ python setup.py sdist那這種包如何安裝呢？
答案是，使用下一節(jié)即將介紹的 setuptools 中提供的 easy_install 工具。
$ easy_install xxx.tar.gz使用 sdist 將根據當前平臺創(chuàng)建默認格式的存檔。在類 Unix 平臺上，將創(chuàng)建后綴后為 .tar.gz 的 gzip 壓縮的tar文件分發(fā)包，而在Windows上為 ZIP 文件。
當然，你也可以通過指定你要的發(fā)布包格式來打破這個默認行為：
$ python setup.py sdist --formats=gztar,zip你可以指定的格式有哪些呢？
創(chuàng)建一個壓縮的tarball和一個zip文件?？捎酶袷綖?#xff1a;
對以上的格式，有幾點需要注意一下：
-
在版本3.5中才添加了對 xztar 格式的支持
-
zip 格式需要你事先已安裝相應的模塊：zip程序或zipfile模塊（已成為Python的標準庫）
-
ztar 格式正在棄用，請盡量不要使用
另外，如果您希望歸檔文件的所有文件歸root擁有，可以這樣指定
python setup.py sdist --owner=root --group=root構建二進制分發(fā)包
在windows中我們習慣了雙擊 exe 進行軟件的安裝，Python 模塊的安裝也同樣支持 打包成 exe 這樣的二進制軟件包。
$ python setup.py bdist_wininst而在 Linux 中，大家也習慣了使用 rpm 來安裝包，對此你可以使用這條命令實現 rpm 包的構建
$ python setup.py bdist_rpm若你喜歡使用 easy_install 或者 pip 來安裝離線包。你可以將其打包成 egg 包
$ python setup.py bdist_egg若你的項目，需要安裝多個平臺下，既有 Windows 也有 Linux，按照上面的方法，多種格式我們要執(zhí)行多次命令，為了方便，你可以一步到位，執(zhí)行如下這條命令，即可生成多個格式的進制包
$ python setup.py bdist10. 使用 setup.py 安裝包
正常情況下，我們都是通過以上構建的源碼包或者二進制包進行模塊的安裝。
但在編寫 setup.py 的過程中，可能不能一步到位，需要多次調試，這時候如何測試自己寫的 setup.py 文件是可用的呢？
這時候你可以使用這條命令，它會將你的模塊安裝至系統(tǒng)全局環(huán)境中
$ python setup.py install如若你的項目還處于開發(fā)階段，頻繁的安裝模塊，也是一個麻煩事。
這時候你可以使用這條命令安裝，該方法不會真正的安裝包，而是在系統(tǒng)環(huán)境中創(chuàng)建一個軟鏈接指向包實際所在目錄。這邊在修改包之后不用再安裝就能生效，便于調試。
$ python setup.py develop11. 發(fā)布到 PyPi
通過上面的學習，你一定已經學會了如何打包自己的項目，若你覺得自己開發(fā)的模塊非常不錯，想要 share 給其他人使用，你可以將其上傳到 PyPi （Python Package Index）上，它是 Python 官方維護的第三方包倉庫，用于統(tǒng)一存儲和管理開發(fā)者發(fā)布的 Python 包。
如果要發(fā)布自己的包，需要先到 pypi 上注冊賬號。然后創(chuàng)建 ~/.pypirc文件，此文件中配置 PyPI 訪問地址和賬號。如的.pypirc文件內容請根據自己的賬號來修改。
典型的 .pypirc 文件
[distutils] index-servers = pypi[pypi] username:xxx password:xxx然后使用這條命令進行信息注冊，完成后，你可以在 PyPi 上看到項目信息。
$ python setup.py register注冊完了后，你還要上傳源碼包，別人才使用下載安裝
$ python setup.py upload或者也可以使用 twine 工具注冊上傳，它是一個專門用于與 pypi 進行交互的工具，詳情可以參考官網：https://www.ctolib.com/twine.html，這里不詳細講了。
參考文章
-
http://blog.konghy.cn/2018/04/29/setup-dot-py/
-
https://note.qidong.name/2018/01/python-setup-requires/
總結
以上是生活随笔為你收集整理的Python 的 setup.py 详解的全部內容，希望文章能夠幫你解決所遇到的問題。
