Python包管理工具setuptools

為什么需要對項目分發打包？

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

打包，就是將你的源代碼進一步封裝，並且將所有的項目部署工作都事先安排好，這樣使用者拿到后即裝即用，不用再操心如何部署的問題。

 

包分發的始祖：distutils

distutils 是 Python 的一個標准庫，從命名上很容易看出它是一個分發（distribute）工具（utlis），它是 Python 官方開發的一個分發打包工具，所有

后續的打包工具，全部都是基於它進行開發的。

distutils 的精髓在於編寫 setup.py，它是模塊分發與安裝的指導文件。

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

python setup.py install

這樣的安裝方法是通過源碼安裝，與之對應的是通過二進制軟件包的安裝。

 

分發工具升級：setuptools

setuptools 是 distutils 增強版，不包括在標准庫中。其擴展了很多功能，能夠幫助開發者更好的創建和分發 Python 包。大部分 Python 用

戶都會使用更先進的 setuptools 模塊。

distribute 是 setuptools 有一個分支版本，分支的原因可能是有一部分開發者認為 setuptools 開發太慢了。但現在，distribute 又合並回

了 setuptools 中。因此，我們可以認為它們是同一個東西。

如何在一個干凈的環境中安裝 setuptools 呢？

主要有兩種方法：

• 源碼安裝：在 https://pypi.org/project/setuptools/#files 中下載 zip 包 解壓執行 python setup.py install 安裝
• 通過引導程序安裝：下載引導程序，它可以用來下載或者更新最新版本的 setuptools

$ wget http://peak.telecommunity.com/dist/ez_setup.py

# 安裝
$ python ez_setup.py

# 更新，以下兩種任選
$ python ez_setup.py –U setuptools
$ pip install -U setuptools

　　

easy_install 使用指南

當你安裝完 setuptools 后，就擁有了一個叫做 easy_install 的第三方管理工具，這也是它區分於 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 的一些常用的方法，想要了解更多，你可以點擊官方文檔：https://setuptools.readthedocs.io/en/latest/easy_install.html

 

源碼包與二進制包什么區別？

Python 包的分發可以分為兩種：

1. 以源碼包的方式發布

     源碼包安裝的過程，是先解壓，再編譯，最后才安裝，所以它是跨平台的，由於每次安裝都要進行編譯，相對二進包安裝方式來說安裝速度較慢。

     源碼包的本質是一個壓縮包。

2. 以二進制包形式發布

     二進制包的安裝過程省去了編譯的過程，直接進行解壓安裝，所以安裝速度較源碼包來說更快。由於不同平台的編譯出來的包無法通用，所以在發

     布時，需事先編譯好多個平台的包。

 

eggs 與 wheels 有什么區別

Egg 格式是由 setuptools 在 2004 年引入，而 Wheel 格式是由 PEP427 在 2012 年定義。Wheel 的出現是為了替代 Egg，它的本質是一個zip包，

其現在被認為是 Python 的二進制包的標准格式。以下是 Wheel 和 Egg 的主要區別：

• Wheel 有一個官方的 PEP427 來定義，而 Egg 沒有 PEP 定義
• Wheel 是一種分發格式，即打包格式。而 Egg 既是一種分發格式，也是一種運行時安裝的格式，並且是可以被直接 import
• Wheel 文件不會包含 .pyc 文件
• Wheel 使用和 PEP376 兼容的 .dist-info 目錄，而 Egg 使用 .egg-info 目錄
• Wheel 有着更豐富的命名規則。
• Wheel 是有版本的。每個 Wheel 文件都包含 wheel 規范的版本和打包的實現
• Wheel 在內部被 sysconfig path type 管理，因此轉向其他格式也更容易

wheel 包可以通過 pip 來安裝，只不過需要先安裝 wheel 模塊，然后再使用 pip 的命令。

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

 

setup.py 的如何編寫

打包分發最關鍵的一步是編寫 setup.py 文件。

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

from setuptools import setup, find_packages

setup(
    name="mytest",
    version="1.0",
    author="wangbm",
    author_email="[e-mail]",
    description="Learn to Pack Python Module",
    
    # 項目主頁
    url="http://python-online.cn/", 
    
    # 你要安裝的包，通過 setuptools.find_packages 找到當前目錄下有哪些包
    packages=find_packages()
)

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

程序分類信息

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

from setuptools import setup, find_packages

setup(
    classifiers = [
        # 發展時期,常見的如下
        #   3 - Alpha
        #   4 - Beta
        #   5 - Production/Stable
        'Development Status :: 3 - Alpha',

        # 開發的目標用戶
        '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',
    ]
)

關於文件的分發

from setuptools import setup, find_packages


