chess.svg module renders SVG Tiny images (mostly for IPython/Jupyter
Notebook integration). The piece images by
Colin M.L. Burnett are triple
licensed under the GFDL, BSD and GPL.
piece(piece: chess.Piece, size: Optional[int] = None) → str¶
Renders the given
chess.Pieceas an SVG image.
>>> import chess >>> import chess.svg >>> >>> chess.svg.piece(chess.Piece.from_symbol("R")) # doctest: +SKIP
board(board: Optional[chess.BaseBoard] = None, *, squares: Union[SupportsInt, Iterable[int], None] = None, flipped: bool = False, coordinates: bool = True, lastmove: Optional[chess.Move] = None, check: Optional[int] = None, arrows: Iterable[Union[chess.svg.Arrow, Tuple[int, int]]] = (), size: Optional[int] = None, style: Optional[str] = None) → str¶
Renders a board with pieces and/or selected squares as an SVG image.
- board – A
chess.BaseBoardfor a chessboard with pieces or
None(the default) for a chessboard without pieces.
- squares – A
chess.SquareSetwith selected squares.
- flipped – Pass
Trueto flip the board.
- coordinates – Pass
Falseto disable coordinates in the margin.
- lastmove – A
chess.Moveto be highlighted.
- check – A square to be marked as check.
- arrows – A list of
[chess.svg.Arrow(chess.E2, chess.E4)]or a list of tuples like
[(chess.E2, chess.E4)]. An arrow from a square pointing to the same square is drawn as a circle, like
- size – The size of the image in pixels (e.g.,
400for a 400 by 400 board) or
None(the default) for no size limit.
- style – A CSS stylesheet to include in the SVG image.
>>> import chess >>> import chess.svg >>> >>> board = chess.Board("8/8/8/8/4N3/8/8/8 w - - 0 1") >>> squares = board.attacks(chess.E4) >>> chess.svg.board(board=board, squares=squares) # doctest: +SKIP
- board – A