Add option to see the board visually

Author: AttackingOrDefending

README.md

@@ -36,6 +36,26 @@ from tictactoe import Board
 
 board = Board(dimensions=(10, 10, 10), x_in_a_row=8)
 ```
+* See the board
+```python
+from tictactoe import Board
+
+board = Board(dimensions=(2, 2, 2), x_in_a_row=2)
+board.push((0, 0, 0))
+board.push((0, 1, 0))
+print(board)
+
+"""
+ X |   
+-------
+ O |   
+-------
+-------
+   |   
+-------
+   |   
+"""
+```
 * Generate endgame tablebases
 ```python
 from tictactoe.egtb import Generator

test_tictactoe/test_init.py

@@ -101,9 +101,31 @@ def test_x_and_o_won():
         assert True
 
 
+def test_repr():
+    board = Board((2, 2, 2), 2)
+    board.push((0, 0, 0))
+    board.push((0, 1, 0))
+    board.push((0, 0, 1))
+    board.push((1, 1, 0))
+    board.push((1, 0, 1))
+    board.push((1, 0, 0))
+    board.push((1, 1, 1))
+
+    correct_repr = """ X | O 
+-------
+ O | O 
+-------
+-------
+ X | X 
+-------
+   | X """
+    assert correct_repr == str(board)
+
+
 if __name__ == "__main__":
     test_result()
     test_copy()
     test_inbound_outofbounds()
     test_move()
     test_illegal_move()
+    test_repr()

tictactoe/__init__.py

@@ -6,7 +6,7 @@
 
 __author__ = "AttackingOrDefending"
 __copyright__ = "2022, " + __author__
-__version__ = "0.0.5"
+__version__ = "0.0.6"
 
 
 _all_numpy_int_types = Union[np.int8, np.int16, np.int32, np.int64]
@@ -165,6 +165,26 @@ def result(self) -> Optional[int]:
             return 0
         return None
 
+    def _get_dimension_repr(self, board_partition):
+        if len(board_partition.shape) > 1:
+            board_repr = ""
+            divider = ((board_partition.shape[0] * 4 - 1) * "-" + "\n") * (len(board_partition.shape) - 1)
+            for board_partition_index in range(board_partition.shape[-1]):
+                board_repr += self._get_dimension_repr(board_partition[..., board_partition_index]) + "\n"
+                board_repr += divider
+            board_repr = board_repr[:-(len(divider) + 1)]
+            return board_repr
+        else:
+            row = ""
+            for item in board_partition:
+                mark = "O" if item == O else ("X" if item == X else " ")
+                row += f" {mark} |"
+            row = row[:-1]
+            return row
+
+    def __repr__(self):
+        return self._get_dimension_repr(self.board)
+
 
 class Move:
     def __init__(self, coordinate_move: Optional[Iterable[int]] = None, str_move: Optional[str] = None) -> None: