discord.py evalにawaitを含められない

Question

したいこと

discord.pyでeval機能を作ろうと思っています。

/eval await message.channel.send("test")

みたいな感じに入力すると送信したチャンネルに「test」と帰ってくるようにしたいです。

現在のコード

@client.event
async def on_message(message):
    if message.content.startswith("/eval"):
        args = message.content.splitlines()
        code = ""
        for x in args[1:]:
            code += "\n" + x
        exec(code)

発生した問題

/eval print("test")

などは問題なく出力されるのですが、awaitが入ると

SyntaxError: 'await' outside function

このようなエラーが出てしまいます。

一応調べて出てきたものは試したのですが、うまくいきませんでした。
どうしたらいいでしょうか？

環境

python 3.8.3
discord.py 1.3.4

Comments

[退会済みユーザー]

すごいトリッキーなコードがあるようです。
https://stackoverflow.com/questions/44859165/async-exec-in-python
async関数内でexec(await含むコード文字列)するのではなく、await含むコード文字列で関数定義をexec内で行い、現在のスコープにないその関数をlocals()から取ってきて自分でawaitして呼び出すという技の模様。確認はしてません。

[退会済みユーザー]

ちなみにexecの中でawaitをasyncio.run()に置き換えて使おうとすると、
"asyncio.run() cannot be called from a running event loop"
で怒られました。こういうアプローチしかないんでしょうね。

Answer 1

問題点:

• エラー内容: 予約語 await は async で定義された関数内でしか使えません。※注1

　これは、exec(code) が呼ばれた async def on_message の事ではなく、
exec に渡される code 内のコードの事を指します。

解決策: 単一の「式」で良いなら、await は外側に出して、
await に渡す式のみを評価対象にしましょう。

Pythonにおける式(expression)と文(statement)の違いが判らない場合、
eval と exec の違いを調べて下さい。戻り値が欲しい場合は、eval を用います。

@client.event
async def on_message(message):
    if message.content.startswith("/eval await "):
        src = message.content.split(" ", 2)[-1].lstrip()
        await eval(src)
    elif message.content.startswith("/eval"):
        ...

---

※ 注1

コルーチンの関数内でなくても使えるようにしようという動きはあって、
Python 3.8 では、コンパイル時のフラグによりこれを可能にできます。

exec/eval ではこのオプションを指定できないので、
compile() 関数を使って コードオブジェクトを生成します。

import ast
import functools

async_compile = functools.partial(compile,
    mode="exec",
    filename="<discord>",
    flags=ast.PyCF_ALLOW_TOP_LEVEL_AWAIT)


@client.event
async def on_message(message, _eval_prefix="/eval "):
   if message.content.startswith(_eval_prefix):
       src = message.content[len(_eval_prefix):].lstrip()
       code = async_compile(src)
       await eval(code)

※ 実際に discord.py ではテストしてません。

ひとつ問題があって、await eval(code) ではコルーチンを期待するので、
awaitを含むコード(コルーチン)と、それ以外の普通のコードを区別する必要があります。
print("test") 等は None を返すので、await None ではエラーになります。
これの解決策は下のコードにて。

---

動作確認に使ったコード (win10/Python3.8で動作確認)

#!/usr/bin/env python3.8

import asyncio
import ast
from functools import partial

async_compile = partial(compile,
    filename="<stdin>",
    mode="exec",
    flags=ast.PyCF_ALLOW_TOP_LEVEL_AWAIT)


def async_eval(src, variables=None):
    if not variables:
        variables = {}
    # XXX: コルーチンにするには、最低限一つの await を含む必要が有る為
    # コンパイル対象のコードの末尾に await asyncio.sleep(0) を追加してます。
    # ここは、他により良い解決策があるかもしれません。
    return eval(async_compile("\n".join([src, "await asyncio.sleep(0)"])), globals(), variables)


async def main():
    from textwrap import dedent

    A = 10
    B = 20

    # ローカル変数を渡す例。see also eval/exec の第二第三引数
    await async_eval('print("A + B = ", A + B)', locals())

    # awaitを含む式のテスト。
    await async_eval("await asyncio.sleep(1)")

    # 複数の await を含むコードのテスト。
    # dedentはコードを読みやすくするためのもので、
    # 各行頭のインデントを削除した文字列がasync_evalへ渡されます。
    await async_eval(dedent("""
        print(1)
        await asyncio.sleep(1)
        print(2)
        await asyncio.sleep(1)
        print(3)
    """))


    await asyncio.sleep(1)
    print("END")


if __name__ == '__main__':
    asyncio.run(main())

Comments

[Reply]

エラー内容: 予約語 await は async で定義された関数内でしか使えません。

eval() はasyncで定義されていない関数を呼び出した、ということなのでしょうか？

一応一つ目のコードで実行できましたが、execやevalの使い方も曖昧だったので少し調べてみます。
丁寧な対応ありがとうございます。

[teamikl]

> eval() はasyncで定義されていない関数を呼び出した

エラーは await についてなので、これは違います。

eval/exec に渡された文字は
await message.channel.send("test") ですが、エラー原因は関数呼び出しではなく
async def の関数定義がないのに await を使ってるのが SyntaxError の原因です。

コードを async def ～で囲んで eval/exec に渡す事により、エラー無く通るようになりますが、
期待通りの動作をさせるには、eval/exec 内だけではなく、呼び出し元での await は必須になります。

回答の下で示した例は、コンパイルオプションで
async def 以外で await の利用を可能にするアプローチです。