integrations.protocols

  1"""
  2integrations/protocols.py
  3"""
  4
  5from dataclasses import dataclass, field, fields, is_dataclass
  6from typing import TYPE_CHECKING, Any, Literal, Protocol
  7
  8if TYPE_CHECKING:
  9    from libs.types import MessageType, MessageTypeDict, StyleOptions
 10
 11
 12class DataMixin:
 13    """共通処理"""
 14
 15    def reset(self) -> None:
 16        """デフォルト値にリセット"""
 17        if not is_dataclass(self):
 18            raise TypeError(f"{self.__class__.__name__} must be a dataclass")
 19
 20        default = type(self)()
 21        for f in fields(self):
 22            setattr(self, f.name, getattr(default, f.name))
 23
 24
 25@dataclass
 26class MsgData(DataMixin):
 27    """ポストされたメッセージデータ"""
 28
 29    text: str = field(default=str())
 30    """本文"""
 31    event_ts: str = field(default="undetermined")
 32    """イベント発生タイムスタンプ"""
 33    thread_ts: str = field(default="undetermined")
 34    """スレッド元タイムスタンプ
 35    - *0*: スレッドになっていない
 36    - *undetermined*: 未定義状態
 37    """
 38    edited_ts: str = field(default="undetermined")
 39    """イベント編集タイムスタンプ"""
 40    channel_id: str = field(default=str())
 41    """チャンネルID"""
 42    channel_type: Literal[
 43        "channel",
 44        "group",
 45        "im",
 46        "search_messages",
 47        "undetermined",
 48    ] = field(default="undetermined")
 49    """チャンネルタイプ
 50    - *channel*: 通常チャンネル
 51    - *group*: プライベートチャンネル
 52    - *im*: ダイレクトメッセージ
 53    - *search_messages*: 検索API
 54    - *undetermined*: 未定義状態
 55    """
 56    user_id: str = field(default=str())
 57    """ユーザーID"""
 58    status: Literal[
 59        "message_append",
 60        "message_changed",
 61        "message_deleted",
 62        "undetermined",
 63    ] = field(default="undetermined")
 64    """イベントステータス
 65    - *message_append*: 新規ポスト
 66    - *message_changed*: 編集
 67    - *message_deleted*: 削除
 68    - *undetermined*: 未定義状態
 69    """
 70    reaction_ok: list = field(default_factory=list)
 71    reaction_ng: list = field(default_factory=list)
 72    remarks: list = field(default_factory=list)
 73    """メモ格納用"""
 74
 75
 76@dataclass
 77class PostData(DataMixin):
 78    """ポストするデータ"""
 79
 80    headline: dict[str, str] = field(default_factory=dict)
 81    """ヘッダ文"""
 82    message: list[dict[str, "MessageTypeDict"]] = field(default_factory=list)
 83    """本文
 84    識別子(タイトルなど)をキーにした辞書型
 85    """
 86    thread: bool = field(default=True)
 87    """スレッドに返す"""
 88    ts: str = field(default="undetermined")
 89    """指定タイムスタンプへの強制リプライ"""
 90
 91
 92@dataclass
 93class StatusData(DataMixin):
 94    """処理した結果"""
 95
 96    command_type: Literal[
 97        "results",
 98        "graph",
 99        "ranking",
100        "rating",
101        "report",
102        "comparison",
103        "unknown",
104    ] = field(default="unknown")
105    """実行(する/した)サブコマンド
106    - *results*: 成績サマリ
107    - *graph*: グラフ生成
108    - *ranking*: ランキング
109    - *rating*: レーティング
110    - *report*: レポート
111    - *comparison*: 突合処理
112    - *unknown*: 未定義
113    """
114
115    command_flg: bool = field(default=False)
116    """コマンドとして実行されたかチェック
117    - *True*: コマンド実行
118    - *False*: キーワード呼び出し
119    """
120    command_name: str = field(default="")
121    """実行したコマンド名"""
122
123    reaction: bool = field(default=False)
124    """データステータス状態
125    - *True*: 矛盾なくデータを取り込んだ(OK)
126    - *False*: 矛盾があったがデータを取り込んだ or データを取り込めなかった(NG)
127    """
128    action: Literal["change", "delete", "nothing"] = field(default="nothing")
129    """DBに対する操作
130    - *change*: insert/updateが実行された
131    - *delete*: deleteが実行された
132    - *nothing*: 何もしてない
133    """
134    target_ts: list = field(default_factory=list)
135    """同じ処理をしたタイムスタンプリスト(1件だけの処理でもセットされる)"""
136    rpoint_sum: int = field(default=0)
137    """素点合計値格納用"""
138
139    result: bool = field(default=True)
140    """メッセージデータに対する処理結果
141    - *True*: 目的の処理が達成できた
142    - *False*: 何らかの原因で処理が達成できなかった
143    """
144    message: Any = field(default=None)
145    """汎用メッセージ"""
146    source: str = field(default="")
147    """入力元識別子"""
148
149
150class MessageParserProtocol(Protocol):
151    """メッセージ解析クラス"""
152
153    data: MsgData
154    """受け取ったメッセージデータ"""
155    post: PostData
156    """送信する内容"""
157    status: StatusData
158    """処理した結果"""
159
160    @property
161    def in_thread(self) -> bool:
162        """スレッド内のメッセージか判定"""
163
164    @property
165    def is_command(self) -> bool:
166        """コマンドとして実行されたかチェック
167        - *True*: スラッシュコマンド
168        - *False*: チャンネル内呼び出しキーワード
169        """
170
171    @property
172    def is_bot(self) -> bool:
173        """botによる操作かチェック
174        - *True*: botが操作
175        - *False*: ユーザが操作
176        """
177
178    @property
179    def keyword(self) -> str:
180        """コマンドとして認識している文字列を返す"""
181
182    @property
183    def argument(self) -> list:
184        """コマンド引数として認識しているオプションを文字列のリストで返す"""
185
186    @property
187    def reply_ts(self) -> str:
188        """リプライ先のタイムスタンプ"""
189
190    @property
191    def check_updatable(self) -> bool:
192        """DB更新可能チャンネルか判定"""
193
194    @property
195    def ignore_user(self) -> bool:
196        """コマンドを拒否するユーザか判定"""
197
198    def set_data(self, title: str, data: "MessageType", options: "StyleOptions"):
199        """メッセージデータをセット"""
200
201    def get_score(self, keyword: str) -> dict:
202        """本文からスコアデータを取り出す"""
203
204    def get_remarks(self, keyword: str) -> list:
205        """本文からメモデータを取り出す"""
206
207    def parser(self, body: Any):
208        """メッセージ解析メソッド"""
209
210    def reset(self):
211        """状態リセット"""