python中的utils模块_使用Python的package机制如何简化utils包设计详解
package 機制
package是模塊的集合,每一個Package的根目錄下面都應當有一個__init__.py 文件。當解釋器發現目錄下有這個文件時,他就會認為這是一個Package,而不是一個普通的目錄。
對于 package 機制的說明,其實官方文檔已經有非常詳盡的論述了,本文并不著眼于此。
簡單來說,一個目錄下如果包含 __init__.py ,則被 Python 視作一個 Python package。其中:
__init__.py 中的東西,在初始化這個包時,會首先被加載
package 中還可以定義 sub package
初衷
為了概念統一,我們把寫代碼的人,大致分為兩種角色:
Library Author
Caller 即 API 使用者
有時候我們會是 1 或者 2,有時候我們可能既是 1 又是 2 ( 比如負責一個較大的系統時)
很顯然,本文的角度是從 1 出發的(即我們只扮演庫作者,并且不知道我們的調用者是誰)。
最開始時,utils 可能僅僅是一個 utils.py 就可以了,然后調用者 from utils import XXUtils 就完事了,這自然沒有本文什么事。
然而大部分情況不是這樣的,所有 Utils 都放到一個文件里面是 stupid 的(一個源碼文件最多 400~500行 )。所以我們的目錄結構會是這樣的:
utils/
__init__.py
a_util.py
b_util.py
......
調用者怎么使用呢?from utils.a_util import AUtils
這種方式有一個假定:調用者要很清楚他所需要的 Utils 位于哪個 py 文件中。但是這種假定并不總是成立,大家對于同一概念的理解,極有可能是千差萬別的。比如 utils,你覺得叫做 utils 合適,別人還覺得叫做 tools 合適呢,其實都是同一個東西。
顯然,這加重了調用者的心智負擔。更加顯然的是,作為庫作者,我們有義務來優化調用者的使用體驗!(不然你的庫再牛逼,沒有人愛用也是空彈琴。)
HOW
合理利用 package 機制,就能馬上優化這一體驗。
我們只要在 __init__.py 中這么寫即可:
__init__.py
from .a_util import AUtils
from .b_util import BUtils
調用者則仍然是這么使用:
from utils import AUtils,BUtils
即:調用者根本不關心你的實現在哪里,你只要給我一個 utils 的命名空間即可,而且確保所有的 Utils 都在這個命名空間里面。
為了更加符合 PEP8 的規范,作為庫作者,我們的目錄結構可能會變成這樣:
utils/
__init__.py
_a_util.py 不對外界公開,僅限本package的其他模塊使用
_b_util.py
應用
不僅是對于 utils 包,對與 constants 包,exceptions 包也可以應用此方法。在許多開源庫中,大牛們經常使用這一手法來優化我們的體驗(太常見了,幾乎大部分開源庫的 __init__.py 中都會寫東西)
總結
以上就是這篇文章的全部內容了,希望本文的內容對大家的學習或者工作具有一定的參考學習價值,如果有疑問大家可以留言交流,謝謝大家對編程小技巧的支持。
總結
以上是生活随笔為你收集整理的python中的utils模块_使用Python的package机制如何简化utils包设计详解的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: problem a: 简单的整数排序_什
- 下一篇: java开发流程图_Java 详解 JV