TIL20. Python : Coroutine 이란?

📌 이 포스팅에서는 python의 coroutine에 대해 알아보겠습니다.

🌈 Coroutine 이란?

🔥 Coroutine 이란?

🔥 Coroutine 상태보기

🔥 Coroutine 데코레이터 패턴

🔥 Coroutine에서 return 사용하기

🔥 Coroutine 중첩과 yield from

1. Coroutine 이란?

🤔 Coroutine은 무엇일까?

✔️ 코루틴을 이해하기 전에 메인루틴과 서브루틴라는 개념부터 알아보겠습니다. 메인루틴은 위에서 아래로 순차적으로 진행되는 프로세스를 의미하고, 서브루틴은 메인루틴에서 함수를 만나면 함수 선언 위치로 이동했다가 return에 의해 다시 함수 호출 부분으로 돌아와 다시 프로세스를 진행하는 흐름을 의미합니다.
✔️ 예를들어, 위에서 아래로 코드를 읽어들이는 메인루틴으로 프로세스가 진행되다가 서브루틴인 함수 호출을 만나면, 그 위치를 기억한 상태에서 함수 선언 위치로 이동해 코드를 읽어들이고 return을 만나면 값을 가진 채로 기억해 둔 함수호출 위치로 돌아오는 것이 서브루틴입니다.
✔️ next를 통해 제너레이터를 실행했을 때, yield를 만나면 그 위치를 기억하고 멈췄다가 다시 next를 실행하면 다음 yield를 만나기 전까지 실행하는 것이 제너레이터의 핵심이고, yield는 메인루틴과 서브루틴이 양방향 통신을 가능하게 하기 때문에 서브루틴을 동시에 여러개를 실행할 수 있게해줍니다. 이를 코루틴이라 합니다.
✔️ 즉, 코루틴은 루틴 실행 중 멈춤이 가능하고, 특정 위치로 돌아갔다가 다시 원래 위치로 돌아와 흐름을 수행하기 때문에 동시성 프로그래밍 가능하게해줍니다.
✔️ 더불어 코루틴은 하나의 쓰레드를 사용하기 때문에 스케쥴링 오버헤드가 매우 적습니다.

🤔 Coroutine의 양방향 통신

✔️ yield의 오른쪽은 next 함수를 통해 제너레이터가 실행됬을 때 메인루틴으로 반환하는 값이고, yield 왼쪽에 할당된 값은 메인루틴에서 제너레이터 내부로 값을 전달하기 위한 변수입니다.
✔️ 즉, yield를 만나 중지되었다가 메인루트에서 send를 통해 yield에 값을 전달하면 다시 yield가 실행되고 send의 값은 함수 내부로 전달됩니다.
✔️ coroutine은 이처럼 yield를 통해 양방향으로 동시성으로 흐름제어를 가능하게 해줍니다.

def coroutine1():
    print("coroutine started.")
    i = yield  # 👈 yield를 만나면 위치를 기억하고 멈춤
    print("coroutine received : {}".format(i))
c1 = coroutine1()
print(c1)  # 👈 <generator object coroutine1 at 0x7fa9a4301040>
print(type(c1))  # 👈 <class 'generator'>
next(c1)  # 👈 coroutine started. <<< "yield 전까지 실행하고, i=yield에 위치에서 stop"
c1.send(100)  # coroutine received : 100 <<< 값을 send 매서드로 전달하면 i에 100이 담겨 실행    

✔️ send 매서드로 값을 전달하지 않고, next를 다시 실행하면 메인루틴에서는 default로 None을 전달합니다.

def coroutine1():
    print("coroutine started.")
    i = yield 
    print("coroutine received : {}".format(i))
c1 = coroutine1()
next(c1)  # 👈 coroutine started. 
next(c1)  
"""
coroutine received : None
StopIteration
"""

✔️ next를 통해 제너레이터를 실행하기 전 send로 yield에 값을 전달하면 TypeError가 발생합니다.
✔️ 제너레이터가 시작되기 전에 메인루트에서 yield 왼쪽에 값을 전달했기 때문입니다. 즉, yield에서 멈춰 값을 전달받을 수 있도록 준비된 상태에서 send를 통해 전달해야합니다.

def coroutine1():
    print("coroutine started.")
    i = yield  # 👈 yield를 만나면 위치를 기억하고 멈춤
    print("coroutine received : {}".format(i))
