Функція порожнього генератора Python

У python можна легко визначити функцію ітератора, помістивши ключове слово yield в тіло функції, наприклад:

def gen():
    for i in range(100):
        yield i

Як я можу визначити функцію генератора, яка не дає значення (генерує 0 значень), наступний код не працює, оскільки python не може знати, що це має бути генератор, а не звичайна функція:

def empty():
    pass

Я міг би зробити щось подібне

def empty():
    if False:
        yield None

Але це було б дуже потворно. Чи є якийсь приємний спосіб реалізувати порожню функцію ітератора?

Ви можете використовувати returnодин раз в генераторі; він зупиняє ітерацію, не даючи нічого, і таким чином забезпечує явну альтернативу дозволу функції вичерпати область дії. Тому використовуйте, yieldщоб перетворити функцію на генератор, але перед нею returnзакінчіть генератор, перш ніж щось дати.

>>> def f():
...     return
...     yield
... 
>>> list(f())
[]

Я не впевнений, що це набагато краще, ніж те, що у вас є - воно просто замінює ifтвердження про відсутність операції на yieldтвердження про заборону . Але це більш ідіоматично. Зверніть увагу, що просто використання yieldне працює.

>>> def f():
...     yield
... 
>>> list(f())
[None]

Чому б просто не використовувати iter(())?

Це питання конкретно задає питання порожньої функції генератора . З цієї причини я вважаю, що це питання про внутрішню узгодженість синтаксису Python, а не питання про найкращий спосіб створити порожній ітератор загалом.

Якщо питання насправді стосується найкращого способу створити порожній ітератор, то ви можете погодитись із Zectbumo щодо використання iter(())натомість. Однак важливо зауважити, що iter(())функція не повертає! Він безпосередньо повертає порожній ітерабель. Припустимо, ви працюєте з API, який очікує виклику, який повертає ітерабельний. Вам доведеться зробити щось подібне:

def empty():
    return iter(())

(Кредит повинен надійти Unutbu за надання першої правильної версії цієї відповіді.)

Зараз, можливо, вам буде зрозуміле вищесказане, але я можу уявити ситуації, коли це було б менш зрозуміло. Розглянемо цей приклад довгого списку (надуманих) визначень функції генератора:

def zeros():
    while True:
        yield 0

def ones():
    while True:
        yield 1

...

В кінці цього довгого списку я волів би побачити щось із yieldцим, наприклад:

def empty():
    return
    yield

або, в Python 3.3 і вище (як пропонується DSM ), це:

def empty():
    yield from ()

Наявність yieldключового слова з короткого погляду дає зрозуміти, що це лише чергова функція генератора, як і всі інші. Потрібно трохи більше часу, щоб побачити, що iter(())версія робить те саме.

Це незначна різниця, але я, чесно кажучи, думаю, що yieldосновані функції є більш читабельними та ремонтопридатними.

iter(())

Вам не потрібен генератор. Давай хлопці!

Python 3.3 (тому що я на yield fromударі і тому, що @senderle вкрав мою першу думку):

>>> def f():
...     yield from ()
... 
>>> list(f())
[]

Але мушу визнати, мені важко придумати варіант використання для цього, який iter([])або (x)range(0)не працював би однаково добре.

Інший варіант:

(_ for _ in ())

Це має бути функція генератора? Якщо ні, то як

def f():
    return iter(())

"Стандартним" способом зробити порожній ітератор видається iter ([]). Я запропонував зробити [] аргументом за замовчуванням для iter (); це було відхилено з вагомими аргументами, див. http://bugs.python.org/issue25215 - Jurjen

Як сказав @senderle, використовуйте це:

def empty():
    return
    yield

Я пишу цю відповідь здебільшого, щоб поділитися ще одним обґрунтуванням її.

Однією з причин вибору цього рішення над іншими є те, що воно є оптимальним для перекладача.

>>> import dis
>>> def empty_yield_from():
...     yield from ()
... 
>>> def empty_iter():
...     return iter(())
... 
>>> def empty_return():
...     return
...     yield
...
>>> def noop():
...     pass
...
>>> dis.dis(empty_yield_from)
  2           0 LOAD_CONST               1 (())
              2 GET_YIELD_FROM_ITER
              4 LOAD_CONST               0 (None)
              6 YIELD_FROM
              8 POP_TOP
             10 LOAD_CONST               0 (None)
             12 RETURN_VALUE
>>> dis.dis(empty_iter)
  2           0 LOAD_GLOBAL              0 (iter)
              2 LOAD_CONST               1 (())
              4 CALL_FUNCTION            1
              6 RETURN_VALUE
>>> dis.dis(empty_return)
  2           0 LOAD_CONST               0 (None)
              2 RETURN_VALUE
>>> dis.dis(noop)
  2           0 LOAD_CONST               0 (None)
              2 RETURN_VALUE

Як ми бачимо, empty_returnфайл має точно такий самий байт-код, як звичайна порожня функція; решта виконують низку інших операцій, які все одно не змінюють поведінку. Єдина відмінність між empty_returnі noopполягає в тому, що перший має встановлений прапор генератора:

>>> dis.show_code(noop)
Name:              noop
Filename:          <stdin>
Argument count:    0
Positional-only arguments: 0
Kw-only arguments: 0
Number of locals:  0
Stack size:        1
Flags:             OPTIMIZED, NEWLOCALS, NOFREE
Constants:
   0: None
>>> dis.show_code(empty_return)
Name:              empty_return
Filename:          <stdin>
Argument count:    0
Positional-only arguments: 0
Kw-only arguments: 0
Number of locals:  0
Stack size:        1
Flags:             OPTIMIZED, NEWLOCALS, GENERATOR, NOFREE
Constants:
   0: None

Звичайно, сила цього аргументу дуже залежить від конкретної реалізації Python, що використовується; досить розумний альтернативний перекладач може помітити, що інші операції не становлять нічого корисного, і оптимізувати їх. Однак, навіть якщо такі оптимізації присутні, вони вимагають, щоб інтерпретатор витрачав час на їх виконання та захищав від порушень припущень про оптимізацію, як, наприклад, iterідентифікатор у глобальній області, що відбивається на щось інше (навіть якщо це, швидше за все, вказувало б на помилку, якщо вона насправді сталося). У разі empty_returnпросто немає чого оптимізувати, тому навіть відносно наївний CPython не буде витрачати час на будь-які помилкові операції.

generator = (item for item in [])

Я хочу навести приклад на основі класу, оскільки ми ще не пропонували жодного. Це викликається ітератор, який не генерує жодних елементів. Я вважаю, що це прямий та описовий спосіб вирішення проблеми.

class EmptyGenerator:
    def __iter__(self):
        return self
    def __next__(self):
        raise StopIteration

>>> list(EmptyGenerator())
[]