使用Python的package機(jī)制如何簡化utils包設(shè)計(jì)詳解
package 機(jī)制
package是模塊的集合,每一個(gè)Package的根目錄下面都應(yīng)當(dāng)有一個(gè)__init__.py 文件。當(dāng)解釋器發(fā)現(xiàn)目錄下有這個(gè)文件時(shí),他就會(huì)認(rèn)為這是一個(gè)Package,而不是一個(gè)普通的目錄。
對(duì)于 package 機(jī)制的說明,其實(shí)官方文檔已經(jīng)有非常詳盡的論述了,本文并不著眼于此。
簡單來說,一個(gè)目錄下如果包含 __init__.py ,則被 Python 視作一個(gè) Python package。其中:
- __init__.py 中的東西,在初始化這個(gè)包時(shí),會(huì)首先被加載
- package 中還可以定義 sub package
初衷
為了概念統(tǒng)一,我們把寫代碼的人,大致分為兩種角色:
- Library Author
- Caller 即 API 使用者
有時(shí)候我們會(huì)是 1 或者 2, 有時(shí)候我們可能既是 1 又是 2 ( 比如負(fù)責(zé)一個(gè)較大的系統(tǒng)時(shí))
很顯然,本文的角度是從 1 出發(fā)的(即我們只扮演庫作者,并且不知道我們的調(diào)用者是誰)。
最開始時(shí),utils 可能僅僅是一個(gè) utils.py 就可以了,然后調(diào)用者 from utils import XXUtils 就完事了,這自然沒有本文什么事。
然而大部分情況不是這樣的,所有 Utils 都放到一個(gè)文件里面是 stupid 的(一個(gè)源碼文件最多 400~500行 )。所以我們的目錄結(jié)構(gòu)會(huì)是這樣的:
utils/ __init__.py a_util.py b_util.py ......
調(diào)用者怎么使用呢?from utils.a_util import AUtils
這種方式有一個(gè)假定:調(diào)用者要很清楚他所需要的 Utils 位于哪個(gè) py 文件中。但是這種假定并不總是成立,大家對(duì)于同一概念的理解,極有可能是千差萬別的。比如 utils,你覺得叫做 utils 合適,別人還覺得叫做 tools 合適呢,其實(shí)都是同一個(gè)東西。
顯然,這加重了調(diào)用者的心智負(fù)擔(dān)。更加顯然的是,作為庫作者,我們有義務(wù)來優(yōu)化調(diào)用者的使用體驗(yàn)?。ú蝗荒愕膸煸倥1?,沒有人愛用也是空彈琴。)
HOW
合理利用 package 機(jī)制,就能馬上優(yōu)化這一體驗(yàn)。
我們只要在 __init__.py 中這么寫即可:
__init__.py from .a_util import AUtils from .b_util import BUtils
調(diào)用者則仍然是這么使用:
from utils import AUtils, BUtils
即:調(diào)用者根本不關(guān)心你的實(shí)現(xiàn)在哪里,你只要給我一個(gè) utils 的命名空間即可,而且確保所有的 Utils 都在這個(gè)命名空間里面。
為了更加符合 PEP8 的規(guī)范,作為庫作者,我們的目錄結(jié)構(gòu)可能會(huì)變成這樣:
utils/ __init__.py _a_util.py 不對(duì)外界公開, 僅限本package的其他模塊使用 _b_util.py
應(yīng)用
不僅是對(duì)于 utils 包,對(duì)與 constants 包,exceptions 包也可以應(yīng)用此方法。在許多開源庫中,大牛們經(jīng)常使用這一手法來優(yōu)化我們的體驗(yàn)(太常見了,幾乎大部分開源庫的 __init__.py 中都會(huì)寫東西)
總結(jié)
以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,如果有疑問大家可以留言交流,謝謝大家對(duì)腳本之家的支持。
- Python標(biāo)準(zhǔn)庫之Sys模塊使用詳解
- python標(biāo)準(zhǔn)日志模塊logging的使用方法
- Python中os和shutil模塊實(shí)用方法集錦
- Python的subprocess模塊總結(jié)
- Python os模塊介紹
- python的正則表達(dá)式re模塊的常用方法
- Python中內(nèi)置的日志模塊logging用法詳解
- python中requests模塊的使用方法
- 對(duì)Python進(jìn)行數(shù)據(jù)分析_關(guān)于Package的安裝問題
- python一鍵升級(jí)所有pip package的方法
- Python開發(fā)常用的一些開源Package分享
- Python模塊、包(Package)概念與用法分析
相關(guān)文章
pytorch模型預(yù)測結(jié)果與ndarray互轉(zhuǎn)方式
今天小編就為大家分享一篇pytorch模型預(yù)測結(jié)果與ndarray互轉(zhuǎn)方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2020-01-01
一文帶你掌握Python?Seaborn數(shù)據(jù)可視化高級(jí)篇
這篇文章主要為大家詳細(xì)介紹了如何使用?Seaborn?創(chuàng)建復(fù)合圖形,如網(wǎng)格圖、因子圖和聚類熱圖等,文中示例代碼講解詳細(xì),感興趣的小伙伴可以學(xué)習(xí)一下2023-07-07
scrapy結(jié)合selenium解析動(dòng)態(tài)頁面的實(shí)現(xiàn)
這篇文章主要介紹了scrapy結(jié)合selenium解析動(dòng)態(tài)頁面的實(shí)現(xiàn),文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-09-09
Django實(shí)現(xiàn)支付寶付款和微信支付的示例代碼
支付寶支付和微信支付是當(dāng)今互聯(lián)網(wǎng)產(chǎn)品常用的功能,這篇文章主要介紹了Django實(shí)現(xiàn)支付寶付款和微信支付的示例代碼,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2018-07-07
Python模塊_PyLibTiff讀取tif文件的實(shí)例
今天小編就為大家分享一篇Python模塊_PyLibTiff讀取tif文件的實(shí)例,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2020-01-01
Python這樣操作能存儲(chǔ)100多萬行的xlsx文件
這篇文章主要介紹了Python這樣操作能存儲(chǔ)100多萬行的xlsx文件的方法,本文通過實(shí)例代碼給大家介紹的非常詳細(xì),具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2019-04-04
python redis 批量設(shè)置過期key過程解析
這篇文章主要介紹了python redis 批量設(shè)置過期key過程解析,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2019-11-11

