Как питонный способ избежать параметров по умолчанию, которые являются пустыми списками?

Question

Иногда кажется естественным иметь параметр по умолчанию, который является пустым списком. Тем не менее Python дает неожиданное поведение в этих ситуациях .

Если, например, у меня есть функция:

def my_func(working_list = []):
    working_list.append("a")
    print(working_list)

При первом вызове по умолчанию сработает, но после этого вызовы обновят существующий список (по одному вызову «a») и напечатают обновленную версию.

Итак, какой же питонный способ получить желаемое поведение (новый список при каждом вызове)?

Answer 1

def my_func(working_list=None):
    if working_list is None: 
        working_list = []

    working_list.append("a")
    print(working_list)

Документы говорят, что вы должны использовать None в качестве значения по умолчанию и явно проверить его в теле функции.

Answer 2

Существующие ответы уже предоставили прямые решения в соответствии с просьбой. Тем не менее, поскольку это очень распространенная ошибка для новых программистов на Python, стоит добавить объяснение, почему Python ведет себя таким образом, которое хорошо изложено в " Руководстве автостопом по Python " как " Mutable Аргументы по умолчанию": http://docs.python -guide.org / ен / последний / запись / подводные камни /

Цитата: " Аргументы Python по умолчанию оцениваются один раз при определении функции, а не каждый раз, когда вызывается функция (как, например, в Ruby). Это означает, что если вы используете изменяемый аргумент по умолчанию и изменяете это, вы будете и мутировали этот объект для всех будущих вызовов этой функции"

Пример кода для его реализации:

def foo(element, to=None):
    if to is None:
        to = []
    to.append(element)
    return to

Answer 3

Не то, чтобы это имело значение в этом случае, но вы можете использовать идентификатор объекта для проверки на None:

if working_list is None: working_list = []

Вы также можете воспользоваться булевым оператором или определенным в python:

working_list = working_list or []

Хотя это будет вести себя неожиданно, если вызывающая сторона выдаст вам пустой список (который считается ложным) как working_list и ожидает, что ваша функция изменит список, который он ему дал.

Answer 4

Если функция предназначена для изменения параметра, переданного как working_list, см. Ответ HenryR (= Нет, проверьте наличие Нет внутри).

Но если вы не намеревались изменить аргумент, просто используйте его в качестве отправной точки для списка, вы можете просто скопировать его:

def myFunc(starting_list = []):
    starting_list = list(starting_list)
    starting_list.append("a")
    print starting_list

(или в этом простом случае просто print starting_list + ["a"], но я думаю, это был просто игрушечный пример)

В общем, изменение ваших аргументов - плохой стиль в Python. Единственные функции, которые, как ожидается, будут мутировать объект, - это методы объекта. Еще реже мутировать необязательный аргумент - действительно ли побочный эффект, который происходит только при некоторых вызовах, действительно лучший интерфейс?

• Если вы делаете это из привычки C к «выходным аргументам», это совершенно не нужно - вы всегда можете вернуть несколько значений в виде кортежа.

• Если вы делаете это для эффективного построения длинного списка результатов без создания промежуточных списков, попробуйте написать его как генератор и использовать result_list.extend(myFunc()) при вызове. Таким образом, ваши соглашения о вызовах остаются очень чистыми.

Один шаблон, в котором часто делается мутирование необязательного аргумента , представляет собой скрытый аргумент "memo" в рекурсивных функциях:

def depth_first_walk_graph(graph, node, _visited=None):
    if _visited is None:
        _visited = set()  # create memo once in top-level call

    if node in _visited:
        return
    _visited.add(node)
    for neighbour in graph[node]:
        depth_first_walk_graph(graph, neighbour, _visited)

Answer 5

Я могу быть не по теме, но помните, что если вы просто хотите передать переменное число аргументов, питонический способ - передать кортеж *args или словарь **kargs. Они не обязательны и лучше синтаксиса myFunc([1, 2, 3]).

Если вы хотите передать кортеж:

def myFunc(arg1, *args):
  print args
  w = []
  w += args
  print w
>>>myFunc(1, 2, 3, 4, 5, 6, 7)
(2, 3, 4, 5, 6, 7)
[2, 3, 4, 5, 6, 7]

Если вы хотите передать словарь:

def myFunc(arg1, **kargs):
   print kargs
>>>myFunc(1, option1=2, option2=3)
{'option2' : 2, 'option1' : 3}

Answer 6

Там уже были хорошие и правильные ответы. Я просто хотел дать другой синтаксис для написания того, что вы хотите делать, что я считаю более красивым, когда вы, например, хотите создать класс с пустыми списками по умолчанию:

class Node(object):
    def __init__(self, _id, val, parents=None, children=None):
        self.id = _id
        self.val = val
        self.parents = parents if parents is not None else []
        self.children = children if children is not None else []

Этот фрагмент использует синтаксис оператора if else. Мне это особенно нравится, потому что это аккуратная маленькая строчка без двоеточий и т. Д., И она почти читается как обычное английское предложение. :)

В вашем случае вы могли бы написать

def myFunc(working_list=None):
    working_list = [] if working_list is None else working_list
    working_list.append("a")
    print working_list