在了解setup.py之前，有必要介紹一下python庫分發(fā)打包的前世今生。

1. 為什么需要對項目分發(fā)打包?

平常我們習(xí)慣了使用 pip 來安裝一些第三方模塊，這個安裝過程之所以簡單，是因為模塊開發(fā)者為我們默默地為我們做了所有繁雜的工作，而這個過程就是  打包。

打包，就是將你的源代碼進(jìn)一步封裝，并且將所有的部署工作都事先安排好，這樣使用者拿到后即裝即用，不用再操心如何部署的問題(如果你不想對照著一堆部署文檔手工操作的話)。

Python 發(fā)展了這么些年了，項目打包工具也已經(jīng)很成熟了。他們都有哪些呢?

你可能聽過 disutils、 distutils 、distutils2、setuptools等等，好像很熟悉，卻又很陌生，他們都是什么關(guān)系呢?

2. 包分發(fā)的始祖：distutils

distutils 是 Python 的一個標(biāo)準(zhǔn)庫，從命名上很容易看出它是一個分發(fā)(distribute)工具(utlis)，它是 Python  官方開發(fā)的一個分發(fā)打包工具，所有后續(xù)的打包工具，全部都是基于它進(jìn)行開發(fā)的。

distutils 的精髓在于編寫 setup.py，它是模塊分發(fā)與安裝的指導(dǎo)文件。

那么如何編寫 setup.py 呢?這里面的內(nèi)容非常多，我會在后面進(jìn)行詳細(xì)的解析，請你耐心往下看。

你有可能沒寫過 setup.py ，但你絕對使用過 setup.py 來做一些事情，比如下面這條命令，我們經(jīng)常用它來進(jìn)行模塊的安裝。

$?python?setup.py?install

這樣的安裝方法叫源碼安裝，與之對應(yīng)的是通過二進(jìn)制軟件包安裝，同樣我也會在后面進(jìn)行介紹。

3. 分發(fā)工具升級：setuptools

setuptools 是 distutils 增強(qiáng)版，不包括在標(biāo)準(zhǔn)庫中。其擴(kuò)展了很多功能，能夠幫助開發(fā)者更好的創(chuàng)建和分發(fā) Python 包。大部分  Python 用戶都會使用更先進(jìn)的 setuptools 模塊。

distribute，或許你在其他地方也見過它，這里也提一下。

distribute 是 setuptools 有一個分支版本，分支的原因可能是有一部分開發(fā)者認(rèn)為 setuptools  開發(fā)太慢了。但現(xiàn)在，distribute 又合并回了 setuptools 中。因此，我們可以認(rèn)為它們是同一個東西。

還有一個大包分發(fā)工具是 distutils2，其試圖嘗試充分利用distutils，detuptools 和 distribute 并成為 Python  標(biāo)準(zhǔn)庫中的標(biāo)準(zhǔn)工具。但該計劃并沒有達(dá)到預(yù)期的目的，且已經(jīng)是一個廢棄的項目。

因此，setuptools 是一個優(yōu)秀的，可靠的 Python 包安裝與分發(fā)工具。

通過pycharm創(chuàng)建虛擬環(huán)境時，都會默認(rèn)安裝setuptools工具。

4. easy_install 使用指南

當(dāng)你安裝完 setuptools 后，就擁有了一個叫做 easy_install 的第三方管理工具，這也是它區(qū)分于 distutils  的一大改進(jìn)。

這里簡單介紹一下它的用法，雖然它已經(jīng)用得非常少了。

先是包的安裝

安裝
# 通過包名，從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  
# 在安裝時你可以添加額外的參數(shù) 指定安裝目錄：--install-dir=DIR, -d DIR 指定用戶安裝：--user
 
升級
# 從 pypi 中搜索并升級包 
$ easy_install --upgrade pkg_name  
# 指定版本進(jìn)行升級 
$ easy_install "SomePackage==2.0"

刪除
$ easy_install -m pkg_name

總結(jié)一句：setuptools  是官方提供的一個專業(yè)用于包分發(fā)的工具，若只從安裝的角度來看，它的功能確實簡單。它更大的意義是對包的分發(fā)很有用，定制化程序非常高，我們現(xiàn)在也還在用它進(jìn)行版本包的發(fā)布。

5. 源碼包與二進(jìn)制包什么區(qū)別?

Python 包的分發(fā)可以分為兩種：

以源碼包的方式發(fā)布

以二進(jìn)制包形式發(fā)布

以源碼包的方式發(fā)布

安裝以源碼包方式發(fā)布的包的過程，是先解壓，再編譯，最后才安裝（上面提到的python setup.py install），所以它是跨平臺的，由于每次安裝都要進(jìn)行編譯，相對二進(jìn)包安裝方式來說安裝速度較慢。

源碼包的本質(zhì)是一個壓縮包，其常見的格式有：

以二進(jìn)制包形式發(fā)布

二進(jìn)制包的安裝過程省去了編譯的過程，直接進(jìn)行解壓安裝，所以安裝速度較源碼包來說更快。

