終結 Python 原生字典？這個庫要逆天了

本篇文章收錄於《Python黑魔法手冊》v3.0 第七章，手冊完整版在線閱讀地址： ython黑魔法手冊 3.0 文檔

---

字典是 Python 中基礎的數據結構之一，字典的使用，能夠說是很是的簡單粗暴，但即使是這樣一個與世無爭的數據結構，仍然有不少人 "用不慣它" 。

也許你並不以爲，但我相信，你看了這篇文章後，必定會和我同樣，對原生字典開始有了偏見。

我舉個簡單的例子吧

當你想訪問字典中的某個 key 時，你須要使用字典特定的訪問方式，而這種方式須要你鍵入 一對中括號 還有 一對引號

>>> profile = dict(name="iswbm")
>>> profile
{'name': 'iswbm'}
>>> profile["name"]
'iswbm'
複製代碼

是否是開始以爲忍無可忍了？

若是能夠像調用對象屬性同樣使用 . 去訪問 key 就行了，能夠省去不少多餘的鍵盤擊入，就像這樣子

>>> profile.name
'iswbm'
複製代碼

是的，今天這篇文章就是跟你們分享一種能夠直接使用 . 訪問和操做字典的一個黑魔法庫 -- munch。

1. 安裝方法

使用以下命令進行安裝

$ python -m pip install munch
複製代碼

2. 簡單示例

munch 有一個 Munch 類，它繼承自原生字典，使用 isinstance 能夠驗證

>>> from munch import Munch
>>> profile = Munch()
>>> isinstance(profile, dict)
True
>>>
複製代碼

並實現了點式賦值與訪問，profile.name 與 profile['name'] 是等價的

>>> profile.name = "iswbm"
>>> profile.age = 18
>>> profile
Munch({'name': 'iswbm', 'age': 18})
>>>
>>> profile.name
'iswbm'
>>> profile["name"]
'iswbm'
複製代碼

3. 兼容字典的全部操做

自己 Munch 繼承自 dict，dict 的操做也一樣適用於 Munch 對象，不妨再來驗證下

首先是：增刪改查

# 新增元素
>>> profile["gender"] = "male"
>>> profile
Munch({'name': 'iswbm', 'age': 18, 'gender': 'male'})

# 修改元素
>>> profile["gender"] = "female"
>>> profile
Munch({'name': 'iswbm', 'age': 18, 'gender': 'female'})

# 刪除元素
>>> profile.pop("gender")
'female'
>>> profile
Munch({'name': 'iswbm', 'age': 18})
>>>
>>> del profile["age"]
>>> profile
Munch({'name': 'iswbm'})
複製代碼

再者是：一些經常使用方法

>>> profile.keys()
dict_keys(['name'])
>>>
>>> profile.values()
dict_values(['iswbm'])
>>>
>>> profile.get('name')
'iswbm'
>>> profile.setdefault('gender', 'male')
'male'
>>> profile
Munch({'name': 'iswbm', 'gender': 'male'})
複製代碼

4. 設置返回默認值

當訪問一個字典中不存在的 key 時，會報 KeyError 的錯誤

>>> profile = {}
>>> profile["name"]
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
KeyError: 'name'
複製代碼

對於這種狀況，一般咱們會使用 get 來規避

>>> profile = {}
>>> profile.get("name", "undefined")
'undefined'
複製代碼

固然你在 munch 中仍然能夠這麼用，不過還有一種更好的方法：使用 DefaultMunch，它會在你訪問不存在的 key 時，給你返回一個設定好的默認值

>>> from munch import DefaultMunch
>>> profile = DefaultMunch("undefined", {"name": "iswbm"})
>>> profile
DefaultMunch('undefined', {'name': 'iswbm'})
>>> profile.age
'undefined'
>>> profile
DefaultMunch('undefined', {'name': 'iswbm'})
複製代碼

5. 工廠函數自動建立key

上面使用 DefaultMunch 僅當你訪問不存在的 key 是返回一個默認值，但這個行爲並不會修改原 munch 對象的任何內容。

若你想訪問不存在的 key 時，自動觸發給原 munch 中新增你想要訪問的 key ，併爲其設置一個默認值，能夠試一下 DefaultFactoryMunch 傳入一個工廠函數。

>>> from munch import DefaultFactoryMunch
>>> profile = DefaultFactoryMunch(list, name='iswbm')
>>> profile
DefaultFactoryMunch(list, {'name': 'iswbm'})
>>>
>>> profile.brothers
[]
>>> profile
DefaultFactoryMunch(list, {'name': 'iswbm', 'brothers': []})
複製代碼

6. 序列化的支持

Munch 支持序列化爲 JSON 或者 YAML 格式的字符串對象

轉換成 JSON

>>> from munch import Munch
>>> munch_obj = Munch(foo=Munch(lol=True), bar=100, msg='hello')
>>>
>>> import json
>>> json.dumps(munch_obj)
'{"foo": {"lol": true}, "bar": 100, "msg": "hello"}'
複製代碼

轉換成 YAML

>>> from munch import Munch
>>> munch_obj = Munch(foo=Munch(lol=True), bar=100, msg='hello')
>>> import yaml
>>> yaml.dump(munch_obj)
'!munch.Munch\nbar: 100\nfoo: !munch.Munch\n lol: true\nmsg: hello\n'
>>>
>>> print(yaml.dump(munch_obj))
!munch.Munch
bar: 100
foo: !munch.Munch
  lol: true
msg: hello

>>>
複製代碼

建議使用 safe_dump 去掉 !munch.Munch

>>> print(yaml.safe_dump(munch_obj))
bar: 100
foo:
  lol: true
msg: hello
複製代碼

7. 說說侷限性

以上就是關於 munch 的使用全解，munch 的進一步封裝使得數據的訪問及操做更得更加 Pythonic ，替換原生字典在大部分場景下都不會有太大問題。

但同時也不得不認可，munch 在一些場景下沒法達到原生字典的效果，好比我想字典裏的 key 爲 "1.2" 的時候，原生字典能很好的表示它。

>>> dict_obj = {"1.2": "hello"}
>>> dict_obj["1.2"]
'hello'
複製代碼

切換到 munch ，你會發現沒法在初始化 munch 對象的時候，傳入 1.2 的 key

>>> from munch import Munch
>>> dict_obj = Munch(1.2="hello")
  File "<stdin>", line 1
    dict_obj = Munch(1.2="hello")
                     ^
SyntaxError: expression cannot contain assignment, perhaps you meant "=="?
複製代碼

就算你用原生的字典的方式添加了這個 key-value，也根本沒法使用 . 的方式取到 1.2 對應的 value。

>>> from munch import Munch
>>> dict_obj = Munch()
>>> dict_obj["1.2"]="hello"
>>> dict_obj
Munch({'1.2': 'hello'})
>>> dict_obj.1.2
  File "<stdin>", line 1
    dict_obj.1.2
            ^
SyntaxError: invalid syntax
複製代碼

也正是由於這樣，原生字典至今仍是不可替代的存在。

以上就今天跟你們分享的內容，這篇文章是《Python黑魔法手冊》 v3.0 版的最後一篇文章，目前 PDF 已經制做完成。

這本手冊目前已經發布到了 Github，點擊這個連接便可下載：Release v3.0 · iswbm/magic-python

原創不容易，若文章對你有用，還請你給我 一個點贊，感激涕零！