Introduction 🇯🇵¶

既存のライブラリが抱える問題¶

Pythonには既に幾つかasyncライブラリがあります。一つはもちろん標準ライブラリの asyncio 。一つは構造化された並行性で有名な Trio 。そして Trio に大きな影響を与えたとみられる Curio (ただし今はもう不具合修正を受け付けるのみで機能追加はしない模様)、等々。

それぞれ違いはあると思うのですがどれにも共通して言えるのはGUIプログラムとの相性が悪い事です。私は何も「GUIライブラリとasyncライブラリはそれぞれがメインループを持つから同じスレッド内で同居できないよね」と言いたいわけではありません。実際 PyGame の様に利用者側にメインループの実装を委ねている場合は PyGame のメインループをasyncライブラリのいちタスクとして実装してしまえば同居できそうですし [1]、 Kivy や BeeWare に関しては自身でasyncライブラリに対応してくれてますし、 tkinter や PyQt にはそれを可能にする外部ライブラリがあるようです。仮にそのどれにも当てはまらなかったとしても Trio には guest mode という「他のメインループの邪魔をせずに動作するモード」があるため同居の問題は解決されていると見做していいのではないでしょうか。

では何故GUIプログラムとの相性が悪いと思うのかと言うと “即座にタスクを開始/再開する機能” を持っていないからです。例えば asyncio においてタスクを立ち上げるには asyncio.create_task() や asyncio.TaskGroup.create_task() を用いると思うのですがどちらも即座ではありません。一応私の言う”即座”を明確にしておくと次のテストに通ることを意味します。

import asyncio

flag = False

async def async_fn():
    global flag; flag = True

async def main():
    asyncio.create_task(async_fn())
    assert flag

asyncio.run(main())

このテストは通りません。何故なら asyncio.create_task() は即座にタスクを立ち上げるわけではなく”いずれ”立ち上がるよう予約するからです。 asyncio.TaskGroup.create_task() や trio.Nursery.start() や trio.Nursery.start_soon() も同様です (最後のは”soon”がついているので当たり前ですが)。

再開する機能に関しても同じで asyncio.Event.wait() や trio.Event.wait() で停まっているタスクは Event.set() が呼ばれた時に即座に再開するわけではなく”いずれ”再開するよう予約されます。すなわち以下のテストは通りません。

import asyncio

flag = False


async def async_fn(e):
    e.set()
    assert flag


async def main():
    e = asyncio.Event()
    asyncio.create_task(async_fn(e))
    await e.wait()
    global flag; flag = True


asyncio.run(main())

即座にタスクを開始/再開できないと何が不都合なのでしょうか？例としてボタンが押されている間だけその背景色を変える次のような疑似コードを考えます。

async def ボタンの背景色の切り替え():
    while True:
        await ボタンが押される
        ボタンの背景色を変える
        await ボタンが離される
        ボタンの背景色を戻す

そしてタスクが await ボタンが押される の地点で停まっている時にユーザーがボタンを押した状況を考えます。先程言ったように asyncio や trio は即座にはタスクを再開しないのでまだ背景色は変わりません (なのでユーザーからするとボタンの反応が悪く感じるかもしれませんがこれから起こる事に比べれば些細な事です)。ここでタスクが再開する前にユーザーがボタンを離すと何が起こるでしょうか？その後再開したタスクは await ボタンが離される の地点で停まることになりますが ユーザーは既にボタンを離しています 。なのでタスクは既に終わってしまった出来事を待つ羽目になり、ユーザーが再度ボタンを押して離すまでは背景色が戻らないままになってしまうのです。

Note

Kivy では更に状況が悪くなります。Kivyでは入力イベントは状態の変わるオブジェクトで表されていて、即座にコールバック関数内で処理しないと状態が変わってしまう状況があるからです。なのでタスクの再開を待つ余裕はありません。

このように出来事をこぼさずに検知しようとすると即座にタスクを開始/再開できないasyncライブラリ達は苦労します。具体的には”出来事”を一旦蓄える必要がありそうです。コールバック関数を用いた従来のやり方で”出来事”を記録しておき遅れて開始/再開してきたタスクに伝えるのです(つまりはバッファリング)。このやり方が速度面で実用的なのか分かりませんがとにかく私にはそれぐらいしか思い浮かびませんでした。それにたとえそれでうまくいったとしてもユーザーがボタンの反応を悪く感じる問題は残ったままです。

以上が asyncgui が解決した問題でありその存在理由となります。

asyncguiの特徴¶

即座にタスクを動かす¶

上で挙げた問題は asyncgui では起きません。何故なら

asyncgui.start() と asyncgui.Nursery.start() は即座にタスクを立ち上げ
asyncgui.Event.fire() は即座にタスクを再開するからです。

また他の機能も全て即座にタスクを開始/再開します。ようするに asyncgui の全ての機能がそのように動くという事です。

メインループを持たない¶

冒頭ではメインループの同居問題に触れましたが asyncgui ではそれは起こりません。メインループを持たないからです。 asyncgui は自身ではそれを持たない代わりに別にあるメインループ(例えばGUIライブラリが持つ物)に乗っかる形で動作します。ただしその為には asyncgui とそのメインループを取り巻くAPIを繋げる作業が必要となります。これに関しては Usage 🇯🇵 で解説します。

Note

“別にあるメインループ”は別のasyncライブラリの物でも構いません。つまりは(一部制約はあるものの)二つのasyncライブラリを同一スレッド内で動かすことすら可能です。

グローバルな状態を持たない¶

元々意図していたわけでは無いのですが asyncgui はグローバルな状態を全く持たない設計になりました。全ての状態は

自由変数 (関数内で定義された別の関数がある時に内側の関数が外側の関数内のローカル変数に触れているとそれは自由変数であり、状態としての性質を持つようになる)
コルーチンやジェネレーター内のローカル変数
インスタンス属性

のどれかで表され

モジュールレベル変数
クラス属性

で表すことはありません。

Note

他のasyncライブラリはグローバルな状態を持っています。

例: asyncio.tasks._current_tasks, trio._core.GLOBAL_CONTEXT

単独ではsleepすらできない¶

驚くかもしれませんが asyncgui 単独では入出力はおろか await sleep(...) すらできません。その実現にはメインループが要るからです。そして上で述べたように asyncgui はメインループを持ちません…なのでできないわけです。

ただそれはあくまで単独での話であって上で触れた”作業”を行えば可能です。むしろ其れがこのライブラリの想定された使い方であり、 asyncgui 自体はPython言語(或いはCPython特有の振る舞い)にのみに依存する機能の実装が主で外界(OS)とのやりとりはしません [2]。