파이썬 - asgi 버전(2, 3)에 따라 달라지는 uvicorn 호스팅
지난 글에서 ASGI 버전 3을 만족하는 유형의 asgi 예제를 봤는데요,
# test_main.py
async def simple_app_v3(scope, receive, send):
event = await receive()
await send({
'type': 'http.response.start',
'status': 200,
'headers': [
[b'content-type', b'text/plain'],
]
})
await send({"type": "http.response.body", "body": b'Hello, world!'})
application = simple_app_v3
그에 앞서 나온
(문서에 Legacy Application으로 표기된) 버전 2는 scope와 receive/send가 분리된 형식으로 돼 있습니다. 이에 대한 예제를 보면,
jordaneremieff/asgi-examples
; https://github.com/jordaneremieff/asgi-examples
def simple_app_v2(scope):
async def asgi(receive, send):
await send(
{
"type": "http.response.start",
"status": 200,
"headers": [[b"content-type", b"text/plain"]],
}
)
await send({"type": "http.response.body", "body": b"Hello, world!"})
return asgi
application = simple_app_v2
scope을 받는 함수가 내부적으로 send/receive를 정의한 함수를 반환하는 형태로 구성하고 있는데요, 2가지(asgi v2, v3) 모두 uvicorn으로는 이렇게 실행할 수 있습니다.
uvicorn test_main:application --port 18090
부가적으로 uvicorn은 명령행에서 --interface 인자를 통해 asgi 버전을 지정할 수 있습니다. 그래서 simple_app_v2와 simple_app_v3에 따라 각각 다음과 같이 인자를 명시할 수도 있습니다.
[asgi v2]
uvicorn test_main:simple_app_v2 --port 18090 --interface asgi2
[asgi v3]
uvicorn test_main:simple_app_v3 --port 18090 --interface asgi3
만약 지정하지 않았다면 "auto"인데 자동으로 판단해 주는 것입니다. 그렇다면 uvicorn은 어떻게 v2, v3 인터페이스를 판단하는 걸까요? 혹시 def 정의에 붙는 async 유무에 따라 결정할까요?
실제로 이에 대한 테스트를 async 가변 인자에 내부적으로는 v3 규칙을 따르는 함수를 만들고,
async def simple_app_any(*args, **kwargs):
scope = args[0]
receive = args[1]
send = args[2]
event = await receive() // 내부 코드는 version 3 스펙을 따름
await send({
'type': 'http.response.start',
'status': 200,
'headers': [
[b'content-type', b'text/plain'],
]
})
await send({"type": "http.response.body", "body": b'Hello, world!'})
이것을 uvicorn의 v2로 실행하면 당연히 오류가 발생할 것입니다.
$ uvicorn test_main:simple_app_any --port 18090 --interface asgi2
...[생략]...
Traceback (most recent call last):
File "/home/kevin/.local/lib/python3.8/site-packages/uvicorn/protocols/http/httptools_impl.py", line 435, in run_asgi
result = await app( # type: ignore[func-returns-value]
File "/home/kevin/.local/lib/python3.8/site-packages/uvicorn/middleware/proxy_headers.py", line 80, in __call__
return await self.app(scope, receive, send)
File "/home/kevin/.local/lib/python3.8/site-packages/uvicorn/middleware/asgi2.py", line 20, in __call__
instance = self.app(scope)
TypeError: 'coroutine' object is not callable)
왜냐하면, v2 스펙상 self.app은 동기 함수로 약속돼 있기 때문에 async 함수로는 오류가 발생하는 것이 맞습니다. (단지, "TypeError: 'coroutine' object is not callable" 오류는 맞지 않는데요, 이에 대해서는 마지막에 설명하겠습니다.)
재미있는 것은 그렇다고 해서 v3 스펙으로 호출해도 여전히 오류가 발생한다는 점입니다.
$ uvicorn test_main:simple_app_any --port 18090 --interface asgi3
...[생략]...
Traceback (most recent call last):
File "/home/kevin/.local/lib/python3.8/site-packages/uvicorn/protocols/http/httptools_impl.py", line 435, in run_asgi
result = await app( # type: ignore[func-returns-value]
File "/home/kevin/.local/lib/python3.8/site-packages/uvicorn/middleware/proxy_headers.py", line 80, in __call__
return await self.app(scope, receive, send)
TypeError: 'coroutine' object is not callable)
대신 이번에는 "await self.app(scope, receive, send)"로 비동기 호출을 했다는 것만 다릅니다. 하지만 그런데도 오류가 발생하는 것은 self.app이 (coroutine function이 아니라) coroutine으로 보관돼 있기 때문입니다. 아니... 왜 그런 것일까요? ^^
우선, 이 문제를 해석하려면 Coroutine과 Coroutine Function의 차이를 알아야 합니다. 이에 대해서는 다음의 글에 자세하게 설명하니 생략하고,
Coroutines vs Coroutine Functions in Python
; https://medium.com/geekculture/coroutines-vs-coroutine-functions-in-python-a3957c1a0f9b
따라서, asgi3 규약으로 호출했는데도 uvicorn은 "async def simple_app_any" 함수를 Coroutine Function으로 구분하지 않고 v2의 경우처럼 일반 함수로 인식해 그것에 대해 한 번 더 호출한 함수를 self.app에 보관해 두고 있었다고 추측할 수 있습니다. 결국 self.app에는 coroutine이 들어가게 되고 그것을 await 호출을 했으니 저런 오류가 발생한 것입니다.
그렇다면, 가변 인자를 갖는 함수로 정의된 경우라면 uvicorn이 한번 호출한다는 것을 가정하고 이렇게 만들어 주면 됩니다.
# uvicorn test_main:simple_app_any --port 18090 --interface asgi3
def simple_app_any_wrap():
async def _handler(*args, **kwargs):
scope = args[0]
receive = args[1]
send = args[2]
await simple_app_any(scope, receive, send)
return _handler
async def simple_app_any(*args, **kwargs):
# ...[생략]...
뭐랄까, uvicorn은 asgi3 인자로 명시했지만 어찌 되었든 v2/v3를 판별하는 코드를 (아마도) scope, receive, send 3개의 인자를 갖고 있는지 여부로 판별하는 듯합니다. 만약 3개의 인자를 갖고 있다면 처음 한 번의 호출을 하지 않고, 그렇지 않다면 호출을 무조건 해버리는 것입니다.
실제로 위의 simple_app_any_wrap 함수에 임의로 3개의 인자를 받게 만들면,
def simple_app_any_wrap(arg1, arg2, arg3):
# ...[생략]...
이제는 최초 한 번 호출을 하지 않으므로 이런 예외가 발생합니다.
Traceback (most recent call last):
File "/home/kevin/.local/lib/python3.8/site-packages/uvicorn/protocols/http/httptools_impl.py", line 435, in run_asgi
result = await app( # type: ignore[func-returns-value]
File "/home/kevin/.local/lib/python3.8/site-packages/uvicorn/middleware/proxy_headers.py", line 80, in __call__
return await self.app(scope, receive, send)
TypeError: object function can't be used in 'await' expression
정리하면, asgi v3인 경우에는,
- 인자를 아예 받지 않는 동기 함수에서, 한 번 호출되는 것을 가정해 3개의 인자(또는 가변 인자)를 받아 처리하는 함수를 반환하거나,
- 인자를 3개 받아 처리하는 async 함수를 정의하거나,
반드시 저 2개 함수 정의 중 하나여야 합니다. 즉, 가변 함수를 직접 받는 함수를 정의할 수는 없습니다.
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]