Python の yield とジェネレーターの詳細な紹介

この記事では主にPythonのyieldとgeneratorの関連情報を浅いところから深いところまで説明しています。記事内の紹介は非常に詳細であり、必要な友人は以下を参照してください。

はじめに

この記事では、ジェネレーターとは何か、ジェネレーターの生成方法、ジェネレーターの特徴、ジェネレーターの基本および高度な応用シナリオ、発電機を使用する際の注意事項。この記事には強化されたジェネレーターや pep342 関連のコンテンツは含まれていません。この部分は後で紹介します。

ジェネレーターの基本

Pythonの関数定義では、yield式が出ていれば、実際にはジェネレーター関数が定義されており、このジェネレーター関数と呼ばれるコード>の戻り値が返されます。発電機です。この通常の関数呼び出しは異なります。例: <code>generator function返回值是一个generator。这根普通的函数调用有所区别，For example：

def gen_generator():
 yield 1
def gen_value():
 return 1
 
if __name__ == '__main__':
 ret = gen_generator()
 print ret, type(ret) #<generator object gen_generator at 0x02645648> <type &#39;generator&#39;>
 ret = gen_value()
 print ret, type(ret) # 1 <type &#39;int&#39;>

从上面的代码可以看出，gen_generator函数返回的是一个generator实例

generator有以下特别：

•遵循迭代器（iterator）协议，迭代器协议需要实现__iter__ 、next接口

•能过多次进入、多次返回，能够暂停函数体中代码的执行

下面看一下测试代码：

>>> def gen_example():
... print 'before any yield'
... yield 'first yield'
... print 'between yields'
... yield 'second yield'
... print 'no yield anymore'
... 
>>> gen = gen_example()
>>> gen.next()　　　　＃ 第一次调用next
before any yield
'first yield'
>>> gen.next()　　　　＃ 第二次调用next
between yields
'second yield'
>>> gen.next()　　　　＃ 第三次调用next
no yield anymore
Traceback (most recent call last):
 File "<stdin>", line 1, in <module>
StopIteratio

调用gen example方法并没有输出任何内容，说明函数体的代码尚未开始执行。当调用generator的next方法，generator会执行到yield 表达式处，返回yield表达式的内容，然后暂停（挂起）在这个地方，所以第一次调用next打印第一句并返回“first yield”。 暂停意味着方法的局部变量，指针信息，运行环境都保存起来，直到下一次调用next方法恢复。第二次调用next之后就暂停在最后一个yield，再次调用next()方法，则会抛出StopIteration异常。　

因为for语句能自动捕获StopIteration异常，所以generator（本质上是任何iterator）较为常用的方法是在循环中使用：　

def generator_example():
 yield 1
 yield 2

if __name__ == '__main__':
 for e in generator_example():
 print e
 # output 1 2

generator function产生的generator与普通的function有什么区别呢

　　（1）function每次都是从第一行开始运行，而generator从上一次yield开始的地方运行

　　（2）function调用一次返回一个（一组）值，而generator可以多次返回

　　（3）function可以被无数次重复调用，而一个generator实例在yield最后一个值 或者return之后就不能继续调用了

在函数中使用Yield，然后调用该函数是生成generator的一种方式。另一种常见的方式是使用generator expression，For example：

　　>>> gen = (x * x for x in xrange(5))
　　>>> print gen
　　<generator object <genexpr> at 0x02655710>

generator应用

generator基础应用　　

　　为什么使用generator呢，最重要的原因是可以按需生成并“返回”结果，而不是一次性产生所有的返回值，况且有时候根本就不知道“所有的返回值”。

比如对于下面的代码　　

RANGE_NUM = 100
 for i in [x*x for x in range(RANGE_NUM)]: # 第一种方法：对列表进行迭代
 # do sth for example
 print i

 for i in (x*x for x in range(RANGE_NUM)): # 第二种方法：对generator进行迭代
 # do sth for example
 print i

在上面的代码中，两个for语句输出是一样的，代码字面上看来也就是中括号与小括号的区别。但这点区别差异是很大的，第一种方法返回值是一个列表，第二个方法返回的是一个generator对象。随着RANGE_NUM的变大，第一种方法返回的列表也越大，占用的内存也越大；但是对于第二种方法没有任何区别。

