integrations.protocols

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