ホーム  -> Python  -> Python APIの解説 -> その他のAPI

5.Other noteworthy APIs（その他のAPI）

スマートトレインでは、スナップの色の並びをプログラムで処理するためのクラスや関数が用意されています。
ここでは、スナップコマンド（色の並び）を扱う基本的な使い方を紹介します。

【スナップコマンドクラス（色の並びを表す）】

class trainlib.messages.SnapCommand(iterable=(), /)
スマートトレインのスナップコマンド（色の並び）を表すクラスです。
最大4つを扱うことができ、スナップの命令を確認・比較する際に使います。
・スナップは 必ず「白」か「水色」で始まります。
・足りない色は自動で 「黒」が補われます。
・== を使うと、色の並びが特定の順番と完全一致するかを調べられます。

使用例
この例では SnapColorValue を C としてインポートしています。
（例：from trainlib.enums import SnapColorValue as C）

msg.colors == (C.WHITE, C.RED, C.BLACK, C.BLACK)　　 # 完全一致
msg.colors == (C.WHITE, C.RED)　　 # BLACK は省略可能

【start_with関数（色の並びの先頭を調べる）】

start_with(colors: Union[Tuple[定数はこちら], 定数はこちら ], *args:定数はこちら )
スナップコマンドが、指定した色の並びで始まっているかどうかを調べる関数です。
完全一致（==）ではなく、先頭の部分だけを比較したいときに使います。
この関数には、start_with() または starts_with() のどちらの名前でもアクセスできます（どちらも同じ動作をします）。

使用例
この例では、SnapColorValue を C としてインポートしています。

snap_command.starts_with(C.WHITE, C.RED)
msg.colors.start_with(C.CYAN, C.BLUE)



【starts_with関数（色の並びの先頭を調べる）】

starts_with(colors: Union[Tuple[定数はこちら], 定数はこちら ], *args:定数はこちら )
スナップコマンドが、指定した色の並びで始まっているかどうかを調べる関数です。
完全一致（==）ではなく、先頭の部分だけを比較したいときに使います。
この関数には、start_with() または starts_with() のどちらの名前でもアクセスできます（どちらも同じ動作をします）。

使用例
この例では、SnapColorValue を C としてインポートしています。

snap_command.starts_with(C.WHITE, C.RED)
msg.colors.start_with(C.CYAN, C.BLUE)


引数：colors（SnapColorValue）
色をいくつか指定するための引数です。
次の2通りの方法があります。好きな方を使ってOKです。

① () を使って、色をまとめて指定
　例：(RED, BLUE)

② 色を,で区切って指定
　例：RED, BLUE