我们再来看一个可以“返回”无穷多次的例子：

def fib():
 a, b = 1, 1
 while True:
 yield a
 a, b = b, a+b

这个generator拥有生成无数多“返回值”的能力，使用者可以自己决定什么时候停止迭代

generator高级应用

使用场景一：　　

Generator可用于产生数据流， generator并不立刻产生返回值，而是等到被需要的时候才会产生返回值，相当于一个主动拉取的过程(pull)，比如现在有一个日志文件，每行产生一条记录，对于每一条记录，不同部门的人可能处理方式不同，但是我们可以提供一个公用的、按需生成的数据流。

def gen_data_from_file(file_name):
 for line in file(file_name):
 yield line

def gen_words(line):
 for word in (w for w in line.split() if w.strip()):
 yield word

def count_words(file_name):
 word_map = {}
 for line in gen_data_from_file(file_name):
 for word in gen_words(line):
  if word not in word_map:
  word_map[word] = 0
  word_map[word] += 1
 return word_map

def count_total_chars(file_name):
 total = 0
 for line in gen_data_from_file(file_name):
 total += len(line)
 return total
 
if __name__ == '__main__':
 print count_words('test.txt'), count_total_chars('test.txt')

上面的例子来自08年的PyCon一个讲座。gen_words gen_data_from_file是数据生产者，而count_words count_total_chars是数据的消费者。可以看到，数据只有在需要的时候去拉取的，而不是提前准备好。另外gen_words中 (w for w in line.split() if w.strip())

 def do(a):
 print 'do', a
 CallBackMgr.callback(5, lambda a = a: post_do(a))
 
 def post_do(a):
 print 'post_do', a

上記のコードからわかるように、gen_generator 関数はジェネレーター インスタンスを返します

generator には次の特別な機能があります:

🎜🎜 •イテレータ（反復子）プロトコルに従い、次のインターフェース__iter__を実装する必要がある
🎜🎜 •複数回入ったり戻ったり、関数本体を一時停止したりできるコード 🎜🎜🎜 テスト コードを見てみましょう: 🎜🎜

 @yield_dec
 def do(a):
 print 'do', a
 yield 5
 print 'post_do', a

🎜 gen サンプル メソッドを呼び出しても何も出力されず、関数本体のコードがまだ実行を開始していないことを示しています。ジェネレーターの next メソッドが呼び出されると、ジェネレーターは yield 式まで実行し、yield 式の内容を返し、この場所で一時停止 (ハング) するため、next への最初の呼び出しで最初の文が出力され、「」が返されます。最初の収穫」。 一時停止とは、次のメソッドが呼び出されて再開されるまで、メソッドのローカル変数、ポインター情報、および実行環境が保存されることを意味します。 next を 2 回呼び出した後、最後の yield で一時停止します。next() メソッドを再度呼び出すと、StopIteration 例外がスローされます。 🎜🎜 for ステートメントは StopIteration 例外を自動的にキャプチャできるため、ジェネレーター (基本的に任意のイテレーター) のより一般的な方法は、それをループ内で使用することです: 🎜

# -*- coding:utf-8 -*-
import sys
# import Timer
import types
import time

class YieldManager(object):
 def __init__(self, tick_delta = 0.01):
 self.generator_dict = {}
 # self._tick_timer = Timer.addRepeatTimer(tick_delta, lambda: self.tick())

 def tick(self):
 cur = time.time()
 for gene, t in self.generator_dict.items():
  if cur >= t:
  self._do_resume_genetator(gene,cur)

 def _do_resume_genetator(self,gene, cur ):
 try:
  self.on_generator_excute(gene, cur)
 except StopIteration,e:
  self.remove_generator(gene)
 except Exception, e:
  print 'unexcepet error', type(e)
  self.remove_generator(gene)

 def add_generator(self, gen, deadline):
 self.generator_dict[gen] = deadline

 def remove_generator(self, gene):
 del self.generator_dict[gene]

 def on_generator_excute(self, gen, cur_time = None):
 t = gen.next()
 cur_time = cur_time or time.time()
 self.add_generator(gen, t + cur_time)

