refactor: move Nominee Info into its own directory

Author: jbriones1

src/elections/crud.py

@@ -3,7 +3,7 @@
 import sqlalchemy
 from sqlalchemy.ext.asyncio import AsyncSession
 
-from elections.tables import Election, NomineeInfo
+from elections.tables import Election
 
 
 async def get_all_elections(db_session: AsyncSession) -> Sequence[Election]:
@@ -47,32 +47,3 @@ async def delete_election(db_session: AsyncSession, slug: str) -> None:
         .delete(Election)
         .where(Election.slug == slug)
     )
-
-# ------------------------------------------------------- #
-
-async def get_nominee_info(
-    db_session: AsyncSession,
-    computing_id: str,
-) -> NomineeInfo | None:
-    return await db_session.scalar(
-        sqlalchemy
-        .select(NomineeInfo)
-        .where(NomineeInfo.computing_id == computing_id)
-    )
-
-async def create_nominee_info(
-    db_session: AsyncSession,
-    info: NomineeInfo,
-):
-    db_session.add(info)
-
-async def update_nominee_info(
-    db_session: AsyncSession,
-    info: NomineeInfo,
-):
-    await db_session.execute(
-        sqlalchemy
-        .update(NomineeInfo)
-        .where(NomineeInfo.computing_id == info.computing_id)
-        .values(info.to_update_dict())
-    )

src/elections/urls.py

@@ -6,6 +6,7 @@
 import database
 import elections.crud
 import elections.tables
+import nominees.crud
 import registrations.crud
 from elections.models import (
     ElectionParams,
@@ -82,8 +83,6 @@ def _raise_if_bad_election_data(
             detail=f"election slug '{slug}' is too long",
         )
 
-# election ------------------------------------------------------------- #
-
 @router.get(
     "",
     description="Returns a list of all election & their status",
@@ -165,7 +164,7 @@ async def get_election(
                 continue
 
             # NOTE: if a nominee does not input their legal name, they are not considered a nominee
-            nominee_info = await elections.crud.get_nominee_info(db_session, nomination.computing_id)
+            nominee_info = await nominees.crud.get_nominee_info(db_session, nomination.computing_id)
             if nominee_info is None:
                 continue
 

src/load_test_db.py

@@ -12,8 +12,9 @@
 # tables, or the current python context will not be able to find them & they won't be loaded
 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, create_nominee_info, update_election
+from elections.crud import create_election, update_election
 from elections.tables import Election, NomineeInfo
+from nominees.crud import create_nominee_info
 from officers.constants import OfficerPositionEnum
 from officers.crud import (
     create_new_officer_info,

src/main.py

@@ -9,7 +9,7 @@
 import auth.urls
 import database
 import elections.urls
-import nominee.urls
+import nominees.urls
 import officers.urls
 import permission.urls
 import registrations.urls
@@ -58,7 +58,7 @@
 app.include_router(auth.urls.router)
 app.include_router(elections.urls.router)
 app.include_router(registrations.urls.router)
-app.include_router(nominee.urls.router)
+app.include_router(nominees.urls.router)
 app.include_router(officers.urls.router)
 app.include_router(permission.urls.router)
 

src/nominees/crud.py

@@ -0,0 +1,32 @@
+import sqlalchemy
+from sqlalchemy.ext.asyncio import AsyncSession
+
+from elections.tables import NomineeInfo
+
+
+async def get_nominee_info(
+    db_session: AsyncSession,
+    computing_id: str,
+) -> NomineeInfo | None:
+    return await db_session.scalar(
+        sqlalchemy
+        .select(NomineeInfo)
+        .where(NomineeInfo.computing_id == computing_id)
+    )
+
+async def create_nominee_info(
+    db_session: AsyncSession,
+    info: NomineeInfo,
+):
+    db_session.add(info)
+
+async def update_nominee_info(
+    db_session: AsyncSession,
+    info: NomineeInfo,
+):
+    await db_session.execute(
+        sqlalchemy
+        .update(NomineeInfo)
+        .where(NomineeInfo.computing_id == info.computing_id)
+        .values(info.to_update_dict())
+    )

src/nominee/urls.py renamed to src/nominees/urls.py

@@ -2,8 +2,7 @@
 from fastapi.responses import JSONResponse
 
 import database
-import elections
-import elections.crud
+import nominees.crud
 from elections.models import (
     NomineeInfoModel,
     NomineeInfoUpdateParams,
@@ -32,7 +31,7 @@ async def get_nominee_info(
 ):
     # Putting this one behind the admin wall since it has contact information
     await admin_or_raise(request, db_session)
-    nominee_info = await elections.crud.get_nominee_info(db_session, computing_id)
+    nominee_info = await nominees.crud.get_nominee_info(db_session, computing_id)
     if nominee_info is None:
         raise HTTPException(
             status_code=status.HTTP_404_NOT_FOUND,
@@ -72,13 +71,13 @@ async def provide_nominee_info(
     if body.discord_username is not None:
         updated_data["discord_username"] = body.discord_username
 
-    existing_info = await elections.crud.get_nominee_info(db_session, computing_id)
+    existing_info = await nominees.crud.get_nominee_info(db_session, computing_id)
     # if not already existing, create it
     if not existing_info:
         # unpack dictionary and expand into NomineeInfo class
         new_nominee_info = NomineeInfo(computing_id=computing_id, **updated_data)
         # create a new nominee
-        await elections.crud.create_nominee_info(db_session, new_nominee_info)
+        await nominees.crud.create_nominee_info(db_session, new_nominee_info)
     # else just update the partial data
     else:
         merged_data = {
@@ -92,11 +91,11 @@ async def provide_nominee_info(
         #  update the dictionary with new data
         merged_data.update(updated_data)
         updated_nominee_info = NomineeInfo(**merged_data)
-        await elections.crud.update_nominee_info(db_session, updated_nominee_info)
+        await nominees.crud.update_nominee_info(db_session, updated_nominee_info)
 
     await db_session.commit()
 
-    nominee_info = await elections.crud.get_nominee_info(db_session, computing_id)
+    nominee_info = await nominees.crud.get_nominee_info(db_session, computing_id)
     if not nominee_info:
         raise HTTPException(
             status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,

src/registrations/urls.py

@@ -5,6 +5,7 @@
 
 import database
 import elections.crud
+import nominees.crud
 import registrations.crud
 from elections.models import (
     ElectionStatusEnum,
@@ -81,7 +82,7 @@ async def register_in_election(
             detail=f"invalid position {body.position}"
         )
 
-    if await elections.crud.get_nominee_info(db_session, body.computing_id) is None:
+    if await nominees.crud.get_nominee_info(db_session, body.computing_id) is None:
         # ensure that the user has a nominee info entry before allowing registration to occur.
         raise HTTPException(
             status_code=status.HTTP_400_BAD_REQUEST,

tests/integration/test_elections.py

@@ -10,9 +10,11 @@
 from src.elections.crud import (
     get_all_elections,
     get_election,
-    get_nominee_info,
 )
 from src.main import app
+from src.nominees.crud import (
+    get_nominee_info,
+)
 from src.registrations.crud import (
     get_all_registrations_in_election,
 )