fix: add nominees models and tables

Author: jbriones1

src/elections/models.py

@@ -47,18 +47,3 @@ class ElectionUpdateParams(BaseModel):
     available_positions: list[OfficerPositionEnum] | None = None
     survey_link: str | None = None
 
-class NomineeInfoModel(BaseModel):
-    computing_id: str
-    full_name: str
-    linked_in: str
-    instagram: str
-    email: str
-    discord_username: str
-
-class NomineeInfoUpdateParams(BaseModel):
-    full_name: str | None = None
-    linked_in: str | None = None
-    instagram: str | None = None
-    email: str | None = None
-    discord_username: str | None = None
-

src/elections/tables.py

@@ -6,10 +6,6 @@
 )
 from sqlalchemy.orm import Mapped, mapped_column
 
-from constants import (
-    COMPUTING_ID_LEN,
-    DISCORD_NICKNAME_LEN,
-)
 from database import Base
 from elections.models import (
     ElectionStatusEnum,
@@ -122,39 +118,3 @@ def status(self, at_time: datetime) -> str:
         else:
             return ElectionStatusEnum.AFTER_VOTING
 
-class NomineeInfo(Base):
-    __tablename__ = "election_nominee_info"
-
-    computing_id: Mapped[str] = mapped_column(String(COMPUTING_ID_LEN), primary_key=True)
-    full_name: Mapped[str] = mapped_column(String(64), nullable=False)
-    linked_in: Mapped[str] = mapped_column(String(128))
-    instagram: Mapped[str] = mapped_column(String(128))
-    email: Mapped[str] = mapped_column(String(64))
-    discord_username: Mapped[str] = mapped_column(String(DISCORD_NICKNAME_LEN))
-
-    def to_update_dict(self) -> dict:
-        return {
-            "computing_id": self.computing_id,
-            "full_name": self.full_name,
-
-            "linked_in": self.linked_in,
-            "instagram": self.instagram,
-            "email": self.email,
-            "discord_username": self.discord_username,
-        }
-
-    def serialize(self) -> dict:
-        # NOTE: this function is currently the same as to_update_dict since the contents
-        # have a different invariant they're upholding, which may cause them to change if a
-        # new property is introduced. For example, dates must be converted into strings
-        # to be serialized, but must not for update dictionaries.
-        return {
-            "computing_id": self.computing_id,
-            "full_name": self.full_name,
-
-            "linked_in": self.linked_in,
-            "instagram": self.instagram,
-            "email": self.email,
-            "discord_username": self.discord_username,
-        }
-

src/load_test_db.py

@@ -13,8 +13,9 @@
 from auth.crud import create_user_session, update_site_user
 from database import SQLALCHEMY_TEST_DATABASE_URL, Base, DatabaseSessionManager
 from elections.crud import create_election, update_election
-from elections.tables import Election, NomineeInfo
+from elections.tables import Election
 from nominees.crud import create_nominee_info
+from nominees.tables import NomineeInfo
 from officers.constants import OfficerPositionEnum
 from officers.crud import (
     create_new_officer_info,

src/nominees/crud.py

@@ -1,7 +1,7 @@
 import sqlalchemy
 from sqlalchemy.ext.asyncio import AsyncSession
 
-from elections.tables import NomineeInfo
+from nominees.tables import NomineeInfo
 
 
 async def get_nominee_info(

src/nominees/models.py

@@ -0,0 +1,18 @@
+from pydantic import BaseModel
+
+
+class NomineeInfoModel(BaseModel):
+    computing_id: str
+    full_name: str
+    linked_in: str
+    instagram: str
+    email: str
+    discord_username: str
+
+class NomineeInfoUpdateParams(BaseModel):
+    full_name: str | None = None
+    linked_in: str | None = None
+    instagram: str | None = None
+    email: str | None = None
+    discord_username: str | None = None
+

src/nominees/tables.py

@@ -0,0 +1,48 @@
+from sqlalchemy import (
+    String,
+)
+from sqlalchemy.orm import Mapped, mapped_column
+
+from constants import (
+    COMPUTING_ID_LEN,
+    DISCORD_NICKNAME_LEN,
+)
+from database import Base
+
+
+class NomineeInfo(Base):
+    __tablename__ = "election_nominee_info"
+
+    computing_id: Mapped[str] = mapped_column(String(COMPUTING_ID_LEN), primary_key=True)
+    full_name: Mapped[str] = mapped_column(String(64), nullable=False)
+    linked_in: Mapped[str] = mapped_column(String(128))
+    instagram: Mapped[str] = mapped_column(String(128))
+    email: Mapped[str] = mapped_column(String(64))
+    discord_username: Mapped[str] = mapped_column(String(DISCORD_NICKNAME_LEN))
+
+    def to_update_dict(self) -> dict:
+        return {
+            "computing_id": self.computing_id,
+            "full_name": self.full_name,
+
+            "linked_in": self.linked_in,
+            "instagram": self.instagram,
+            "email": self.email,
+            "discord_username": self.discord_username,
+        }
+
+    def serialize(self) -> dict:
+        # NOTE: this function is currently the same as to_update_dict since the contents
+        # have a different invariant they're upholding, which may cause them to change if a
+        # new property is introduced. For example, dates must be converted into strings
+        # to be serialized, but must not for update dictionaries.
+        return {
+            "computing_id": self.computing_id,
+            "full_name": self.full_name,
+
+            "linked_in": self.linked_in,
+            "instagram": self.instagram,
+            "email": self.email,
+            "discord_username": self.discord_username,
+        }
+

src/nominees/urls.py

@@ -3,11 +3,11 @@
 
 import database
 import nominees.crud
-from elections.models import (
+from nominees.models import (
     NomineeInfoModel,
     NomineeInfoUpdateParams,
 )
-from elections.tables import NomineeInfo
+from nominees.tables import NomineeInfo
 from utils.urls import admin_or_raise
 
 router = APIRouter(