把 python 程序打包成 egg 或者 whl 安裝包


原文出處:http://www.worldhello.net/2010/12/08/2178.html
本文略有改動

1.1 安裝setuptools

首先要安裝setuptools工具。Debian/Ubuntu下可以直接使用apt安裝:

$ sudo apt-get install python-setuptools

或者通過pip安裝:

$ pip install setuptools

更新setuptools

$ pip install --upgrade setuptools

或者下載setuptoolswhl包來安裝。可以在這里查看最新版本下載。下載完畢以后通過sh安裝。

$ wget https://files.pythonhosted.org/packages/ec/51/f45cea425fd5cb0b0380f5b0f048ebc1da5b417e48d304838c02d6288a1e/setuptools-41.0.1-py2.py3-none-any.whl
$ pip install setuptools-41.0.1-py2.py3-none-any.whl

現在就可以使用pip命令來安裝其他的 egg 或者 whl 包了。

1.2 制作自己的egg包

總是安裝別人的 egg/whl 包,是不是也想制作自己的包呢?好,接下來我們就自己制作一個簡單的包。 首先建立工程目錄egg-demo,初始化一個 setup.py 文件:

$ mkdir egg-demo
$ cd egg-demo
$ touch setup.py
$ ls
setup.py

下面主要就是填充 setup.py。setup.py 其實是 python 工具包distutils的配置文件,setuptools就是基於distutils來做的。 在 setup.py 中通過setup函數來配置打包信息。首先要引入setuptools的函數setupsetuptoolssetup其實就是distutilssetup函數,填寫 setup.py 為以下內容:

$ cat setup.py
#!/usr/bin/env python
#-*- coding:utf-8 -*-

from setuptools import setup

setup()

寫到這里,一個空的 egg 配置文件就寫好了。我們可以使用下面命令生成 egg 包:

$ python setup.py bdist_egg

或者生成 whl 包:

$ python setup.py bdist_wheel

下面看看究竟生成了什么:

$ ls -F
build/ dist/ setup.py UNKNOWN.egg-info/

可以看到多了三個文件夾。而在 dist 文件夾下,有一個 egg 文件:UNKNOWN-0.0.0-py3.6.egg。 產蛋成功!先看看這個 egg 文件是什么格式的:

$ file dist/UNKNOWN-0.0.0-py3.6.egg
dist/UNKNOWN-0.0.0-py3.6.egg: Zip archive data, at least v2.0 to extract

噢,原來就是一個zip壓縮包呀!好,再來看看內部構造:

$ unzip -l dist/UNKNOWN-0.0.0-py3.6.egg
Archive:  dist/UNKNOWN-0.0.0-py3.6.egg
  Length      Date    Time    Name
---------  ---------- -----   ----
      181  2019-07-16 14:43   EGG-INFO/PKG-INFO
      132  2019-07-16 14:43   EGG-INFO/SOURCES.txt
        1  2019-07-16 14:43   EGG-INFO/dependency_links.txt
        1  2019-07-16 14:43   EGG-INFO/top_level.txt
        1  2019-07-16 14:43   EGG-INFO/zip-safe
---------                     -------
      316                     5 files

同樣的,可以對 whl 文件進行查看:

$ file dist/UNKNOWN-0.0.0-py3-none-any.whl
dist/UNKNOWN-0.0.0-py3-none-any.whl: Zip archive data, at least v2.0 to extract

$ unzip -l dist/UNKNOWN-0.0.0-py3-none-any.whl
Archive:  dist/UNKNOWN-0.0.0-py3-none-any.whl
  Length      Date    Time    Name
---------  ---------- -----   ----
      171  2019-07-16 06:44   UNKNOWN-0.0.0.dist-info/METADATA
       97  2019-07-16 06:44   UNKNOWN-0.0.0.dist-info/WHEEL
        1  2019-07-16 06:44   UNKNOWN-0.0.0.dist-info/top_level.txt
      296  2019-07-16 06:44   UNKNOWN-0.0.0.dist-info/RECORD
---------                     -------
      565                     4 files

可以看到,whl 文件和 egg 文件還是有不同的。


只有一個EGG-INFO文件夾,內含五個 egg 信息文件,沒了。 這個 egg 名稱未知,版本 0.0.0。這是因為我們在setup里什么也沒有設置。 顯然,這個 egg 什么也不能做。 下面給它加點料。 在setup.py中,setup函數接收一系列屬性作為配置參數。

  • name:name 是 egg 包的名稱,也是尋找要打包的文件夾的名稱,默認是 UNKNOWN。
  • version:版本號,默認 0.0.0
  • packages:這里要用到 setuptools 的另一個函數 find_packages,顧名思義,find_packages 用來將指定目錄下的文件打包。
  • zip_safe:默認是 False,這樣在每次生成 egg 包時都會檢查項目文件的內容,確保無誤。

還有一些描述性的屬性,如 description,long_description,author,author_email,license,keywords,platform,url 等。 填充setup.py文件如下::

$ cat setup.py
#!/usr/bin/env python
#-*- coding:utf-8 -*-

from setuptools import setup, find_packages

