Used string based forward refs and typing.TYPE_CHECKING to avoid circular imports

Author: ChrisLovering

api/models/orm/__init__.py

@@ -3,5 +3,4 @@
 from .infraction import Infraction  # noqa: F401
 from .jam import Jam  # noqa: F401
 from .team import Team  # noqa: F401
-from .team_has_users import team_has_users_table  # noqa: F401
 from .user import JamSpecificDetail, User  # noqa: F401

api/models/orm/infraction.py

@@ -3,7 +3,6 @@
 from sqlalchemy import Enum, ForeignKey, String
 from sqlalchemy.orm import Mapped, mapped_column
 
-from api.models.orm import Jam, User
 from api.models.orm.base import Base
 
 InfractionType = Literal["note", "ban", "warning"]
@@ -15,8 +14,8 @@ class Infraction(Base):
     __tablename__ = "infractions"
 
     infraction_id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
-    user_id: Mapped[int] = mapped_column(ForeignKey(User.user_id))
-    issued_in_jam_id: Mapped[int] = mapped_column(ForeignKey(Jam.jam_id))
+    user_id: Mapped[int] = mapped_column(ForeignKey("users.user_id"))
+    issued_in_jam_id: Mapped[int] = mapped_column(ForeignKey("jams.jam_id"))
     infraction_type: Mapped[InfractionType] = mapped_column(
         Enum(*InfractionType.__args__, name="infraction_type_enum"),
         nullable=False,

api/models/orm/jam.py

@@ -1,9 +1,13 @@
+from typing import TYPE_CHECKING
+
 from sqlalchemy import Boolean, String
 from sqlalchemy.orm import Mapped, mapped_column, relationship
 
-from api.models.orm import Team
 from api.models.orm.base import Base
 
+if TYPE_CHECKING:
+    from api.models.orm import Team
+
 
 class Jam(Base):
     """A code jam."""
@@ -14,4 +18,4 @@ class Jam(Base):
     name: Mapped[str] = mapped_column(String(), nullable=False)
     ongoing: Mapped[bool] = mapped_column(Boolean, nullable=False, default=False)
 
-    teams: Mapped[list[Team]] = relationship()
+    teams: Mapped[list["Team"]] = relationship()

api/models/orm/team.py

@@ -1,8 +1,13 @@
+from typing import TYPE_CHECKING
+
 from sqlalchemy import BigInteger, Boolean, ForeignKey, Index, String, text
 from sqlalchemy.orm import Mapped, mapped_column, relationship
 
-from api.models.orm import Jam, User, team_has_users_table
 from api.models.orm.base import Base
+from api.models.orm.team_has_users import team_has_users_table
+
+if TYPE_CHECKING:
+    from api.models.orm import User
 
 
 class Team(Base):
@@ -11,8 +16,8 @@ class Team(Base):
     __tablename__ = "teams"
 
     team_id: Mapped[int] = mapped_column(primary_key=True)
-    jam_id: Mapped[int] = mapped_column(ForeignKey(Jam.jam_id))
-    leader_id: Mapped[int] = mapped_column(ForeignKey(User.user_id))
+    jam_id: Mapped[int] = mapped_column(ForeignKey("jams.jam_id"))
+    leader_id: Mapped[int] = mapped_column(ForeignKey("users.user_id"))
     name: Mapped[str] = mapped_column(String(), nullable=False)
 
     # These two fields are nullable to accommodate historic data
@@ -23,8 +28,8 @@ class Team(Base):
     winner: Mapped[bool] = mapped_column(Boolean, nullable=True)
     first_place_winner: Mapped[bool] = mapped_column(Boolean, nullable=True)
 
-    users: Mapped[list[User]] = relationship(
+    users: Mapped[list["User"]] = relationship(
         secondary=team_has_users_table,
         back_populates="teams",
     )
-    __table_args__ = Index("team_name_jam_unique", text("lower(name)"), "jam_id", unique=True)
+    __table_args__ = (Index("team_name_jam_unique", text("lower(name)"), "jam_id", unique=True),)

api/models/orm/team_has_users.py

@@ -5,6 +5,6 @@
 team_has_users_table = Table(
     "team_has_users",
     Base.metadata,
-    Column("team_id", ForeignKey("teams.id"), primary_key=True),
-    Column("user_id", ForeignKey("users.id"), primary_key=True),
+    Column("team_id", ForeignKey("teams.team_id"), primary_key=True),
+    Column("user_id", ForeignKey("users.user_id"), primary_key=True),
 )

api/models/orm/user.py

@@ -1,22 +1,26 @@
-from typing import Literal
+from typing import TYPE_CHECKING, Literal
 
 from sqlalchemy import BigInteger, Boolean, Enum, ForeignKey, String
 from sqlalchemy.orm import Mapped, mapped_column, relationship
 
-from api.models.orm import Jam, Team, team_has_users_table
 from api.models.orm.base import Base
+from api.models.orm.team_has_users import team_has_users_table
 
 ExperienceLevels = Literal["beginner", "decent", "expierienced", "very_expierienced"]
 
 
+if TYPE_CHECKING:
+    from api.models.orm import Team
+
+
 class User(Base):
     """A user who has participated in a code jam."""
 
     __tablename__ = "users"
 
     user_id: Mapped[int] = mapped_column(BigInteger, primary_key=True, autoincrement=False)
 
-    teams: Mapped[list[Team]] = relationship(
+    teams: Mapped[list["Team"]] = relationship(
         secondary=team_has_users_table,
         back_populates="users",
     )
@@ -29,8 +33,8 @@ class JamSpecificDetail(Base):
     __tablename__ = "jam_specific_details"
 
     jam_specific_detail_id: Mapped[int] = mapped_column(primary_key=True)
-    user_id: Mapped[int] = mapped_column(ForeignKey(User.id))
-    jam_id: Mapped[int] = mapped_column(ForeignKey(Jam.jam_id))
+    user_id: Mapped[int] = mapped_column(ForeignKey(User.user_id))
+    jam_id: Mapped[int] = mapped_column(ForeignKey("jams.jam_id"))
     experience_level_git: Mapped[ExperienceLevels] = mapped_column(
         Enum(*ExperienceLevels.__args__, name="experience_level_git_enum"),
         nullable=False,