Refactor GitHub Actions workflows for testing and publishing; update Python version to 3.11 and improve package build process

Author: miskibin

.github/workflows/python-app.yml

@@ -10,27 +10,35 @@ permissions:
   contents: read
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Set up Python 3.10
-        uses: actions/setup-python@v3
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
-      - uses: actions/checkout@v3
+          python-version: "3.11"
       - name: Install dependencies
-        working-directory: .
         run: |
-          ls -la
-          python -m pip install virtualenv
-          python -m virtualenv .venv
-          source .venv/bin/activate
-          pip install pytest 
-          pip install -r requirements.txt
-          export PYTHONPATH+=$PYTHONPATH:$(pwd)
-          pip install -e .
-      - name: Test with pytest
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+      - name: Run tests
         run: |
-          source .venv/bin/activate
-          python -m pytest . -vv
+          python -m pytest test/ -v
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+      - name: Type check with mypy
+        run: |
+          python -m mypy draughts --ignore-missing-imports

.github/workflows/python-publish.yml

@@ -10,19 +10,42 @@ name: Upload Python Package
 on:
   push:
     tags:
-      - "*"
+      - "v*"
 
 jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install build dependencies
+        run: python -m pip install --upgrade pip build
+      - name: Build package
+        run: python -m build
+      - name: Store distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
   pypi-publish:
     name: Upload release to PyPI
+    needs: build
     runs-on: ubuntu-latest
     environment:
       name: pypi
       url: https://pypi.org/p/py-draughts
     permissions:
       id-token: write
     steps:
-      - name: Checkout
-        uses: actions/checkout@v3
+      - name: Download distribution packages
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
       - name: Publish package distributions to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1

draughts/boards/base.py

@@ -85,15 +85,16 @@ class BaseBoard(ABC):
 
     DIAGONAL_LONG_MOVES = ...
     """
-    Dictionary of pseudo-legal moves for king pieces. Generated only on module import.
-    This dictionary contains all possible moves for king piece (as if there were no other pieces on the board).
+    Dictionary of pseudo-legal moves for man pieces. Generated only on module import.
+    Despite the name, this contains SHORT moves (first 2 squares) sufficient for men.
     
     **Structure:**
     ``[(right-up moves), (left-up moves), (right-down moves), (left-down moves)]``
     """
     DIAGONAL_SHORT_MOVES = ...
     """ 
-    Same as ``DIAGONAL_LONG_MOVES`` but contains only first 2 squares of the move.
+    Dictionary of pseudo-legal moves for king pieces. Generated only on module import.
+    Despite the name, this contains LONG moves (all squares on diagonal) for kings.
     (one for move and one for capture)
     """
 
@@ -104,6 +105,9 @@ def __init_subclass__(cls, **kwargs):
         for var_name, var_value in child_class_vars.items():
             if var_name in parent_class_vars and not var_name.startswith("_"):
                 setattr(parent_class, var_name, var_value)
+        # Note: Names are intentionally swapped - DIAGONAL_SHORT_MOVES holds long moves (all squares)
+        # because kings need to traverse entire diagonals, while DIAGONAL_LONG_MOVES holds short moves
+        # (first 2 squares) which is sufficient for men who only move/capture one square at a time
         cls.DIAGONAL_SHORT_MOVES = get_diagonal_moves(len(cls.STARTING_POSITION))
         cls.DIAGONAL_LONG_MOVES = get_short_diagonal_moves(len(cls.STARTING_POSITION))
 
@@ -314,29 +318,29 @@ def from_fen(cls, fen: str) -> BaseBoard:
         except AttributeError as e:
             raise AttributeError(f"Invalid FEN: {fen} \n {e}")
         logger.debug(f"turn: {turn}, white: {white}, black: {black}")
