デコレータによってコルーチンを高階関数の戻り値にしたい

Question

前提・実現したいこと

pyserial_asyncioを使った通信プログラムを作っています。TCP socketとのゲートウェイを作る為、ノンブロッキングIO処理を行っています。

今回問題となっているのは、そのシリアル通信側。

相手機器とは幾つかのメッセージシーケンスを持っていて、それぞれに受信時の相手側が送りつける終了文字が異なります。その受信シーケンスを終了させる条件を定義する関数を用意しました。

受信バッファ読み出し部は共通のため、それをreceive関数としてシーケンス関数にデコレートしました。

import asyncio
import serial_asyncio
import functools

class MachineCommunication():

    def __init__(self,port,baudrate):
        self.__reader = None
        self.__writer = None
        self.__port = port
        self.__baudrate = baudrate
    
    async def connect(self):
        self.__reader, self.__writer = await serial_asyncio.open_serial_connection(url=self.__port,
                                                                                           baudrate=int(self.__baudrate))    
    async def send(self, msg):
        self.__writer.write((msg + '\r').encode())

    def receive(Function):
        @functools.wraps(Function)
        async listener(self):
            msg = ''
            while Function(msg)
                msg = await self.__reader.readuntil(b'\r') # pyserial_asyncioのストリームリーダ
                msg = msg.rstrip().decode()
        return listener
    
    @receive
    def sequence_A(self,msg):
        if msg == '受信を終了する文字':
            return False
        else:
            メッセージをさばく処理
            return True
    
    @receive
    def sequence_B(self,msg):
        if msg == '受信を終了する文字':
            return True
        else:
            メッセージをさばく処理
            return False

発生している問題・エラーメッセージ

問題は、どうやって上記のsequence_A, sequence_B を呼び出す時にrecieveをawaitさせるか？という事です。
これらの関数を呼び出す時はコルーチンではないため、
await sequence_A
などとは定義できません。しかし、awaitさせないと、

1. sendを使ってメッセージ送信
2. seqence_Aを使って受信待ち
3. sendを使って次のメッセージ送信
4. seqence_Bを使って受信待ち
5. 終了

のそれぞれ2,4 を待ってくれません。

試したこと

デコレータを使わず、recieve関数をコルーチンにして呼び出す形にすればうまくいきました。
しかし、すっきり書きたいので、デコレータでうまく行く方法を探しています。

補足情報（FW/ツールのバージョンなど）

Python3.7を使っています。

Comments

[takusan189]

ご回答ありがとうございます。やってみたのですが、やはり受信を待ってはくれませんでした。

Sequence_A,Bは終了文字監視のみなので、そこで待つのではなくて、
async def listener(self):
asincio.sleep(1)

の様に受信処理部分にタイマを設けてもこの時間待ってくれない、という症状です。

プライベート変数についてアドバイスありがとうございます。先月からPython始めたばかりの初心者であまり精通しておらず…

モジュール読み込みさせない事が目的なんてすね？

Answer 1

asyncio.run すればいいだけでは？
シリアル通信環境がないので、ダミー関数で実験

import asyncio
import functools
import time

class MachineCommunication:

    def __init__(self):
        print('__init__')

    async def connect(self):
        print('connect')

    async def send(self, msg):
        print('send', msg)

    def receive(Function):
        @functools.wraps(Function)
        async def listener(self):
            print('listener sleeping...')
            await asyncio.sleep(1)
            print('listener sleeping... done.')
            Function(self, '')
        def wait(self):
            asyncio.run(listener(self))
        return wait

    @receive
    def sequence_A(self, msg):
        print('sequence_A')
        if msg == '受信を終了する文字':
            return False
        else:
            # メッセージをさばく処理
            return True

    @receive
    def sequence_B(self, msg):
        print('sequence_B')
        if msg == '受信を終了する文字':
            return True
        else:
            # メッセージをさばく処理
            return False

m = MachineCommunication()
asyncio.run(m.send('a'))
m.sequence_A()
asyncio.run(m.send('b'))
m.sequence_B()

実験結果

__init__
send a
listener sleeping...
listener sleeping... done.
sequence_A
send b
listener sleeping...
listener sleeping... done.
sequence_B

listener を返すのであれば、以下のように await するのが一般的ですけど。

import asyncio
import functools
import time

class MachineCommunication:

    def __init__(self):
        print('__init__')

    async def connect(self):
        print('connect')

    async def send(self, msg):
        print('send', msg)

    def receive(Function):
        @functools.wraps(Function)
        async def listener(self):
            print('listener sleeping...')
            await asyncio.sleep(1)
            print('listener sleeping... done.')
            Function(self, '')
        return listener

    @receive
    def sequence_A(self, msg):
        print('sequence_A')
        if msg == '受信を終了する文字':
            return False
        else:
            # メッセージをさばく処理
            return True

    @receive
    def sequence_B(self, msg):
        print('sequence_B')
        if msg == '受信を終了する文字':
            return True
        else:
            # メッセージをさばく処理
            return False

async def amain():
    m = MachineCommunication()
    await m.send('a')
    await m.sequence_A()
    await m.send('b')
    await m.sequence_B()

def main():
    asyncio.run(amain())

if __name__ == '__main__':
    main()

それと、プライベート変数はアンダースコア1個にしましょう。
理由はPEP8参照: https://pep8-ja.readthedocs.io/ja/latest/

Comments

[takusan189]

ご回答ありがとうございます。やってみたのですが、やはり受信を待ってはくれませんでした。

Sequence_A,Bは終了文字監視のみなので、そこで待つのではなくて、
async def listener(self):
asincio.sleep(1)

の様に受信処理部分にタイマを設けてもこの時間待ってくれない、という症状です。

プライベート変数についてアドバイスありがとうございます。先月からPython始めたばかりの初心者であまり精通しておらず…

モジュール読み込みさせない事が目的なんてすね？

[shiracamus]

wait関数が増えてることに気付いてますかね？
asyncio.sleep処理を追加した処理に書き換えてみました。
コピペして動作確認してみてください。

アンダースコア2個は、サブクラスでの名前衝突回避のためだけに使いましょう、とPEP8にかかれています。

[takusan189]

いろいろお手間おかけしまして申し訳ありません。コピーペーストしたコードでしたら正常に動作いたしました。
本番製品コードは会社のPCで今日は確認できませんが、明日もう一度みなおしてみます。現象としては、await m.sequence_A() の箇所にはawaitが付けられないよ、という様なエラーがでていたと思います。
def sequence_A() にはデコレータによってコルーチン化されているものの、async句が無いのでコルーチンと見なされずにawaitが付けられないのかと思い質問させていただきました。

ご丁寧にありがとうございました。

Answer 2

参考までに、検証したコードを記載します。

import asyncio
import functools

class MachineCommunication:

    def __init__(self):
        print('__init__')

    async def connect(self):
        print('connect')

    async def send(self, msg):
        print('send', msg)

    def receive(Function):
        @functools.wraps(Function)
        async def listener(self):
            msg = ''
            while Function(self,msg):
                msg = 'START'
                await asyncio.sleep(1)
                msg = 'END'
        return listener

    @receive
    def sequence_A(self, msg):
        print('sequence_A')
        if msg == 'END':
            print('A処理完了')
            return False
        else:
            # メッセージをさばく処理
            print('A処理中')
            return True

    @receive
    def sequence_B(self, msg):
        print('sequence_B')
        if msg == 'END':
            print('B処理完了')
            return False
        else:
            # メッセージをさばく処理
            print('B処理中')
            return True

async def amain():
    m = MachineCommunication()
    await m.send('a')
    await m.sequence_A()
    await m.send('b')
    await m.sequence_B()

def main():
    loop = asyncio.get_event_loop()
    loop.run_until_complete(amain())

if __name__ == '__main__':
    main()

実行結果は以下の通りでした。

__init__
send a
sequence_A
A処理中
sequence_A
A処理完了
send b
sequence_B
B処理中
sequence_B
B処理完了