clean naming again

Author: EarthenSky

src/officers/crud.py

@@ -16,9 +16,9 @@
 _logger = logging.getLogger(__name__)
 
 
-async def most_recent_exec_term(db_session: database.DBSession, computing_id: str) -> OfficerTerm | None:
+async def most_recent_officer_term(db_session: database.DBSession, computing_id: str) -> OfficerTerm | None:
     """
-    Returns the most recent OfficerTerm an exec has had
+    Returns the most recent OfficerTerm an exec has held
     """
     query = (
         sqlalchemy
@@ -31,16 +31,15 @@ async def most_recent_exec_term(db_session: database.DBSession, computing_id: st
 
 async def current_officer_positions(db_session: database.DBSession, computing_id: str) -> list[str]:
     """
-    Returns [] if the user is not currently an officer.
+    Returns the list of officer positions a user currently has. Returns [] if the user is not currently an officer.
 
-    Gets positions ordered most recent start date first.
-
-    An officer can have multiple positions, such as Webmaster, Frosh chair, and DoEE.
+    An officer can have multiple positions at once, such as Webmaster, Frosh chair, and DoEE.
     """
     query = (
         sqlalchemy
         .select(OfficerTerm)
         .where(OfficerTerm.computing_id == computing_id)
+        # In order of most recent start date first
         .order_by(OfficerTerm.start_date.desc())
     )
     query = utils.is_active_officer(query)

src/permission/types.py

@@ -18,10 +18,10 @@ async def has_permission(db_session: database.DBSession, computing_id: str) -> b
         A semester is defined in semester_start
         """
 
-        most_recent_exec_term = await officers.crud.most_recent_exec_term(db_session, computing_id)
-        if most_recent_exec_term is None:
+        term = await officers.crud.most_recent_officer_term(db_session, computing_id)
+        if term is None:
             return False
-        elif most_recent_exec_term.end_date is None:
+        elif term.end_date is None:
             # considered an active exec if no end_date
             return True
 
@@ -30,7 +30,7 @@ async def has_permission(db_session: database.DBSession, computing_id: str) -> b
         NUM_SEMESTERS = 5
         cutoff_date = step_semesters(semester_start, -NUM_SEMESTERS)
 
-        return most_recent_exec_term.end_date > cutoff_date
+        return term.end_date > cutoff_date
 
 class WebsiteAdmin:
     WEBSITE_ADMIN_POSITIONS: ClassVar[list[OfficerPosition]] = [

tests/integration/test_officers.py

@@ -5,7 +5,7 @@
 import load_test_db
 from database import SQLALCHEMY_TEST_DATABASE_URL, DatabaseSessionManager
 from officers.constants import OfficerPosition
-from officers.crud import all_officer_terms, current_executive_team, most_recent_exec_term
+from officers.crud import all_officer_terms, current_executive_team, most_recent_officer_term
 
 # TODO: setup a database on the CI machine & run this as a unit test then (since
 # this isn't really an integration test)
@@ -27,9 +27,9 @@ async def test__read_execs(database_setup):
     sessionmanager = await database_setup
     async with sessionmanager.session() as db_session:
         # test that reads from the database succeeded as expected
-        assert (await most_recent_exec_term(db_session, "blarg")) is None
-        assert await most_recent_exec_term(db_session, "abc22") is None
-        abc11_officer_term = await most_recent_exec_term(db_session, "abc11")
+        assert (await most_recent_officer_term(db_session, "blarg")) is None
+        assert await most_recent_officer_term(db_session, "abc22") is None
+        abc11_officer_term = await most_recent_officer_term(db_session, "abc11")
 
         assert abc11_officer_term.computing_id == "abc11"
         assert abc11_officer_term.position == OfficerPosition.EXECUTIVE_AT_LARGE