學習Python包的構建與分發

時間  2020-05-15
標籤 學習 python 構建 分發 欄目 Python 简体版
原文   原文鏈接

首發於公衆號：Python編程時光html

1. 爲何須要對項目分發打包？

日常咱們習慣了使用 pip 來安裝一些第三方模塊，這個安裝過程之因此簡單，是由於模塊開發者爲咱們默默地爲咱們作了全部繁雜的工做，而這個過程就是 打包。python

打包，就是將你的源代碼進一步封裝，而且將全部的項目部署工做都事先安排好，這樣使用者拿到後即裝即用，不用再操心如何部署的問題（若是你不想對照着一堆部署文檔手工操做的話）。git

無論你是在工做中，仍是業餘準備本身寫一個能夠上傳到 PyPI 的項目，你都要學會如何打包你的項目。shell

Python 發展了這麼些年了，項目打包工具也已經很成熟了。他們都有哪些呢？編程

你可能聽過 disutils、 distutils 、distutils2、setuptools等等，好像很熟悉，卻又很陌生，他們都是什麼關係呢？windows

2. 包分發的始祖：distutils

distutils 是 Python 的一個標準庫，從命名上很容易看出它是一個分發（distribute）工具（utlis），它是 Python 官方開發的一個分發打包工具，全部後續的打包工具，所有都是基於它進行開發的。api

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

那麼如何編寫 setup.py 呢？這裏面的內容很是多，我會在後面進行詳細的解析，請你耐心往下看。工具

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

$ python setup.py install

這樣的安裝方法是經過源碼安裝，與之對應的是經過二進制軟件包的安裝，一樣我也會在後面進行介紹。

3. 分發工具升級：setuptools

setuptools 是 distutils 加強版，不包括在標準庫中。其擴展了不少功能，可以幫助開發者更好的建立和分發 Python 包。大部分 Python 用戶都會使用更先進的 setuptools 模塊。

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

distribute 是 setuptools 有一個分支版本，分支的緣由多是有一部分開發者認爲 setuptools 開發太慢了。但如今，distribute 又合併回了 setuptools 中。所以，咱們能夠認爲它們是同一個東西。

還有一個大包分發工具是 distutils2，其試圖嘗試充分利用distutils，detuptools 和 distribute 併成爲 Python 標準庫中的標準工具。但該計劃並無達到預期的目的，且已是一個廢棄的項目。

所以，setuptools 是一個優秀的，可靠的 Python 包安裝與分發工具。

那麼如何在一個乾淨的環境中安裝 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

4. 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 只會從 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 是官方提供的一個專業用於包分發的工具，若只從安裝的角度來看，它的功能確實簡單。它更大的意義是對包的分發頗有用，定製化程序很是高，咱們如今也還在用它進行版本包的發佈。

5. 源碼包與二進制包什麼區別？

Python 包的分發能夠分爲兩種：

  1. 以源碼包的方式發佈

源碼包安裝的過程，是先解壓，再編譯，最後才安裝，因此它是跨平臺的，因爲每次安裝都要進行編譯，相對二進包安裝方式來講安裝速度較慢。

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

  1. 以二進制包形式發佈

二進制包的安裝過程省去了編譯的過程，直接進行解壓安裝，因此安裝速度較源碼包來講更快。

因爲不一樣平臺的編譯出來的包沒法通用，因此在發佈時，需事先編譯好多個平臺的包。

二進制包的常見格式有：

6. 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

7. 超詳細講解 setup.py 的編寫？

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

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

from setuptools import setup, find_packages

setup(
    name="mytest",
    version="1.0",
    author="wangbm",
    author_email="wongbingming@163.com",
    description="Learn to Pack Python Module  -->公衆號：Python編程時光",
    
    # 項目主頁
    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="wongbingming@163.com",
    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"],
    }
)

