File size: 5,962 Bytes
be86a81 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
"""
SQLAlchemy Models for Todo Application
This module defines the database schema for:
- User accounts with password hashing
- Todo items with soft delete support
- Session management for JWT refresh tokens
All models use UUID primary keys and timestamp tracking.
"""
import uuid
from datetime import datetime
from typing import Optional
from sqlalchemy import Boolean, DateTime, String, Text, Enum as SQLEnum, ForeignKey
from sqlalchemy.dialects.postgresql import UUID
from sqlalchemy.orm import Mapped, mapped_column, relationship
from enum import Enum
from src.models.database import Base
# Enums for Todo fields
class TodoStatus(str, Enum):
"""Todo status enumeration"""
PENDING = "pending"
IN_PROGRESS = "in_progress"
COMPLETED = "completed"
class TodoPriority(str, Enum):
"""Todo priority enumeration"""
LOW = "low"
MEDIUM = "medium"
HIGH = "high"
class UserRole(str, Enum):
"""User role enumeration"""
USER = "user"
ADMIN = "admin"
# Model Mixins
class TimestampMixin:
"""Mixin for adding created_at and updated_at timestamps"""
created_at: Mapped[datetime] = mapped_column(
DateTime(timezone=True),
default=lambda: datetime.utcnow(),
nullable=False
)
updated_at: Mapped[datetime] = mapped_column(
DateTime(timezone=True),
default=lambda: datetime.utcnow(),
onupdate=lambda: datetime.utcnow(),
nullable=False
)
# User Model
class User(Base, TimestampMixin):
"""
User account model
Fields:
id: UUID primary key
email: Unique email address (used for login)
password_hash: Bcrypt hashed password
role: User role (user or admin)
is_verified: Email verification status
created_at: Account creation timestamp
updated_at: Last update timestamp
Relationships:
todos: User's todo items
sessions: User's active sessions
"""
__tablename__ = "users"
id: Mapped[uuid.UUID] = mapped_column(
UUID(as_uuid=True),
primary_key=True,
default=uuid.uuid4
)
email: Mapped[str] = mapped_column(
String(255),
unique=True,
index=True,
nullable=False
)
password_hash: Mapped[str] = mapped_column(
String(255),
nullable=False
)
role: Mapped[UserRole] = mapped_column(
SQLEnum(UserRole),
default=UserRole.USER,
nullable=False
)
is_verified: Mapped[bool] = mapped_column(
Boolean,
default=False,
nullable=False
)
# Relationships
todos = relationship("Todo", back_populates="user", cascade="all, delete-orphan")
sessions = relationship("Session", back_populates="user", cascade="all, delete-orphan")
# Todo Model
class Todo(Base, TimestampMixin):
"""
Todo item model with soft delete support
Fields:
id: UUID primary key
user_id: Foreign key to users table
title: Todo title
description: Detailed description (optional)
status: Current status (pending, in_progress, completed)
priority: Priority level (low, medium, high)
due_date: Due date for completion (optional)
category: Category label (optional)
created_at: Creation timestamp
updated_at: Last update timestamp
deleted_at: Soft delete timestamp (null if not deleted)
Relationships:
user: Owner of the todo
"""
__tablename__ = "todos"
id: Mapped[uuid.UUID] = mapped_column(
UUID(as_uuid=True),
primary_key=True,
default=uuid.uuid4
)
user_id: Mapped[uuid.UUID] = mapped_column(
UUID(as_uuid=True),
ForeignKey("users.id", ondelete="CASCADE"),
nullable=False,
index=True
)
title: Mapped[str] = mapped_column(
String(255),
nullable=False
)
description: Mapped[Optional[str]] = mapped_column(
Text,
nullable=True
)
status: Mapped[TodoStatus] = mapped_column(
SQLEnum(TodoStatus),
default=TodoStatus.PENDING,
nullable=False
)
priority: Mapped[TodoPriority] = mapped_column(
SQLEnum(TodoPriority),
default=TodoPriority.MEDIUM,
nullable=False
)
due_date: Mapped[Optional[datetime]] = mapped_column(
DateTime(timezone=True),
nullable=True
)
category: Mapped[Optional[str]] = mapped_column(
String(100),
nullable=True
)
deleted_at: Mapped[Optional[datetime]] = mapped_column(
DateTime(timezone=True),
nullable=True
)
# Relationships
user = relationship("User", back_populates="todos")
# Session Model
class Session(Base, TimestampMixin):
"""
Session model for JWT refresh token management
Fields:
id: UUID primary key
user_id: Foreign key to users table
refresh_token: Hashed refresh token
expires_at: Token expiration timestamp
created_at: Session creation timestamp
revoked_at: Token revocation timestamp (null if active)
Relationships:
user: Owner of the session
"""
__tablename__ = "sessions"
id: Mapped[uuid.UUID] = mapped_column(
UUID(as_uuid=True),
primary_key=True,
default=uuid.uuid4
)
user_id: Mapped[uuid.UUID] = mapped_column(
UUID(as_uuid=True),
ForeignKey("users.id", ondelete="CASCADE"),
nullable=False,
index=True
)
refresh_token: Mapped[str] = mapped_column(
String(500),
unique=True,
index=True,
nullable=False
)
expires_at: Mapped[datetime] = mapped_column(
DateTime(timezone=True),
nullable=False
)
revoked_at: Mapped[Optional[datetime]] = mapped_column(
DateTime(timezone=True),
nullable=True
)
# Relationships
user = relationship("User", back_populates="sessions")
|