g_yield_mgr = YieldManager()

def yield_dec(func):
 def _inner_func(*args, **kwargs):
 gen = func(*args, **kwargs)
 if type(gen) is types.GeneratorType:
  g_yield_mgr.on_generator_excute(gen)

 return gen
 return _inner_func

@yield_dec
def do(a):
 print 'do', a
 yield 2.5
 print 'post_do', a
 yield 3
 print 'post_do again', a

if __name__ == '__main__':
 do(1)
 for i in range(1, 10):
 print 'simulate a timer, %s seconds passed' % i
 time.sleep(1)
 g_yield_mgr.tick()

🎜🎜 ジェネレーター関数によって生成されるジェネレーターと普通の関数🎜🎜🎜 (1) 関数は毎回最初の行から実行され、ジェネレーターは最後の yield の先頭から実行されます🎜🎜 (2) 関数呼び出しは、次の時点で 1 つの (一連の) 値を返します。 🎜🎜 ( 3) 関数は数え切れないほど繰り返し呼び出すことができますが、関数内で Yield または return の最後の値を使用して呼び出した後は、ジェネレーター インスタンスを呼び続けることはできません。この関数はジェネレーターを生成する方法です。もう 1 つの一般的な方法は、generator 式 を使用することです。たとえば、次のようになります。すべての戻り値を一度に生成するのではなく、オンデマンドで結果を「返す」と、「すべての戻り値」がまったくわからない場合があります。 🎜🎜🎜たとえば、次のコードの場合 🎜 🎜

def visit(data):
 for elem in data:
 if isinstance(elem, tuple) or isinstance(elem, list):
  visit(elem) # here value retuened is generator
 else:
  yield elem
  
if __name__ == '__main__':
 for e in visit([1, 2, (3, 4), 5]):
 print e

🎜 上記のコードでは、2つのfor文の出力は同じです コードは文字通り角括弧と括弧の違いのように見えます。ただし、この違いは大きく異なります。最初のメソッドはリストを返し、2 番目のメソッドはジェネレーター オブジェクトを返します。 RANGE_NUM が大きくなると、最初のメソッドによって返されるリストも大きくなり、占有されるメモリも大きくなりますが、2 番目のメソッドでは違いはありません。 🎜🎜無限回「返す」ことができる別の例を見てみましょう: 🎜

def visit(data):
 for elem in data:
 if isinstance(elem, tuple) or isinstance(elem, list):
  for e in visit(elem):
  yield e
 else:
  yield elem

🎜このジェネレーターには、反復をいつ停止するかをユーザーが決定できる機能があります🎜🎜🎜🎜ジェネレーターの高度なアプリケーション🎜。 🎜🎜🎜使用シナリオ 1: 🎜🎜🎜ジェネレーターは、戻り値をすぐには生成しませんが、アクティブなプル プロセス (プル) に相当します。たとえば、ログ ファイルがあり、各行でレコードが生成されます。各レコードは、異なる部門の人々によって異なる方法で処理される可能性がありますが、共通のオンデマンド データ フローを提供できます。 🎜

 def visit(data):
 for elem in data:
  if isinstance(elem, tuple) or isinstance(elem, list):
  yield from visit(elem)
  else:
  yield elem

🎜上記の例は、2008 年の PyCon での講演からのものです。 gen_words gen_data_from_file はデータ プロデューサー、count_words count_total_chars はデータ コンシューマーです。ご覧のとおり、データは事前​​に準備されるのではなく、必要な場合にのみ取得されます。さらに、gen_words の (w for w in line.split() if w.strip()) もジェネレーターを生成します🎜🎜🎜使用シナリオ 2:🎜🎜

一些编程场景中，一件事情可能需要执行一部分逻辑，然后等待一段时间、或者等待某个异步的结果、或者等待某个状态，然后继续执行另一部分逻辑。比如微服务架构中，服务A执行了一段逻辑之后，去服务B请求一些数据，然后在服务A上继续执行。或者在游戏编程中，一个技能分成分多段，先执行一部分动作（效果），然后等待一段时间，然后再继续。对于这种需要等待、而又不希望阻塞的情况，我们一般使用回调（callback）的方式。下面举一个简单的例子：

 def do(a):
 print 'do', a
 CallBackMgr.callback(5, lambda a = a: post_do(a))
 
 def post_do(a):
 print 'post_do', a

