Summary of magic method

下面列表是目前所提到的所有魔术方法的汇总。

Caveats in Python

Mutable default arguments

看下面的例子

def wrong_user_input(user_data: dict = {'name': 'yuri', 'age': 23}):

name = user_data.pop('name')

age = user_data.pop('age')

return f"{name}({age})"

执行结果

>>> wrong_user_input()

'yuri (23)'

>>> wrong_user_input({'name': 'jerry', 'age': 15})

'jerry (15)'

>>> wrong_user_input()

Traceback (most recent call last):

File "", line 1, in

File "testinput.py", line 10, in wrong_user_input

name = user_data.pop('name')

KeyError: 'name'

可以看到如果使用可变变量作为函数默认参数，那么就会出现上述情况。调用几次之后会发现默认参数被修改到面目全非。

这时候可以修改如下：

def correct_user_input(user_data: dict = None):

user_data = user_data or {'name': 'yuri', 'age': 23}

name = user_data.pop('name')

age = user_data.pop('age')

return f"{name}({age})"

执行结果

>>> correct_user_input()

'yuri (23)'

>>> correct_user_input({'name': 'jerry', 'age': 15})

'jerry (15)'

>>> correct_user_input()

'yuri (23)'

可以看到无论怎么调用，函数都不会出错。

Extending built-in type

扩展内置类型的正确做法是使用 collections 模块里面的带 User 开头的类。比如， 想要扩展 List，就可以使用 UserList，再比如想要扩展 Dict，就可以使用 UserDict。看下面的例子：

class BadDict(dict):

"""docstring for MyDict"""

def __getitem__(self, key):

value = super().__getitem__(key)

if value % 2 == 0:

prefix = "even"

else:

prefix = "odd"

return f"{key}:{prefix}({value})"

执行结果

>>> bd = BadDict({"one": 2, "two": 5})

>>> bd['one']

'one: even(2)'

>>> [item for item in bd.items()]

[('one', 2), ('two', 5)]

>>>

可以看到，当执行循环的时候字典的值并不是所预期的加上 prefix。

虽然在其他编译器可能不会出现这种情况，比如 Pypy，但是最好是能写出适配所有情况的代码，修改如下：

class GoodDict(UserDict):

"""docstring for MyDict"""

def __getitem__(self, key):

value = super().__getitem__(key)

if value % 2 == 0:

prefix = "even"

else:

prefix = "odd"

return f"{key}: {prefix}({value})"

这次我们改用 UserDict 类，执行结果如下：

>>> gd = GoodDict({"one": 2, "two": 5})

>>> gd['one']

'one: even(2)'

>>> [item for item in gd.items()]

[('one', 'one: even(2)'), ('two', 'two: odd(5)')]

可以见到，一切如预期。