Блог

Я хочу написать функцию генератора Python, которая на самом деле никогда ничего не выдает. По сути, это выпадающий список «ничего не делать», который может использоваться другим кодом, который ожидает вызова генератора (но не всегда нуждается в результатах от него). Пока у меня есть это:

 def empty_generator():
    # ... do some stuff, but don't yield anything
    if False:
        yield
  

Теперь это работает нормально, но мне интересно, есть ли более выразительный способ сказать то же самое, то есть объявить функцию генератором, даже если она никогда не выдает никакого значения. Трюк, который я использовал выше, заключается в том, чтобы показать Python оператор yield внутри моей функции, даже если он недоступен.

Другой способ

 def empty_generator():
    return
    yield
  

На самом деле не «более выразительно», но короче. 🙂

Обратите внимание, что iter([]) or simply [] также подойдет.

Еще более короткое решение:

 def empty_generator():
  yield from []
  

Для максимальной читаемости и ремонтопригодности я бы отдал приоритет конструкции, которая находится в верхней части функции. Так что либо

1. ваша исходная if False: yield конструкция, но перенесенная на самую первую строку, или
2. отдельный декоратор, который добавляет поведение генератора к вызываемому без генератора.

(Это при условии, что вам не просто нужен вызываемый объект, который что-то сделал, а затем вернул пустой iterable / iterator. Если это так, то вы могли бы просто использовать обычную функцию и return () / return iter(()) в конце.)

Представьте, что читатель вашего кода видит:

 def name_fitting_what_the_function_does():
    # We need this function to be an empty generator:
    if False: yield

    # that crucial stuff that this function exists to do
  

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

Какой длины тело вашей функции? Больше пары строк? Тогда, как читатель, я почувствую праведную ярость и осуждение по отношению к автору, если я не получу подсказки о том, что эта функция является генератором до самого конца, потому что я, вероятно, потратил значительные умственные затраты, создавая в своей голове модель, основанную на предположении, что это обычная функция — первая yield в генераторе в идеале должна быть сразу видна, когда вы даже не знаете, как ее искать.

Кроме того, в функции длиной более нескольких строк более надежна конструкция в самом начале функции — я могу поверить, что любой, кто просматривал функцию, вероятно, видел ее первую строку каждый раз, когда они смотрели на нее. Это означает более высокую вероятность того, что если бы эта строка была ошибочной или прерывистой, кто-то бы это заметил. Это означает, что я могу быть менее бдительным в отношении возможности того, что все это на самом деле сломано, но используется таким образом, что делает поломку неочевидной.

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

В качестве альтернативы, вы могли бы пойти по пути декоратора:

 @generator_that_yields_nothing
def name_fitting_what_the_function_does():
    # that crucial stuff for which this exists


def generator_that_yields_nothing(wrapped):
    @functools.wraps(wrapped)
    def wrapper_generator():
        if False: yield
        wrapped()
    return wrapper_generator