Python模塊Addict的安裝與使用

Addit 是一個(gè)Python模塊，除了提供標(biāo)準(zhǔn)的字典語法外，Addit 生成的字典的值既可以使用屬性來獲取，也可以使用屬性進(jìn)行設(shè)置。

這意味著你不用再寫這樣的字典了：

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安裝：

pip installaddict

或通過conda：

conda installaddict -c conda-forge

Addit 在Python2.7+和Python3上都可以運(yùn)行。

2.用法

Addict 繼承自字典，但在訪問和設(shè)置其值方面更加靈活。使用 Addict 的字典是一種樂趣！
設(shè)置嵌套詞典的項(xiàng)是極其舒服的：

>>> from addict import Dict
>>> mapping = Dict()
>>> mapping.a.b.c.d.e = 2
>>> mapping
{'a': {'b': {'c': {'d': {'e': 2}}}}}

如果Dict是用任何可迭代值實(shí)例化的，它將遍歷并克隆這些值，然后寫入到對應(yīng)的屬性及值中，比如：

>>> mapping = {'a': [{'b': 3}, {'b': 3}]}
>>> dictionary = Dict(mapping)
>>> dictionary.a[0].b
3

但mapping['a']不再與dictionary['a']相同。

>>> mapping['a'] is dictionary['a']
False

當(dāng)然，此特點(diǎn)僅限于構(gòu)造函數(shù)，而不是在使用屬性或設(shè)置值時(shí)：

>>> a = Dict()
>>> b = [1, 2, 3]
>>> a.b = b
>>> a.b is b
True

3.要牢記的事情

記住，int不是有效的屬性名，因此必須使用 get/setitem 語法 設(shè)置/獲取 非字符串的 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 不會(huì)讓你覆蓋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.默認(rèn)值

對于不在字典中的鍵，Addit的行為如defaultdict(Dict)，因此丟失的鍵返回一個(gè)空的Dict而不是拋出KeyError如果此行為不是所需的，則可以使用以下方式恢復(fù)拋出KeyError：

>>> class DictNoDefault(Dict):
>>>   def __missing__(self, key):
>>>     raise KeyError(key)

但請注意，這樣會(huì)失去速記賦值功能(addicted.a.b.c.d.e = 2)

6.轉(zhuǎn)化為普通字典

如果你覺得將 Addict 傳遞到其他函數(shù)或模塊并不安全，請使用to_dict()方法，它返回會(huì)把 Addict 轉(zhuǎn)化為普通字典。

>>> 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'

當(dāng)您希望在幾行代碼中創(chuàng)建嵌套的字典，然后將其發(fā)送到不同的函數(shù)或模塊時(shí)，這非常適合：

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.計(jì)數(shù)

Dict輕松訪問和修改深度嵌套屬性的能力使其成為計(jì)數(shù)的理想選擇。使用Addict，你還可以容易允許按多個(gè)級別計(jì)數(shù)，內(nèi)部使用的原理是collections.Counter。

比如以下數(shù)據(jù)：

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'}
]

如果你想計(jì)算有多少人出生在born性別的gender使用eyes眼睛，你可以很容易地計(jì)算出這些信息：

counter = Dict()

for row in data:
    born = row['born']
    gender = row['gender']
    eyes = row['eyes']

    counter[born][gender][eyes] += 1 print(counter)

# 結(jié)果：{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的更新方式如下，它會(huì)遞歸并實(shí)際更新嵌套的字典：

>>> D = Dict({'a': {'b': 3}})
>>> D.update({'a': {'c': 4}})
>>> print(D)
{'a': {'b': 3, 'c': 4}}

9.Addict 是怎么來的？

這個(gè)模塊完全是從用Python創(chuàng)建Elasticsearch查詢的繁瑣過程中發(fā)展而來的。每當(dāng)你發(fā)現(xiàn)自己在寫了很復(fù)雜的字典邏輯時(shí)，只要記住你沒有必要這樣做，使用 Addict 就行。

審核編輯：湯梓紅