libs.bootstrap.section

  1"""
  2libs/bootstrap/section.py
  3"""
  4
  5import logging
  6from pathlib import Path
  7from typing import TYPE_CHECKING, Any, Optional, TypeAlias, Union
  8
  9from libs.domain.datamodels import CommandAttrs
 10
 11if TYPE_CHECKING:
 12    from configparser import ConfigParser, SectionProxy
 13
 14    from integrations.discord.config import SvcConfig as DiscordConfig
 15    from integrations.slack.config import SvcConfig as SlackConfig
 16    from integrations.standard_io.config import SvcConfig as StdConfig
 17    from integrations.web.config import SvcConfig as WebConfig
 18    from libs.bootstrap.app_config import BadgeDisplay
 19    from libs.commands.registry.member import MemberSection
 20    from libs.commands.registry.team import TeamSection
 21
 22ServiceClassType: TypeAlias = Union[
 23    "SlackConfig",
 24    "DiscordConfig",
 25    "WebConfig",
 26    "StdConfig",
 27]
 28"""連携サービスクラス"""
 29
 30SettingClassType: TypeAlias = Union[
 31    "SettingSection",
 32    "MemberSection",
 33    "TeamSection",
 34    "AliasSection",
 35    "BadgeDisplay",
 36]
 37"""設定関連クラス"""
 38
 39SubClassType: TypeAlias = Union[
 40    "SettingClassType",
 41    "SubCommands",
 42    "ServiceClassType",
 43]
 44
 45
 46class CommonMethodMixin:
 47    """共通メソッド"""
 48
 49    section_proxy: "SectionProxy"
 50    """読み込み先(パーサー + セクション名)"""
 51
 52    def get(self, key: str, fallback: Any = None) -> Any:
 53        """値の取得"""
 54        return self.section_proxy.get(key, fallback)
 55
 56    def getint(self, key: str, fallback: int = 0) -> int:
 57        """整数値の取得"""
 58        return self.section_proxy.getint(key, fallback)
 59
 60    def getfloat(self, key: str, fallback: float = 0.0) -> float:
 61        """数値の取得"""
 62        return self.section_proxy.getfloat(key, fallback)
 63
 64    def getboolean(self, key: str, fallback: bool = False) -> bool:
 65        """真偽値の取得"""
 66        return self.section_proxy.getboolean(key, fallback)
 67
 68    def getlist(self, key: str, fallback: str = "") -> list[str]:
 69        """リストの取得"""
 70        return [x.strip() for x in self.section_proxy.get(key, fallback).split(",")]
 71
 72    def keys(self) -> list[str]:
 73        """キーリストの返却"""
 74        return list(self.section_proxy.keys())
 75
 76    def values(self) -> list[str]:
 77        """値リストの返却"""
 78        return list(self.section_proxy.values())
 79
 80    def items(self) -> list[tuple[str, str]]:
 81        """ItemsViewを返却"""
 82        return list(self.section_proxy.items())
 83
 84
 85class BaseSection(CommonMethodMixin):
 86    """基底クラス"""
 87
 88    section: str
 89    """セクション名"""
 90    main_parser: "ConfigParser"
 91    """設定パーサー"""
 92    section_proxy: "SectionProxy"
 93    """読み込み先(パーサー + セクション名)"""
 94
 95    def __init__(self, outer: SubClassType) -> None:
 96        self.main_parser = outer.main_parser
 97        assert self.main_parser
 98        if not hasattr(self, "section") or self.section not in self.main_parser:
 99            return
100
101        self.initialization(self.main_parser[self.section])
102
103    def __repr__(self) -> str:
104        return str({k: v for k, v in vars(self).items() if not str(k).startswith("_")})
105
106    def initialization(self, section_proxy: "SectionProxy") -> None:
107        """
108        設定ファイルから値の取り込み
109
110        Args:
111            section_proxy (SectionProxy): 読み込み先(パーサー + セクション名)
112
113        """
114        self.section_proxy = section_proxy
115        for k in self.section_proxy.keys():
116            if k not in self.to_dict():
117                continue  # インスタンス変数と一致しない項目はスキップ
118            current_value = self.__dict__.get(k)
119            match current_value:
120                case _ if k in self.__dict__ and isinstance(current_value, str):
121                    setattr(self, k, self.get(k))
122                case _ if isinstance(current_value, bool):
123                    setattr(self, k, self.section_proxy.getboolean(k))
124                case _ if k in self.__dict__ and isinstance(current_value, int):
125                    setattr(self, k, self.getint(k))
126                case _ if k in self.__dict__ and isinstance(current_value, float):
127                    setattr(self, k, self.getfloat(k))
128                case _ if k in self.__dict__ and isinstance(current_value, list):
129                    v_list = self.getlist(k)
130                    if current_value:  # 設定済みリストは追加
131                        current_value.extend(v_list)
132                    else:
133                        setattr(self, k, v_list)
134                case _ if k in self.__dict__ and isinstance(current_value, Path):
135                    setattr(self, k, Path(self.get(k)))
136                case None if k in self.__dict__:
137                    if k in ["backup_dir", "rule_config"]:  # Optional[Path]
138                        setattr(self, k, Path(self.get(k)))
139                    else:
140                        setattr(self, k, self.get(k))
141                case _:
142                    setattr(self, k, current_value)
143
144    def _before_config_load(self) -> None:
145        """設定値取り込み前の初期化処理"""
146        if (reset_method := getattr(self, "default_reset", None)) and callable(reset_method):
147            reset_method()
148
149    def _after_config_load(self, _section_proxy: "SectionProxy") -> None:
150        """設定値取り込み後の追加処理"""
151
152    def config_load(self, section_proxy: "SectionProxy") -> None:
153        """
154        設定値取り込み
155
156        Args:
157            section_proxy (SectionProxy): 読み込み先(パーサー + セクション名)
158
159        """
160        self._before_config_load()
161        self.initialization(section_proxy)
162        self._after_config_load(section_proxy)
163
164        logging.trace("%s: %s", self.section, self)  # type: ignore
165
166    def to_dict(self, drop_items: Optional[list[str]] = None) -> dict[str, str]:
167        """
168        必要なパラメータを辞書型で返す
169
170        Args:
171            drop_items (Optional[list[str]], optional): 返却に含めないキーリスト. Defaults to None.
172
173        Returns:
174             dict[str, str]: 返却値
175
176        """
177        ret_dict: dict[str, str] = {}
178        for key in vars(self):
179            if key.startswith("_"):
180                continue
181            ret_dict[key] = getattr(self, key)
182
183        if drop_items:
184            for item in drop_items:
185                if item in ret_dict:
186                    ret_dict.pop(item)
187
188        return ret_dict
189
190
191class SettingSection(BaseSection):
192    """settingセクション処理"""
193
194    remarks_word: str
195    """メモ記録用キーワード"""
196    remarks_suffix: list[str]
197    """メモ記録用キーワードサフィックス"""
198    rule_config: Optional[Path]
199    """ルール設定ファイル"""
200    default_rule: str
201    """ルール識別子未指定時に使用される識別子"""
202    separate: bool
203    """スコア入力元識別子別集計フラグ
204    - *True*: 識別子別に集計
205    - *False*: すべて集計
206    """
207    channel_id: Optional[str]
208    """チャンネルIDを上書きする"""
209    time_adjust: int
210    """日付変更後、集計範囲に含める追加時間"""
211    search_word: str
212    """コメント固定(検索時の検索文字列)"""
213    group_length: int
214    """コメント固定(検索時の集約文字数)"""
215    guest_mark: str
216    """ゲスト無効時に未登録メンバーに付与する印"""
217    database_file: Union[str, Path]
218    """成績管理データベースファイル名"""
219    backup_dir: Optional[Path]
220    """バックアップ先ディレクトリ"""
221    font_file: Path
222    """グラフ描写に使用するフォントファイル"""
223    graph_style: str
224    """グラフスタイル"""
225    work_dir: Path
226    """作業ディレクトリ"""
227
228    def __init__(self) -> None:
229        self.section: str = "setting"
230        self.default_reset()
231
232    def default_reset(self) -> None:
233        """パラメータ初期化"""
234        self.remarks_word = str("麻雀メモ")
235        self.remarks_suffix = []
236        self.rule_config = None
237        self.time_adjust = int(12)
238        self.default_rule = str("")
239        self.separate = bool(False)
240        self.channel_id = None
241        self.search_word = str("")
242        self.group_length = int(0)
243        self.guest_mark = str("※")
244        self.database_file = Path("mahjong.db")
245        self.backup_dir = None
246        self.font_file = Path("ipaexg.ttf")
247        self.graph_style = str("ggplot")
248        self.work_dir = Path("work")
249
250
251class AliasSection(BaseSection):
252    """aliasセクション処理"""
253
254    results: list[str]
255    """成績サマリ出力コマンド"""
256    graph: list[str]
257    """成績グラフ出力コマンド"""
258    ranking: list[str]
259    """ランキング出力コマンド"""
260    report: list[str]
261    """レポート出力コマンド"""
262    download: list[str]
263    member: list[str]
264    """メンバーリスト表示コマンド"""
265    add: list[str]
266    delete: list[str]
267    team_create: list[str]
268    team_del: list[str]
269    team_add: list[str]
270    team_remove: list[str]
271    team_list: list[str]
272    """チームリスト出力コマンド"""
273    team_clear: list[str]
274
275    def __init__(self) -> None:
276        self.section = "alias"
277        self.default_reset()
278
279    def default_reset(self) -> None:
280        """パラメータ初期化"""
281        self.results = ["results", "成績"]
282        self.graph = ["graph", "グラフ"]
283        self.ranking = ["ranking", "ランキング"]
284        self.report = ["report", "レポート"]
285        self.download = ["download", "ダウンロード"]
286        self.member = ["member", "userlist", "member_list"]
287        self.add = ["add"]
288        self.delete = ["del"]
289        self.team_create = ["team_create"]
290        self.team_del = ["team_del"]
291        self.team_add = ["team_add"]
292        self.team_remove = ["team_remove"]
293        self.team_list = ["team_list"]
294        self.team_clear = ["team_clear"]
295
296    def _after_config_load(self, _section_proxy: "SectionProxy") -> None:
297        """AliasSection専用の追加処理"""
298
299        # delのエイリアス取り込み(設定ファイルに`delete`と書かれていない)
300        self.delete.extend(self.getlist("del", fallback="del"))
301
302
303class SubCommands(BaseSection, CommandAttrs):
304    """サブコマンドセクション処理"""
305
306    default_commandword: str
307    """コマンドワードデフォルト値"""