API Reference
The libscid Python API surface is structured into four domain modules:
| Domain | Key Symbols | Description |
|---|---|---|
| Core | Game, Cursor, Position, Arbiter |
Game container, immutable move tree cursors, board analysis, and draw adjudication. |
| Database | Database, DatabaseFilters, DatabaseSearch, HeaderCriteria, Filter |
PGN/Scid database indexing, multi-criteria header queries, and filter bitsets. |
| PGN & Events | PgnOptions, Nag, MoveMetadata, iter_movetext, MovetextEvent |
PGN serialization, numeric annotation glyphs, metadata, and event-driven AST streaming. |
| Exceptions | LibScidError |
Library root error raised when native operations or validation fail. |
Complete Public Surface (libscid.__all__)
__all__ = [
# Core Game & Navigation
"Game",
"Cursor",
"Position",
"Arbiter",
# Database, Search & Filtering
"Database",
"DatabaseFilters",
"DatabaseSearch",
"HeaderCriteria",
"Filter",
# PGN, Annotations & Events
"PgnOptions",
"Nag",
"MoveMetadata",
"iter_movetext",
"MovetextEvent",
"MovetextLineStart",
"MovetextMove",
"MovetextLineEnd",
# Exceptions
"LibScidError",
]