Merge pull request #112 from JoelEager/cleanup-and-bump

Cleanup and bump

Author: JoelEager

package.json

@@ -1,16 +1,16 @@
 {
   "title": "CSH Packet",
   "name": "csh-packet",
-  "version": "3.1.0",
-  "description": "A webpacket for CSH",
+  "version": "3.1.1",
+  "description": "A web app implementation of the CSH introductory packet.",
   "bugs": {
     "url": "https://github.com/ComputerScienceHouse/packet/issues",
     "email": "[email protected]"
   },
   "license": "MIT",
-  "author": "Devin Matte",
   "contributors": [
-    "Devin Matte (https://devinmatte.com/)"
+    "Devin Matte (https://devinmatte.com/)",
+    "Joel Eager (https://github.com/JoelEager)"
   ],
   "repository": {
     "type": "git",

packet/__init__.py

@@ -1,5 +1,5 @@
 """
-The application setup and initialization code lives here.
+The application setup and initialization code lives here
 """
 
 import os
@@ -30,7 +30,6 @@
 # Logger configuration
 logging.getLogger().setLevel(app.config["LOG_LEVEL"])
 app.logger.info("Launching packet v" + app.config["VERSION"])
-
 app.logger.info("Using the {} realm".format(app.config["REALM"]))
 
 # Initialize the extensions

packet/ldap.py

@@ -8,33 +8,54 @@
 
 
 def _ldap_get_group_members(group):
+    """
+    :return: A list of CSHMember instances
+    """
     return _ldap.get_group(group).get_members()
 
 
 def _ldap_is_member_of_group(member, group):
-    group_list = member.get("memberOf")
-    for group_dn in group_list:
+    """
+    :param member: A CSHMember instance
+    """
+    for group_dn in member.get("memberOf"):
         if group == group_dn.split(",")[0][3:]:
             return True
+
     return False
 
 
 # Getters
 
 @lru_cache(maxsize=256)
 def ldap_get_member(username):
+    """
+    :return: A CSHMember instance
+    """
     return _ldap.get_member(username, uid=True)
 
 
 def ldap_get_active_members():
+    """
+    Gets all current, dues-paying members
+    :return: A list of CSHMember instances
+    """
     return _ldap_get_group_members("active")
 
 
 def ldap_get_intro_members():
+    """
+    Gets all freshmen members
+    :return: A list of CSHMember instances
+    """
     return _ldap_get_group_members("intromembers")
 
 
 def ldap_get_eboard():
+    """
+    Gets all voting members of eboard
+    :return: A list of CSHMember instances
+    """
     members = _ldap_get_group_members("eboard-chairman") + _ldap_get_group_members("eboard-evaluations"
         ) + _ldap_get_group_members("eboard-financial") + _ldap_get_group_members("eboard-history"
         ) + _ldap_get_group_members("eboard-imps") + _ldap_get_group_members("eboard-opcomm"
@@ -46,7 +67,8 @@ def ldap_get_eboard():
 
 def ldap_get_live_onfloor():
     """
-    :return: All upperclassmen who live on floor and are not eboard
+    All upperclassmen who live on floor and are not eboard
+    :return: A list of CSHMember instances
     """
     members = []
     onfloor = _ldap_get_group_members("onfloor")
@@ -59,15 +81,25 @@ def ldap_get_live_onfloor():
 
 # Status checkers
 
-def ldap_is_eboard(account):
-    return _ldap_is_member_of_group(account, 'eboard')
+def ldap_is_eboard(member):
+    """
+    :param member: A CSHMember instance
+    """
+    return _ldap_is_member_of_group(member, "eboard")
+
 
+def ldap_is_intromember(member):
+    """
+    :param member: A CSHMember instance
+    """
+    return _ldap_is_member_of_group(member, "intromembers")
 
-def ldap_is_intromember(account):
-    return _ldap_is_member_of_group(account, 'intromembers')
 
-def ldap_get_roomnumber(account):
+def ldap_get_roomnumber(member):
+    """
+    :param member: A CSHMember instance
+    """
     try:
-        return account.roomNumber
+        return member.roomNumber
     except AttributeError:
         return None

packet/models.py

@@ -52,6 +52,9 @@ class Packet(db.Model):
     end = Column(DateTime, nullable=False)
 
     freshman = relationship("Freshman", back_populates="packets")
+
+    # The `lazy="subquery"` kwarg enables eager loading for signatures which makes signature calculations much faster
+    # See the docs here for details: https://docs.sqlalchemy.org/en/latest/orm/loading_relationships.html
     upper_signatures = relationship("UpperSignature", lazy="subquery",
                                     order_by="UpperSignature.signed.desc(), UpperSignature.updated")
     fresh_signatures = relationship("FreshSignature", lazy="subquery",