从嵌套字典中删除字段的优雅方法

2023-12-14

我必须从字典中删除一些字段，这些字段的键在列表中。所以我写了这个函数：

def delete_keys_from_dict(dict_del, lst_keys):
    """
    Delete the keys present in lst_keys from the dictionary.
    Loops recursively over nested dictionaries.
    """
    dict_foo = dict_del.copy()  #Used as iterator to avoid the 'DictionaryHasChanged' error
    for field in dict_foo.keys():
        if field in lst_keys:
            del dict_del[field]
        if type(dict_foo[field]) == dict:
            delete_keys_from_dict(dict_del[field], lst_keys)
    return dict_del

这段代码可以工作，但它不是很优雅，我确信有更好的解决方案。

首先，我认为你的代码可以工作，但不能不优雅的。没有直接的理由不使用您提供的代码。

不过，有一些事情可以做得更好：

比较类型

您的代码包含以下行：

if type(dict_foo[field]) == dict:

这绝对是可以改进的。一般来说（另见PEP8）你应该使用isinstance而不是比较类型：

if isinstance(dict_foo[field], dict)

然而，这也会返回True if dict_foo[field]是一个子类dict。如果你不想这样，你也可以使用is代替==。这会稍微快一些（并且可能不易察觉）。

如果您还想允许任意类似字典的对象，您可以更进一步并测试它是否是collections.abc.MutableMapping。那将是True for dict and dict子类以及显式实现该接口而无需子类化的所有可变映射dict，例如UserDict:

>>> from collections import MutableMapping
>>> # from UserDict import UserDict # Python 2.x
>>> from collections import UserDict  # Python 3.x - 3.6
>>> # from collections.abc import MutableMapping # Python 3.7+
>>> isinstance(UserDict(), MutableMapping)
True
>>> isinstance(UserDict(), dict)
False

就地修改并返回值

通常，函数要么就地修改数据结构or返回一个新的（修改后的）数据结构。仅举几个例子：list.append, dict.clear, dict.update全部就地修改数据结构并且return None。这使得跟踪函数的作用变得更加容易。然而，这并不是一个硬性规则，并且该规则总是存在有效的例外情况。然而我个人认为这样的函数不需要是一个例外，我会简单地删除return dict_delline 并让它隐式返回None，但是YMMV。

从字典中删除键

您复制了字典以避免在迭代期间删除键值对时出现问题。但是，正如另一个答案已经提到的，您可以迭代应删除的键并尝试删除它们：

for key in keys_to_remove:
    try:
        del dict[key]
    except KeyError:
        pass

这还有一个额外的优点，那就是你不需要嵌套两个循环（其中could会更慢，特别是当需要删除的键的数量很长时）。

如果你不喜欢空虚except您还可以使用以下子句：contextlib.suppress（需要 Python 3.4+）：

from contextlib import suppress

for key in keys_to_remove:
    with suppress(KeyError):
        del dict[key]

变量名称

我会重命名一些变量，因为它们不具描述性，甚至具有误导性：

delete_keys_from_dict也许应该提到 subdict 处理，也许delete_keys_from_dict_recursive.
dict_del听起来像是被删除的字典。我倾向于更喜欢这样的名字dictionary or dct因为函数名称已经描述了对字典所做的操作。
lst_keys，那里也一样。我可能会用keys那里。如果你想更具体一些，比如keys_sequence会更有意义，因为它接受任何sequence（你只需要能够迭代它多次），而不仅仅是列表。
dict_foo，就是不行...
field也不太合适，这是一个key.

把它们放在一起：

正如我之前所说，我个人会就地修改字典not再次归还字典。因此，我提出了两种解决方案，一种是就地修改它但不返回任何内容，另一种是创建一个删除键的新字典。

就地修改的版本（非常像 Ned Batchelders 的解决方案）：

from collections import MutableMapping
from contextlib import suppress

def delete_keys_from_dict(dictionary, keys):
    for key in keys:
        with suppress(KeyError):
            del dictionary[key]
    for value in dictionary.values():
        if isinstance(value, MutableMapping):
            delete_keys_from_dict(value, keys)

返回一个新对象的解决方案：

from collections import MutableMapping

def delete_keys_from_dict(dictionary, keys):
    keys_set = set(keys)  # Just an optimization for the "if key in keys" lookup.

    modified_dict = {}
    for key, value in dictionary.items():
        if key not in keys_set:
            if isinstance(value, MutableMapping):
                modified_dict[key] = delete_keys_from_dict(value, keys_set)
            else:
                modified_dict[key] = value  # or copy.deepcopy(value) if a copy is desired for non-dicts.
    return modified_dict

然而，它只制作字典的副本，其他值不会作为副本返回，您可以轻松地将它们包装在copy.deepcopy（我在代码的适当位置添加了注释）如果您愿意的话。

本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)

python

Dictionary