c2 = coroutine1()
c2.send(100) # 👈 TypeError: can't send non-None value to a just-started generator << 제너레이터를 실행 후 값을 보내라    

2. Coroutine 상태보기

🤔 Coroutine의 상태 종류

✔️ coroutine 상태 코드

• GEN_CREATED : 처음 대기 상태(제너레이터 시작 전)
• GEN_RUNNING : 실행 상태
• GEN_SUSPENDED : yield 대기 상태
• GEN_CLOSED : 실행 완료

🤔 getgeneratorstate

✔️ getgeneratorstate는 inspect에서 import하여 사용합니다.
✔️ yield 왼쪽은 메인루트에서 send로 전달되는 값을 받는 곳이고, yield 오른쪽은 흐름이 다시 시작될 때, 메인루틴으로 return되는 값입니다.

from inspect import getgeneratorstate # 👈 "getgeneratorstate" import
def coroutine2(x):
    print("coroutine started. : {}".format(x))
    y = yield x
    print("coroutine received. : {}".format(y))
    z = yield x + y
    print("coroutine received. : {}".format(z))
c3 = coroutine2(10)
print(getgeneratorstate(c3)) # GEN_CREATED
print(next(c3))
"""
coroutine started. : 10 👈 함수안에서 출력한 값
10  👈 next(c3)의 값 == yield에서 메인루틴으로 반환한 값
"""
print(getgeneratorstate(c3)) # GEN_SUSPENDED
print(c3.send(15)) 
"""
coroutine received. : 15 👈 함수안에서 출력한 값
25 👈 next(c3)의 값 == yield에서 메인루틴(x+y)으로 반환한 값
"""
print(c3.send(20))
"""
coroutine received. : 20 👈 함수안에서 출력한 값
StopIteration
"""

3. Coroutine 데코레이터 패턴

🤔 next 매서드 없이 Courtine 사용

✔️ Coroutine를 next 매서드 없이 사용하려면, 아래처럼 데코레이터 패턴을 활용할 수 있습니다.

from functools import wraps
# 데코레이터 생성
def coroutine(func):
    """Decorator run until yield"""
    @wraps(func)
    def primer(*args, **kwargs):
        gen = func(*args, **kwargs)
        next(gen)
        return gen
    return primer
# Coroutine 생성
@coroutine
def sumer():
    total = 0
    term = 0
    while True:
        term = yield total
        total += term
sexysum = sumer()
print(sexysum.send(100)) # 100
print(sexysum.send(40)) # 140
print(sexysum.send(60)) # 200

4. Coroutine에서 return 사용하기

🤔 예외를 잡아내서 value값 확인

def averager_return():
    total = 0.0
    cnt = 0
    avg = None
    while True: # 👈 무한반복
        term = yield
        if term is None:
            break  # 👈 send값이 None이면 break
        total += term
        cnt += 1
        avg = total / cnt
    return 'Average : {}'.format(avg)
avger = averager_return()
next(avger)
avger.send(10)
avger.send(30)
avger.send(50)
try:
    avger.send(None)  # 👈 send값으로 None 전달
except StopIteration as e: # 👈 에러값잡아서 value 확인
    print(e.value) # Average : 30.0

5. Coroutine 중첩과 yield from

🤔 coroutine을 중첩시켜 보겠습니다.

✔️ for문으로 coroutine을 중첩시키면, next를 실행될 때마다 yield의 오른쪽값을 반환하는 것을 볼 수 있습니다.
✔️ 또한 coroutine 구문을 list로 출력하면 한번에 모든 값이 나옵니다.

def gen1():
    for x in 'AB':
        yield x
    for y in range(1,4):
        yield y
test1 = gen1()
print(next(test1)) # A
print(next(test1)) # B
print(next(test1)) # 1
print(next(test1)) # 2
print(next(test1)) # 3
# print(next(test1)) # StopIteration
test2 = gen1()
print(list(test2)) # ['A', 'B', 1, 2, 3]

🤔 yield form은 coroutine의 중첩을 생략한것과 같습니다.

✔️ python 3.7 버전부터는 yeild from이 await으로 바뀌었다고 합니다.

def gen2():
    yield from 'AB'
    yield from range(1,4)
test3 = gen2()
print(next(test3)) # A
print(next(test3)) # B
print(next(test3)) # 1
print(next(test3)) # 2
print(next(test3)) # 3
# print(next(test3)) # StopIteration
print(list(gen2())) # ['A', 'B', 1, 2, 3]