Changeset 44:a7e53eb3f54d

Timestamp:

12/19/10 23:24:15 (5 years ago)

Author:

Daniil Alexeyevsky <me.dendik@?>

Branch:

default

Children:

45:acaa43cb15ad, 47:14c3d41ce15d

Message:

snake.py: added some (ugly) docstrings, closes #7

File:

• snake.py (modified) (9 diffs)

snake.py

@@ -š +1 @@
+"""Guts of snakes."""
+
 import engine
 
 def preprocess(line):
+    """Remove comments and junk spaces from line of snake definition file."""
     if '//' in line:
         line = line[:line.index('//')]
@@ -8 +11 @@
 
 class Snake(object):
+    """Snakes.
+
+    Attributes:
+
+    - `cells` -- list of cells belonging to the snake The first of these cells
+      becomes head, the last one becomes tail, the rest ar body. If snake has
+      only one cell, it is tail.
+    - `color` -- color of snake
+    - `rules` -- a list of Rule objects
+    """
+
     def __init__ (self, cells, color):
         self.cells = cells
@@ -14 +28 @@
 
     def load (self, file):
+        """Load snake description from file.
+        
+        See program design docs for file syntax.
+        """
         magic, name = preprocess(file.readline()).split(' ', 1)
         assert magic == "snake", "This is not snake file"
@@ -24 +42 @@
 
     def fill (self):
+        """Mark every cell in `self.cells` as belonging to self."""
         for cell in self.cells:
             cell.snake = self
@@ -32 +51 @@
 
 class Rule(object):
+    """Rule defining possible behaviour of snake."""
 
     codes = {
@@ -48 +68 @@
 
     def load (self, file):
+        """Load rule definition from file. Ignore any leading empty lines."""
         y = 0
         for line in file:
@@ -62 +83 @@
 
     def parse_cell(self, x, y, char):
+        """Parse definition of cell in rule file.
+
+        Cell is defined by one character.
+        """
         assert char.lower() in self.codes, "Illegal symbol in rule: %s" % char
         cell = engine.Cell(x, y, None)
@@ -77 +102 @@
 
     def applies (self, field, x, y):
+        """True if the rule applies in the field at position (x,y)."""
         for px, fx in zip(range(7), range(x - 3, x + 4)):
             for py, fy in zip(range(7), range(y - 3, y + 4)):
@@ -88 +114 @@
 
     def rotate (self, rot):
+        """Rotate rule pattern `rot` times counterclockwise."""
         for i in range(((rot % 4) + 4) % 4):
             self.rotate_ccw()
 
     def rotate_ccw(self):
+        """Rotate rule pattern one time counterclockwise."""
         pattern = {}
         for x in range(7):