setup(
    name="mytest",
    version="1.0",
    author="wangbm",
    author_email="[e-mail]",
    description="Learn to Pack Python Module",
    url="http://python-online.cn/", 
    packages=find_packages(),
    
    # 安裝過程中，需要安裝的靜態文件，如配置文件、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 的文件，來控制文件的分發。

如下這是一個 MANIFEST.in 的樣例：

include *.txt
recursive-include examples *.txt *.py
prune examples/sample?/build

這些配置，規定了如下幾點

• 所有根目錄下的以 txt 為后綴名的文件，都會分發
• 根目錄下的 examples 目錄 和 txt、py文件都會分發
• 路徑匹配上 examples/sample?/build 不會分發

MANIFEST.in 需要放在和 setup.py 同級的頂級目錄下，setuptools 會自動讀取該文件。

關於依賴包下載安裝

from setuptools import setup, find_packages


setup(
	...
    
    # 表明當前模塊依賴哪些包，若環境中沒有，則會從pypi中下載安裝
    install_requires=['docutils>=0.3'],
    
    # setup.py 本身要依賴的包，這通常是為一些setuptools的插件准備的配置
    # 這里列出的包，不會自動安裝。
    setup_requires=['pbr'],
    
    # 僅在測試時需要使用的依賴，在正常發布的代碼中是沒有用的。
    # 在執行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"],
    }
)

關於安裝環境的限制

有些庫並不是在所有的 Python 版本中都適用的，若一個庫安裝在一個未兼容的 Python 環境中，理論上不應該在使用時才報錯，而應該在安裝過程就使其失敗，

提示禁止安裝。這樣的功能，可以使用 python_requires 來實現。

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

生成可執行文件的分發

from setuptools import setup, find_packages


setup(
    name="mytest",
    version="1.0",
    author="wangbm",
    author_email="[e-mail]",
    description="Learn to Pack Python Module",
    url="http://python-online.cn/", 
    packages=find_packages(),
   
    # 用來支持自動生成腳本，安裝后會自動生成 /usr/bin/foo 的可執行文件
    # 該文件入口指向 foo/main.py 的main 函數
    entry_points={
        'console_scripts': [
            'foo = foo.main:main'
        ]
    },
    
    # 將 bin/foo.sh 和 bar.py 腳本，生成到系統 PATH中
    # 執行 python setup.py install 后
    # 會生成 如 /usr/bin/foo.sh 和 如 /usr/bin/bar.py
    scripts=['bin/foo.sh', 'bar.py']
)

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

若你想對這些文件再作一些更改，比如去掉多余的后綴，可以這樣做

from setuptools.command.install_scripts import install_scripts

class InstallScripts(install_scripts):

    def run(self):
        setuptools.command.install_scripts.install_scripts.run(self)

        # Rename some script files
        for script in self.get_outputs():
            if basename.endswith(".py") or basename.endswith(".sh"):
                dest = script[:-3]
            else:
                continue
            print("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

setup.py 的參數非常多，更多參數可見：https://setuptools.readthedocs.io/en/latest/setuptools.html

 

如何使用 setup.py 來構建包？

構建源碼發布包：用於發布一個 Python 模塊或項目，將源碼打包成 tar.gz （用於 Linux 環境中）或者 zip 壓縮包（用於 Windows 環境中）

$ python setup.py sdist

那這種包如何安裝呢？

使用 setuptools 中提供的 easy_install 工具。

easy_install xxx.tar.gz

使用 sdist 將根據當前平台創建默認格式的存檔。在類 Unix 平台上，將創建后綴后為 .tar.gz 的 gzip 壓縮的tar文件分發包，而在Windows上為 ZIP 文件。

當然，你也可以通過指定你要的發布包格式來打破這個默認行為：

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

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

$ python setup.py bdist_wininst

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

$ python setup.py bdist_egg

若你的項目，需要安裝多個平台下，既有 Windows 也有 Linux，按照上面的方法，多種格式我們要執行多次命令，為了方便，你可以一步到位，

執行如下這條命令，即可生成多個格式的進制包：

$ python setup.py bdist

　　

如何使用 setup.py 來安裝包？

正常情況下，我們都是通過以上構建的源碼包或者二進制包進行模塊的安裝。

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

這時候你可以使用這條命令，它會將你的模塊安裝至系統全局環境中：

$ python setup.py install

 如若你的項目還處於開發階段，頻繁的安裝模塊，也是一個麻煩事。這時候你可以使用這條命令安裝，該方法不會真正的安裝包，而是在系統

環境中創建一個軟鏈接指向包實際所在目錄。這邊在修改包之后不用再安裝就能生效，便於調試。

$ python setup.py develop