Merge pull request niklasf#1 from niklasf/master

tanmay2004 · web-flow · commit a4a1da76f5aa · 2020-09-28T00:40:38.000+05:30
Update fork with latest edits
diff --git a/chess/__init__.py b/chess/__init__.py
@@ -455,12 +455,6 @@ class Move:
     promotion: Optional[PieceType] = None
     drop: Optional[PieceType] = None
 
-    def __init__(self, from_square: Square, to_square: Square, promotion: Optional[PieceType] = None, drop: Optional[PieceType] = None) -> None:
-        self.from_square = from_square
-        self.to_square = to_square
-        self.promotion = promotion
-        self.drop = drop
-
     def uci(self) -> str:
         """
         Gets a UCI string for the move.
@@ -568,7 +562,7 @@ def _reset_board(self) -> None:
         self.occupied = BB_RANK_1 | BB_RANK_2 | BB_RANK_7 | BB_RANK_8
 
     def reset_board(self) -> None:
-        """Resets piece positions to the starting position."""
+        """Resets pieces to the starting position."""
         self._reset_board()
 
     def _clear_board(self) -> None:
@@ -978,13 +972,13 @@ def set_piece_map(self, pieces: Mapping[Square, Piece]) -> None:
         """
         self._set_piece_map(pieces)
 
-    def _set_chess960_pos(self, sharnagl: int) -> None:
-        if not 0 <= sharnagl <= 959:
-            raise ValueError(f"chess960 position index not 0 <= {sharnagl!r} <= 959")
+    def _set_chess960_pos(self, scharnagl: int) -> None:
+        if not 0 <= scharnagl <= 959:
+            raise ValueError(f"chess960 position index not 0 <= {scharnagl!r} <= 959")
 
         # See http://www.russellcottrell.com/Chess/Chess960.htm for
         # a description of the algorithm.
-        n, bw = divmod(sharnagl, 4)
+        n, bw = divmod(scharnagl, 4)
         n, bb = divmod(n, 4)
         n, q = divmod(n, 6)
 
@@ -1039,16 +1033,16 @@ def _set_chess960_pos(self, sharnagl: int) -> None:
         self.occupied = BB_RANK_1 | BB_RANK_2 | BB_RANK_7 | BB_RANK_8
         self.promoted = BB_EMPTY
 
-    def set_chess960_pos(self, sharnagl: int) -> None:
+    def set_chess960_pos(self, scharnagl: int) -> None:
         """
         Sets up a Chess960 starting position given its index between 0 and 959.
         Also see :func:`~chess.BaseBoard.from_chess960_pos()`.
         """
-        self._set_chess960_pos(sharnagl)
+        self._set_chess960_pos(scharnagl)
 
     def chess960_pos(self) -> Optional[int]:
         """
-        Gets the Chess960 starting position index between 0 and 959
+        Gets the Chess960 starting position index between 0 and 959,
         or ``None``.
         """
         if self.occupied_co[WHITE] != BB_RANK_1 | BB_RANK_2:
@@ -1295,7 +1289,7 @@ def empty(cls: Type[BaseBoardT]) -> BaseBoardT:
         return cls(None)
 
     @classmethod
-    def from_chess960_pos(cls: Type[BaseBoardT], sharnagl: int) -> BaseBoardT:
+    def from_chess960_pos(cls: Type[BaseBoardT], scharnagl: int) -> BaseBoardT:
         """
         Creates a new board, initialized with a Chess960 starting position.
 
@@ -1305,7 +1299,7 @@ def from_chess960_pos(cls: Type[BaseBoardT], sharnagl: int) -> BaseBoardT:
         >>> board = chess.Board.from_chess960_pos(random.randint(0, 959))
         """
         board = cls.empty()
-        board.set_chess960_pos(sharnagl)
+        board.set_chess960_pos(scharnagl)
         return board
 
 
@@ -1436,6 +1430,11 @@ def reset(self) -> None:
         self.reset_board()
 
     def reset_board(self) -> None:
+        """
+        Resets only pieces to the starting position. Use
+        :func:`~chess.Board.reset()` to fully restore the starting position
+        (including turn, castling rights, etc.).
+        """
         super().reset_board()
         self.clear_stack()
 
@@ -2114,7 +2113,7 @@ def pop(self: BoardT) -> Move:
         """
         Restores the previous position and returns the last move from the stack.
 
-        :raises: :exc:`IndexError` if the stack is empty.
+        :raises: :exc:`IndexError` if the move stack is empty.
         """
         move = self.move_stack.pop()
         self._stack.pop().restore(self)