这里的CallBackMgr注册了一个5s后的时间，5s之后再调用lambda函数，可见一段逻辑被分裂到两个函数，而且还需要上下文的传递（如这里的参数a）。我们用yield来修改一下这个例子，yield返回值代表等待的时间。

 @yield_dec
 def do(a):
 print 'do', a
 yield 5
 print 'post_do', a

这里需要实现一个YieldManager， 通过yield_dec这个decrator将do这个generator注册到YieldManager，并在5s后调用next方法。Yield版本实现了和回调一样的功能，但是看起来要清晰许多。

下面给出一个简单的实现以供参考：

# -*- coding:utf-8 -*-
import sys
# import Timer
import types
import time

class YieldManager(object):
 def __init__(self, tick_delta = 0.01):
 self.generator_dict = {}
 # self._tick_timer = Timer.addRepeatTimer(tick_delta, lambda: self.tick())

 def tick(self):
 cur = time.time()
 for gene, t in self.generator_dict.items():
  if cur >= t:
  self._do_resume_genetator(gene,cur)

 def _do_resume_genetator(self,gene, cur ):
 try:
  self.on_generator_excute(gene, cur)
 except StopIteration,e:
  self.remove_generator(gene)
 except Exception, e:
  print 'unexcepet error', type(e)
  self.remove_generator(gene)

 def add_generator(self, gen, deadline):
 self.generator_dict[gen] = deadline

 def remove_generator(self, gene):
 del self.generator_dict[gene]

 def on_generator_excute(self, gen, cur_time = None):
 t = gen.next()
 cur_time = cur_time or time.time()
 self.add_generator(gen, t + cur_time)

g_yield_mgr = YieldManager()

def yield_dec(func):
 def _inner_func(*args, **kwargs):
 gen = func(*args, **kwargs)
 if type(gen) is types.GeneratorType:
  g_yield_mgr.on_generator_excute(gen)

 return gen
 return _inner_func

@yield_dec
def do(a):
 print 'do', a
 yield 2.5
 print 'post_do', a
 yield 3
 print 'post_do again', a

if __name__ == '__main__':
 do(1)
 for i in range(1, 10):
 print 'simulate a timer, %s seconds passed' % i
 time.sleep(1)
 g_yield_mgr.tick()

注意事项：

（1）Yield是不能嵌套的！

def visit(data):
 for elem in data:
 if isinstance(elem, tuple) or isinstance(elem, list):
  visit(elem) # here value retuened is generator
 else:
  yield elem
  
if __name__ == '__main__':
 for e in visit([1, 2, (3, 4), 5]):
 print e

上面的代码访问嵌套序列里面的每一个元素，我们期望的输出是1 2 3 4 5，而实际输出是1 2 5 。为什么呢，如注释所示，visit是一个generator function，所以第4行返回的是generator object，而代码也没这个generator实例迭代。那么改改代码，对这个临时的generator 进行迭代就行了。

def visit(data):
 for elem in data:
 if isinstance(elem, tuple) or isinstance(elem, list):
  for e in visit(elem):
  yield e
 else:
  yield elem

或者在python3.3中 可以使用yield from，这个语法是在pep380加入的

 def visit(data):
 for elem in data:
  if isinstance(elem, tuple) or isinstance(elem, list):
  yield from visit(elem)
  else:
  yield elem

（2）generator function中使用return

在python doc中，明确提到是可以使用return的，当generator执行到这里的时候抛出StopIteration异常。

def gen_with_return(range_num):
 if range_num < 0:
 return
 else:
 for i in xrange(range_num):
  yield i

if __name__ == &#39;__main__&#39;:
 print list(gen_with_return(-1))
 print list(gen_with_return(1))

但是，generator function中的return是不能带任何返回值的

 def gen_with_return(range_num):
 if range_num < 0:
  return 0
 else:
  for i in xrange(range_num):
  yield i

上面的代码会报错：SyntaxError: 'return' with argument inside generator

总结

以上がPython の yield とジェネレーターの詳細な紹介の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。