<em>Mac</em>Book项目 2009年学校开始实施<em>Mac</em>Book项目,所有师生配备一本<em>Mac</em>Book,并同步更新了校园无线网络。学校每周进行电脑技术更新,每月发送技术支持资料,极大改变了教学及学习方式。因此2011
2021-06-01 09:32:01
在瞭解setup.py之前,有必要介紹一下python庫分發打包的前世今生。
平常我們習慣了使用 pip 來安裝一些第三方模組,這個安裝過程之所以簡單,是因為模組開發者為我們默默地為我們做了所有繁雜的工作,而這個過程就是 打包。
打包,就是將你的原始碼進一步封裝,並且將所有的部署工作都事先安排好,這樣使用者拿到後即裝即用,不用再操心如何部署的問題(如果你不想對照著一堆部署檔案手工操作的話)。
Python 發展了這麼些年了,專案打包工具也已經很成熟了。他們都有哪些呢?
你可能聽過 disutils、 distutils 、distutils2、setuptools等等,好像很熟悉,卻又很陌生,他們都是什麼關係呢?
distutils 是 Python 的一個標準庫,從命名上很容易看出它是一個分發(distribute)工具(utlis),它是 Python 官方開發的一個分發打包工具,所有後續的打包工具,全部都是基於它進行開發的。
distutils 的精髓在於編寫 setup.py,它是模組分發與安裝的指導檔案。
那麼如何編寫 setup.py 呢?這裡面的內容非常多,我會在後面進行詳細的解析,請你耐心往下看。
你有可能沒寫過 setup.py ,但你絕對使用過 setup.py 來做一些事情,比如下面這條命令,我們經常用它來進行模組的安裝。
$ python setup.py install
這樣的安裝方法叫原始碼安裝,與之對應的是通過二進位制軟體包安裝,同樣我也會在後面進行介紹。
setuptools 是 distutils 增強版,不包括在標準庫中。其擴充套件了很多功能,能夠幫助開發者更好的建立和分發 Python 包。大部分 Python 使用者都會使用更先進的 setuptools 模組。
distribute,或許你在其他地方也見過它,這裡也提一下。
distribute 是 setuptools 有一個分支版本,分支的原因可能是有一部分開發者認為 setuptools 開發太慢了。但現在,distribute 又合併回了 setuptools 中。因此,我們可以認為它們是同一個東西。
還有一個大包分發工具是 distutils2,其試圖嘗試充分利用distutils,detuptools 和 distribute 併成為 Python 標準庫中的標準工具。但該計劃並沒有達到預期的目的,且已經是一個廢棄的專案。
因此,setuptools 是一個優秀的,可靠的 Python 包安裝與分發工具。
通過pycharm建立虛擬環境時,都會預設安裝setuptools工具。
當你安裝完 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
總結一句:setuptools 是官方提供的一個專業用於包分發的工具,若只從安裝的角度來看,它的功能確實簡單。它更大的意義是對包的分發很有用,客製化化程式非常高,我們現在也還在用它進行版本包的釋出。
Python 包的分發可以分為兩種:
以原始碼包的方式釋出
以二進位制包形式釋出
安裝以原始碼包方式釋出的包的過程,是先解壓,再編譯,最後才安裝(上面提到的python setup.py install),所以它是跨平臺的,由於每次安裝都要進行編譯,相對二進包安裝方式來說安裝速度較慢。
原始碼包的本質是一個壓縮包,其常見的格式有:
二進位制包的安裝過程省去了編譯的過程,直接進行解壓安裝,所以安裝速度較原始碼包來說更快。
由於不同平臺的編譯出來的包無法通用,所以在釋出時,需事先編譯好多個平臺的包。
二進位制包的常見格式有:
Egg 格式是由 setuptools 在 2004 年引入,而 Wheel 格式是由 PEP427 在 2012 年定義。Wheel 的出現是為了替代 Egg,它的本質是一個zip包,其現在被認為是 Python 的二進位制包的標準格式。
以下是 Wheel 和 Egg 的主要區別:
$ pip install wheel $ pip wheel --wheel-dir=/local/wheels pkg
打包分發最關鍵的一步是編寫 setup.py 檔案。
以下是一個 setup.py 簡單的使用範例
from setuptools import setup, find_packages setup( name="mytest", version="1.0", author="name", author_email="name@163.com", # 專案地址 url="https://github.com/test/mytest", description="Learn to Pack Python Module", # 你要安裝的包,通過 setuptools.find_packages 自動發現當前目錄下有哪些包 packages=find_packages() )
接下來,我將慢慢擴充這個setup函數,增加更多的引數,以便你能理解setup函數能做哪些事情。
有些庫並不是在所有的 Python 版本中都適用的,若一個庫安裝在一個未相容的 Python 環境中,理論上不應該在使用時才報錯,而應該在安裝過程就使其失敗,提示禁止安裝。
這可以使用 python_requires 來實現。
setup( ... python_requires='>=2.7, <=3', )
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"], } )
from setuptools import setup, find_packages setup( name="mytest", version="1.0", author="name", author_email="name@163.com", description="Learn to Pack Python Module", url="https://github.com/test/mytest", 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'] } )
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( ... # 用來支援自動生成指令碼,安裝後會自動生成 /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 中,並新增可執行許可權。
setup.py 裡只能指定 version,而不能指定 release,如果你需要變更版本號,可以使用 --release 引數進行指定
python setup.py bdist_rpm --release=20200617
setup.py 的引數非常多,能夠不借助檔案寫好一個setup.py好像沒那麼簡單。為了備忘,我整理了 setup 函數常用的一些引數:
更多引數可見:https://setuptools.readthedocs.io/en/latest/setuptools.html
a、構建原始碼釋出包。
用於釋出一個 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檔案。可用格式為:
對以上的格式,有幾點需要注意一下:
另外,如果您希望歸檔檔案的所有檔案歸root擁有,可以這樣指定
python setup.py sdist --owner=root --group=root
b、構建二進位制分發包。
在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
正常情況下,我們都是通過以上構建的原始碼包或者二進位制包進行模組的安裝。
但在編寫 setup.py 的過程中,可能不能一步到位,需要多次偵錯,這時候如何測試自己寫的 setup.py 檔案是可用的呢?
這時候你可以使用python setup.py install命令,它會將你的模組安裝至系統全域性環境中.
如若你的專案還處於開發階段,頻繁的安裝模組,也是一個麻煩事。
這時候你可以使用這條命令安裝,該方法不會真正的安裝包,而是在系統環境中建立一個軟連結指向包實際所在目錄。這邊在修改包之後不用再安裝就能生效,便於偵錯。
$ python setup.py develop
通過上面的學習,你一定已經學會了如何打包自己的專案,若你覺得自己開發的模組非常不錯,想要 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
到此這篇關於python中的setup.py的文章就介紹到這了,更多相關python setup.py內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com!
相關文章
<em>Mac</em>Book项目 2009年学校开始实施<em>Mac</em>Book项目,所有师生配备一本<em>Mac</em>Book,并同步更新了校园无线网络。学校每周进行电脑技术更新,每月发送技术支持资料,极大改变了教学及学习方式。因此2011
2021-06-01 09:32:01
综合看Anker超能充系列的性价比很高,并且与不仅和iPhone12/苹果<em>Mac</em>Book很配,而且适合多设备充电需求的日常使用或差旅场景,不管是安卓还是Switch同样也能用得上它,希望这次分享能给准备购入充电器的小伙伴们有所
2021-06-01 09:31:42
除了L4WUDU与吴亦凡已经多次共事,成为了明面上的厂牌成员,吴亦凡还曾带领20XXCLUB全队参加2020年的一场音乐节,这也是20XXCLUB首次全员合照,王嗣尧Turbo、陈彦希Regi、<em>Mac</em> Ova Seas、林渝植等人全部出场。然而让
2021-06-01 09:31:34
目前应用IPFS的机构:1 谷歌<em>浏览器</em>支持IPFS分布式协议 2 万维网 (历史档案博物馆)数据库 3 火狐<em>浏览器</em>支持 IPFS分布式协议 4 EOS 等数字货币数据存储 5 美国国会图书馆,历史资料永久保存在 IPFS 6 加
2021-06-01 09:31:24
开拓者的车机是兼容苹果和<em>安卓</em>,虽然我不怎么用,但确实兼顾了我家人的很多需求:副驾的门板还配有解锁开关,有的时候老婆开车,下车的时候偶尔会忘记解锁,我在副驾驶可以自己开门:第二排设计很好,不仅配置了一个很大的
2021-06-01 09:30:48
不仅是<em>安卓</em>手机,苹果手机的降价力度也是前所未有了,iPhone12也“跳水价”了,发布价是6799元,如今已经跌至5308元,降价幅度超过1400元,最新定价确认了。iPhone12是苹果首款5G手机,同时也是全球首款5nm芯片的智能机,它
2021-06-01 09:30:45