@@ -2130,7 +2129,7 @@ def peek(self) -> Move:
 
     def find_move(self, from_square: Square, to_square: Square, promotion: Optional[PieceType] = None) -> Move:
         """
-        Finds a matching legal move for an origin square, a target square and
+        Finds a matching legal move for an origin square, a target square, and
         an optional promotion piece type.
 
         For pawn moves to the backrank, the promotion piece type defaults to
@@ -2386,8 +2385,8 @@ def set_piece_map(self, pieces: Mapping[Square, Piece]) -> None:
         super().set_piece_map(pieces)
         self.clear_stack()
 
-    def set_chess960_pos(self, sharnagl: int) -> None:
-        super().set_chess960_pos(sharnagl)
+    def set_chess960_pos(self, scharnagl: int) -> None:
+        super().set_chess960_pos(scharnagl)
         self.chess960 = True
         self.turn = WHITE
         self.castling_rights = self.rooks
@@ -2399,7 +2398,7 @@ def set_chess960_pos(self, sharnagl: int) -> None:
 
     def chess960_pos(self, *, ignore_turn: bool = False, ignore_castling: bool = False, ignore_counters: bool = True) -> Optional[int]:
         """
-        Gets the Chess960 starting position index between 0 and 956
+        Gets the Chess960 starting position index between 0 and 956,
         or ``None`` if the current position is not a Chess960 starting
         position.
 
@@ -3536,9 +3535,9 @@ def from_epd(cls: Type[BoardT], epd: str, *, chess960: bool = False) -> Tuple[Bo
         return board, board.set_epd(epd)
 
     @classmethod
-    def from_chess960_pos(cls: Type[BoardT], sharnagl: int) -> BoardT:
+    def from_chess960_pos(cls: Type[BoardT], scharnagl: int) -> BoardT:
         board = cls.empty(chess960=True)
-        board.set_chess960_pos(sharnagl)
+        board.set_chess960_pos(scharnagl)
         return board
 
 
diff --git a/chess/variant.py b/chess/variant.py
@@ -772,8 +772,8 @@ def parse_san(self, san: str) -> chess.Move:
             return super().parse_san(san)
 
     def has_insufficient_material(self, color: chess.Color) -> bool:
-        # In practise no material can leave the game, but this is easy to
-        # implement anyway. Note that bishops can be captured and put onto
+        # In practice, no material can leave the game, but this is easy to
+        # implement, anyway. Note that bishops can be captured and put onto
         # a different color complex.
         return (
             chess.popcount(self.occupied) + sum(len(pocket) for pocket in self.pockets) <= 3 and
diff --git a/docs/variant.rst b/docs/variant.rst
@@ -7,16 +7,16 @@ python-chess supports several chess variants.
 >>>
 >>> board = chess.variant.GiveawayBoard()
 
->>> # General information about the variants
+>>> # General information about the variants.
 >>> type(board).uci_variant
 'giveaway'
 >>> type(board).xboard_variant
 'giveaway'
 >>> type(board).starting_fen
 'rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w - - 0 1'
 
-See :func:`chess.Board.is_variant_end()`, :func:`~chess.Board.is_variant_win()`
-:func:`~chess.Board.is_variant_draw()` :func:`~chess.Board.is_variant_loss()`
+See :func:`chess.Board.is_variant_end()`, :func:`~chess.Board.is_variant_win()`,
+:func:`~chess.Board.is_variant_draw()`, or :func:`~chess.Board.is_variant_loss()`
 for special variant end conditions and results.
 
 ================ ========================================= ============= ============
diff --git a/examples/bratko_kopec/bratko_kopec.py b/examples/bratko_kopec/bratko_kopec.py
@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
 """Run an EPD test suite with a UCI engine."""
 
diff --git a/examples/chess960_pos_list.py b/examples/chess960_pos_list.py
@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
 """List all Chess960 starting positions."""
 
@@ -10,11 +10,11 @@
 def main(bench_only: bool = False) -> None:
     board = chess.Board.empty(chess960=True)
 
-    for sharnagl in range(0, 960):
-        board.set_chess960_pos(sharnagl)
+    for scharnagl in range(0, 960):
+        board.set_chess960_pos(scharnagl)
 
         if not bench_only:
-            print(str(sharnagl).rjust(3), board.fen())
+            print(str(scharnagl).rjust(3), board.fen())
 
 
 if __name__ == "__main__":
diff --git a/examples/perft/perft.py b/examples/perft/perft.py
@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
 """
 Run perft test to check correctness and speed of the legal move generator.
diff --git a/examples/polyglot_tree.py b/examples/polyglot_tree.py
@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
 """Print a Polyglot opening book in tree form."""
 
diff --git a/examples/push_san.py b/examples/push_san.py
@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
 """Play the immortal game using push_san() from chess.Board()."""
 
diff --git a/examples/xray_attacks.py b/examples/xray_attacks.py
@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
 """Compute X-ray attacks through more valuable pieces."""
 
diff --git a/setup.py b/setup.py
@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 #
 # This file is part of the python-chess library.
diff --git a/test.py b/test.py
@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 #
 # This file is part of the python-chess library.
 # Copyright (C) 2012-2020 Niklas Fiekas <niklas.fiekas@backscattering.de>

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-#!/usr/bin/env python`
	`1`	`+#!/usr/bin/env python3`
`2`	`2`
`3`	`3`	`"""Run an EPD test suite with a UCI engine."""`
`4`	`4`