Code cleanup

Author: JoelEager

packet/commands.py

@@ -11,6 +11,7 @@
 from .models import Freshman, Packet, FreshSignature, UpperSignature, MiscSignature
 from .ldap import ldap_get_eboard, ldap_get_live_onfloor
 
+
 @app.cli.command("create-secret")
 def create_secret():
     """
@@ -19,15 +20,18 @@ def create_secret():
     print("Here's your random secure token:")
     print(token_hex())
 
+
 packet_start_time = time(hour=19)
 packet_end_time = time(hour=21)
 
+
 class CSVFreshman:
     def __init__(self, row):
         self.name = row[0]
         self.rit_username = row[3]
         self.onfloor = row[1] == "TRUE"
 
+
 def parse_csv(freshmen_csv):
     print("Parsing file...")
     try:
@@ -37,6 +41,7 @@ def parse_csv(freshmen_csv):
         print("Failure while parsing CSV")
         raise e
 
+
 @app.cli.command("sync-freshmen")
 @click.argument("freshmen_csv")
 def sync_freshmen(freshmen_csv):
@@ -82,6 +87,7 @@ def sync_freshmen(freshmen_csv):
     db.session.commit()
     print("Done!")
 
+
 @app.cli.command("create-packets")
 @click.argument("freshmen_csv")
 def create_packets(freshmen_csv):
@@ -126,6 +132,7 @@ def create_packets(freshmen_csv):
     db.session.commit()
     print("Done!")
 
+
 @app.cli.command("ldap-sync")
 def ldap_sync():
     """
@@ -162,6 +169,7 @@ def ldap_sync():
     db.session.commit()
     print("Done!")
 
+
 @app.cli.command("fetch-results")
 def fetch_results():
     """

packet/context_processors.py

@@ -9,6 +9,7 @@
 from packet.models import Freshman
 from packet import app
 
+
 # pylint: disable=bare-except
 @lru_cache(maxsize=128)
 def get_csh_name(username):
@@ -18,6 +19,7 @@ def get_csh_name(username):
     except:
         return username
 
+
 # pylint: disable=bare-except
 @lru_cache(maxsize=128)
 def get_rit_name(username):
@@ -27,12 +29,14 @@ def get_rit_name(username):
     except:
         return username
 
+
 def log_time(label):
     """
     Used during debugging to log timestamps while rendering templates
     """
     print(label, datetime.now())
 
+
 @app.context_processor
 def utility_processor():
     return dict(get_csh_name=get_csh_name, get_rit_name=get_rit_name, log_time=log_time)

packet/debug_utils.py

@@ -7,6 +7,7 @@
 
 from packet import context_processors
 
+
 def log_time(func):
     """
     Decorator for logging the execution time of a function
@@ -24,6 +25,7 @@ def wrapped_function(*args, **kwargs):
 
     return wrapped_function
 
+
 def log_cache():
     """
     Utility call for logging cache info

packet/models.py

@@ -43,12 +43,6 @@ class Freshman(db.Model):
     # One freshman can have multiple packets if they repeat the intro process
     packets = relationship("Packet", order_by="desc(Packet.id)")
 
-    def current_packet(self):
-        """
-        :return: The most recent packet for this freshman
-        """
-        return next(iter(self.packets), None)
-
 
 class Packet(db.Model):
     __tablename__ = "packet"
@@ -61,23 +55,29 @@ class Packet(db.Model):
     info_achieve = Column(Text, nullable=True)  # Used to fulfil the technical achievements list requirement
 
     freshman = relationship("Freshman", back_populates="packets")
-    upper_signatures = relationship("UpperSignature", order_by="UpperSignature.signed.desc(), UpperSignature.updated",
-                                    lazy="subquery")
-    fresh_signatures = relationship("FreshSignature", order_by="FreshSignature.signed.desc(), FreshSignature.updated",
-                                    lazy="subquery")
-    misc_signatures = relationship("MiscSignature", order_by="MiscSignature.updated", lazy="subquery")
+    upper_signatures = relationship("UpperSignature", lazy="subquery",
+                                    order_by="UpperSignature.signed.desc(), UpperSignature.updated")
+    fresh_signatures = relationship("FreshSignature", lazy="subquery",
+                                    order_by="FreshSignature.signed.desc(), FreshSignature.updated")
+    misc_signatures = relationship("MiscSignature", lazy="subquery", order_by="MiscSignature.updated")
 
     def is_open(self):
         return self.start < datetime.now() < self.end
 
     def signatures_required(self):
+        """
+        :return: A SigCounts instance with the fields set to the number of signatures received by this packet
+        """
         eboard = sum(map(lambda sig: 1 if sig.eboard else 0, self.upper_signatures))
         upper = len(self.upper_signatures) - eboard
         fresh = len(self.fresh_signatures)
 
         return SigCounts(eboard, upper, fresh, REQUIRED_MISC_SIGNATURES)
 
     def signatures_received(self):
+        """
+        :return: A SigCounts instance with the fields set to the number of required signatures for this packet
+        """
         eboard = sum(map(lambda sig: 1 if sig.eboard and sig.signed else 0, self.upper_signatures))
         upper = sum(map(lambda sig: 1 if not sig.eboard and sig.signed else 0, self.upper_signatures))
         fresh = sum(map(lambda sig: 1 if sig.signed else 0, self.fresh_signatures))
@@ -86,7 +86,9 @@ def signatures_received(self):
 
     def did_sign(self, username, is_csh):
         """
+        :param username: The CSH or RIT username to check for
         :param is_csh: Set to True for CSH accounts and False for freshmen
+        :return: Boolean value for if the given account signed this packet
         """
         if is_csh:
             for sig in filter(lambda sig: sig.member == username, chain(self.upper_signatures, self.misc_signatures)):

packet/routes/shared.py

@@ -1,3 +1,7 @@
+"""
+Routes available to both freshmen and CSH users
+"""
+
 from datetime import datetime
 from flask import render_template, redirect