關於 install_requires， 有如下五種經常使用的表示方法：

  1. 'argparse'，只包含包名。 這種形式只檢查包的存在性，不檢查版本。 方便，但不利於控制風險。
  2. 'setuptools==38.2.4'，指定版本。 這種形式把風險降到了最低，確保了開發、測試與部署的版本一致，不會出現意外。 缺點是不利於更新，每次更新都須要改動代碼。
  3. 'docutils >= 0.3'，這是比較經常使用的形式。 當對某個庫比較信任時，這種形式能夠自動保持版本爲最新。
  4. 'Django >= 1.11, != 1.11.1, <= 2'，這是比較複雜的形式。 如這個例子，保證了Django的大版本在1.11和2之間，也即1.11.x；而且，排除了已知有問題的版本1.11.1（僅舉例）。 對於一些大型、複雜的庫，這種形式是最合適的。
  5. 'requests[security, socks] >= 2.18.4'，這是包含了額外的可選依賴的形式。 正常安裝requests會自動安裝它的install_requires中指定的依賴，而不會安裝security和socks這兩組依賴。 這兩組依賴是定義在它的extras_require中。 這種形式，用在深度使用某些庫時。

關於安裝環境的限制

有些庫並非在因此的 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="wongbingming@163.com",
    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 的參數很是多，可以不借助文檔寫好一個setup.py好像沒那麼簡單。爲了備忘，我整理了 setup 函數經常使用的一些參數：

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

8. 打包輔助神器PBR 是什麼？

pbr 是 setuptools 的輔助工具，最初是爲 OpenStack 開發(https://launchpad.net/pbr)，基於d2to1。

pbr 會讀取和過濾setup.cfg中的數據，而後將解析後的數據提供給 setup.py 做爲參數。包含以下功能：

  1. 從git中獲取Version、AUTHORS and ChangeLog信息
  2. Sphinx Autodoc。pbr 會掃描project，找到全部模塊，生成stub files
  3. Requirements。pbr會讀取requirements.txt，生成setup函數須要的install_requires/tests_require/dependency_links

這裏須要注意，在 requirements.txt 文件的頭部可使用：--index https://pypi.python.org/simple/，這一行把一個抽象的依賴聲明如 requests==1.2.0 轉變爲一個具體的依賴聲明 requests 1.2.0 from pypi.python.org/simple/

  1. long_description。從README.rst, README.txt or README file中生成long_description參數

使用pbr很簡單：

from setuptools import setup

setup(
    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.ini
        etc/dhcp-agent.ini
    etc/init.d = neutron.init

[entry_points] 段跟 setuptools 的方式相同。

到此，我講了三種編寫使用 setup.py 的方法

  • 使用命令行參數指定，一個一個將參數傳遞進去（極不推薦）
  • 在 setup.py 中的setup函數中指定（推薦使用）
  • 使用 pbr ，在 setup.cfg 中指定（易於管理，更推薦）

9. 如何使用 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

你能夠指定的格式有哪些呢？

建立一個壓縮的tarball和一個zip文件。可用格式爲：

對以上的格式，有幾點須要注意一下：

  • 在版本3.5中才添加了對 xztar 格式的支持
  • zip 格式須要你事先已安裝相應的模塊：zip程序或zipfile模塊（已成爲Python的標準庫）
  • ztar 格式正在棄用，請儘可能不要使用

另外，若是您但願歸檔文件的全部文件歸root擁有，能夠這樣指定

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

二、構建二進制分發包。

在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，按照上面的方法，多種格式咱們要執行屢次命令，爲了方便，你能夠一步到位，執行以下這條命令，便可生成多個格式的進制包

$ python setup.py bdist

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

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

但在編寫 setup.py 的過程當中，可能不能一步到位，須要屢次調試，這時候如何測試本身寫的 setup.py 文件是可用的呢？

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

$ python setup.py install

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

這時候你可使用這條命令安裝，該方法不會真正的安裝包，而是在系統環境中建立一個軟連接指向包實際所在目錄。這邊在修改包以後不用再安裝就能生效，便於調試。

$ python setup.py develop

11. 如何發佈包到 PyPi？

經過上面的學習，你必定已經學會了如何打包本身的項目，若你以爲本身開發的模塊很是不錯，想要 share 給其餘人使用，你能夠將其上傳到 PyPi （Python Package Index）上，它是 Python 官方維護的第三方包倉庫，用於統一存儲和管理開發者發佈的 Python 包。

若是要發佈本身的包，須要先到 pypi 上註冊帳號。而後建立 ~/.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，這裏不詳細講了。

參考文章

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程