setup(
        name = "demo",
        version="0.1.0",
        packages = find_packages(),
        zip_safe = False,

        description = "egg test demo.",
        long_description = "egg test demo, haha.",
        author = "amoblin",
        author_email = "amoblin@ossxp.com",

        license = "GPL",
        keywords = ("test", "egg"),
        platforms = "Independant",
        url = "",
        )

egg-demo目錄下建立和上述 name 名稱相同的目錄demodemo目錄下寫__init__.py文件:

$ mkdir demo
$ cat demo/__init__.py
#!/usr/bin/env python
#-*- coding:utf-8 -*-

def test():
    print "Hello, I'm amoblin."

if __name__ == '__main__':
    test()

再次生成 egg 包以后查看 egg 包信息:

$ python setup.py bdist_egg
$ unzip -l dist/demo-0.1.0-py3.6.egg
Archive:  dist/demo-0.1.0-py3.6.egg
  Length      Date    Time    Name
---------  ---------- -----   ----
      227  2019-07-16 14:50   EGG-INFO/PKG-INFO
      164  2019-07-16 14:50   EGG-INFO/SOURCES.txt
        1  2019-07-16 14:50   EGG-INFO/dependency_links.txt
        1  2019-07-16 14:50   EGG-INFO/not-zip-safe
        5  2019-07-16 14:50   EGG-INFO/top_level.txt
      111  2019-07-16 14:49   demo/__init__.py
---------                     -------
      509                     6 files

可以看到,多了一個文件夾demo,里面有我們寫的__init__.py。 奉行敏捷原則,先安裝了體驗一下再說:

$ sudo python setup.py install
running install
running bdist_egg
running egg_info
writing demo.egg-info/PKG-INFO
writing dependency_links to demo.egg-info/dependency_links.txt
writing top-level names to demo.egg-info/top_level.txt
reading manifest file 'demo.egg-info/SOURCES.txt'
writing manifest file 'demo.egg-info/SOURCES.txt'
installing library code to build/bdist.linux-x86_64/egg
running install_lib
running build_py
creating build/bdist.linux-x86_64/egg
creating build/bdist.linux-x86_64/egg/demo
copying build/lib/demo/__init__.py -> build/bdist.linux-x86_64/egg/demo
byte-compiling build/bdist.linux-x86_64/egg/demo/__init__.py to __init__.cpython-36.pyc
creating build/bdist.linux-x86_64/egg/EGG-INFO
copying demo.egg-info/PKG-INFO -> build/bdist.linux-x86_64/egg/EGG-INFO
copying demo.egg-info/SOURCES.txt -> build/bdist.linux-x86_64/egg/EGG-INFO
copying demo.egg-info/dependency_links.txt -> build/bdist.linux-x86_64/egg/EGG-INFO
copying demo.egg-info/not-zip-safe -> build/bdist.linux-x86_64/egg/EGG-INFO
copying demo.egg-info/top_level.txt -> build/bdist.linux-x86_64/egg/EGG-INFO
creating 'dist/demo-0.1.0-py3.6.egg' and adding 'build/bdist.linux-x86_64/egg' to it
removing 'build/bdist.linux-x86_64/egg' (and everything under it)
Processing demo-0.1.0-py3.6.egg
removing '/usr/local/lib/python3.6/dist-packages/demo-0.1.0-py3.6.egg' (and everything under it)
creating /usr/local/lib/python3.6/dist-packages/demo-0.1.0-py3.6.egg
Extracting demo-0.1.0-py3.6.egg to /usr/local/lib/python3.6/dist-packages
demo 0.1.0 is already the active version in easy-install.pth

Installed /usr/local/lib/python3.6/dist-packages/demo-0.1.0-py3.6.egg
Processing dependencies for demo==0.1.0
Finished processing dependencies for demo==0.1.0

在這一步,也可以直接進入到 dist 文件夾中,使用 pip install demo-0.1.0-py3.6.egg 命令來安裝。還更加方便,因為在卸載的時候也可以使用 pip remove 命令來卸載

OK!安裝完畢!接下來我們就可以直接通過import來使用啦!

$ python -c "from demo import test;test()"
Hello, I'm amoblin.

成功輸出!這說明安裝正確。我們的一個 egg 包誕生了。 一般情況下,我們的源程序都放在 src 目錄下,所以接下來將 demo 文件夾移動到 src 里。但這樣也要修改setup.py文件,修改find_packages函數中參數為'src',同時增加package_dir參數:

packages=find_packages('src'),
package_dir = {'':'src'}

這樣告訴 setuptools 在 src 目錄下找包,而不是原來默認的工程根目錄。

1.3 egg 文件卸載

以 python3.6 版本為例,egg 文件一般安裝在/usr/local/lib/python3.6/dist-packages/目錄下,該目錄下還有一個easy-install.pth文件,用於存放安裝的 egg 信息:

$ cd /usr/local/lib/python3.6/dist-packages
$ cat easy-install.pth|grep demo
./demo-0.1.0-py3.6.egg
$ ls -F|grep demo
demo-0.1.0-py3.6.egg/

卸載 egg 文件很簡單,首先將包含此 egg 的行從 easy-install.pth 中刪除,然后刪除 egg 文件夾即可。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM