Python API リファレンス

rsshogi は Rust 製将棋ライブラリの Python バインディングである。 高速な盤面操作、合法手生成、複数形式の棋譜読み書き、定跡検索、機械学習向けバイナリ変換を型安全な API として提供する。

このリファレンスの読み方

各ページは共通の記法規則で記述されている。

• シグネチャ：Python の型注釈付きコードブロックで示す（例：board.to_sfen() -> str）。
• 一覧表と詳細解説：各クラスのメソッドやプロパティを機能別の表で整理し、引数や戻り値の詳細が重要なメソッドは個別の節とコード例で解説する。
• 例外方針：多くの API は共通の例外規則に従う。
  • 型が不正：TypeError を送出する。
  • 値は型として正しいが内容が不正（不正な SFEN や USI 文字列、非合法手、範囲外の整数など）：ValueError を送出する。
  • 履歴や検索結果が空：None を返す（例：board.last_move()、board.pop()、book.get(key)）。

インストール

通常の環境では標準パッケージをインストールする。

pip install rsshogi

AVX2 対応の x86_64 CPU 環境では、SIMD 命令を有効化した高速版パッケージを選択できる。 通常版と高速版は同じ rsshogi モジュール名を提供するため、環境ごとにどちらか一方のみをインストールする。

pip install rsshogi-avx2

モジュール構成

rsshogi は機能ごとのサブモジュールで構成されている。 なお rsshogi.core は利便性のため rsshogi.types の主要型（Color、Piece、PieceType、Square）も再エクスポートする。

インポート例

from rsshogi.core import (
    AperyMove,
    AperyMove32,
    Board,
    Move,
    Move32,
    PositionState,
    UsiPositionParts,
    ValidationIssue,
    ValidationReport,
    normalize_usi_position,
    parse_usi_position,
    parse_usi_position_parts,
    to_move,
)
from rsshogi.types import (
    Bitboard,
    Color,
    Hand,
    MoveType,
    Piece,
    PieceType,
    RepetitionState,
    Square,
)
from rsshogi.record import (
    EngineInfo,
    GameResult,
    GameResultInfo,
    MoveEntry,
    Record,
    RecordBuilder,
    RecordEditor,
    RecordMetadata,
    RecordMetadataBuilder,
    RecordMetadataKey,
    SpecialMoveEntry,
    TimeControl,
)
from rsshogi.book import (
    NativeBook, NativeBookEditor, NativeBookBuilder,
    NativeBookEntry, NativeBookPosition, NativeBookMetadata,
    NativeScore, NativeBound, NativeCandidate,
    SbkBook,
    YaneuraOuBook,
)
from rsshogi.usi import UsiBestMove, UsiBound, UsiGoCommand, UsiInfo, UsiScore
from rsshogi.policy import (
    COMPACT_MOVE_LABEL_COUNT,
    MOVE_LABEL_COUNT,
    compact_move_label,
    move_label,
)
from rsshogi.sazpack import (
    SazGame,
    SazPolicyEntry,
    SazPosition,
    SazWdl,
    decode_sazpack,
    write_sazpack,
)
from rsshogi.initial_positions import InitialPosition
from rsshogi.svg import Svg
from rsshogi.numpy import (
    HuffmanCodedPos,
    HuffmanCodedPosAndEval,
    PackedSfen,
    PackedSfenValue,
)

クラスと型の一覧

盤面と局面検証

指し手表現

基本型

棋譜と分岐編集

定跡データベース

NativeScore、NativeBound、NativeCandidate、NativeBookEntry、NativeBookPosition、NativeBookMetadata は評価、候補手、局面 snapshot と文書属性を保持する。

USI プロトコルとユーティリティ

スタンドアロン関数一覧

対応データフォーマット

関連項目

• クイックスタート
• 例とパターン
• フォーマット仕様一覧