chore: replace OfficerPosition strings with OfficerPositionEnum

jbriones1 · jbriones1 · commit 1d50019fc712 · 2025-09-11T10:37:06.000-07:00
diff --git a/src/elections/crud.py b/src/elections/crud.py
@@ -4,7 +4,7 @@
 from sqlalchemy.ext.asyncio import AsyncSession
 
 from elections.tables import Election, NomineeApplication, NomineeInfo
-from officers.types import OfficerPositionEnum
+from officers.constants import OfficerPositionEnum
 
 
 async def get_all_elections(db_session: AsyncSession) -> Sequence[Election]:
diff --git a/src/elections/models.py b/src/elections/models.py
@@ -2,7 +2,7 @@
 
 from pydantic import BaseModel, Field
 
-from officers.types import OfficerPositionEnum
+from officers.constants import OfficerPositionEnum
 
 
 class ElectionTypeEnum(StrEnum):
diff --git a/src/elections/tables.py b/src/elections/tables.py
@@ -19,7 +19,7 @@
     ElectionUpdateParams,
     NomineeApplicationUpdateParams,
 )
-from officers.types import OfficerPositionEnum
+from officers.constants import OfficerPositionEnum
 from utils.types import StringList
 
 MAX_ELECTION_NAME = 64
diff --git a/src/elections/urls.py b/src/elections/urls.py
@@ -21,8 +21,7 @@
     NomineeInfoUpdateParams,
 )
 from elections.tables import Election, NomineeApplication, NomineeInfo
-from officers.constants import COUNCIL_REP_ELECTION_POSITIONS, GENERAL_ELECTION_POSITIONS
-from officers.types import OfficerPositionEnum
+from officers.constants import COUNCIL_REP_ELECTION_POSITIONS, GENERAL_ELECTION_POSITIONS, OfficerPositionEnum
 from permission.types import ElectionOfficer, WebsiteAdmin
 from utils.shared_models import DetailModel, SuccessResponse
 from utils.urls import admin_or_raise, get_current_user, logged_in_or_raise
diff --git a/src/load_test_db.py b/src/load_test_db.py
@@ -14,7 +14,7 @@
 from database import SQLALCHEMY_TEST_DATABASE_URL, Base, DatabaseSessionManager
 from elections.crud import add_registration, create_election, create_nominee_info, update_election
 from elections.tables import Election, NomineeApplication, NomineeInfo
-from officers.constants import OfficerPosition
+from officers.constants import OfficerPositionEnum
 from officers.crud import (
     create_new_officer_info,
     create_new_officer_term,
@@ -125,7 +125,7 @@ async def load_test_officers_data(db_session: AsyncSession):
     await create_new_officer_term(db_session, OfficerTerm(
         computing_id="abc11",
 
-        position=OfficerPosition.VICE_PRESIDENT,
+        position=OfficerPositionEnum.VICE_PRESIDENT,
         start_date=date.today() - timedelta(days=365),
         end_date=date.today() - timedelta(days=1),
 
@@ -142,7 +142,7 @@ async def load_test_officers_data(db_session: AsyncSession):
     await create_new_officer_term(db_session, OfficerTerm(
         computing_id="abc11",
 
-        position=OfficerPosition.EXECUTIVE_AT_LARGE,
+        position=OfficerPositionEnum.EXECUTIVE_AT_LARGE,
         start_date=date.today(),
         end_date=None,
 
@@ -159,7 +159,7 @@ async def load_test_officers_data(db_session: AsyncSession):
     await create_new_officer_term(db_session, OfficerTerm(
         computing_id="abc33",
 
-        position=OfficerPosition.PRESIDENT,
+        position=OfficerPositionEnum.PRESIDENT,
         start_date=date.today(),
         end_date=date.today() + timedelta(days=365),
 
@@ -177,7 +177,7 @@ async def load_test_officers_data(db_session: AsyncSession):
     await create_new_officer_term(db_session, OfficerTerm(
         computing_id="abc22",
 
-        position=OfficerPosition.DIRECTOR_OF_ARCHIVES,
+        position=OfficerPositionEnum.DIRECTOR_OF_ARCHIVES,
         start_date=date.today(),
         end_date=date.today() + timedelta(days=365),
 
@@ -208,7 +208,7 @@ async def load_test_officers_data(db_session: AsyncSession):
     await update_officer_term(db_session, OfficerTerm(
         computing_id="abc33",
 
-        position=OfficerPosition.PRESIDENT,
+        position=OfficerPositionEnum.PRESIDENT,
         start_date=date.today(),
         end_date=date.today() + timedelta(days=365),
 
@@ -243,7 +243,7 @@ async def load_sysadmin(db_session: AsyncSession):
     await create_new_officer_term(db_session, OfficerTerm(
         computing_id=SYSADMIN_COMPUTING_ID,
 
-        position=OfficerPosition.FIRST_YEAR_REPRESENTATIVE,
+        position=OfficerPositionEnum.FIRST_YEAR_REPRESENTATIVE,
         start_date=date.today() - timedelta(days=(365*3)),
         end_date=date.today() - timedelta(days=(365*2)),
 
@@ -260,7 +260,7 @@ async def load_sysadmin(db_session: AsyncSession):
     await create_new_officer_term(db_session, OfficerTerm(
         computing_id=SYSADMIN_COMPUTING_ID,
 
-        position=OfficerPosition.SYSTEM_ADMINISTRATOR,
+        position=OfficerPositionEnum.SYSTEM_ADMINISTRATOR,
         start_date=date.today() - timedelta(days=365),
         end_date=None,
 
@@ -278,7 +278,7 @@ async def load_sysadmin(db_session: AsyncSession):
     await create_new_officer_term(db_session, OfficerTerm(
         computing_id=SYSADMIN_COMPUTING_ID,
 
-        position=OfficerPosition.DIRECTOR_OF_ARCHIVES,
+        position=OfficerPositionEnum.DIRECTOR_OF_ARCHIVES,
         start_date=date.today() + timedelta(days=365*1),
         end_date=date.today() + timedelta(days=365*2),
 
diff --git a/src/officers/constants.py b/src/officers/constants.py
@@ -1,7 +1,7 @@
-from officers.types import OfficerPositionEnum
+from enum import StrEnum
 
 
-class OfficerPosition:
+class OfficerPositionEnum(StrEnum):
     PRESIDENT = "president"
     VICE_PRESIDENT = "vice-president"
     TREASURER = "treasurer"
@@ -25,12 +25,13 @@ class OfficerPosition:
     WEBMASTER = "webmaster"
     SOCIAL_MEDIA_MANAGER = "social media manager"
 
+class OfficerPosition:
     @staticmethod
     def position_list() -> list[OfficerPositionEnum]:
         return _OFFICER_POSITION_LIST
 
     @staticmethod
-    def length_in_semesters(position: str) -> int | None:
+    def length_in_semesters(position: OfficerPositionEnum) -> int | None:
         # TODO (#101): ask the committee to maintain a json file with all the important details from the constitution
         """How many semester position is active for, according to the CSSS Constitution"""
         if position not in _LENGTH_MAP:
@@ -40,7 +41,7 @@ def length_in_semesters(position: str) -> int | None:
             return _LENGTH_MAP[position]
 
     @staticmethod
-    def to_email(position: str) -> str | None:
+    def to_email(position: OfficerPositionEnum) -> str | None:
         return _EMAIL_MAP.get(position, None)
 
     @staticmethod
@@ -50,13 +51,13 @@ def num_active(position: str) -> int | None:
         """
         # None means there can be any number active
         if (
-            position == OfficerPosition.EXECUTIVE_AT_LARGE
-            or position == OfficerPosition.FIRST_YEAR_REPRESENTATIVE
+            position == OfficerPositionEnum.EXECUTIVE_AT_LARGE
+            or position == OfficerPositionEnum.FIRST_YEAR_REPRESENTATIVE
         ):
             return 2
         elif (
-            position == OfficerPosition.FROSH_WEEK_CHAIR
-            or position == OfficerPosition.SOCIAL_MEDIA_MANAGER
+            position == OfficerPositionEnum.FROSH_WEEK_CHAIR
+            or position == OfficerPositionEnum.SOCIAL_MEDIA_MANAGER
         ):
             return None
         else:
@@ -68,90 +69,90 @@ def is_signer(position: str) -> bool:
         If the officer is a signing authority of the CSSS
         """
         return (
-            position == OfficerPosition.PRESIDENT
-            or position == OfficerPosition.VICE_PRESIDENT
-            or position == OfficerPosition.TREASURER
-            or position == OfficerPosition.DIRECTOR_OF_RESOURCES
-            or position == OfficerPosition.DIRECTOR_OF_EVENTS
+            position == OfficerPositionEnum.PRESIDENT
+            or position == OfficerPositionEnum.VICE_PRESIDENT
+            or position == OfficerPositionEnum.TREASURER
+            or position == OfficerPositionEnum.DIRECTOR_OF_RESOURCES
+            or position == OfficerPositionEnum.DIRECTOR_OF_EVENTS
         )
 
     @staticmethod
     def expected_positions() -> list[str]:
         # TODO (#93): use this function in the daily cronjobs
         return [
-            OfficerPosition.PRESIDENT,
-            OfficerPosition.VICE_PRESIDENT,
-            OfficerPosition.TREASURER,
-
-            OfficerPosition.DIRECTOR_OF_RESOURCES,
-            OfficerPosition.DIRECTOR_OF_EVENTS,
-            OfficerPosition.DIRECTOR_OF_EDUCATIONAL_EVENTS,
-            OfficerPosition.ASSISTANT_DIRECTOR_OF_EVENTS,
-            OfficerPosition.DIRECTOR_OF_COMMUNICATIONS,
-            #OfficerPosition.DIRECTOR_OF_OUTREACH, # TODO (#101): when https://github.com/CSSS/documents/pull/9/files merged
-            OfficerPosition.DIRECTOR_OF_MULTIMEDIA,
-            OfficerPosition.DIRECTOR_OF_ARCHIVES,
-            OfficerPosition.EXECUTIVE_AT_LARGE,
+            OfficerPositionEnum.PRESIDENT,
+            OfficerPositionEnum.VICE_PRESIDENT,
+            OfficerPositionEnum.TREASURER,
+
+            OfficerPositionEnum.DIRECTOR_OF_RESOURCES,
+            OfficerPositionEnum.DIRECTOR_OF_EVENTS,
+            OfficerPositionEnum.DIRECTOR_OF_EDUCATIONAL_EVENTS,
+            OfficerPositionEnum.ASSISTANT_DIRECTOR_OF_EVENTS,
+            OfficerPositionEnum.DIRECTOR_OF_COMMUNICATIONS,
+            #OfficerPositionEnum.DIRECTOR_OF_OUTREACH, # TODO (#101): when https://github.com/CSSS/documents/pull/9/files merged
+            OfficerPositionEnum.DIRECTOR_OF_MULTIMEDIA,
+            OfficerPositionEnum.DIRECTOR_OF_ARCHIVES,
+            OfficerPositionEnum.EXECUTIVE_AT_LARGE,
             # TODO (#101): expect these only during fall & spring semesters.
-            #OfficerPosition.FIRST_YEAR_REPRESENTATIVE,
+            #OfficerPositionEnum.FIRST_YEAR_REPRESENTATIVE,
 
             #ElectionsOfficer,
-            OfficerPosition.SFSS_COUNCIL_REPRESENTATIVE,
-            OfficerPosition.FROSH_WEEK_CHAIR,
+            OfficerPositionEnum.SFSS_COUNCIL_REPRESENTATIVE,
+            OfficerPositionEnum.FROSH_WEEK_CHAIR,
 
-            OfficerPosition.SYSTEM_ADMINISTRATOR,
-            OfficerPosition.WEBMASTER,
+            OfficerPositionEnum.SYSTEM_ADMINISTRATOR,
+            OfficerPositionEnum.WEBMASTER,
         ]
 
 _EMAIL_MAP = {
-    OfficerPosition.PRESIDENT: "csss-president-current@sfu.ca",
-    OfficerPosition.VICE_PRESIDENT: "csss-vp-current@sfu.ca",
-    OfficerPosition.TREASURER: "csss-treasurer-current@sfu.ca",
-
-    OfficerPosition.DIRECTOR_OF_RESOURCES: "csss-dor-current@sfu.ca",
-    OfficerPosition.DIRECTOR_OF_EVENTS: "csss-doe-current@sfu.ca",
-    OfficerPosition.DIRECTOR_OF_EDUCATIONAL_EVENTS: "csss-doee-current@sfu.ca",
-    OfficerPosition.ASSISTANT_DIRECTOR_OF_EVENTS: "csss-adoe-current@sfu.ca",
-    OfficerPosition.DIRECTOR_OF_COMMUNICATIONS: "csss-doc-current@sfu.ca",
-    #OfficerPosition.DIRECTOR_OF_OUTREACH,
-    OfficerPosition.DIRECTOR_OF_MULTIMEDIA: "csss-domm-current@sfu.ca",
-    OfficerPosition.DIRECTOR_OF_ARCHIVES: "csss-doa-current@sfu.ca",
-    OfficerPosition.EXECUTIVE_AT_LARGE: "csss-eal-current@sfu.ca",
-    OfficerPosition.FIRST_YEAR_REPRESENTATIVE: "csss-fyr-current@sfu.ca",
-
-    OfficerPosition.ELECTIONS_OFFICER: "csss-elections@sfu.ca",
-    OfficerPosition.SFSS_COUNCIL_REPRESENTATIVE: "csss-councilrep@sfu.ca",
-    OfficerPosition.FROSH_WEEK_CHAIR: "csss-froshchair@sfu.ca",
-
-    OfficerPosition.SYSTEM_ADMINISTRATOR: "csss-sysadmin@sfu.ca",
-    OfficerPosition.WEBMASTER: "csss-webmaster@sfu.ca",
-    OfficerPosition.SOCIAL_MEDIA_MANAGER: "N/A",
+    OfficerPositionEnum.PRESIDENT: "csss-president-current@sfu.ca",
+    OfficerPositionEnum.VICE_PRESIDENT: "csss-vp-current@sfu.ca",
+    OfficerPositionEnum.TREASURER: "csss-treasurer-current@sfu.ca",
+
+    OfficerPositionEnum.DIRECTOR_OF_RESOURCES: "csss-dor-current@sfu.ca",
+    OfficerPositionEnum.DIRECTOR_OF_EVENTS: "csss-doe-current@sfu.ca",
+    OfficerPositionEnum.DIRECTOR_OF_EDUCATIONAL_EVENTS: "csss-doee-current@sfu.ca",
+    OfficerPositionEnum.ASSISTANT_DIRECTOR_OF_EVENTS: "csss-adoe-current@sfu.ca",
+    OfficerPositionEnum.DIRECTOR_OF_COMMUNICATIONS: "csss-doc-current@sfu.ca",
+    #OfficerPositionEnum.DIRECTOR_OF_OUTREACH,
+    OfficerPositionEnum.DIRECTOR_OF_MULTIMEDIA: "csss-domm-current@sfu.ca",
+    OfficerPositionEnum.DIRECTOR_OF_ARCHIVES: "csss-doa-current@sfu.ca",
+    OfficerPositionEnum.EXECUTIVE_AT_LARGE: "csss-eal-current@sfu.ca",
+    OfficerPositionEnum.FIRST_YEAR_REPRESENTATIVE: "csss-fyr-current@sfu.ca",
+
+    OfficerPositionEnum.ELECTIONS_OFFICER: "csss-elections@sfu.ca",
+    OfficerPositionEnum.SFSS_COUNCIL_REPRESENTATIVE: "csss-councilrep@sfu.ca",
+    OfficerPositionEnum.FROSH_WEEK_CHAIR: "csss-froshchair@sfu.ca",
+
+    OfficerPositionEnum.SYSTEM_ADMINISTRATOR: "csss-sysadmin@sfu.ca",
+    OfficerPositionEnum.WEBMASTER: "csss-webmaster@sfu.ca",
+    OfficerPositionEnum.SOCIAL_MEDIA_MANAGER: "N/A",
 }
 
 # None, means that the length of the position does not have a set length in semesters
 _LENGTH_MAP = {
-    OfficerPosition.PRESIDENT: 3,
-    OfficerPosition.VICE_PRESIDENT: 3,
-    OfficerPosition.TREASURER: 3,
-
-    OfficerPosition.DIRECTOR_OF_RESOURCES: 3,
-    OfficerPosition.DIRECTOR_OF_EVENTS: 3,
-    OfficerPosition.DIRECTOR_OF_EDUCATIONAL_EVENTS: 3,
-    OfficerPosition.ASSISTANT_DIRECTOR_OF_EVENTS: 3,
-    OfficerPosition.DIRECTOR_OF_COMMUNICATIONS: 3,
-    #OfficerPosition.DIRECTOR_OF_OUTREACH: 3,
-    OfficerPosition.DIRECTOR_OF_MULTIMEDIA: 3,
-    OfficerPosition.DIRECTOR_OF_ARCHIVES: 3,
-    OfficerPosition.EXECUTIVE_AT_LARGE: 1,
-    OfficerPosition.FIRST_YEAR_REPRESENTATIVE: 2,
-
-    OfficerPosition.ELECTIONS_OFFICER: None,
-    OfficerPosition.SFSS_COUNCIL_REPRESENTATIVE: 3,
-    OfficerPosition.FROSH_WEEK_CHAIR: None,
-
-    OfficerPosition.SYSTEM_ADMINISTRATOR: None,
-    OfficerPosition.WEBMASTER: None,
-    OfficerPosition.SOCIAL_MEDIA_MANAGER: None,
+    OfficerPositionEnum.PRESIDENT: 3,
+    OfficerPositionEnum.VICE_PRESIDENT: 3,
+    OfficerPositionEnum.TREASURER: 3,
+
+    OfficerPositionEnum.DIRECTOR_OF_RESOURCES: 3,
+    OfficerPositionEnum.DIRECTOR_OF_EVENTS: 3,
+    OfficerPositionEnum.DIRECTOR_OF_EDUCATIONAL_EVENTS: 3,
+    OfficerPositionEnum.ASSISTANT_DIRECTOR_OF_EVENTS: 3,
+    OfficerPositionEnum.DIRECTOR_OF_COMMUNICATIONS: 3,
+    #OfficerPositionEnum.DIRECTOR_OF_OUTREACH: 3,
+    OfficerPositionEnum.DIRECTOR_OF_MULTIMEDIA: 3,
+    OfficerPositionEnum.DIRECTOR_OF_ARCHIVES: 3,
+    OfficerPositionEnum.EXECUTIVE_AT_LARGE: 1,
+    OfficerPositionEnum.FIRST_YEAR_REPRESENTATIVE: 2,
+
+    OfficerPositionEnum.ELECTIONS_OFFICER: None,
+    OfficerPositionEnum.SFSS_COUNCIL_REPRESENTATIVE: 3,
+    OfficerPositionEnum.FROSH_WEEK_CHAIR: None,
+
+    OfficerPositionEnum.SYSTEM_ADMINISTRATOR: None,
+    OfficerPositionEnum.WEBMASTER: None,
+    OfficerPositionEnum.SOCIAL_MEDIA_MANAGER: None,
 }
 
 _OFFICER_POSITION_LIST = [
diff --git a/src/officers/types.py b/src/officers/types.py
@@ -2,7 +2,6 @@
 
 from dataclasses import asdict, dataclass
 from datetime import date
-from enum import StrEnum
 
 from fastapi import HTTPException
 
@@ -14,30 +13,6 @@
 from officers.tables import OfficerInfo, OfficerTerm
 
 
-class OfficerPositionEnum(StrEnum):
-    PRESIDENT = "president"
-    VICE_PRESIDENT = "vice-president"
-    TREASURER = "treasurer"
-
-    DIRECTOR_OF_RESOURCES = "director of resources"
-    DIRECTOR_OF_EVENTS = "director of events"
-    DIRECTOR_OF_EDUCATIONAL_EVENTS = "director of educational events"
-    ASSISTANT_DIRECTOR_OF_EVENTS = "assistant director of events"
-    DIRECTOR_OF_COMMUNICATIONS = "director of communications"
-    #DIRECTOR_OF_OUTREACH = "director of outreach"
-    DIRECTOR_OF_MULTIMEDIA = "director of multimedia"
-    DIRECTOR_OF_ARCHIVES = "director of archives"
-    EXECUTIVE_AT_LARGE = "executive at large"
-    FIRST_YEAR_REPRESENTATIVE = "first year representative"
-
-    ELECTIONS_OFFICER = "elections officer"
-    SFSS_COUNCIL_REPRESENTATIVE = "sfss council representative"
-    FROSH_WEEK_CHAIR = "frosh week chair"
-
-    SYSTEM_ADMINISTRATOR = "system administrator"
-    WEBMASTER = "webmaster"
-    SOCIAL_MEDIA_MANAGER = "social media manager"
-
 @dataclass
 class InitialOfficerInfo:
     computing_id: str
diff --git a/src/permission/types.py b/src/permission/types.py

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`ElectionUpdateParams,`
`20`	`20`	`NomineeApplicationUpdateParams,`
`21`	`21`	`)`
`22`		`-from officers.types import OfficerPositionEnum`
	`22`	`+from officers.constants import OfficerPositionEnum`
`23`	`23`	`from utils.types import StringList`
`24`	`24`
`25`	`25`	`MAX_ELECTION_NAME = 64`