重写的魔法方法返回False？Python自定义字典类问题排查

我正在实现一个类字典的自定义类MeasurementDataset，为采集的测量数据提供一些便捷功能，代码如下：

class MeasurementDataset:
    def __init__(self):
        self._dict = dict()

    @staticmethod
    def hash_input(fnc):
        def wrapper(*args):
            args = list(args)
            if not isinstance(args[1], str):
                args[1] = tuple(args[1])
            fnc(*args)  # 未返回被装饰函数的执行结果

        return wrapper

    @hash_input
    def __contains__(self, key):
        print(f"internal check: {key in self._dict}")
        return key in self._dict

    @hash_input
    def __getitem__(self, key):
        print(f"internal check: {self._dict[key]}")
        return self._dict[key]

    @hash_input
    def __setitem__(self, key, value):
        self._dict[key] = value

原本期望这个类能像普通字典一样工作，但运行时发现，虽然魔法方法内部的执行结果正确，但最终输出却不符合预期：

In [3]: d = MeasurementDataset()

In [5]: key = (1, 2, 3, 4)

In [6]: value = f.measure(key)

In [15]: value
Out[15]: Measurement(cf=156.37, bw=35.84, loss=5.59)

In [7]: d[key] = value

In [12]: key in d
internal check: True
Out[12]: False

In [14]: print(d[key])
internal check: Measurement(cf=156.37, bw=35.84, loss=5.59)
None

问题原因 #

问题出在装饰器hash_input的wrapper函数上：它调用了被装饰的函数fnc(*args)，但没有返回该函数的执行结果。对于__contains__、__getitem__这类需要返回值的魔法方法来说，wrapper函数默认会返回None，这就导致外部调用时拿到的是None，而非魔法方法实际计算出的结果。

修复方案 #

在wrapper函数中返回fnc(*args)的执行结果即可，修改后的装饰器代码如下：

@staticmethod
def hash_input(fnc):
    def wrapper(*args):
        args = list(args)
        if not isinstance(args[1], str):
            args[1] = tuple(args[1])
        return fnc(*args)  # 添加返回语句

    return wrapper

修改后再运行测试代码，就能得到符合预期的结果：

In [12]: key in d
internal check: True
Out[12]: True

In [14]: print(d[key])
internal check: Measurement(cf=156.37, bw=35.84, loss=5.59)
Measurement(cf=156.37, bw=35.84, loss=5.59)

内容的提问来源于stack exchange，提问作者mttrns