Changed election parameters from a list to a dedicated dataclass, reflected changes across urls.py

Author: DerpyWasHere

src/elections/crud.py

@@ -1,5 +1,5 @@
-import dataclasses
 import logging
+from dataclasses import dataclass
 from datetime import datetime
 
 import sqlalchemy
@@ -9,6 +9,21 @@
 from officers.constants import OfficerPosition
 from officers.tables import OfficerInfo, OfficerTerm
 
+
+@dataclass
+class ElectionParameters:
+    """
+    Dataclass encompassing the data that can go into an Election.
+    """
+    slug: str
+    name: str
+    officer_id: str
+    type: str
+    date: datetime
+    end_date: datetime
+    survey_link: str
+
+
 _logger = logging.getLogger(__name__)
 
 async def get_election(db_session: database.DBSession, election_slug: str) -> Election | None:
@@ -20,18 +35,18 @@ async def get_election(db_session: database.DBSession, election_slug: str) -> El
     result = await db_session.scalar(query)
     return result
 
-async def create_election(params: dict[str, datetime], db_session: database.DBSession) -> None:
+async def create_election(params: ElectionParameters, db_session: database.DBSession) -> None:
     """
     Creates a new election with given parameters.
     Does not validate if an election _already_ exists
     """
-    election = Election(slug=params["slug"],
-               name=params["name"],
-               officer_id=params["officer_id"],
-               type=params["type"],
-               date=params["date"],
-               end_date=params["end_date"],
-               websurvey=params["websurvey"])
+    election = Election(slug=params.slug,
+               name=params.name,
+               officer_id=params.officer_id,
+               type=params.type,
+               date=params.date,
+               end_date=params.end_date,
+               survey_link=params.survey_link)
     db_session.add(election)
 
 async def delete_election(slug: str, db_session: database.DBSession) -> None:
@@ -42,25 +57,25 @@ async def delete_election(slug: str, db_session: database.DBSession) -> None:
     query = sqlalchemy.delete(Election).where(Election.slug == slug)
     await db_session.execute(query)
 
-async def update_election(params: dict[str, datetime], db_session: database.DBSession) -> None:
+async def update_election(params: ElectionParameters, db_session: database.DBSession) -> None:
     """
     Updates an election with the provided parameters.
     Take care as this will replace values with None if not populated.
     You _cannot_ change the name or slug, you should instead delete and create a new election.
     Does not validate if an election _already_ exists
     """
 
-    election = (await db_session.execute(sqlalchemy.select(Election).filter_by(slug=params["slug"]))).scalar_one()
+    election = (await db_session.execute(sqlalchemy.select(Election).filter_by(slug=params.slug))).scalar_one()
 
-    if params["date"] is not None:
-        election.date = params["date"]
-    if params["type"] is not None:
-        election.type = params["type"]
-    if params["end_date"] is not None:
-        election.end_date = params["end_date"]
-    if params["websurvey"] is not None:
-        election.websurvey = params["websurvey"]
+    if params.date is not None:
+        election.date = params.date
+    if params.type is not None:
+        election.type = params.type
+    if params.end_date is not None:
+        election.end_date = params.end_date
+    if params.survey_link is not None:
+        election.survey_link = params.survey_link
 
-    query = sqlalchemy.update(Election).where(Election.slug == params["slug"]).values(election)
+    query = sqlalchemy.update(Election).where(Election.slug == params.slug).values(election)
     await db_session.execute(query)
 

src/elections/urls.py

@@ -7,6 +7,7 @@
 
 import requests  # TODO: make this async
 import xmltodict
+from crud import ElectionParameters
 from fastapi import APIRouter, BackgroundTasks, FastAPI, HTTPException, Request, status
 from fastapi.exceptions import RequestValidationError
 from tables import election_types
@@ -53,7 +54,7 @@ async def create_election(
     election_type: str,
     date: datetime | None = None,
     end_date: datetime | None = None,
-    websurvey: str | None = None
+    survey_link: str | None = None
 ):
     """
     aaa
@@ -75,15 +76,15 @@ async def create_election(
     if election_type not in election_types:
         raise RequestValidationError()
 
-    params = {
-        "slug" : _slugify(name),
-        "name": name,
-        "officer_id" : await auth.crud.get_computing_id(db_session, session_id),
-        "type": election_type,
-        "date": date,
-        "end_date": end_date,
-        "websurvey": websurvey
-    }
+    params = ElectionParameters(
+        _slugify(name),
+        name,
+        await auth.crud.get_computing_id(db_session, session_id),
+        election_type,
+        date,
+        end_date,
+        survey_link
+    )
 
     await elections.crud.create_election(params, db_session)
     await db_session.commit()
@@ -127,7 +128,7 @@ async def update_election(
     election_type: str,
     date: datetime | None = None,
     end_date: datetime | None = None,
-    websurvey: str | None = None
+    survey_link: str | None = None
 ):
     session_id = request.cookies.get("session_id", None)
     user_auth = await _validate_user(db_session, session_id)
@@ -139,15 +140,15 @@ async def update_election(
             headers={"WWW-Authenticate": "Basic"},
         )
     if slug is not None:
-        params = {
-            "slug" : slug,
-            "name" : name,
-            "officer_id" : await auth.crud.get_computing_id(db_session, session_id),
-            "type": election_type,
-            "date": date,
-            "end_date": end_date,
-            "websurvey": websurvey
-        }
+        params = ElectionParameters(
+            _slugify(name),
+            name,
+            await auth.crud.get_computing_id(db_session, session_id),
+            election_type,
+            date,
+            end_date,
+            survey_link
+        )
         await elections.crud.update_election(params, db_session)
         await db_session.commit()