Addit 是一个Python模块,除了提供标准的字典语法外,Addit 生成的字典的值既可以使用属性来获取,也可以使用属性进行设置。
这意味着你不用再写这样的字典了:
- body = {
- 'query': {
- 'filtered': {
- 'query': {
- 'match': {'description': 'addictive'}
- },
- 'filter': {
- 'term': {'created_by': 'Mats'}
- }
- }
- }
- }
复制代码
相反,你只需编写以下三行代码就能完成目的:
- body = Dict()
- body.query.filtered.query.match.description = 'addictive'
- body.query.filtered.filter.term.created_by = 'Mats'
复制代码
1.安装
你可以通过pip安装:
或通过conda :
- conda install addict -c conda-forge
复制代码
Addit 在Python2.7+和Python3上都可以运行。
2.用法
Addict 继承自字典,但在访问和设置其值方面更加灵活。使用 Addict 的字典是一种乐趣!
设置嵌套词典的项是极其舒服的:
- >>> from addict import Dict
- >>> mapping = Dict()
- >>> mapping.a.b.c.d.e = 2
- >>> mapping
- {'a': {'b': {'c': {'d': {'e': 2}}}}}
复制代码
如果Dict是用任何可迭代值实例化的,它将遍历并克隆这些值,然后写入到对应的属性及值中,比如:
- >>> mapping = {'a': [{'b': 3}, {'b': 3}]}
- >>> dictionary = Dict(mapping)
- >>> dictionary.a[0].b
- 3
复制代码
但mapping['a']不再与dictionary['a']相同。
- >>> mapping['a'] is dictionary['a']
- False
复制代码
当然,此特点仅限于构造函数,而不是在使用属性或设置值时:
- >>> a = Dict()
- >>> b = [1, 2, 3]
- >>> a.b = b
- >>> a.b is b
- True
复制代码
3.要牢记的事情
记住,int不是有效的属性名,因此必须使用 get/setitem 语法 设置/获取 非字符串的 dict 键:
- >>> mapping = Dict()
- >>> mapping.keys = 2
- Traceback (most recent call last):
- File "", line 1, in
- File "addict/addict.py", line 53, in __setattr__
- raise AttributeError("'Dict' object attribute '%s' is read-only" % name)
- AttributeError: 'Dict' object attribute 'keys' is read-only
复制代码
不过,你可以随意混合使用这两种语法:
- >>> addicted.a.b['c'].d.e
- 2
复制代码
4.属性,如键、item等
Addit 不会让你覆盖dict的属性,因此以下操作将不起作用:
- >>> mapping = Dict()
- >>> mapping.keys = 2
- Traceback (most recent call last):
- File "", line 1, in
- File "addict/addict.py", line 53, in __setattr__
- raise AttributeError("'Dict' object attribute '%s' is read-only" % name)
- AttributeError: 'Dict' object attribute 'keys' is read-only
复制代码
不过,使用下面这种方式就可以:
- >>> a = Dict()
- >>> a['keys'] = 2
- >>> a
- {'keys': 2}
- >>> a['keys']
- 2
复制代码
5.默认值
对于不在字典中的键,Addit的行为如defaultdict(Dict),因此丢失的键返回一个空的Dict而不是抛出KeyError如果此行为不是所需的,则可以使用以下方式恢复抛出KeyError:
>>> class DictNoDefault(Dict):
- >>> def __missing__(self, key):
- >>> raise KeyError(key)
复制代码
但请注意,这样会失去速记赋值功能(addicted.a.b.c.d.e = 2)
6.转化为普通字典
如果你觉得将 Addict 传递到其他函数或模块并不安全,请使用to_dict()方法,它返回会把 Addict 转化为普通字典。
- >>> regular_dict = my_addict.to_dict()
- >>> regular_dict.a = 2
- Traceback (most recent call last):
- File "", line 1, in
- AttributeError: 'dict' object has no attribute 'a'
复制代码
当您希望在几行代码中创建嵌套的字典,然后将其发送到不同的函数或模块时,这非常适合:
- body = Dict()
- body.query.filtered.query.match.description = 'addictive'
- body.query.filtered.filter.term.created_by = 'Mats'
- third_party_module.search(query=body.to_dict())
复制代码
7.计数
Dict轻松访问和修改深度嵌套属性的能力使其成为计数的理想选择。使用Addict,你还可以容易允许按多个级别计数,内部使用的原理是collections.Counter。
比如以下数据:
- data = [
- {'born': 1980, 'gender': 'M', 'eyes': 'green'},
- {'born': 1980, 'gender': 'F', 'eyes': 'green'},
- {'born': 1980, 'gender': 'M', 'eyes': 'blue'},
- {'born': 1980, 'gender': 'M', 'eyes': 'green'},
- {'born': 1980, 'gender': 'M', 'eyes': 'green'},
- {'born': 1980, 'gender': 'F', 'eyes': 'blue'},
- {'born': 1981, 'gender': 'M', 'eyes': 'blue'},
- {'born': 1981, 'gender': 'F', 'eyes': 'green'},
- {'born': 1981, 'gender': 'M', 'eyes': 'blue'},
- {'born': 1981, 'gender': 'F', 'eyes': 'blue'},
- {'born': 1981, 'gender': 'M', 'eyes': 'green'},
- {'born': 1981, 'gender': 'F', 'eyes': 'blue'}
- ]
复制代码
如果你想计算有多少人出生在born性别的gender使用eyes眼睛,你可以很容易地计算出这些信息:
counter = Dict()
- for row in data:
- born = row['born']
- gender = row['gender']
- eyes = row['eyes']
- counter[born][gender][eyes] += 1 print(counter)
- # 结果:{1980: {'M': {'blue': 1, 'green': 3}, 'F': {'blue': 1, 'green': 1}}, 1981: {'M': {'blue': 2, 'green': 1}, 'F': {'blue': 2, 'green': 1}}}
复制代码
8.更新普通字典的更新方式如下:
- >>> d = {'a': {'b': 3}}
- >>> d.update({'a': {'c': 4}})
- >>> print(d)
- {'a': {'c': 4}}
复制代码
addict的更新方式如下,它会递归并实际更新嵌套的字典:
- >>> D = Dict({'a': {'b': 3}})
- >>> D.update({'a': {'c': 4}})
- >>> print(D)
- {'a': {'b': 3, 'c': 4}}
复制代码
9.Addict 是怎么来的?
这个模块完全是从用Python创建Elasticsearch查询的繁琐过程中发展而来的。每当你发现自己在写了很复杂的字典逻辑时,只要记住你没有必要这样做,使用 Addict 就行。
|