Мутабельные аргументы в Python

В Python для параметра функции можно задать значение, которое будет использоваться по умолчанию:

def inc(n=0):
'''Increments the given `n`. Returns `1` if nothing is passed in.'''
return n + 1

inc() # 1
inc(3) # 4

В JavaScript тоже так можно:

function inc(n = 0) {
return n + 1;
}

inc(); // 1
inc(3); // 4

В примерах выше значение n — число 0, неизменяемый (иммутабельный) примитив. С неизменяемыми значениями (число, строка, кортеж и пр.) всё работает прозрачно и ожидаемо. Однако, если значение будет изменяемое (ссылка на объект), но Питон может больно укусить:

def f(s=[]):
'''Appends `5` to the given list `s` and returns its length.'''
s.append(5)
return len(s)

f() # 1
f() # 2, хопа-ча!
f() # 3, хопа-ча-ча!
f() # 4, хопа-ча-ча-ча!
# ...

Для наглядности вот схема окружения функции f. Видно, что каждый раз 5 добавляется в одно и то же место:

s — это ссылка на объект, значение которого по-умолчанию является пустым списком. Когда Питон инициализирует функцию f (интерпретирует инструкцию def ...), он создаёт связывание s = [] один раз. При последующих вызовах f используется уже существующая ссылка s, чьё значение мутирует. Документация говорит, что так не планировалось:

Default parameter values are evaluated from left to right when the function definition is executed. This means that the expression is evaluated once, when the function is defined, and that the same “pre-computed” value is used for each call. This is especially important to understand when a default parameter is a mutable object, such as a list or a dictionary: if the function modifies the object (e.g. by appending an item to a list), the default value is in effect modified. This is generally not what was intended. A way around this is to use None as the default, and explicitly test for it in the body of the function, e.g.:

def whats_on_the_telly(penguin=None):
if penguin is None:
penguin = []
penguin.append("property of the zoo")
return penguin

Хотим предсказуемый дефолтный список — делаем проверку вручную.

JavaScript тут ведёт себя нормально, т.к. инициализирует аргумент каждый раз при вызове функции, а не в момент её создания:

The default argument is evaluated at call time. So, unlike (for example) Python, a new object is created each time the function is called.

function f(s = []) {
s.push(5);
return s.length;
}
f() // 1
f() // 1
// ..., the value doesn't change.

На схеме видно, что функция f при каждом вызове создаёт s в своём локальном окружении:

Локальная переменная s будет при каждом вызове f указывать на новое значение [], никак не касаясь тех значений, которые были созданы в предыдущих вызовах.

Написано по мотивам вот этой лекции про мутации.