淺析python打包工具distutils、setuptools
python中安裝包的方式有很多種:
- 源碼包:python setup.py install
- 在線安裝:pip install 包名(linux) / easy_install 包名(window)
python包在開發(fā)中十分常見,一般的使用套路是所有的功能做一個(gè)python模塊包,打包模塊,然后發(fā)布,安裝使用。打包和安裝包就是最常見的工作。學(xué)習(xí)中遇到distutils和setuptools兩種打包的工具,學(xué)習(xí)之后做筆記記錄。
distutils
distutils 是 python 標(biāo)準(zhǔn)庫的一部分,這個(gè)庫的目的是為開發(fā)者提供一種方便的打包方式, 同時(shí)為使用者提供方便的安裝方式。當(dāng)我們開發(fā)了自己的模塊之后,使用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'], )
三、執(zhí)行打包命令
再次查看當(dāng)前目錄下自動(dòng)生成了一個(gè)文件夾dist,文件夾中有一個(gè)壓縮包即為我們的目標(biāo)文件。另外有一個(gè)記錄文件MANIFEST。
四、安裝模塊
hello_module-1.0.tar.gz 是生成的python模塊。切換到的我的python虛擬環(huán)境中,安裝該模塊。
使用python setup.py install
安裝該模塊。從路徑可以看出,該模塊安裝到標(biāo)準(zhǔn)庫的制定路徑下。
五、使用模塊
安裝好模塊之后,在python的交互環(huán)境中導(dǎo)入模塊。模塊就是hello.py文件,引用hello.py文件中的hello_fun()函數(shù)。
setuptools
setuptools是distutils的增強(qiáng)版。setuptools有一個(gè)entry_points功能很方便,類似linux啟動(dòng)某個(gè)服務(wù),如在linux命令行里firefox能啟動(dòng)火狐瀏覽器。
首先檢驗(yàn)沒有安裝之前,命令path沒有作用。
一、創(chuàng)建功能包
創(chuàng)建一個(gè)文件夾demo,在文件夾里創(chuàng)建get_path.py和__init__.py兩個(gè)文件。get_path.py是功能函數(shù),__init__.py是包的標(biāo)識(shí)文件。
get_path.py
import os def fun(): print "i am in the path:" print os.getcwd()
二、配置setup.py文件
創(chuàng)建setup.py文件,填寫必要的打包信息。
setup.py
#-*- encoding: UTF-8 -*- from setuptools import setup setup( name = "demo", # 包名 version = "0.1", # 版本信息 packages = ['demo'], # 要打包的項(xiàng)目文件夾 include_package_data=True, # 自動(dòng)打包文件夾內(nèi)所有數(shù)據(jù) zip_safe=True, # 設(shè)定項(xiàng)目包為安全,不用每次都檢測(cè)其安全性 install_requires = [ # 安裝依賴的其他包(測(cè)試數(shù)據(jù)) 'docutils>=0.3', 'requests', ], # 設(shè)置程序的入口為path # 安裝后,命令行執(zhí)行path相當(dāng)于調(diào)用get_path.py中的fun方法 entry_points={ 'console_scripts':[ 'path = demo.get_path:fun' ] }, ) <br data-filtered="filtered"><br data-filtered="filtered">
在配置中將該模塊需要的依賴全部都寫好,安裝時(shí)指定地址去下載。這種方式簡(jiǎn)化了使用時(shí)的安裝過程,但是還不夠好。最好的方式是pip的自動(dòng)下載。
三、打包
打包之后多出兩個(gè)文件夾,分別是demo.egg-info和dist。demo.egg-info是必要的安裝信息,而dist中的壓縮包就是安裝包。
查看dist/demo-0.1.tar.gz解壓之后的文件。
四、安裝包
五、使用包
安裝之后在命令行中直接輸入path,回車能夠看到調(diào)用了get_path.py中的函數(shù)fun(),輸出字符串。
同時(shí)也可以導(dǎo)入使用。
setuptools的進(jìn)階使用
上面使用setuptools時(shí)只是簡(jiǎn)單的用一個(gè)配置文件setup.py就完成了打包信息填寫。在真實(shí)的開發(fā)環(huán)境中,往往是多個(gè)文件配合。以openstack的打包為例。openstack中引入了Pbr的管理工具。
pbr是setuptools的輔助工具,最初為openstack開發(fā),基于d2to1。Pbr會(huì)讀取和過濾setup.cfg中的內(nèi)容,然后將解析后的數(shù)據(jù)提供給setup.py作為參數(shù)。
setup.cfg提供setup.py的默認(rèn)參數(shù),同時(shí)易于修改。Setup.py先解析setup.cfg文件,然后執(zhí)行相關(guān)命令。包括以下功能:
1、從git中獲取Version,AUTHORS和ChangeLog信息
2、SphinxAutodoc。pbr會(huì)掃描project,找到所有模塊,生成stubfiles
3、Requirements。讀取requirements.txt文件,生成setup函數(shù)需要依賴包
4、long_description。從README.rst、README.txt或者READMEfile中生成long_description參數(shù)
Pbr的文件很簡(jiǎn)單,如下。配置之后會(huì)自動(dòng)尋找目錄下的setup.cfg文件,解析文件參數(shù)給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
總結(jié)
以上所述是小編給大家介紹的python打包工具distutils、setuptools ,希望對(duì)大家有所幫助,如果大家有任何疑問請(qǐng)給我留言,小編會(huì)及時(shí)回復(fù)大家的。在此也非常感謝大家對(duì)腳本之家網(wǎng)站的支持!
相關(guān)文章
Python3實(shí)現(xiàn)的字典、列表和json對(duì)象互轉(zhuǎn)功能示例
這篇文章主要介紹了Python3實(shí)現(xiàn)的字典、列表和json對(duì)象互轉(zhuǎn)功能,結(jié)合實(shí)例形式分析了Python使用json模塊針對(duì)json格式數(shù)據(jù)編碼轉(zhuǎn)換相關(guān)操作技巧,需要的朋友可以參考下2018-05-05python-jwt用戶認(rèn)證食用教學(xué)的實(shí)現(xiàn)方法
這篇文章主要介紹了python-jwt用戶認(rèn)證食用教學(xué)的實(shí)現(xiàn)方法,本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-01-01Python 實(shí)現(xiàn)日志同時(shí)輸出到屏幕和文件
這篇文章主要介紹了Python 實(shí)現(xiàn)日志同時(shí)輸出到屏幕和文件,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2020-02-02Django之全局使用request.user.username的實(shí)例詳解
這篇文章主要介紹了Django之全局使用request.user.username的實(shí)例詳解,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2020-05-05Python3爬蟲里關(guān)于識(shí)別微博宮格驗(yàn)證碼的知識(shí)點(diǎn)詳解
在本篇文章里小編給大家分享了關(guān)于Python3爬蟲里關(guān)于識(shí)別微博宮格驗(yàn)證碼的知識(shí)點(diǎn),有興趣的朋友們可以參考下。2020-07-07針對(duì)Pandas的總結(jié)以及數(shù)據(jù)讀取_pd.read_csv()的使用詳解
這篇文章主要針對(duì)Pandas總結(jié)以及數(shù)據(jù)讀取_pd.read_csv()的使用詳解做出了實(shí)例,講解非常全面,值得收藏,需要的朋友可以參考下2023-03-03Python采用Django開發(fā)自己的博客系統(tǒng)
這篇文章主要為大家詳細(xì)介紹了Python采用Django開發(fā)自己的博客系統(tǒng),文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2016-08-08