Изменяемые значения по умолчанию в Python: отличайте пропущенные аргументы от общего состояния

Что это такое

Python вычисляет значения аргументов функции по умолчанию при выполнении определения, а не при каждом вызове. Учебник особо отмечает изменяемые значения по умолчанию, такие как списки и словари, поскольку последующие вызовы могут наблюдать изменения того же объекта. В нём показано создание нового списка внутри функции, если аргумент пропущен. Python default argument values

Почему это важно

Агент может очистить список в конце вызова и посчитать, что изоляция восстановлена. При этом выходы по исключению и намеренное совместное использование остаются неясными. Прежде чем реализовывать значение по умолчанию, определите, означает ли пропущенный аргумент новый объект, общий объект или отсутствие значения.

Как применять

• Изучите сигнатуру функции и каждое изменение значения, используемого по умолчанию. Проследите и вложенные изменяемые объекты: неизменяемый внешний контейнер сам по себе не задаёт новый вложенный объект для каждого вызова.
• Если при пропуске аргумента должно выделяться новое значение, используйте маркер отсутствующего значения и создавайте объект внутри функции. None подходит только тогда, когда сам по себе не является значимым отдельным входным значением.
• Предложите последовательные вызовы с пропущенным аргументом и проверьте независимость их результатов. Включите вызов, завершающийся ошибкой на полпути, чтобы изоляция не основывалась на очистке.
• Отдельно тестируйте значения, явно переданные вызывающей стороной. Решите, должна ли функция менять переданный объект или работать с копией, и документируйте этот контракт.
• Проверьте адаптеры и обёртки на передачу аргументов, которая случайно превращает пропуск в значимое значение. Сохраняйте требуемое различие во всём публичном API.

Подводные камни

Некоторые функции намеренно используют сохраняемое между вызовами состояние по умолчанию, но для этого нужны явный контракт и проверка конкурентного выполнения. Не заменяйте общий кэш выделением памяти для каждого вызова, не рассмотрев требуемое поведение. Маркер должен оставаться отличимым от допустимых входных данных. Предложенные тестовые примеры определяют, что проверять; в этой статье не заявляется ни об измеренной частоте дефектов, ни о выполненном наборе регрессионных тестов.