由于不同平臺的編譯出來的包無法通用，所以在發(fā)布時，需事先編譯好多個平臺的包。

二進(jìn)制包的常見格式有：

eggs 與 wheels 有什么區(qū)別?

Egg 格式是由 setuptools 在 2004 年引入，而 Wheel 格式是由 PEP427 在 2012 年定義。Wheel 的出現(xiàn)是為了替代  Egg，它的本質(zhì)是一個zip包，其現(xiàn)在被認(rèn)為是 Python 的二進(jìn)制包的標(biāo)準(zhǔn)格式。

以下是 Wheel 和 Egg 的主要區(qū)別：

• Wheel 有一個官方的 PEP427 來定義，而 Egg 沒有 PEP 定義
• Wheel 是一種分發(fā)格式，即打包格式。而 Egg 既是一種分發(fā)格式，也是一種運(yùn)行時安裝的格式，并且是可以被直接 import
• Wheel 文件不會包含 .pyc 文件
• Wheel 使用和 PEP376 兼容的 .dist-info 目錄，而 Egg 使用 .egg-info 目錄
• Wheel 有著更豐富的命名規(guī)則。
• Wheel 是有版本的。每個 Wheel 文件都包含 wheel 規(guī)范的版本和打包的實現(xiàn)
• Wheel 在內(nèi)部被 sysconfig path type 管理，因此轉(zhuǎn)向其他格式也更容易
• wheel 包可以通過 pip 來安裝，只不過需要先安裝 wheel 模塊，然后再使用 pip 的命令。

$ pip install wheel $ pip wheel --wheel-dir=/local/wheels pkg

下面進(jìn)入正題：setup.py

1. 超詳細(xì)講解 setup.py 的編寫

打包分發(fā)最關(guān)鍵的一步是編寫 setup.py 文件。

以下是一個 setup.py 簡單的使用示例

from setuptools import setup, find_packages
  setup(            
     name="mytest",     
     version="1.0",     
     author="name",     
     author_email="name@163.com",    
     # 項目地址 
     url="https://github.com/test/mytest",
     description="Learn to Pack Python Module",             
     # 你要安裝的包，通過 setuptools.find_packages 自動發(fā)現(xiàn)當(dāng)前目錄下有哪些包     
     packages=find_packages()
)

接下來，我將慢慢擴(kuò)充這個setup函數(shù)，增加更多的參數(shù)，以便你能理解setup函數(shù)能做哪些事情。

 關(guān)于安裝環(huán)境的限制

有些庫并不是在所有的 Python 版本中都適用的，若一個庫安裝在一個未兼容的 Python  環(huán)境中，理論上不應(yīng)該在使用時才報錯，而應(yīng)該在安裝過程就使其失敗，提示禁止安裝。

這可以使用 python_requires 來實現(xiàn)。

setup(     
    ...     
    python_requires='>=2.7, <=3', 
)

 關(guān)于依賴包下載安裝

from setuptools import setup, find_packages   
setup(     
    ...      
    # 表明當(dāng)前模塊依賴哪些包，若環(huán)境中沒有，則會從pypi中下載安裝     
    install_requires=['docutils>=0.3'],      
    # setup.py 本身要依賴的包，這通常是為一些setuptools的插件準(zhǔn)備的配置    
    # 這里列出的包，不會自動安裝。     
    setup_requires=['pbr'],      
    # 僅在測試時需要使用的依賴，在正常發(fā)布的代碼中是沒有用的。     
    # 在執(zhí)行python setup.py test時，可以自動安裝這三個庫，確保測試的正常運(yùn)行。     
    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 不會，這里僅表示該模塊會依賴這些包     
    # 但是這些包通常不會使用到，只有當(dāng)你深度使用模塊時，才會用到，這里需要你手動安裝    
     extras_require={        
        'PDF':  ["ReportLab>=1.2", "RXP"],         
        'reST': ["docutils>=0.3"],    
     } 
)

 關(guān)于文件的分發(fā)

from setuptools import setup, find_packages   
setup(     
    name="mytest",    
    version="1.0",    
    author="name",    
    author_email="name@163.com",     
    description="Learn to Pack Python Module",     
    url="https://github.com/test/mytest",  
    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']                
    } 
)

關(guān)于程序分類信息

classifiers  參數(shù)說明包的分類信息。所有支持的分類列表見：https://pypi.org/pypi?%3Aaction=list_classifiers

示例：

from setuptools import setup, find_packages  
setup(     
    classifiers = [         
        # 發(fā)展時期,常見的如下         
        #   3 - Alpha         
        #   4 - Beta         
        #   5 - Production/Stable         
        'Development Status :: 3 - Alpha',          
        # 開發(fā)的目標(biāo)用戶         
        'Intended Audience :: Developers',          
        # 屬于什么類型         
        'Topic :: Software Development :: Build Tools',          
        # 許可證信息         
        'License :: OSI Approved :: MIT License',          
        # 目標(biāo) 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',     
    ] 
)

2.生成可執(zhí)行文件的分發(fā)

