Python黑魔法库安装及操作字典示例详解

本篇文章收录于《python黑魔法手册》v3.0 第七章，手册完整版在线阅读地址：python黑魔法手册 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

>>> dict_obj = {"1.2": "hello"}
>>> dict_obj["1.2"]
'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

以上就是python黑魔法库安装及操作字典示例详解的详细内容，更多关于黑魔法库安装及操作的资料请关注其它相关文章！