Add type hints and more tests (#4)

Author: AttackingOrDefending

.github/workflows/code-cov.yml

@@ -0,0 +1,26 @@
+name: CodeCov
+
+on: [push, pull_request]
+
+jobs:
+  run:
+    runs-on: windows-latest
+    env:
+      OS: windows-latest
+      PYTHON: '3.10'
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: ‘2’
+
+    - name: Setup Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+    - name: Generate Report
+      run: |
+        pip install pytest pytest-cov numpy
+        pytest test.py --cov=tictactoe --cov-report=xml
+        coverage report --show-missing
+    - name: Upload Coverage to Codecov
+      uses: codecov/codecov-action@v2

README.md

@@ -1,5 +1,5 @@
 # python-tictactoe
-[![PyPI version](https://badge.fury.io/py/python-tictactoe.svg)](https://badge.fury.io/py/python-tictactoe) [![Tests](https://github.com/AttackingOrDefending/python-tictactoe/actions/workflows/tests.yml/badge.svg)](https://github.com/AttackingOrDefending/python-tictactoe/actions/workflows/tests.yml) [![Build](https://github.com/AttackingOrDefending/python-tictactoe/actions/workflows/build.yml/badge.svg)](https://github.com/AttackingOrDefending/python-tictactoe/actions/workflows/build.yml)
+[![PyPI version](https://badge.fury.io/py/python-tictactoe.svg)](https://badge.fury.io/py/python-tictactoe) [![Tests](https://github.com/AttackingOrDefending/python-tictactoe/actions/workflows/tests.yml/badge.svg)](https://github.com/AttackingOrDefending/python-tictactoe/actions/workflows/tests.yml) [![Build](https://github.com/AttackingOrDefending/python-tictactoe/actions/workflows/build.yml/badge.svg)](https://github.com/AttackingOrDefending/python-tictactoe/actions/workflows/build.yml) [![codecov](https://codecov.io/gh/AttackingOrDefending/python-tictactoe/branch/main/graph/badge.svg?token=7N5LHRA3OC)](https://codecov.io/gh/AttackingOrDefending/python-tictactoe)
 
 A tic-tac-toe library that supports different sizes and dimensions and how many marks in a row to win.
 
@@ -12,6 +12,8 @@ Download and install the latest release:
 
 ## Features
 
+* Includes mypy typings.
+
 * Different board sizes
 ```python
 from tictactoe import Board

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = python-tictactoe
-version = 0.0.2
+version = 0.0.3
 author = AttackingOrDefending
 description = A tic-tac-toe library that supports different sizes and dimensions and how many marks in a row to win
 long_description = file: README.md

test.py

@@ -1,4 +1,5 @@
-from tictactoe import Board
+from tictactoe import Board, Move
+import numpy
 
 
 def draw_board():
@@ -60,5 +61,34 @@ def test_result():
     assert unfinished_board().result() is None
 
 
+def test_copy():
+    board = unfinished_board()
+    assert board.possible_moves().tolist() == board.copy().possible_moves().tolist()
+
+
+def test_inbound_outofbounds():
+    board = unfinished_board()
+    assert board.in_bounds(numpy.array([2, 2]))
+    assert board.out_of_bounds(numpy.array([3, 2]))
+
+
+def test_move():
+    assert Move((2, 2)).str_move == '2-2'
+    assert Move(str_move='1-2').coordinate_move == (1, 2)
+
+
+def test_illegal_move():
+    board = unfinished_board()
+    try:
+        board.push((0, 0))
+        assert False
+    except ValueError:
+        assert True
+
+
 if __name__ == "__main__":
     test_result()
+    test_copy()
+    test_inbound_outofbounds()
+    test_move()
+    test_illegal_move()

tictactoe/__init__.py

@@ -1,36 +1,38 @@
+from __future__ import annotations
 import itertools
 import numpy
+from typing import List, Tuple, Iterable, Optional
 
 X = 1
 O = 2
 
 
 class Board:
-    def __init__(self, dimensions=(3, 3), x_in_a_row=3):
+    def __init__(self, dimensions: Tuple[int, ...] = (3, 3), x_in_a_row: int = 3) -> None:
         self.dimensions = dimensions
         self.x_in_a_row = x_in_a_row
         self.board = self.create_board()
         self._directions = self.find_directions()
         self.move_count = 0
-        self.moves = []
-        self.x = []
-        self.o = []
+        self.moves: List[Move] = []
+        self.x: List[Move] = []
+        self.o: List[Move] = []
         self.turn = X
 
-    def create_board(self):
+    def create_board(self) -> numpy.ndarray:
         return numpy.zeros(self.dimensions)
 
-    def copy(self):
+    def copy(self) -> Board:
         board = Board(self.dimensions, self.x_in_a_row)
         board.turn = self.turn
         board.board = self.board.copy()
         return board
 
-    def get_mark_at_position(self, position):
+    def get_mark_at_position(self, position: Iterable[int]) -> int:
         position = tuple(position)
         return self.board[position]
 
-    def set_mark(self, coordinates, player):
+    def set_mark(self, coordinates: Tuple[int, ...], player: int) -> None:
         self.board[coordinates] = player
         if player == X:
             self.x.append(Move(coordinates))
@@ -40,17 +42,17 @@ def set_mark(self, coordinates, player):
     def is_empty(self, position):
         return self.get_mark_at_position(position) == 0
 
-    def push(self, coordinates):
+    def push(self, coordinates: Iterable[int]) -> None:
         coordinates = tuple(coordinates)
         if not self.is_empty(coordinates):
-            raise Exception("Position is not empty.")
+            raise ValueError("Position is not empty.")
         move = Move(coordinates)
         self.set_mark(coordinates, self.turn)
         self.turn = X if self.turn == O else O
         self.moves.append(move)
         self.move_count += 1
 
-    def find_directions(self):
+    def find_directions(self) -> List[Tuple[int, ...]]:
         directions = list(itertools.product([1, 0, -1], repeat=len(self.dimensions)))
         correct_directions = []
         for direction in directions:
@@ -62,16 +64,16 @@ def find_directions(self):
                     break
         return correct_directions
 
-    def possible_moves(self):
+    def possible_moves(self) -> numpy.ndarray:
         return numpy.argwhere(self.board == 0)
 
-    def out_of_bounds(self, pos):
+    def out_of_bounds(self, pos: numpy.ndarray) -> numpy.bool_:
         return (pos < 0).any() or (pos >= self.dimensions).any()
 
-    def in_bounds(self, pos):
+    def in_bounds(self, pos: numpy.ndarray) -> bool:
         return not self.out_of_bounds(pos)
 
-    def has_won(self, player):
+    def has_won(self, player: int) -> bool:
         positions = numpy.argwhere(self.board == player)
         for position in positions:
             for direction in self._directions:
@@ -83,21 +85,22 @@ def has_won(self, player):
                     return True
         return False
 
-    def result(self):
+    def result(self) -> Optional[int]:
         if self.has_won(X):
             return X
         elif self.has_won(O):
             return O
         elif self.board.all():
             return 0
+        return None
 
 
 class Move:
-    def __init__(self, coordinate_move=None, str_move=None):
+    def __init__(self, coordinate_move: Optional[Tuple[int, ...]] = None, str_move: Optional[str] = None) -> None:
         assert coordinate_move or str_move
         self.coordinate_move = coordinate_move
         self.str_move = str_move
         if self.coordinate_move:
             self.str_move = "-".join(map(str, tuple(self.coordinate_move)))
-        else:
+        elif self.str_move:
             self.coordinate_move = tuple(map(int, self.str_move.split("-")))