models.py

from enum import Enum
from typing import Optional

from pydantic import BaseModel


class User(BaseModel):
    """A model respresenting a user for a codejam."""

    user_id: int
    is_leader: bool

    class Config:
        """Sets ORM mode to true so that pydantic will validate the objects returned by SQLAlchemy."""

        orm_mode = True


class Team(BaseModel):
    """A model representing a team for a codejam."""

    name: str
    users: list[User]
    discord_role_id: Optional[int] = None
    discord_channel_id: Optional[int] = None


class CodeJam(BaseModel):
    """A model representing a codejam."""

    name: str
    teams: list[Team]
    ongoing: bool = False


class InfractionType(str, Enum):
    """An enumeration of codejam infraction types."""

    note = "note"
    ban = "ban"
    warning = "warning"


class Infraction(BaseModel):
    """A model representing an infraction."""

    user_id: int
    jam_id: int
    reason: str
    infraction_type: InfractionType


class Winner(BaseModel):
    """A model representing a codejam winner."""

    user_id: int
    first_place: bool

    class Config:
        """Sets ORM mode to true so that pydantic will validate the objects returned by SQLAlchemy."""

        orm_mode = True


class WinnerResponse(Winner):
    """Response model representing a codejam winner."""

    jam_id: int


class TeamResponse(Team):
    """Response model representing a team."""

    id: int
    jam_id: int

    class Config:
        """Sets ORM mode to true so that pydantic will validate the objects returned by SQLAlchemy."""

        orm_mode = True


class InfractionResponse(Infraction):
    """Reponse model representing an infraction."""

    id: int

    class Config:
        """Sets ORM mode to true so that pydantic will validate the objects returned by SQLAlchemy."""

        orm_mode = True


class ParticipationHistory(BaseModel):
    """A model representing the participathon history of a user in a codejam."""

    jam_id: int
    top_10: bool
    first_place: bool
    team_id: int
    is_leader: bool
    infractions: list[InfractionResponse]

    class Config:
        """Sets ORM mode to true so that pydantic will validate the objects returned by SQLAlchemy."""

        orm_mode = True


class UserResponse(BaseModel):
    """Response model representing a user."""

    id: int
    participation_history: list[ParticipationHistory]

    class Config:
        """Sets ORM mode to true so that pydantic will validate the objects returned by SQLAlchemy."""

        orm_mode = True


class CodeJamResponse(CodeJam):
    """Response model representing a code jam."""

    id: int
    teams: list[TeamResponse]
    infractions: list[InfractionResponse]
    winners: list[Winner]

    class Config:
        """Sets ORM mode to true so that pydantic will validate the objects returned by SQLAlchemy."""

        orm_mode = True


class UserTeamResponse(BaseModel):
    """Response model representing user and team relationship."""

    user_id: int
    team: TeamResponse
    is_leader: bool

    class Config:
        """Sets ORM mode to true so that pydantic will validate the objects returned by SQLAlchemy."""

        orm_mode = True