Linting and docstringing board/board.py

1 files changed, 37 insertions, 37 deletions

diff --git a/board/board.py b/board/board.py
index dbec117..069b568 100644
--- a/board/board.py
+++ b/board/board.py
@@ -1,14 +1,18 @@
+""" board/board.py - Pelilaudan käsittelyyn tarkoitetut jutut """
 from random import randrange
 from sys import stderr
 from copy import deepcopy
 
 class Board():
+    """	Board - Luokka joka pitää huolen pelilaudasta ja siihen kohdistuvista
+                siirroista.
+    """
     def __init__(self, size = 10, bombs = 0):
         # Lauta pitää olla vähintään 2x2, jotta on jotain pelattavaa
         size = 2 if size < 2 else size
         size = 50 if size > 50 else size
         self.size = size
-            
+
         # Pommeja pitää olla vähintään yksi, kuten tyhjiäkin
         bombs = size*size*size//100 if bombs < 1 else bombs
         bombs = size*size-1 if bombs>=size*size else bombs
@@ -20,14 +24,16 @@ class Board():
         self.initialize_tiles( size )
         self.randomize_bombs( bombs )
         self.calculate_neighbours()
-        
+
 
     def initialize_tiles(self, size):
+        """ alustaa pelilaudan matriisit """
         self.tiles = [[0 for _ in range(size)] for _ in range(size)]
         self.masked = [[10 for _ in range(size)] for _ in range(size)]
-        
+
 
     def randomize_bombs(self, bomb_count):
+        """ arpoo pelilaudalle pommit """
         for _ in range(bomb_count):
             while True:
                 x, y = randrange(0,self.size), randrange(0,self.size)
@@ -35,9 +41,10 @@ class Board():
                     continue
                 self.tiles[x][y]=9
                 break
-                
+
 
     def calculate_neighbours(self):
+        """ laskee naapurissa olevien pommien määrät valmiiksi laudalle """
         for y in range(self.size):
             for x in range(self.size):
                 if self.tiles[x][y] == 9:
@@ -47,13 +54,15 @@ class Board():
                     if self.tiles[nx][ny] == 9:
                         neighbouring_bombs += 1
                 self.tiles[x][y] = neighbouring_bombs
-        
+
 
     def invalid_coordinates(self, x, y):
+        """ onko koordinaatit pelilaudan ulkopuolella """
         return x < 0 or x >= self.size or y < 0 or y >= self.size
-        
+
 
     def get_neighbours_coords(self, x, y, include_home = False):
+        """ antaa listan naapureiden koordinaateista """
         offsets = (
             (-1,-1), (0,-1), (1,-1),
             (-1, 0), (0, 0), (1, 0),
@@ -68,28 +77,31 @@ class Board():
             if not self.invalid_coordinates(x+dx, y+dy):
                 coordinates.append( (x+dx, y+dy) )
         return coordinates
-            
+
 
     def get_view(self):
+        """ antaa matriisin nykyisestä pelinäkymästä """
         view = deepcopy(self.masked)
         for y in range(self.size):
             for x in range(self.size):
                 if not view[x][y]:
                     view[x][y]=self.tiles[x][y]
         return view
-        
+
 
     def is_winning(self):
+        """ tarkistaa onko peli voitettu """
         for y in range(self.size):
             for x in range(self.size):
                 if self.tiles[x][y] != 9 and self.masked[x][y]:
                     return False
         return True
-            
 
-    def collect_area(self, x, y, area=set()):
-        if not area:
-            area.add((x,y))
+
+    def collect_area(self, x, y, area = None):
+        """ tunnustelee ja palauttaa tyhjän alueen koordinaatit """
+        if area is None:
+            area = {(x,y)}
         to_test = []
         for nx, ny in self.get_neighbours_coords(x, y):
             if self.tiles[nx][ny] == 0 and (nx,ny) not in area:
@@ -98,21 +110,23 @@ class Board():
         for tx, ty in to_test:
             area=area.union(self.collect_area(tx, ty, area))
         return area
-        
+
 
     def get_mask(self, x, y):
+        """ onko ruutu vielä piilossa """
         return self.masked[x][y]
 
 
     def flag_tile(self, x, y):
+        """ aseta lippu peitetylle ruudulle"""
         if self.invalid_coordinates(x, y):
             print("Koordinaatit on pelilaudan ulkopuolella", file=stderr)
             return False
-        
+
         if self.masked[x][y] == 0:
             print("Ei voi liputtaa avattua ruutua", file=stderr)
             return False
-            
+
         match self.masked[x][y]:
             case 0:
                 print("Ei voi liputtaa avattua ruutua", file=stderr)
@@ -123,43 +137,29 @@ class Board():
             case 12:
                 self.masked[x][y]=10
                 return True
-        
+
         print("Ruudulla odottamaton lippu", file=stderr)
         return False
 
-        
+
     def make_guess(self, x, y):
+        """ tee arvaus """
         if self.invalid_coordinates(x, y):
             print("Koordinaatit on pelilaudan ulkopuolella", file=stderr)
             return False
-            
+
         if self.masked[x][y] == 0:
             print("Ruutu on jo avattu", file=stderr)
             return False
-            
+
         self.masked[x][y] = 0
-        
+
         if self.tiles[x][y] == 9:
             return False
-            
+
         if self.tiles[x][y] == 0:
             for cx, cy in self.collect_area( x, y ):
                 for nx, ny in self.get_neighbours_coords(cx, cy, True):
                     self.masked[nx][ny] = 0
-                                
+
         return True
-        
-        
-    
-if __name__ == "__main__":
-    def print_matrix(m):
-        for y in range(len(m)):
-            for x in range(len(m[0])):
-                print(end=f"[{m[x][y]:x}]")
-            print()
-
-    b = Board()
-    b.make_guess(5,5)    
-    print_matrix(b.get_view())
-    
-    
\ No newline at end of file