本文主要是对禁止使用可变对象作为参数默认值的编码规范进行了详细介绍。
今天给大家带来的是一篇编程规范方面的内容。
有时候我们在编写函数时，会需要给一些参数设置默认值，这个时候我们需要牢记一点：禁止使用可变对象作为参数默认值。
从一个“反例”开始
我们先编写一个不符合规范的“反例”看看：
# 【反例】
def f(a, lst=[]):
lst.append(a)
return lst
在上面的反例中，我们就使用了可变对象列表，作为我们的参数默认值。
接下来我们用静态代码检查工具pylint检查一下上面的“反例“：
pylint example.py
# Output
************* Module example
example.py:1:0: C0114: Missing module docstring (missing-module-docstring)
example.py:1:0: W0102: Dangerous default value [] as argument (dangerous-default-value)
example.py:1:0: C0103: Function name "f" doesn't conform to snake_case naming style (invalid-name)
example.py:1:0: C0103: Argument name "a" doesn't conform to snake_case naming style (invalid-name)
example.py:1:0: C0116: Missing function or method docstring (missing-function-docstring)
------------------------------------
Your code has been rated at -6.67/10
这里主要看第二条建议：example.py:1:0: W0102: Dangerous default value [] as argument (dangerous-default-value)。
非常明显地提示列表[]是一个危险的默认值，这究竟是为什么呢？
为什么可变对象作为函数默认值很危险？
我们还是使用上面那个简单的“反例”，再传递几个参数，通过结果，就可以明显地看到为什么不建议我们这样做了。
# 【反例】
def f(a, lst=[]):
lst.append(a)
return lst
print(f('1')) # 期望 -> ['1']
print(f('2')) # 期望 -> ['2']
print(f('3', [])) # 期望 -> ['3']
print(f('3', ['1', '2'])) # 期望 -> ['1', '2', '3']
# 实际输出
['1']
['1', '2']
['3']
['1', '2', '3']
从结果我们可以看到，第二次调用函数f('2')的结果是跟我们预期不符的，我们本来的期望值是没有传入lst参数，那么应该给我们返回一个['2']，但是实际结果却是['1', '2']。
这是因为Python函数的默认值只会创建一次，之后第二次调用的时候就是在原默认值上进行修改，而不是重新创建了一个新的默认值，这也就能够解释得通实际结果为什么是这样的了。
所以说，使用可变对象作为默认值会导致得到超出我们预期的结果，这可能会导致出现一些无法定位的bug。
那么，我们应该怎么做？
我们应该怎么做？
既然我们不能使用可变对象作为参数默认值，那么使用不可变对象作为参数默认值就好了，然后再在代码中对默认值的数据类型进行修改。
# 【正例】写法一
def f(a, lst=None):
if not lst:
lst = []
lst.append(a)
return lst
print(f('1')) # 期望 -> ['1']
print(f('2')) # 期望 -> ['2']
print(f('3', [])) # 期望 -> ['3']
print(f('3', ['1', '2'])) # 期望 -> ['1', '2', '3']
# 实际输出
['1']
['2']
['3']
['1', '2', '3']
可以看到，把参数默认值设置为不可变对象的写法就完全符合我们的预期了。
我们还可以简化成下面的写法：
# 【正例】写法二
def f(a, lst=None):
lst = lst or []
lst.append(a)
return lst
上面两种写法都是等价的，而且用pylint检查也不会再出现那个警告了。
今天关于这个编码规范的介绍就到此结束了，喜欢的朋友们可以点一个关注，后续会输出更多关于Python编码规范的相关内容。
网友评论