bit comments

Author: ap-atul

astar.py

@@ -4,6 +4,11 @@
 
 
 class AStar:
+    """
+     A star algorithm implementation
+     f(n) = g(n) + h(n)
+     """
+
     def __init__(self):
         self.paths = [
             KEY_RIGHT,
@@ -21,9 +26,11 @@ def __init__(self):
         self.moves = 0
 
     def collides(self, headPosition, snake):
+        """ Check for body collision on the next step """
         return any([body.position == headPosition for body in snake.body[: -1]])
 
     def getDistances(self, goal, current, snake):
+        """ Finding distance for each path """
         distances = PriorityQueue()
         self.moves += 1
 
@@ -58,6 +65,7 @@ def getDistances(self, goal, current, snake):
         return distances
 
     def getKey(self, food, snake):
+        """ Returns the next step """
         if snake.head.x == food.x and snake.head.y:
             self.moves = 0
             return snake.direction

components.py

@@ -5,6 +5,7 @@
 
 
 class Body(object):
+    """ Each body has a x & y """
     def __init__(self, x, y, char=BODY_CHAR):
         self.x = x
         self.y = y
@@ -16,6 +17,7 @@ def position(self):
 
 
 class Food(object):
+    """ Food with random location """
     def __init__(self, window, snake, char=FOOD_CHAR):
         self.x = randint(10, MAX_X - 10)
         self.y = randint(10, MAX_Y - 10)
@@ -38,6 +40,7 @@ def collides(self):
 
 
 class Snake(object):
+    """ Snake with multiple body """
     def __init__(self, x, y, window):
         self.window = window
         self.body = list()

main.py

@@ -6,6 +6,7 @@
 
 
 class StdOutWrapper:
+    """ Helper to print on terminal """
     text = ""
 
     def write(self, txt):
@@ -32,7 +33,7 @@ def startGame():
     window.border(0)
 
     snake = Snake(SNAKE_X, SNAKE_Y, window)
-    food = Food(window)
+    food = Food(window, snake)
     astar = AStar()
 
     while True: