libs.functions.compose.text_item

  1"""
  2libs/functions/compose/text_item.py
  3"""
  4
  5from typing import TYPE_CHECKING, Literal, Optional
  6
  7from table2ascii import Alignment, PresetStyle, table2ascii
  8
  9import libs.global_value as g
 10from libs.utils.timekit import Delimiter, Format
 11from libs.utils.timekit import ExtendedDatetime as ExtDt
 12
 13if TYPE_CHECKING:
 14    from libs.domain.datamodels import GameInfo
 15
 16
 17def remarks(headword: bool = False) -> str | list[str]:
 18    """
 19    引数で指定された集計方法を注記にまとめる
 20
 21    Args:
 22        headword (bool, optional): 見出しを付ける. Defaults to False.
 23
 24    Returns:
 25        Union[list, str]:
 26        - `headword` がない場合はリストで返す
 27        - `headword` がある場合は文字列で返す
 28
 29    """
 30    remark_list: list[str] = []
 31
 32    if g.params.individual:  # 個人集計時のみ表示
 33        if not g.params.unregistered_replace:
 34            remark_list.append("ゲスト置換なし(" + g.cfg.setting.guest_mark + "：未登録プレイヤー)")
 35        if not g.params.guest_skip:
 36            remark_list.append("2ゲスト戦の結果を含む")
 37    else:  # チーム集計時
 38        if g.params.friendly_fire:
 39            if g.params.game_results and g.params.verbose:
 40                remark_list.append("チーム同卓時の結果を含む(" + g.cfg.setting.guest_mark + ")")
 41            else:
 42                remark_list.append("チーム同卓時の結果を含む")
 43
 44    if g.params.stipulated >= 2:
 45        remark_list.append(f"規定打数 {g.params.stipulated} G以上")
 46    if g.params.command in ["ranking"]:
 47        remark_list.append(f"{g.params.ranked}位まで表示")
 48
 49    # 集計ルール
 50    if g.params.mixed:
 51        match g.params.target_mode:
 52            case 3:
 53                remark_list.append("集計対象ルール すべて(三人打)")
 54            case 4:
 55                remark_list.append("集計対象ルール すべて(四人打)")
 56            case _:
 57                remark_list.append("集計対象ルール すべて")
 58    elif len(g.params.rule_list) > 1:
 59        remark_list.append(f"集計対象ルール {'、'.join(g.params.rule_list)}")
 60    elif g.params.rule_version != g.params.default_rule:
 61        remark_list.append(f"集計対象ルール {'、'.join(g.params.rule_list)}")
 62
 63    if headword:
 64        if remark_list:
 65            return f"特記事項：{'、'.join(remark_list)}"
 66        return "特記事項：なし"
 67
 68    return remark_list
 69
 70
 71def search_word(headword: bool = False) -> str:
 72    """
 73    キーワード検索条件を返す
 74
 75    Args:
 76        headword (bool, optional): 見出しを付ける. Defaults to False.
 77
 78    Returns:
 79        str: 条件をまとめた文字列
 80
 81    """
 82    if ret := g.params.search_word.replace("%", ""):
 83        # 集約条件
 84        if g.params.group_length:
 85            ret += f"（{g.params.group_length}文字集約）"
 86    else:
 87        ret = ""
 88
 89    if headword:
 90        if ret:
 91            return f"検索ワード：{ret}"
 92
 93    return ret
 94
 95
 96def search_range(kind: Literal["str", "list"] = "str", time_pattern: Optional[str] = None) -> list[str] | str:
 97    """
 98    検索範囲を返す（ヘッダ出力用）
 99
100    Args:
101        kind (str): 返値のタイプ. Defaults to str.
102        time_pattern (str, optional): 表示させるフォーマットを選択. Defaults to None.
103
104    Returns:
105        Union[list, str]:
106        - `kind` にlistが指定されている場合はリスト
107        - `kind` にstrが指定されている場合は文字列
108
109    """
110    starttime: str
111    endtime: str
112
113    match time_pattern:
114        case "day":
115            starttime = ExtDt(g.params.starttime).format(Format.TS)
116            endtime = ExtDt(g.params.endtime).format(Format.TS)
117        case "time":
118            starttime = ExtDt(g.params.starttime).format(Format.YMDHM)
119            endtime = ExtDt(g.params.endtime).format(Format.YMDHM)
120        case _:
121            starttime = ExtDt(g.params.starttime).format(Format.YMDHMS)
122            endtime = ExtDt(g.params.endtime).format(Format.YMDHMS)
123
124    match kind:
125        case "list":
126            return [starttime, endtime]
127        case "str":
128            return f"{starttime} ～ {endtime}"
129
130
131def aggregation_range(
132    game_info: "GameInfo",
133    kind: Literal["list", "str"] = "str",
134) -> list[Optional[str]] | str:
135    """
136    集計範囲を返す（ヘッダ出力用）
137
138    Args:
139        game_info (GameInfo): 集計範囲のゲーム情報
140        kind (str): 表示させるフォーマットを選択. Defaults to str.
141            - list: リストで受け取る
142            - str: 文字列で受け取る
143
144    Returns:
145        Union[list, str]:
146        - `kind` にlistが指定されている場合はリストで返す
147        - `kind` にstrが指定されている場合は文字列で返す
148
149    """
150    assert isinstance(game_info.first_game, ExtDt)
151    assert isinstance(game_info.last_game, ExtDt)
152
153    if g.params.search_word:  # コメント検索の場合はコメントで表示
154        first = game_info.first_comment
155        last = game_info.last_comment
156    else:
157        first = game_info.first_game.format(Format.YMDHM)
158        last = game_info.last_game.format(Format.YMDHM)
159
160    match kind:
161        case "list":
162            return [first, last]
163        case "str":
164            return f"{first} ～ {last}"
165
166
167def date_range(
168    kind: Format,
169    prefix_a: Optional[str] = None,
170    prefix_b: Optional[str] = None,
171) -> str:
172    """
173    日付範囲文字列
174
175    Args:
176        kind (Format): ExtendedDatetimeのformatメソッドに渡す引数
177        prefix_a (Optional[str], optional): 単独で返った時の接頭辞. Defaults to None.
178        prefix_b (Optional[str], optional): 範囲で返った時の接頭辞. Defaults to None.
179
180    Returns:
181        str: 生成文字列
182
183    """
184    ret: str
185    str_st: str
186    str_et: str
187    st = ExtDt(g.params.starttime)
188    et = ExtDt(g.params.endtime)
189    ot = ExtDt(g.params.onday)
190
191    if kind.name.endswith("_O"):
192        str_st = st.format(kind)
193        str_et = ot.format(kind)
194    else:
195        str_st = st.format(kind)
196        str_et = et.format(kind)
197
198    if st.format(kind, Delimiter.NUMBER) == ot.format(kind, Delimiter.NUMBER):
199        if prefix_a and prefix_b:
200            ret = f"{prefix_a} ({str_st})"
201        else:
202            ret = f"{str_st}"
203    else:
204        if prefix_a and prefix_b:
205            ret = f"{prefix_b} ({str_st} - {str_et})"
206        else:
207            ret = f"{str_st} - {str_et}"
208
209    return ret
210
211
212def get_members_list() -> str:
213    """
214    登録済みのメンバー一覧を取得する
215
216    Returns:
217        str: メンバーリスト
218
219    """
220    name_list: list[list[str]] = []
221    for pname in g.cfg.member.lists:
222        name_list.append([pname, ", ".join(g.cfg.member.alias(pname))])
223
224    if name_list:
225        output = table2ascii(
226            header=["表示名", "登録されている名前"],
227            body=name_list,
228            alignments=[Alignment.LEFT, Alignment.LEFT],
229            style=PresetStyle.ascii_borderless,
230        )
231    else:
232        output = "メンバーは登録されていません。"
233
234    return output
235
236
237def get_team_list() -> str:
238    """
239    チームの登録状況を取得する
240
241    Returns:
242        str: チームリスト
243
244    """
245    team_list: list[list[str]] = []
246    for team_name in g.cfg.team.lists:
247        if member := ", ".join(g.cfg.team.member(team_name)):
248            team_list.append([team_name, member])
249        else:
250            team_list.append([team_name, "未エントリー"])
251
252    if team_list:
253        output = table2ascii(
254            header=["チーム名", "所属メンバー"],
255            body=team_list,
256            alignments=[Alignment.LEFT, Alignment.LEFT],
257            style=PresetStyle.ascii_borderless,
258        )
259    else:
260        output = "チームは登録されていません。"
261
262    return output