-        cls.STARTING_POSITION = np.zeros(cls.STARTING_POSITION.shape, dtype=np.int8)
+        position = np.zeros(cls.STARTING_POSITION.shape, dtype=np.int8)
         if len(turn) != 1 or (len(white) == 0 and len(black) == 0):
             raise ValueError(f"Invalid FEN: {fen}")
         try:
-            cls.__populate_from_list(white.split(","), Color.WHITE)
-            cls.__populate_from_list(black.split(","), Color.BLACK)
+            cls.__populate_from_list(white.split(","), Color.WHITE, position)
+            cls.__populate_from_list(black.split(","), Color.BLACK, position)
         except ValueError as e:
             logger.error(f"Invalid FEN: {fen} \n {e}")
         turn_color = Color.WHITE if turn == "W" else Color.BLACK
-        return cls(cls.STARTING_POSITION, turn_color)
+        return cls(position, turn_color)
 
     @classmethod
-    def __populate_from_list(cls, fen_list: list[str], color: Color) -> None:
-        board_range = range(1, cls.STARTING_POSITION.shape[0] + 1)
+    def __populate_from_list(cls, fen_list: list[str], color: Color, position: np.ndarray) -> None:
+        board_range = range(1, position.shape[0] + 1)
         for sq in fen_list:
             if sq.isdigit() and int(sq) in board_range:
-                cls.STARTING_POSITION[int(sq) - 1] = color.value
+                position[int(sq) - 1] = color.value
             elif sq.startswith("K") and sq[1:].isdigit() and int(sq[1:]) in board_range:
-                cls.STARTING_POSITION[int(sq[1:]) - 1] = color.value * Figure.KING.value
+                position[int(sq[1:]) - 1] = color.value * Figure.KING.value
             else:
                 raise ValueError(
                     f"invalid square value: {sq} for board with length\
-                        {cls.STARTING_POSITION.shape[0]}"
+                        {position.shape[0]}"
                 )
 
     @property

draughts/move.py

@@ -27,13 +27,13 @@ class Move:
     def __init__(
         self,
         visited_squares: list[int],
-        captured_list: list[int] = [],
-        captured_entities: list[int] = [],
+        captured_list: list[int] | None = None,
+        captured_entities: list[int] | None = None,
         is_promotion: bool = False,
     ) -> None:
         self.square_list = visited_squares
-        self.captured_list = captured_list
-        self.captured_entities = captured_entities
+        self.captured_list = captured_list if captured_list is not None else []
+        self.captured_entities = captured_entities if captured_entities is not None else []
         self.is_promotion = is_promotion
         self.halfmove_clock = 0
 

draughts/py.typed

@@ -0,0 +1,68 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "py-draughts"
+version = "1.3.1"
+description = "A draughts library with advanced (customizable) WEB UI move generation and validation, PDN parsing and writing. Supports multiple variants of game."
+readme = "readme.md"
+license = {file = "LICENSE"}
+authors = [
+    { name = "Michał Skibiński", email = "mskibinski109@gmail.com" }
+]
+keywords = ["draughts", "checkers", "AI", "mini-max", "game", "board"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Games/Entertainment :: Board Games",
+    "Topic :: Games/Entertainment :: Turn Based Strategy",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+requires-python = ">=3.9"
+dependencies = [
+    "tqdm",
+    "numpy",
+    "easy_logs",
+    "fastapi",
+    "uvicorn",
+    "jinja2",
+]
+
+[project.urls]
+Homepage = "https://github.com/michalskibinski109/py-draughts"
+Documentation = "https://michalskibinski109.github.io/py-draughts/index.html"
+Repository = "https://github.com/michalskibinski109/py-draughts"
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "mypy",
+    "sphinx",
+]
+
+[tool.setuptools.packages.find]
+where = ["."]
+
+[tool.setuptools.package-data]
+draughts = [
+    "server/static/js/*",
+    "server/static/css/*",
+    "server/templates/*",
+    "py.typed",
+]
+
+[tool.mypy]
+python_version = "3.9"
+warn_return_any = true
+warn_unused_configs = true