利用 Python 的 package 機制簡化 utils 包設計

package 機制

對於 package 機制的說明，其實官方文檔已經有很是詳盡的論述了，本文並不着眼於此。

簡單來講，一個目錄下若是包含 __init__.py ，則被 Python 視做一個 Python package。其中：

1. __init__.py 中的東西，在初始化這個包時，會首先被加載
2. package 中還能夠定義 sub package

初衷

爲了概念統一，咱們把寫代碼的人，大體分爲兩種角色：

1. Library Author
2. 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 中都會寫東西）