chore(tables): rename the rest of the DB tables

Author: jbriones1

src/auth/crud.py

@@ -4,7 +4,7 @@
 import sqlalchemy
 from sqlalchemy.ext.asyncio import AsyncSession
 
-from auth.tables import SiteUserDB, UserSession
+from auth.tables import SiteUserDB, UserSessionDB
 
 _logger = logging.getLogger(__name__)
 
@@ -16,7 +16,7 @@ async def create_user_session(db_session: AsyncSession, session_id: str, computi
     Also, adds the new user to the SiteUser table if it's their first time logging in.
     """
     existing_user_session = await db_session.scalar(
-        sqlalchemy.select(UserSession).where(UserSession.computing_id == computing_id)
+        sqlalchemy.select(UserSessionDB).where(UserSessionDB.computing_id == computing_id)
     )
     existing_user = await db_session.scalar(
         sqlalchemy.select(SiteUserDB).where(SiteUserDB.computing_id == computing_id)
@@ -40,7 +40,7 @@ async def create_user_session(db_session: AsyncSession, session_id: str, computi
             existing_user.last_logged_in = datetime.now(UTC)
     else:
         db_session.add(
-            UserSession(
+            UserSessionDB(
                 session_id=session_id,
                 computing_id=computing_id,
                 issue_time=datetime.now(UTC),
@@ -49,13 +49,13 @@ async def create_user_session(db_session: AsyncSession, session_id: str, computi
 
 
 async def remove_user_session(db_session: AsyncSession, session_id: str):
-    query = sqlalchemy.select(UserSession).where(UserSession.session_id == session_id)
+    query = sqlalchemy.select(UserSessionDB).where(UserSessionDB.session_id == session_id)
     user_session = await db_session.scalars(query)
     await db_session.delete(user_session.first())
 
 
 async def get_computing_id(db_session: AsyncSession, session_id: str) -> str | None:
-    query = sqlalchemy.select(UserSession).where(UserSession.session_id == session_id)
+    query = sqlalchemy.select(UserSessionDB).where(UserSessionDB.session_id == session_id)
     existing_user_session = (await db_session.scalars(query)).first()
     return existing_user_session.computing_id if existing_user_session else None
 
@@ -64,14 +64,14 @@ async def get_computing_id(db_session: AsyncSession, session_id: str) -> str | N
 async def task_clean_expired_user_sessions(db_session: AsyncSession):
     one_day_ago = datetime.now(UTC) - timedelta(days=0.5)
 
-    query = sqlalchemy.delete(UserSession).where(UserSession.issue_time < one_day_ago)
+    query = sqlalchemy.delete(UserSessionDB).where(UserSessionDB.issue_time < one_day_ago)
     await db_session.execute(query)
     await db_session.commit()
 
 
 # get the site user given a session ID; returns None when session is invalid
 async def get_site_user(db_session: AsyncSession, session_id: str) -> SiteUserDB | None:
-    query = sqlalchemy.select(UserSession).where(UserSession.session_id == session_id)
+    query = sqlalchemy.select(UserSessionDB).where(UserSessionDB.session_id == session_id)
     user_session = await db_session.scalar(query)
     if user_session is None:
         return None
@@ -87,7 +87,7 @@ async def site_user_exists(db_session: AsyncSession, computing_id: str) -> bool:
 
 # update the optional user info for a given site user (e.g., display name, profile picture, ...)
 async def update_site_user(db_session: AsyncSession, session_id: str, profile_picture_url: str) -> bool:
-    query = sqlalchemy.select(UserSession).where(UserSession.session_id == session_id)
+    query = sqlalchemy.select(UserSessionDB).where(UserSessionDB.session_id == session_id)
     user_session = await db_session.scalar(query)
     if user_session is None:
         return False

src/auth/tables.py

@@ -7,7 +7,7 @@
 from database import Base
 
 
-class UserSession(Base):
+class UserSessionDB(Base):
     __tablename__ = "user_session"
 
     computing_id: Mapped[str] = mapped_column(

src/blog/tables.py

@@ -6,7 +6,7 @@
 
 
 # blog table
-class BlogPosts(Base):
+class BlogPostsDB(Base):
     # table name
     __tablename__ = "blog_posts"
 

src/load_test_db.py

@@ -15,7 +15,7 @@
 from elections.crud import create_election, update_election
 from elections.tables import ElectionDB
 from nominees.crud import create_nominee_info
-from nominees.tables import NomineeInfo
+from nominees.tables import NomineeInfoDB
 from officers.constants import OfficerPositionEnum
 from officers.crud import (
     create_new_officer_info,
@@ -397,7 +397,7 @@ async def load_test_elections_data(db_session: AsyncSession):
     )
     await create_nominee_info(
         db_session,
-        NomineeInfo(
+        NomineeInfoDB(
             computing_id="jdo12",
             full_name="John Doe",
             linked_in="linkedin.com/john-doe",
@@ -408,7 +408,7 @@ async def load_test_elections_data(db_session: AsyncSession):
     )
     await create_nominee_info(
         db_session,
-        NomineeInfo(
+        NomineeInfoDB(
             computing_id="pkn4",
             full_name="Puneet North",
             linked_in="linkedin.com/john-doe3",

src/nominees/crud.py

@@ -3,48 +3,43 @@
 import sqlalchemy
 from sqlalchemy.ext.asyncio import AsyncSession
 
-from nominees.tables import NomineeInfo
+from nominees.tables import NomineeInfoDB
 
 
 async def get_all_nominees(
     db_session: AsyncSession,
-) -> Sequence[NomineeInfo]:
-    nominees = (await db_session.scalars(
-        sqlalchemy
-        .select(NomineeInfo)
-    )).all()
+) -> Sequence[NomineeInfoDB]:
+    nominees = (await db_session.scalars(sqlalchemy.select(NomineeInfoDB))).all()
     return nominees
 
+
 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))
+) -> NomineeInfoDB | None:
+    return await db_session.scalar(sqlalchemy.select(NomineeInfoDB).where(NomineeInfoDB.computing_id == computing_id))
 
 
 async def create_nominee_info(
     db_session: AsyncSession,
-    info: NomineeInfo,
+    info: NomineeInfoDB,
 ):
     db_session.add(info)
 
 
 async def update_nominee_info(
     db_session: AsyncSession,
-    info: NomineeInfo,
+    info: NomineeInfoDB,
 ):
     await db_session.execute(
-        sqlalchemy.update(NomineeInfo)
-        .where(NomineeInfo.computing_id == info.computing_id)
+        sqlalchemy.update(NomineeInfoDB)
+        .where(NomineeInfoDB.computing_id == info.computing_id)
         .values(info.to_update_dict())
     )
 
+
 async def delete_nominee_info(
-        db_session: AsyncSession,
-        computing_id: str,
+    db_session: AsyncSession,
+    computing_id: str,
 ):
-    await db_session.execute(
-        sqlalchemy
-        .delete(NomineeInfo)
-        .where(NomineeInfo.computing_id == computing_id)
-    )
+    await db_session.execute(sqlalchemy.delete(NomineeInfoDB).where(NomineeInfoDB.computing_id == computing_id))

src/nominees/tables.py

@@ -10,7 +10,7 @@
 from database import Base
 
 
-class NomineeInfo(Base):
+class NomineeInfoDB(Base):
     __tablename__ = "election_nominee_info"
 
     computing_id: Mapped[str] = mapped_column(String(COMPUTING_ID_LEN), primary_key=True)

src/nominees/urls.py

@@ -8,7 +8,7 @@
     NomineeInfoModel,
     NomineeInfoUpdateParams,
 )
-from nominees.tables import NomineeInfo
+from nominees.tables import NomineeInfoDB
 from utils.shared_models import DetailModel
 
 router = APIRouter(
@@ -45,7 +45,7 @@ async def get_all_nominees(
 async def create_nominee(db_session: database.DBSession, body: NomineeInfoModel):
     await nominees.crud.create_nominee_info(
         db_session,
-        NomineeInfo(
+        NomineeInfoDB(
             computing_id=body.computing_id,
             full_name=body.full_name,
             linked_in=body.linked_in,
@@ -120,7 +120,7 @@ async def provide_nominee_info(db_session: database.DBSession, body: NomineeInfo
     # 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)
+        new_nominee_info = NomineeInfoDB(computing_id=computing_id, **updated_data)
         # create a new nominee
         await nominees.crud.create_nominee_info(db_session, new_nominee_info)
     # else just update the partial data
@@ -135,7 +135,7 @@ async def provide_nominee_info(db_session: database.DBSession, body: NomineeInfo
         }
         #  update the dictionary with new data
         merged_data.update(updated_data)
-        updated_nominee_info = NomineeInfo(**merged_data)
+        updated_nominee_info = NomineeInfoDB(**merged_data)
         await nominees.crud.update_nominee_info(db_session, updated_nominee_info)
 
     await db_session.commit()