Skip to content

core.rst

Latest commit

 

History

History
286 lines (198 loc) · 6.45 KB

core.rst

File metadata and controls

286 lines (198 loc) · 6.45 KB

Core

Colors

Constants for the side to move or the color of a piece.

.. py:data:: chess.WHITE
    :type: chess.Color
    :value: True


.. py:data:: chess.BLACK
    :type: chess.Color
    :value: False

You can get the opposite color using not color.

Piece types

.. py:data:: chess.PAWN
    :type: chess.PieceType
    :value: 1

.. py:data:: chess.KNIGHT
    :type: chess.PieceType
    :value: 2

.. py:data:: chess.BISHOP
    :type: chess.PieceType
    :value: 3

.. py:data:: chess.ROOK
    :type: chess.PieceType
    :value: 4

.. py:data:: chess.QUEEN
    :type: chess.PieceType
    :value: 5

.. py:data:: chess.KING
    :type: chess.PieceType
    :value: 6


.. autofunction:: chess.piece_symbol


.. autofunction:: chess.piece_name

Squares

.. py:data:: chess.A1
    :type: chess.Square
    :value: 0

.. py:data:: chess.B1
    :type: chess.Square
    :value: 1

and so on to

.. py:data:: chess.G8
    :type: chess.Square
    :value: 62

.. py:data:: chess.H8
    :type: chess.Square
    :value: 63


.. py:data:: chess.SQUARES
    :value: [chess.A1, chess.B1, ..., chess.G8, chess.H8]


.. py:data:: chess.SQUARE_NAMES
    :value: ['a1', 'b1', ..., 'g8', 'h8']


.. py:data:: chess.FILE_NAMES
    :value: ['a', 'b', ..., 'g', 'h']


.. py:data:: chess.RANK_NAMES
    :value: ['1', '2', ..., '7', '8']


.. autofunction:: chess.square


.. autofunction:: chess.square_file


.. autofunction:: chess.square_rank


.. autofunction:: chess.square_name


.. autofunction:: chess.square_distance


.. autofunction:: chess.square_mirror

Pieces

.. autoclass:: chess.Piece
    :members:

    .. py:attribute:: piece_type
        :type: chess.PieceType

        The piece type.

    .. py:attribute:: color
        :type: chess.Color

        The piece color.

Moves

.. autoclass:: chess.Move
    :members:

    .. py:attribute:: from_square
        :type: chess.Square

        The source square.

    .. py:attribute:: to_square
        :type: chess.Square

        The target square.

    .. py:attribute:: promotion
        :type: Optional[chess.PieceType]

        The promotion piece type or ``None``.

    .. py:attribute:: drop
        :type: Optional[chess.PieceType]

        The drop piece type or ``None``.

Board

.. autodata:: chess.STARTING_FEN


.. autodata:: chess.STARTING_BOARD_FEN


.. autoclass:: chess.Board
    :members:

    .. py:attribute:: turn
        :type: chess.Color

        The side to move (``chess.WHITE`` or ``chess.BLACK``).

    .. py:attribute:: castling_rights
        :type: chess.Bitboard

        Bitmask of the rooks with castling rights.

        To test for specific squares:

        >>> import chess
        >>>
        >>> board = chess.Board()
        >>> bool(board.castling_rights & chess.BB_H1)  # White can castle with the h1 rook
        True

        To add a specific square:

        >>> board.castling_rights |= chess.BB_A1

        Use :func:`~chess.Board.set_castling_fen()` to set multiple castling
        rights. Also see :func:`~chess.Board.has_castling_rights()`,
        :func:`~chess.Board.has_kingside_castling_rights()`,
        :func:`~chess.Board.has_queenside_castling_rights()`,
        :func:`~chess.Board.has_chess960_castling_rights()`,
        :func:`~chess.Board.clean_castling_rights()`.

    .. py:attribute:: ep_square
        :type: Optional[chess.Square]

        The potential en passant square on the third or sixth rank or ``None``.

        Use :func:`~chess.Board.has_legal_en_passant()` to test if en passant
        capturing would actually be possible on the next move.

    .. py:attribute:: fullmove_number
        :type: int

        Counts move pairs. Starts at `1` and is incremented after every move
        of the black side.

    .. py:attribute:: halfmove_clock
        :type: int

        The number of half-moves since the last capture or pawn move.

    .. py:attribute:: promoted
        :type: chess.Bitboard

        A bitmask of pieces that have been promoted.

    .. py:attribute:: chess960
        :type: bool

        Whether the board is in Chess960 mode. In Chess960 castling moves are
        represented as king moves to the corresponding rook square.

    .. py:attribute:: legal_moves
        :value: chess.LegalMoveGenerator(self)

        A dynamic list of legal moves.

        >>> import chess
        >>>
        >>> board = chess.Board()
        >>> board.legal_moves.count()
        20
        >>> bool(board.legal_moves)
        True
        >>> move = chess.Move.from_uci("g1f3")
        >>> move in board.legal_moves
        True

        Wraps :func:`~chess.Board.generate_legal_moves()` and
        :func:`~chess.Board.is_legal()`.

    .. py:attribute:: pseudo_legal_moves
        :value: chess.PseudoLegalMoveGenerator(self)

        A dynamic list of pseudo-legal moves, much like the legal move list.

        Pseudo-legal moves might leave or put the king in check, but are
        otherwise valid. Null moves are not pseudo-legal. Castling moves are
        only included if they are completely legal.

        Wraps :func:`~chess.Board.generate_pseudo_legal_moves()` and
        :func:`~chess.Board.is_pseudo_legal()`.

    .. py:attribute:: move_stack
        :type: List[chess.Move]

        The move stack. Use :func:`Board.push() <chess.Board.push()>`,
        :func:`Board.pop() <chess.Board.pop()>`,
        :func:`Board.peek() <chess.Board.peek()>` and
        :func:`Board.clear_stack() <chess.Board.clear_stack()>` for
        manipulation.


.. autoclass:: chess.BaseBoard
    :members:

Square sets

.. autoclass:: chess.SquareSet
    :members:

Common integer masks are:

.. py:data:: chess.BB_EMPTY
    :type: chess.Bitboard
    :value: 0

.. py:data:: chess.BB_ALL
    :type: chess.Bitboard
    :value: 0xFFFF_FFFF_FFFF_FFFF

Single squares:

.. py:data:: chess.BB_SQUARES
    :value: [chess.BB_A1, chess.BB_B1, ..., chess.BB_G8, chess.BB_H8]

Ranks and files:

.. py:data:: chess.BB_RANKS
    :value: [chess.BB_RANK_1, ..., chess.BB_RANK_8]



.. py:data:: chess.BB_FILES
    :value: [chess.BB_FILE_A, ..., chess.BB_FILE_H]

Other masks:

.. py:data:: chess.BB_LIGHT_SQUARES
    :type: chess.Bitboard
    :value: 0x55AA_55AA_55AA_55AA

.. py:data:: chess.BB_DARK_SQUARES
    :type: chess.Bitboard
    :value: 0xAA55_AA55_AA55_AA55


.. py:data:: chess.BB_BACKRANKS
    :value: chess.BB_RANK_1 | chess.BB_RANK_8


.. py:data:: chess.BB_CORNERS
    :value: chess.BB_A1 | chess.BB_H1 | chess.BB_A8 | chess.BB_H8

.. py:data:: chess.BB_CENTER
    :value: chess.BB_D4 | chess.BB_E4 | chess.BB_D5 | chess.BB_E5