PGN parsing and writing¶
Parsing¶
-
chess.pgn.
read_game
(handle: TextIO) → Optional[chess.pgn.Game][source]¶ -
chess.pgn.
read_game
(handle: TextIO, *, Visitor: Callable[], chess.pgn.BaseVisitor[ResultT]]) → Optional[ResultT] Reads a game from a file opened in text mode.
>>> import chess.pgn >>> >>> pgn = open("data/pgn/kasparov-deep-blue-1997.pgn") >>> >>> first_game = chess.pgn.read_game(pgn) >>> second_game = chess.pgn.read_game(pgn) >>> >>> first_game.headers["Event"] 'IBM Man-Machine, New York USA' >>> >>> # Iterate through all moves and play them on a board. >>> board = first_game.board() >>> for move in first_game.mainline_moves(): ... board.push(move) ... >>> board Board('4r3/6P1/2p2P1k/1p6/pP2p1R1/P1B5/2P2K2/3r4 b - - 0 45')
By using text mode, the parser does not need to handle encodings. It is the caller’s responsibility to open the file with the correct encoding. PGN files are usually ASCII or UTF-8 encoded, sometimes with BOM (which this parser automatically ignores).
>>> pgn = open("data/pgn/kasparov-deep-blue-1997.pgn", encoding="utf-8")
Use
StringIO
to parse games from a string.>>> import io >>> >>> pgn = io.StringIO("1. e4 e5 2. Nf3 *") >>> game = chess.pgn.read_game(pgn)
The end of a game is determined by a completely blank line or the end of the file. (Of course, blank lines in comments are possible).
According to the PGN standard, at least the usual seven header tags are required for a valid game. This parser also handles games without any headers just fine.
The parser is relatively forgiving when it comes to errors. It skips over tokens it can not parse. By default, any exceptions are logged and collected in
Game.errors
. This behavior can beoverridden
.Returns the parsed game or
None
if the end of file is reached.
Writing¶
If you want to export your game with all headers, comments and variations, you can do it like this:
>>> import chess
>>> import chess.pgn
>>>
>>> game = chess.pgn.Game()
>>> game.headers["Event"] = "Example"
>>> node = game.add_variation(chess.Move.from_uci("e2e4"))
>>> node = node.add_variation(chess.Move.from_uci("e7e5"))
>>> node.comment = "Comment"
>>>
>>> print(game)
[Event "Example"]
[Site "?"]
[Date "????.??.??"]
[Round "?"]
[White "?"]
[Black "?"]
[Result "*"]
1. e4 e5 { Comment } *
Remember that games in files should be separated with extra blank lines.
>>> print(game, file=open("/dev/null", "w"), end="\n\n")
Use the StringExporter()
or
FileExporter()
visitors if you need more control.
Game model¶
Games are represented as a tree of moves. Each GameNode
can have extra
information, such as comments. The root node of a game
(Game
extends the GameNode
) also
holds general information, such as game headers.
-
class
chess.pgn.
Game
(headers: Optional[Union[Mapping[str, str], Iterable[Tuple[str, str]]]] = None)[source]¶ The root node of a game with extra information such as headers and the starting position. Also has all the other properties and methods of
GameNode
.-
headers
: chess.pgn.Headers¶ A mapping of headers. By default, the following 7 headers are provided (Seven Tag Roster):
>>> import chess.pgn >>> >>> game = chess.pgn.Game() >>> game.headers Headers(Event='?', Site='?', Date='????.??.??', Round='?', White='?', Black='?', Result='*')
-
errors
: List[Exception]¶ A list of errors (such as illegal or ambiguous moves) encountered while parsing the game.
-
setup
(board: Union[chess.Board, str]) → None[source]¶ Sets up a specific starting position. This sets (or resets) the
FEN
,SetUp
, andVariant
header tags.
-
accept
(visitor: chess.pgn.BaseVisitor[ResultT]) → ResultT[source]¶ Traverses the game in PGN order using the given visitor. Returns the visitor result.
-
classmethod
from_board
(board: chess.Board) → GameT[source]¶ Creates a game from the move stack of a
Board()
.
-
-
class
chess.pgn.
GameNode
[source]¶ -
parent
: Optional[chess.pgn.GameNode]¶ The parent node or
None
if this is the root node of the game.
-
move
: Optional[chess.Move]¶ The move leading to this node or
None
if this is the root node of the game.
-
nags
: Set[int] = set()¶ A set of NAGs as integers. NAGs always go behind a move, so the root node of the game will never have NAGs.
-
comment
: str = ''¶ A comment that goes behind the move leading to this node. Comments that occur before any moves are assigned to the root node.
-
starting_comment
: str = ''¶ A comment for the start of a variation. Only nodes that actually start a variation (
starts_variation()
checks this) can have a starting comment. The root node can not have a starting comment.
-
variations
: List[chess.pgn.GameNode]¶ A list of child nodes.
-
board
() → chess.Board[source]¶ Gets a board with the position of the node.
For the root node, this is the default starting position (for the
Variant
) unless theFEN
header tag is set.It’s a copy, so modifying the board will not alter the game.
-
san
() → str[source]¶ Gets the standard algebraic notation of the move leading to this node. See
chess.Board.san()
.Do not call this on the root node.
-
uci
(*, chess960: Optional[bool] = None) → str[source]¶ Gets the UCI notation of the move leading to this node. See
chess.Board.uci()
.Do not call this on the root node.
-
end
() → chess.pgn.GameNode[source]¶ Follows the main variation to the end and returns the last node.
-
starts_variation
() → bool[source]¶ Checks if this node starts a variation (and can thus have a starting comment). The root node does not start a variation and can have no starting comment.
For example, in
1. e4 e5 (1... c5 2. Nf3) 2. Nf3
, the node holding 1… c5 starts a variation.
-
is_main_variation
() → bool[source]¶ Checks if this node is the first variation from the point of view of its parent. The root node is also in the main variation.
-
variation
(move: Union[int, chess.Move, chess.pgn.GameNode]) → chess.pgn.GameNode[source]¶ Gets a child node by either the move or the variation index.
-
has_variation
(move: Union[int, chess.Move, chess.pgn.GameNode]) → bool[source]¶ Checks if this node has the given variation.
-
promote_to_main
(move: Union[int, chess.Move, chess.pgn.GameNode]) → None[source]¶ Promotes the given move to the main variation.
-
promote
(move: Union[int, chess.Move, chess.pgn.GameNode]) → None[source]¶ Moves a variation one up in the list of variations.
-
demote
(move: Union[int, chess.Move, chess.pgn.GameNode]) → None[source]¶ Moves a variation one down in the list of variations.
-
remove_variation
(move: Union[int, chess.Move, chess.pgn.GameNode]) → None[source]¶ Removes a variation.
-
add_variation
(move: chess.Move, *, comment: str = '', starting_comment: str = '', nags: Iterable[int] = []) → chess.pgn.GameNode[source]¶ Creates a child node with the given attributes.
-
add_main_variation
(move: chess.Move, *, comment: str = '') → chess.pgn.GameNode[source]¶ Creates a child node with the given attributes and promotes it to the main variation.
-
mainline
() → chess.pgn.Mainline[chess.pgn.GameNode][source]¶ Returns an iterator over the mainline starting after this node.
-
mainline_moves
() → chess.pgn.Mainline[chess.Move][source]¶ Returns an iterator over the main moves after this node.
-
add_line
(moves: Iterable[chess.Move], *, comment: str = '', starting_comment: str = '', nags: Iterable[int] = []) → chess.pgn.GameNode[source]¶ Creates a sequence of child nodes for the given list of moves. Adds comment and nags to the last node of the line and returns it.
-
eval
() → Optional[chess.engine.PovScore][source]¶ Parses the first valid
[%eval ...]
annotation in the comment of this node, if any.
-
set_eval
(score: Optional[chess.engine.PovScore]) → None[source]¶ Replaces the first valid
[%eval ...]
annotation in the comment of this node or adds a new one.
-
arrows
() → List[chess.svg.Arrow][source]¶ Parses all
[%csl ...]
and[%cal ...]
annotations in the comment of this node.Returns a list of
arrows
.
-
set_arrows
(arrows: Iterable[Union[chess.svg.Arrow, Tuple[chess.Square, chess.Square]]]) → None[source]¶ Replaces all valid
[%csl ...]
and[%cal ...]
annotations in the comment of this node or adds new ones.
-
clock
() → Optional[float][source]¶ Parses the first valid
[%clk ...]
annotation in the comment of this node, if any.Returns the player’s remaining time to the next time control after this move, in seconds.
-
set_clock
(seconds: Optional[float]) → None[source]¶ Replaces the first valid
[%clk ...]
annotation in the comment of this node or adds a new one.
-
accept
(visitor: chess.pgn.BaseVisitor[ResultT]) → ResultT[source]¶ Traverses game nodes in PGN order using the given visitor. Starts with the move leading to this node. Returns the visitor result.
-
accept_subgame
(visitor: chess.pgn.BaseVisitor[ResultT]) → ResultT[source]¶ Traverses headers and game nodes in PGN order, as if the game was starting after this node. Returns the visitor result.
-
Visitors¶
Visitors are an advanced concept for game tree traversal.
-
class
chess.pgn.
BaseVisitor
(*args, **kwds)[source]¶ Base class for visitors.
Use with
chess.pgn.Game.accept()
orchess.pgn.GameNode.accept()
orchess.pgn.read_game()
.The methods are called in PGN order.
-
parse_san
(board: chess.Board, san: str) → chess.Move[source]¶ When the visitor is used by a parser, this is called to parse a move in standard algebraic notation.
You can override the default implementation to work around specific quirks of your input format.
-
visit_move
(board: chess.Board, move: chess.Move) → None[source]¶ Called for each move.
board is the board state before the move. The board state must be restored before the traversal continues.
-
visit_board
(board: chess.Board) → None[source]¶ Called for the starting position of the game and after each move.
The board state must be restored before the traversal continues.
-
begin_variation
() → Optional[chess.pgn.SkipType][source]¶ Called at the start of a new variation. It is not called for the mainline of the game.
-
The following visitors are readily available.
-
class
chess.pgn.
GameBuilder
(*args, **kwds)[source]¶ Creates a game model. Default visitor for
read_game()
.-
handle_error
(error: Exception) → None[source]¶ Populates
chess.pgn.Game.errors
with encountered errors and logs them.You can silence the log and handle errors yourself after parsing:
>>> import chess.pgn >>> import logging >>> >>> logging.getLogger("chess.pgn").setLevel(logging.CRITICAL) >>> >>> pgn = open("data/pgn/kasparov-deep-blue-1997.pgn") >>> >>> game = chess.pgn.read_game(pgn) >>> game.errors # List of exceptions []
You can also override this method to hook into error handling:
>>> import chess.pgn >>> >>> class MyGameBuilder(chess.pgn.GameBuilder): >>> def handle_error(self, error: Exception) -> None: >>> pass # Ignore error >>> >>> pgn = open("data/pgn/kasparov-deep-blue-1997.pgn") >>> >>> game = chess.pgn.read_game(pgn, Visitor=MyGameBuilder)
-
-
class
chess.pgn.
BoardBuilder
(*args, **kwds)[source]¶ Returns the final position of the game. The mainline of the game is on the move stack.
-
class
chess.pgn.
StringExporter
(*args, **kwds)[source]¶ Allows exporting a game as a string.
>>> import chess.pgn >>> >>> game = chess.pgn.Game() >>> >>> exporter = chess.pgn.StringExporter(headers=True, variations=True, comments=True) >>> pgn_string = game.accept(exporter)
Only columns characters are written per line. If columns is
None
, then the entire movetext will be on a single line. This does not affect header tags and comments.There will be no newline characters at the end of the string.
-
class
chess.pgn.
FileExporter
(*args, **kwds)[source]¶ Acts like a
StringExporter
, but games are written directly into a text file.There will always be a blank line after each game. Handling encodings is up to the caller.
>>> import chess.pgn >>> >>> game = chess.pgn.Game() >>> >>> new_pgn = open("/dev/null", "w", encoding="utf-8") >>> exporter = chess.pgn.FileExporter(new_pgn) >>> game.accept(exporter)
NAGs¶
Numeric anotation glyphs describe moves and positions using standardized codes
that are understood by many chess programs. During PGN parsing, annotations
like !
, ?
, !!
, etc., are also converted to NAGs.
-
chess.pgn.
NAG_GOOD_MOVE
= 1¶ A good move. Can also be indicated by
!
in PGN notation.
-
chess.pgn.
NAG_MISTAKE
= 2¶ A mistake. Can also be indicated by
?
in PGN notation.
-
chess.pgn.
NAG_BRILLIANT_MOVE
= 3¶ A brilliant move. Can also be indicated by
!!
in PGN notation.
-
chess.pgn.
NAG_BLUNDER
= 4¶ A blunder. Can also be indicated by
??
in PGN notation.
-
chess.pgn.
NAG_SPECULATIVE_MOVE
= 5¶ A speculative move. Can also be indicated by
!?
in PGN notation.
-
chess.pgn.
NAG_DUBIOUS_MOVE
= 6¶ A dubious move. Can also be indicated by
?!
in PGN notation.
Skimming¶
These functions allow for quickly skimming games without fully parsing them.
-
chess.pgn.
read_headers
(handle: TextIO) → Optional[chess.pgn.Headers][source]¶ Reads game headers from a PGN file opened in text mode.
Since actually parsing many games from a big file is relatively expensive, this is a better way to look only for specific games and then seek and parse them later.
This example scans for the first game with Kasparov as the white player.
>>> import chess.pgn >>> >>> pgn = open("data/pgn/kasparov-deep-blue-1997.pgn") >>> >>> kasparov_offsets = [] >>> >>> while True: ... offset = pgn.tell() ... ... headers = chess.pgn.read_headers(pgn) ... if headers is None: ... break ... ... if "Kasparov" in headers.get("White", "?"): ... kasparov_offsets.append(offset)
Then it can later be seeked and parsed.
>>> for offset in kasparov_offsets: ... pgn.seek(offset) ... chess.pgn.read_game(pgn) 0 <Game at ... ('Garry Kasparov' vs. 'Deep Blue (Computer)', 1997.??.??)> 1436 <Game at ... ('Garry Kasparov' vs. 'Deep Blue (Computer)', 1997.??.??)> 3067 <Game at ... ('Garry Kasparov' vs. 'Deep Blue (Computer)', 1997.??.??)>