V2の設計案

[Apricot-S]

V2の設計案について意見交換する

[Apricot-S]

イベントループを RPA.run() に入れて、フレームワーク利用者は on_*() メソッドを登録する形にする。

[Apricot-S]

イメージ

if __name__ == "__main__":
    rpa = RPA()
    # 省略
    rpa.run()

[Apricot-S]

各 Presentation は使用するクラスの型自体を直接変更できるようにする。
通常は不要な特殊な操作 (フレームワーク内部に関する知識が必要) なので、引数にする必要はなさそう。

イメージ

class RPA:
    """Robotic Process Automation (RPA) client for Mahjong Soul (雀魂)."""

    def __init__(self) -> None:
        self.login_presentation = LoginPresentation
        self.home_presentation = HomePresentation
        self.room_host_presentation = RoomHostPresentation
        self.match_presentation = MatchPresentation

[Apricot-S]

こうした方がいいか?

class RPA:
    """Robotic Process Automation (RPA) client for Mahjong Soul (雀魂)."""

    def __init__(self) -> None:
        # 細かい初期化は省略
        self.presentations.login = LoginPresentation
        self.presentations.home = HomePresentation
        self.presentations.room_host = RoomHostPresentation
        self.presentations.match = MatchPresentation

[Apricot-S]

これまで手動で書いていた各 Presentation での操作の代わりに、コールバック関数 on_* をディスパッチする形にする。

実装イメージ

class RPA:
    """Robotic Process Automation (RPA) client for Mahjong Soul (雀魂)."""

    def __init__(self) -> None:
        # 省略
        self.on_login: OnLoginCallback | None = None
        self.on_home: OnHomeCallback | None = None
        self.on_room_host: OnRoomHostCallback | None = None
        self.on_match: OnMatchCallback | None = None

利用イメージ

if __name__ == "__main__":
    rpa = RPA()
    rpa.on_login = on_login
    rpa.on_auth = on_auth
    rpa.on_home = on_home
    rpa.on_room_host = on_room_host
    rpa.on_match = on_match
    rpa.run(data=0, timeout=20.0)

[Apricot-S]

コールバック関数のイメージ

def on_login(presentation: LoginPresentation, data: Any) -> tuple[LoginPresentation, Any]:
    ...

[Apricot-S]

コールバック関数の型のイメージ

OnLoginCallback = Callable[
    [LoginPresentation, Any],
    Awaitable[tuple[LoginPresentation, Any]],
]

[Apricot-S]

各クライアント (ブラウザ、メッセージキューなど) も DI できるようにしたい

[Apricot-S]

型自体を指定するイメージ
テスト時や改造時に直接差し替え可能にする
mitmdump の差し替えは流石に大変なので、アドオンのみメッセージキューに合わせて変更可能にする

class RPA:
    """Robotic Process Automation (RPA) client for Mahjong Soul (雀魂)."""

    def __init__(self) -> None:
        # 省略
        self.browser: BrowserBase = LocalBrowser
        self.mq_client: MessageQueueClientBase = ZMQClient
        self.sniffer_addon: Path = SNIFFER_ADDON_PATH_ZMQ

[Apricot-S]

こうした方がいいか?

class RPA:
    """Robotic Process Automation (RPA) client for Mahjong Soul (雀魂)."""

    def __init__(self) -> None:
        # 細かい初期化は省略
        self.clients.browser = LocalBrowser
        self.clients.message_queue = ZMQClient
        self.clients.sniffer_addon = SNIFFER_ADDON_PATH_ZMQ