Add files via upload

Author: AttackingOrDefending

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 AttackingOrDefending
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,28 @@
+# 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)
+
+python-tictactoe is a tic-tac-toe library that supports different sizes and dimensions and how many marks in a row to win.
+
+## Features
+
+* Different board sizes
+```python
+from tictactoe import Board
+
+board = Board(dimensions=(4, 5))
+```
+* More than 2 dimensions
+```python
+from tictactoe import Board
+
+board = Board(dimensions=(6, 2, 5, 8))
+```
+* More than 3 in a row to win
+```python
+from tictactoe import Board
+
+board = Board(dimensions=(10, 10, 10), x_in_a_row=8)
+```
+
+## License
+python-tictactoe is licensed under the MIT License. Check out LICENSE for the full text.

setup.py

@@ -0,0 +1,25 @@
+import setuptools
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name="python-tictactoe",
+    version="0.0.1",
+    author="AttackingOrDefending",
+    description="A tictactoe library for Python with varying board sizes and move generation",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/AttackingOrDefending/python-tictactoe",
+    project_urls={
+        "Bug Tracker": "https://github.com/AttackingOrDefending/python-tictactoe/issues",
+    },
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    packages=["tictactoe"],
+    python_requires=">=3.6",
+    install_requires=["numpy==1.22.1"],
+)

test.py

@@ -0,0 +1,64 @@
+from tictactoe import Board
+
+
+def draw_board():
+    board = Board()
+    board.push((0, 0))
+    board.push((0, 1))
+    board.push((0, 2))
+    board.push((1, 1))
+    board.push((1, 0))
+    board.push((2, 0))
+    board.push((1, 2))
+    board.push((2, 2))
+    board.push((2, 1))
+    return board
+
+
+def x_win_board():
+    board = Board()
+    board.push((0, 0))
+    board.push((0, 1))
+    board.push((0, 2))
+    board.push((1, 1))
+    board.push((1, 0))
+    board.push((1, 2))
+    board.push((2, 0))
+    return board
+
+
+def o_win_board():
+    board = Board()
+    board.push((0, 0))
+    board.push((0, 1))
+    board.push((0, 2))
+    board.push((1, 1))
+    board.push((1, 0))
+    board.push((2, 0))
+    board.push((1, 2))
+    board.push((2, 1))
+    return board
+
+
+def unfinished_board():
+    board = Board()
+    board.push((0, 0))
+    board.push((0, 1))
+    board.push((0, 2))
+    board.push((1, 1))
+    board.push((1, 0))
+    board.push((2, 0))
+    board.push((1, 2))
+    board.push((2, 2))
+    return board
+
+
+def test_result():
+    assert x_win_board().result() == 1
+    assert o_win_board().result() == 2
+    assert draw_board().result() == 0
+    assert unfinished_board().result() is None
+
+
+if __name__ == "__main__":
+    test_result()

tictactoe/__init__.py

@@ -0,0 +1,103 @@
+import itertools
+import numpy
+
+X = 1
+O = 2
+
+
+class Board:
+    def __init__(self, dimensions=(3, 3), x_in_a_row=3):
+        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.turn = X
+
+    def create_board(self):
+        return numpy.zeros(self.dimensions)
+
+    def copy(self):
+        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):
+        position = tuple(position)
+        return self.board[position]
+
+    def set_mark(self, coordinates, player):
+        self.board[coordinates] = player
+        if player == X:
+            self.x.append(Move(coordinates))
+        else:
+            self.o.append(Move(coordinates))
+
+    def is_empty(self, position):
+        return self.get_mark_at_position(position) == 0
+
+    def push(self, coordinates):
+        coordinates = tuple(coordinates)
+        if not self.is_empty(coordinates):
+            raise Exception("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):
+        directions = list(itertools.product([1, 0, -1], repeat=len(self.dimensions)))
+        correct_directions = []
+        for direction in directions:
+            for item in direction:
+                if item > 0:
+                    correct_directions.append(direction)
+                    break
+                elif item < 0:
+                    break
+        return correct_directions
+
+    def possible_moves(self):
+        return numpy.argwhere(self.board == 0)
+
+    def out_of_bounds(self, pos):
+        return (pos < 0).any() or (pos >= self.dimensions).any()
+
+    def in_bounds(self, pos):
+        return not self.out_of_bounds(pos)
+
+    def has_won(self, player):
+        positions = numpy.argwhere(self.board == player)
+        for position in positions:
+            for direction in self._directions:
+                for in_a_row in range(1, self.x_in_a_row):
+                    pos = position + numpy.multiply(direction, in_a_row)
+                    if self.out_of_bounds(pos) or self.board[tuple(pos)] != player:
+                        break
+                else:
+                    return True
+        return False
+
+    def result(self):
+        if self.has_won(X):
+            return X
+        elif self.has_won(O):
+            return O
+        elif self.board.all():
+            return 0
+
+
+class Move:
+    def __init__(self, coordinate_move=None, str_move=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:
+            self.coordinate_move = tuple(map(int, self.str_move.split("-")))