在上一篇博文中總結了python中導入包,安裝包一條完整的線路。其中有一個有意思的知識點,安裝包的方式有很多種,模塊和包管理中打包,發布,安裝也是值得研究的內容。
python中安裝包的方式有很多種:
- 源碼包:python setup.py install
- 在線安裝:pip install 包名(linux) / easy_install 包名(window)
python包在開發中十分常見,一般的使用套路是所有的功能做一個python模塊包,打包模塊,然后發布,安裝使用。打包和安裝包就是最常見的工作。學習中遇到distutils和setuptools兩種打包的工具,學習之后做筆記記錄。
distutils
distutils 是 python 標准庫的一部分,這個庫的目的是為開發者提供一種方便的打包方式, 同時為使用者提供方便的安裝方式。當我們開發了自己的模塊之后,使用distutils的setup.py打包。
一、完成功能python
hello.py
def hello_fun(): print "i say hello to you"
二、建立setup.py文件
setup.py
from distutils.core import setup setup( name="hello_module", version="1.0", author="ljk", author_email="wilber@sh.com", py_modules=['hello'], )
三、執行打包命令
python setup sdist
再次查看當前目錄下自動生成了一個文件夾dist,文件夾中有一個壓縮包即為我們的目標文件。另外有一個記錄文件MANIFEST。
四、安裝模塊
hello_module-1.0.tar.gz 是生成的python模塊。切換到的我的python虛擬環境中,安裝該模塊。
使用python setup.py install 安裝該模塊。從路徑可以看出,該模塊安裝到標准庫的制定路徑下。
五、使用模塊
安裝好模塊之后,在python的交互環境中導入模塊。模塊就是hello.py文件,引用hello.py文件中的hello_fun()函數。
setuptools
setuptools是distutils的增強版。setuptools有一個entry_points功能很方便,類似linux啟動某個服務,如在linux命令行里firefox能啟動火狐瀏覽器。
首先檢驗沒有安裝之前,命令path沒有作用。
一、創建功能包
創建一個文件夾demo,在文件夾里創建get_path.py和__init__.py兩個文件。get_path.py是功能函數,__init__.py是包的標識文件。
get_path.py
import os def fun(): print "i am in the path:" print os.getcwd()
二、配置setup.py文件
創建setup.py文件,填寫必要的打包信息。
setup.py
#-*- encoding: UTF-8 -*- from setuptools import setup setup( name = "demo", # 包名 version = "0.1", # 版本信息 packages = ['demo'], # 要打包的項目文件夾 include_package_data=True, # 自動打包文件夾內所有數據 zip_safe=True, # 設定項目包為安全,不用每次都檢測其安全性 install_requires = [ # 安裝依賴的其他包(測試數據) 'docutils>=0.3', 'requests', ], # 設置程序的入口為path # 安裝后,命令行執行path相當於調用get_path.py中的fun方法 entry_points={ 'console_scripts':[ 'path = demo.get_path:fun' ] }, )
在配置中將該模塊需要的依賴全部都寫好,安裝時指定地址去下載。這種方式簡化了使用時的安裝過程,但是還不夠好。最好的方式是pip的自動下載。
三、打包
python setup.py sdist
打包之后多出兩個文件夾,分別是demo.egg-info和dist。demo.egg-info是必要的安裝信息,而dist中的壓縮包就是安裝包。
查看dist/demo-0.1.tar.gz解壓之后的文件。
四、安裝包
五、使用包
安裝之后在命令行中直接輸入path,回車能夠看到調用了get_path.py中的函數fun(),輸出字符串。
同時也可以導入使用。
setuptools的進階使用
上面使用setuptools時只是簡單的用一個配置文件setup.py就完成了打包信息填寫。在真實的開發環境中,往往是多個文件配合。以openstack的打包為例。openstack中引入了Pbr的管理工具。
pbr是setuptools的輔助工具,最初為openstack開發,基於d2to1。Pbr會讀取和過濾setup.cfg中的內容,然后將解析后的數據提供給setup.py作為參數。 setup.cfg提供setup.py的默認參數,同時易於修改。Setup.py先解析setup.cfg文件,然后執行相關命令。包括以下功能: 1、從git中獲取Version,AUTHORS和ChangeLog信息 2、SphinxAutodoc。pbr會掃描project,找到所有模塊,生成stubfiles 3、Requirements。讀取requirements.txt文件,生成setup函數需要依賴包 4、long_description。從README.rst、README.txt或者READMEfile中生成long_description參數
Pbr的文件很簡單,如下。配置之后會自動尋找目錄下的setup.cfg文件,解析文件參數給setup.py使用。
setup.py
from setuptools import setup setuptools.setup( setup_requires=['pbr'], pbr=True)
setup.cfg
[metadata] name= keystone version= 2015.2 summary= OpenStack Identity description-file= README.rst author= OpenStack author-email= openstack-dev@lists.openstack.org home-page= http://www.openstack.org/ classifier= Environment:: OpenStack IntendedAudience :: Information Technology IntendedAudience :: System Administrators License:: OSI Approved :: Apache Software License OperatingSystem :: POSIX :: Linux ProgrammingLanguage :: Python ProgrammingLanguage :: Python :: 2 ProgrammingLanguage :: Python :: 2.7 [files] packages= keystone [global] setup-hooks= pbr.hooks.setup_hook [egg_info] tag_build= tag_date= 0 tag_svn_revision= 0 [build_sphinx] all_files= 1 build-dir= doc/build source-dir= doc/source [compile_catalog] directory= keystone/locale domain= keystone
具體參數有待深入學習。。。