Python から rsshogi を使用するための API リファレンスです。
各ページは共通の記法ルールで書かれています。
- シグネチャは Python のコードフェンスで示します（
board.to_sfen() -> str など）。
- 型・列挙・定数が中心のページ（補助型 / GameResult /
Record 系 / 定跡 / NumPy 連携）は、
プロパティ・メソッドを一覧表で示します。
- 主要な操作クラス（Board / Move / Move32）は、
メソッドごとに引数・戻り値・例外・使用例を個別に説明します。
- 例外ポリシーは全 API 共通です。
- 型が不正:
TypeError
- 値は型として正しいが内容が不正（不正な文字列・違法手など）:
ValueError
- 履歴が空などの「未存在」:
None を返す（例: last_move(), pop()）
- 各ページの末尾には関連ページへのリンク（関連項目）があります。
pip install rsshogi
AVX2 対応 x86_64 CPU 向けの高速版も利用できます（通常版とは同時にインストールできません）。迷った場合は通常版を使ってください。
pip install rsshogi-avx2
rsshogi はサブモジュールで構造化されています。
| モジュール | 主な型 | 説明 |
|---|
rsshogi.core | Board, Move32, Move, AperyMove, AperyMove32, PositionState, ValidationReport, ValidationIssue, to_move(), parse_usi_position(), parse_usi_position_parts(), normalize_usi_position() | 盤面、raw-state、指し手 |
rsshogi.types | Color, PieceType, Piece, Square, Bitboard, Hand, MoveType, RepetitionState | 補助型と定数 |
rsshogi.record | Record, RecordMetadata, GameResultInfo, MoveEntry, EngineInfo, SpecialMoveEntry, TimeControl, GameResult | 棋譜の読み書き |
rsshogi.book | StaticBook, MemoryBook, BookBuilder, BookKey, BookMove, BookEntry, YaneuraOuBook, SbkBook | 定跡データベース（内部形式・外部形式） |
rsshogi.usi | UsiInfo, UsiBestMove, UsiGoCommand, UsiScore, UsiBound, move_from_usi(), parse_info(), parse_bestmove() | USI プロトコルの値オブジェクトとパーサ |
rsshogi.policy | move_label(), compact_move_label(), 変換テーブル | policy 学習向けラベル変換 |
rsshogi.initial_positions | InitialPosition | 初期局面の SFEN 定数 |
rsshogi.svg | Svg | 盤面の SVG 描画 |
rsshogi.numpy | PackedSfen, PackedSfenValue, HuffmanCodedPos, HuffmanCodedPosAndEval | NumPy dtype 定義（要 NumPy） |
from rsshogi.core import (
Board,
Move32,
Move,
AperyMove,
AperyMove32,
PositionState,
ValidationIssue,
ValidationReport,
to_move,
parse_usi_position,
normalize_usi_position,
)
from rsshogi.types import Color, PieceType, Piece, Square, Bitboard, Hand, MoveType, RepetitionState
from rsshogi.record import (
Record,
RecordMetadata,
MoveEntry,
EngineInfo,
SpecialMoveEntry,
TimeControl,
GameResult,
)
from rsshogi.book import StaticBook, MemoryBook, BookBuilder, BookKey, BookMove, BookEntry
from rsshogi.book import book_key_from_position, book_key_after, book_builder_from_game_record
from rsshogi.book import YaneuraOuBook, SbkBook
from rsshogi.usi import UsiInfo, UsiBestMove, UsiGoCommand, UsiScore, UsiBound
from rsshogi.policy import (
MOVE_LABEL_COUNT,
COMPACT_MOVE_LABEL_COUNT,
move_label,
compact_move_label,
)
from rsshogi.initial_positions import InitialPosition
from rsshogi.svg import Svg
from rsshogi.numpy import (
PackedSfen,
PackedSfenValue,
HuffmanCodedPos,
HuffmanCodedPosAndEval,
) # NumPy が必要
| フォーマット | パース | エクスポート | 説明 |
|---|
| KIF | o | o | 柿木形式 |
| KI2 | o | o | KIF の指し手のみ形式 |
| CSA | o | o | CSA 標準形式 |
| JKF | - | o | JSON 棋譜形式（エクスポートのみ） |
| sbinpack | o | o | バイナリ学習データ形式 |
| 定跡バイナリ | o | o | 互換定跡形式（StaticBook / MemoryBook） |
| DB2016 | o（参照） | - | .db 外部定跡（YaneuraOuBook） |
| SBK | o（参照） | - | SBK .sbk 外部定跡（SbkBook） |
| HCP / HCPE | o | o | Apery / cshogi 互換の固定長学習データ |