Added headers

iblancett · Oct 19, 2017 · Oct 19, 2017 · Oct 19, 2017 · Oct 19, 2017 · Oct 20, 2017
commit 6894572c2c7fb1c9e6461d73ac12c9dcdd898774
diff --git a/Source/courses.py b/Source/courses.py
@@ -1,3 +1,11 @@
+# Author: Isa Blancett
+# Project: Interactive Programming
+# Date: 10.30.2017
+# Description: Class for reading in a csv file containing course information and
+# creating and instance for each course
+# Acknowledgements: Script structure is modeled after Transcriptase's Game
+# repository on Git
+
 import csv
 
 class Courses(object):

diff --git a/Source/environment.py b/Source/environment.py
@@ -1,3 +1,8 @@
+# Author: Siena Okuno
+# Project: Interactive Programming
+# Date: 10.30.2017
+# Description: Creates GUI for player and posts events when a button is clicked
+
 import pygame
 import os
 import sys

diff --git a/Source/gameplay.py b/Source/gameplay.py
@@ -1,3 +1,11 @@
+# Author: Isa Blancett
+# Project: Interactive Programming
+# Date: 10.30.2017
+# Description: Class for current gameplay status, including course levels and
+# round number
+# Acknowledgements: Script structure is modeled after Transcriptase's Game
+# repository on Git
+
 from sys import exit
 import courses
 import doctest
@@ -7,10 +15,10 @@ class Gameplay(object):
 #Parses player commands and manipulates a map object
 
     def __init__ (self, courses):
-        self.courses = courses
-        self.labels = list(courses)
-        self.order = []
-        self.round = 0
+        self.courses = courses # dictionary of course instances
+        self.labels = list(courses) # list of four letter labels for each course
+        self.order = [] # list of labels in order of the player's choosing
+        self.round = 0 # round number of the current game
 
     def add_order(self, selection):
         """ adds the order to a course's class instance if picked
@@ -23,20 +31,23 @@ def add_order(self, selection):
         >>> print(test_game.courses['mech'].order)
         1
         """
+        # increase round
         self.round = self.round + 1
-        for label in self.labels:
-            if label == selection.pressed:
-                self.courses[label].order = self.round
-                self.courses[label].lvl = 1
-                self.order.append(label)
 
+        # add order and level up newest choice
+        label = selection.pressed
+        self.courses[label].order = self.round
+        self.courses[label].lvl = 1
+        self.order.append(label)
+
+        # return whether all courses have been picked
         return len(self.order) == len(list(self.courses))
 
     def level_up(self):
         """ level up any courses that meet all requirements starting with the
         user's previous choice
 
-        returns: dictionary of courses
+        returns: None
 
         Examples:
         >>> test_game = Gameplay(courses.populate(), 0)
@@ -46,11 +57,14 @@ def level_up(self):
         >>> print(test_game.courses['mech'].lvl)
         2
         """
-
+        # No leveling up until 2 courses have been picked
         if len(self.order) > 1:
+            # Start leveling with second most recent course selection
             for label in reversed(self.order[:-1]):
-                if 0 < int(self.courses[label].lvl) < int(self.courses[label].max) and self.check_reqs(label):
+                # Check for maxed out and for dependencies
+                if int(self.courses[label].lvl) < int(self.courses[label].max) and self.check_reqs(label):
                     self.courses[label].lvl = self.courses[label].lvl + 1
+        return
 
     def check_reqs(self, label):
         """ given a course label, checks whether all dependencies are met
@@ -72,12 +86,17 @@ def check_reqs(self, label):
         """
         reqs_met = []
         lvl = self.courses[label].lvl
+
+        # Loop through reqs of given class
         for req in self.courses[label].reqs:
+            # Parse req string for dependent level, needed course, and needed course level
             deplvl = int(req[0])
+            neededcourse = req[1:5]
+            neededlevel = int(req[-1])
             if deplvl == lvl:
-                neededcourse = req[1:5]
-                neededlevel = int(req[-1])
+                # Append list with True if req has been met
                 reqs_met.append(neededlevel <= self.courses[neededcourse].lvl)
+        # Return true if all reqs are met or no reqs are needed
         return all(reqs_met) or not len(reqs_met)
 
     def evaluate_portfolio(self):
@@ -90,13 +109,16 @@ def evaluate_portfolio(self):
         >>> test_game.evaluate_portfolio()
         "Your portfolio could use a little more work. Try again?"
         """
+        # Get list of current levels and max levels
         lvls = [int(self.courses[label].lvl) for label in list(self.courses)]
         maxlvls = [int(self.courses[label].max) for label in list(self.courses)]
+        # 1 = perfect game, 2 = acceptable game, 0 = bad game (no job 4 u!!)
         if lvls == maxlvls:
             return 1
         elif (sum(lvls)) >= (sum(maxlvls)*3/4):
             return 2
         else:
             return 0
 
+# Example docstring test
 # doctest.run_docstring_examples(Gameplay.evaluate_portfolio, globals(), verbose=True)
diff --git a/Source/main.py b/Source/main.py
@@ -1,19 +1,24 @@
-# import all scripts here
+# Author: Leo Liu, Siena Okuno, & Isa Blancett
+# Project: Interactive Programming
+# Date: 10.30.2017
+# Description: Game setup, loop through game graphics and control, & ending call
+
 import courses
 from gameplay import Gameplay
-import environment
 import sys
 import pygame
 import ending
 from environment import *
 
+# INITIALIZE GAME
 BUTTON = pygame.USEREVENT + 1
 init_courses = courses.populate()
 text_screen = environment.initialize()
 screen = text_screen[0]
 text = text_screen[1]
 control = Gameplay(init_courses)
 
+# LOOP THROUGH GRAPHICS AND CONTROLS, CHECKING FOR PASSING OF EVENTS
 done = False
 while not done:
     for event in pygame.event.get():
@@ -27,7 +32,7 @@
     pygame.display.flip()
     pygame.event.pump()
 
-
+# EVALUATE ENDING AND SEND TO VICTORY SCREEN
 victory = control.evaluate_portfolio()
 if victory == 1:
     ending.determine(victory, ["%s: %s" % (control.courses[course].name, 'MAX') for course in control.courses])