🗃️ Add basic models

alembic-migrations/script.py.mako

@@ -1,4 +1,6 @@
-"""${message}
+# ruff: noqa: D103, D212, D400, D415, INP001
+"""
+${message}
 
 Revision ID: ${up_revision}
 Revises: ${down_revision | comma,n}

pyproject.toml

@@ -214,6 +214,10 @@ reportUnknownMemberType = false
 reportUnknownParameterType = false
 reportUnknownLambdaType = false
 
+executionEnvironments = [
+  { root = "src/db_tables", reportImportCycles = false },
+]
+
 [tool.pytest.ini_options]
 minversion = "6.0"
 asyncio_mode = "auto"

src/db_tables/_media.py

@@ -0,0 +1,15 @@
+from sqlalchemy import ForeignKey
+from sqlalchemy.orm import Mapped, mapped_column
+
+# Prevent circular imports for relationships
+
+
+class Media:
+    """Represents a media object in the database. DO NOT USE DIRECTLY."""
+
+    id: Mapped[int] = mapped_column(primary_key=True, index=True, nullable=False)
+
+    favorite: Mapped[bool] = mapped_column(default=False)
+    watched: Mapped[bool] = mapped_column(default=False)
+
+    user_id: Mapped[int] = mapped_column(ForeignKey("user.id"), nullable=False)

src/db_tables/episode.py

@@ -0,0 +1,25 @@
+from typing import TYPE_CHECKING
+
+from sqlalchemy import ForeignKey
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+
+from src.utils.database import Base
+
+# Prevent circular imports for relationships
+if TYPE_CHECKING:
+    from src.db_tables.show import Show
+    from src.db_tables.user import User
+
+
+class Episode(Base):
+    """User database table."""
+
+    __tablename__ = "episode"
+
+    id: Mapped[int] = mapped_column(primary_key=True, index=True, nullable=False)
+
+    show_id: Mapped[int] = mapped_column(ForeignKey("user.id"), nullable=False)
+    tvdb_id: Mapped[int] = mapped_column(nullable=False)
+
+    show: Mapped["Show"] = relationship(lazy="selectin", back_populates="episodes")
+    user: Mapped["User"] = relationship(lazy="selectin", back_populates="shows")

src/db_tables/movie.py

@@ -0,0 +1,17 @@
+from typing import TYPE_CHECKING
+
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+
+from src.db_tables._media import Media
+from src.utils.database import Base
+
+if TYPE_CHECKING:
+    from src.db_tables.user import User
+
+
+class Movie(Media, Base):
+    """User database table."""
+
+    user: Mapped["User"] = relationship(lazy="selectin", back_populates="movies")
+    tvdb_id: Mapped[int] = mapped_column(nullable=False)
+    __tablename__ = "movie"

src/db_tables/show.py

@@ -0,0 +1,26 @@
+from typing import TYPE_CHECKING
+
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+
+from src.db_tables._media import Media
+from src.utils.database import Base
+
+if TYPE_CHECKING:
+    from src.db_tables.episode import Episode
+    from src.db_tables.user import User
+
+
+class Show(Media, Base):
+    """User database table."""
+
+    __tablename__ = "show"
+
+    user: Mapped["User"] = relationship(lazy="selectin", back_populates="shows")
+    tvdb_id: Mapped[int] = mapped_column(nullable=False)
+
+    # contains episodes whose watch state is different from the show's
+    episodes: Mapped[list["Episode"]] = relationship(
+        lazy="selectin",
+        back_populates="show",
+        cascade="all, delete-orphan",
+    )

src/db_tables/user.py

@@ -0,0 +1,30 @@
+from typing import TYPE_CHECKING
+
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+
+from src.utils.database import Base
+
+# Prevent circular imports for relationships
+if TYPE_CHECKING:
+    from src.db_tables.movie import Movie
+    from src.db_tables.show import Show
+
+
+class User(Base):
+    """User database table."""
+
+    __tablename__ = "user"
+
+    id: Mapped[int] = mapped_column(primary_key=True, index=True, nullable=False)
+
+    shows: Mapped[list["Show"]] = relationship(
+        lazy="selectin",
+        back_populates="user",
+        cascade="all, delete-orphan",
+    )
+
+    movies: Mapped[list["Movie"]] = relationship(
+        lazy="selectin",
+        back_populates="user",
+        cascade="all, delete-orphan",
+    )