refactor: move api to engine package and create snake interface

api/snake.py

@@ -0,0 +1,33 @@
+from abc import abstractmethod
+from api.direction import Direction
+
+
+class SnakeInterface:
+    """
+    Defines the interface for a Snake entity in the game.
+
+    This interface enforces the implementation of movement and vision
+    methods for a Snake.
+    """
+
+    @abstractmethod
+    def move(self, direction: Direction) -> None:
+        """
+        Moves the snake in the specified direction.
+
+        Args:
+            direction (Direction): The direction in which the snake should
+            move.
+        """
+        pass
+
+    @abstractmethod
+    def see(self) -> list[list[str]]:
+        """
+        Provides the snake's current field of view as a 2D grid.
+
+        Returns:
+            list[list[str]]: A 2D list representing what the snake can see
+            around it.
+        """
+        pass

api/entity/apple.py → engine/entity/apple.py

@@ -1,6 +1,6 @@
 from enum import Enum
-from api.entity.entity import Entity
-from api.world import World
+from engine.entity.entity import Entity
+from engine.world import World
 
 
 class AppleType(Enum):

api/entity/snake.py → engine/entity/snake.py

@@ -1,13 +1,14 @@
 from api.direction import Direction
-from api.exception.gameover import GameOver
-from api.entity.apple import Apple
-from api.world import World
-from api.entity.entity import Entity
+from api.snake import SnakeInterface
+from engine.exception.gameover import GameOver
+from engine.entity.apple import Apple
+from engine.world import World
+from engine.entity.entity import Entity
 import random
 from collections import deque
 
 
-class Snake(Entity):
+class Snake(Entity, SnakeInterface):
     """
     Represents a snake in the game, which moves, grows, and interacts with the
     world.
@@ -138,6 +139,9 @@ def size(self) -> int:
         """
         return len(self.__body) + 1
 
+    def see(self):
+        pass
+
     def get_body(self) -> deque[tuple[int, int]]:
         """
         Returns the list of body segments of the snake.

api/map_location.py → engine/map_location.py

@@ -1,4 +1,4 @@
-from api.entity.entity import Entity
+from engine.entity.entity import Entity
 
 
 class MapLocation:

api/world.py → engine/world.py

@@ -1,5 +1,5 @@
-from api.map_location import MapLocation
-from api.entity.entity import Entity
+from engine.map_location import MapLocation
+from engine.entity.entity import Entity
 import sys
 import copy
 import random

main.py

@@ -1,8 +1,12 @@
-from api.world import World
+from engine.world import World
 from api.direction import Direction
-from api.exception.gameover import GameOver
-from api.entity.snake import Snake
-from api.entity.apple import Apple, AppleType
+from engine.exception.gameover import GameOver
+from engine.entity.snake import Snake
+from engine.entity.apple import Apple, AppleType
+import sys
+import os
+
+sys.path.append(os.path.abspath(os.path.dirname(__file__)))
 
 world = World()
 snake = Snake(world, 5, 5, Direction.SOUTH)

tests/entity/test_apple.py

@@ -1,5 +1,5 @@
 import unittest
-from api.entity.apple import Apple, AppleType
+from engine.entity.apple import Apple, AppleType
 
 
 class TestApple(unittest.TestCase):

tests/entity/test_snake.py

@@ -1,7 +1,7 @@
 import unittest
-from api.entity.snake import Snake
+from engine.entity.snake import Snake
 from api.direction import Direction
-from api.world import World
+from engine.world import World
 
 
 class TestSnake(unittest.TestCase):