Python wheel檔案詳細介紹

1. wheel介紹

.whl檔案(WHL file)也稱為輪子(wheel)，這是用於python分發(distribution)的標準內建包格式(standard built-package format)。它包含安裝所需的所有檔案和後設資料(metadata)。.whl檔案使用zip進行壓縮。.whl檔案還包含有關此wheel檔案支援的Python版本和平臺的資訊。.whl檔案格式是一種即裝即用格式(ready-to-install format)，允許在不構建原始碼分發(without building the source distribution)的情況下執行安裝包。

.whl檔案本質上是zip檔案，這些.whl檔案可以使用解壓縮選項(unzip option)或標準解壓縮軟體應用程式(如WinZIP和WinRAR)解壓縮。

.whl檔案按照以下約定命名：

{dist}-{version}(-{build})?-{python.version}-{abi}-{platform}.whl

如果我們之前使用pip安裝過Python包，那麼我們的系統上很可能已經有輪子(wheel)被安裝過。pip是安裝wheel的包管理器。

我們可以通過pip安裝已下載的.whl檔案：pip install <filename>.whl ，安裝包後，我們可以執行Python shell並嘗試匯入包：import whl_dist_name

wheel的直接好處是我們與其他人共用我們的包，他們不必擔心構建它。他們只需pip install後即可使用該軟體包。它也是一個更小的共用檔案(與所有原始碼相比)，安裝速度更快，因為它不需要執行安裝指令碼。

2. wheel的型別

(1).universal wheel：包含py2.py3-none-any.whl。它在任何作業系統和平臺上都支援Python 2和Python 3。

(2).pure-python wheel：包含py3-none-any.whl或py2-none-any.whl。它支援Python 3或Python 2，但不能同時支援兩者。它在其它方面與universal wheel相同，但它會被標記為py2或py3而不是py2.py3標籤。

(3).platform wheel：支援特定的Python版本和平臺。

3. 建立wheel

(1).將所有模組(python指令碼)、包(包含模組的資料夾/目錄)儲存在父目錄中。隨意命名根目錄，通常與專案相關。

(2).最好建立一個空的名為__init__.py檔案，並將此__init__.py檔案放在所有包目錄和子包目錄下。無需將其儲存在根目錄中。

(3).建立一個名為setup.py的檔案並將其放在根目錄中。此指令碼的內容至少應包括：distribution name, version number, and list of package names

(4).轉到你可以執行python和pip命令的命令提示字元。在命令提示字元下更改目錄並導航到放置setup.py的專案的根目錄，執行以下命令：擴充套件名為.whl的檔案將在根目錄下自動建立的子目錄中建立，名為dist。

wheel中並不包含setup.py，wheel不必執行setup.py指令碼。

注：需提取安裝wheel setuptools: pip install wheel setuptools，在conda中預設是安裝的

python setup.py bdist_wheel --universal # universal wheel
python setup.py bdist_wheel # pure-Python wheel

這裡通過conda在虛擬環境base下建立一個wheel，取名為testwheel目錄組織結構如下所示：

setup.py內容如下：

import setuptools
setuptools.setup(
    name="testwheel",
    version="1.0.0",
    author="fengbingchun",
    author_email="fengbingchun@163.com",
    description="test wheel",
    packages=setuptools.find_packages(),
    url="https://github.com/fengbingchun",
    license="MIT",
    python_requires=">=3.8"
)

testwheel目錄下的__init__.py是個空檔案，math目錄下的__init__.py內容如下：

from .math_add import *
from .math_sub import *

math_add.py內容如下：

def add3(a, b, c):
    print("call add operation: three parameters ...")
    return (a+b+c)
def add2(a, b):
    print("call add operation: two parameters ...")
    return (a+b)

math_sub.py內容如下：

def sub3(a, b, c):
    print("call sub operation: three parameters ...")
    return (a-b-c)
def sub2(a, b):
    print("call sub operation: two parameters ...")
    return (a-b)

執行如下命令生成wheel，此wheel僅限於在Python3上執行，將終端定位到setup.py目錄下

執行完上述命令後會產生3個新的目錄，build, dist, testwhell.egg-info，各個目錄的內容如下所示，生成的whell在dist目錄下，全名為testwheel-1.0.0-py3-none-any.whl，只需將此檔案分發出去，其他人安裝後即能使用。

4. 匯入使用wheel

如果你想在專案中安裝已經安裝過的wheel檔案，需要更新此wheel的版本號。如果版本號保持不變，pip將不會安裝它。或者先解除安裝已安裝的whell: pip uninstall testwheel

通過conda新建一個虛擬環境testwheel，用來測試上面生成的testwheel-1.0.0-py3-none-any.whl，將終端定位到其它的test目錄下，並將生成的wheel檔案拷貝到此目錄下，安裝，執行結果如下圖所示：

會將此wheel安裝到anaconda3/envs/testwheel/lib/python3.8/site-packages/目錄下，如下圖所示：

在tmp下新增一個test.py檔案，用於測試wheel，內容如下：

from testwheel.math import math_add, math_sub
a, b, c = 10, 5, 2
print("add3:", math_add.add3(a, b, c))
print("add2:", math_add.add2(a, b))
print("sub3:", math_sub.sub3(a, b, c))
print("sub2:", math_sub.sub2(a, b))
print("test finish")

執行結果如下所示：可見正確的呼叫了wheel中的介面

如果需要反覆的調整wheel的內容，需要反覆的測試，又不想修改version number，一種方法是可先解除安裝已安裝的wheel，然後再次安裝新的wheel，如下圖所示：也可使用--force-reinstall

GitHub傳送門

到此這篇關於Python wheel檔案詳細介紹的文章就介紹到這了,更多相關Python wheel檔案內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！