libs.functions.compose.text_item module¶
libs/functions/compose/text_item.py
- libs.functions.compose.text_item.aggregation_range(game_info, kind='str')¶
集計範囲を返す(ヘッダ出力用)
- Parameters:
game_info (GameInfo) – 集計範囲のゲーム情報
kind (str) –
表示させるフォーマットを選択. Defaults to str.
list: リストで受け取る
str: 文字列で受け取る
- Returns:
kind にlistが指定されている場合はリストで返す
kind にstrが指定されている場合は文字列で返す
- Return type:
Union[list, str]
- libs.functions.compose.text_item.date_range(kind, prefix_a=None, prefix_b=None)¶
日付範囲文字列
- Parameters:
kind (Format) – ExtendedDatetimeのformatメソッドに渡す引数
prefix_a (str, optional) – 単独で返った時の接頭辞. Defaults to None.
prefix_b (str, optional) – 範囲で返った時の接頭辞. Defaults to None.
- Returns:
生成文字列
- Return type:
str
- libs.functions.compose.text_item.get_members_list()¶
登録済みのメンバー一覧を取得する
- Returns:
メンバーリスト
- Return type:
str
- libs.functions.compose.text_item.get_team_list()¶
チームの登録状況を取得する
- Returns:
チームリスト
- Return type:
str
- libs.functions.compose.text_item.remarks(headword=False)¶
引数で指定された集計方法を注記にまとめる
- Parameters:
headword (bool, optional) – 見出しを付ける. Defaults to False.
- Returns:
headwordがない場合はリストで返すheadwordがある場合は文字列で返す
- Return type:
Union[list, str]
- libs.functions.compose.text_item.search_range(kind='str', time_pattern=None)¶
検索範囲を返す(ヘッダ出力用)
- Parameters:
kind (str) – 返値のタイプ. Defaults to str.
time_pattern (str, optional) – 表示させるフォーマットを選択. Defaults to None.
- Returns:
kindにlistが指定されている場合はリストkindにstrが指定されている場合は文字列
- Return type:
Union[list, str]
- libs.functions.compose.text_item.search_word(headword=False)¶
キーワード検索条件を返す
- Parameters:
headword (bool, optional) – 見出しを付ける. Defaults to False.
- Returns:
条件をまとめた文字列
- Return type:
str