from setuptools import setup, find_packages   
setup(     
    ...   
    # 用來支持自動生成腳本，安裝后會自動生成 /usr/bin/foo 的可執(zhí)行文件     
    # 該文件入口指向 foo/main.py 的main 函數(shù)     
    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.py     
    scripts=['bin/foo.sh', 'bar.py']
)                

上面的 scripts 里有的腳本中有 sh 和 py 后綴，那么安裝后，setuptools 會原封不動的移動到 /usr/bin  中，并添加可執(zhí)行權(quán)限。

指定release

setup.py 里只能指定 version，而不能指定 release，如果你需要變更版本號，可以使用 --release 參數(shù)進(jìn)行指定

python setup.py bdist_rpm --release=20200617

setup.py 的參數(shù)非常多，能夠不借助文檔寫好一個setup.py好像沒那么簡單。為了備忘，我整理了 setup 函數(shù)常用的一些參數(shù)：

更多參數(shù)可見：https://setuptools.readthedocs.io/en/latest/setuptools.html

3. 如何使用 setup.py 構(gòu)建包

a、構(gòu)建源碼發(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 將根據(jù)當(dāng)前平臺創(chuàng)建默認(rèn)格式的存檔。在類 Unix 平臺上，將創(chuàng)建后綴后為 .tar.gz 的 gzip  壓縮的tar文件分發(fā)包，而在Windows上為 ZIP 文件。

當(dāng)然，你也可以通過指定你要的發(fā)布包格式來打破這個默認(rèn)行為

$ python setup.py sdist --formats=gztar,zip

你可以指定的格式有哪些呢?

創(chuàng)建一個壓縮的tarball和一個zip文件?？捎酶袷綖椋?/p>

對以上的格式，有幾點(diǎn)需要注意一下：

• 在版本3.5中才添加了對 xztar 格式的支持
• zip 格式需要你事先已安裝相應(yīng)的模塊：zip程序或zipfile模塊(已成為Python的標(biāo)準(zhǔn)庫)
• ztar 格式正在棄用，請盡量不要使用

另外，如果您希望歸檔文件的所有文件歸root擁有，可以這樣指定

python?setup.py?sdist?--owner=root?--group=root

b、構(gòu)建二進(jìn)制分發(fā)包。

在windows中我們習(xí)慣了雙擊 exe 進(jìn)行軟件的安裝，Python 模塊的安裝也同樣支持 打包成 exe 這樣的二進(jìn)制軟件包。

$?python?setup.py?bdist_wininst

而在 Linux 中，大家也習(xí)慣了使用 rpm 來安裝包，對此你可以使用這條命令實現(xiàn) rpm 包的構(gòu)建

$?python?setup.py?bdist_rpm

若你喜歡使用 easy_install 或者 pip 來安裝離線包。你可以將其打包成 egg 包

$?python?setup.py?bdist_egg

若你的項目，需要安裝多個平臺下，既有 Windows 也有  Linux，按照上面的方法，多種格式我們要執(zhí)行多次命令，為了方便，你可以一步到位，執(zhí)行如下這條命令，即可生成多個格式的進(jìn)制包

$?python?setup.py?bdist

4. 如何使用 setup.py 安裝包

正常情況下，我們都是通過以上構(gòu)建的源碼包或者二進(jìn)制包進(jìn)行模塊的安裝。

但在編寫 setup.py 的過程中，可能不能一步到位，需要多次調(diào)試，這時候如何測試自己寫的 setup.py 文件是可用的呢?

這時候你可以使用python setup.py install命令，它會將你的模塊安裝至系統(tǒng)全局環(huán)境中.

如若你的項目還處于開發(fā)階段，頻繁的安裝模塊，也是一個麻煩事。

這時候你可以使用這條命令安裝，該方法不會真正的安裝包，而是在系統(tǒng)環(huán)境中創(chuàng)建一個軟鏈接指向包實際所在目錄。這邊在修改包之后不用再安裝就能生效，便于調(diào)試。

$?python?setup.py?develop

5. 如何發(fā)布包到 PyPi?

通過上面的學(xué)習(xí)，你一定已經(jīng)學(xué)會了如何打包自己的項目，若你覺得自己開發(fā)的模塊非常不錯，想要 share 給其他人使用，你可以將其上傳到 PyPi  (Python Package Index)上，它是 Python 官方維護(hù)的第三方包倉庫，用于統(tǒng)一存儲和管理開發(fā)者發(fā)布的 Python 包。

如果要發(fā)布自己的包，需要先到 pypi 上注冊賬號。然后創(chuàng)建 ~/.pypirc 文件，此文件中配置 PyPI  訪問地址和賬號。如的.pypirc文件內(nèi)容請根據(jù)自己的賬號來修改。

典型的 .pypirc 文件

[distutils] 
index-servers = pypi  
[pypi] 
username:xxx password:xxx

然后使用這條命令進(jìn)行信息注冊，完成后，你可以在 PyPi 上看到項目信息。

$ python setup.py register

注冊完了后，你還要上傳源碼包，別人才使用下載安裝

$ python setup.py upload

到此這篇關(guān)于python中的setup.py的文章就介紹到這了,更多相關(guān)python setup.py內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論