feat: replace is_admin and is_teacher with status and role enums

Author: brandonzorn

asuschedule/enums.py

@@ -0,0 +1,17 @@
+from enum import StrEnum
+
+
+class UserRole(StrEnum):
+    STUDENT = "student"
+    TEACHER = "teacher"
+
+
+class UserStatus(StrEnum):
+    USER = "user"
+    ADMIN = "admin"
+
+
+__all__ = [
+    "UserRole",
+    "UserStatus",
+]

asuschedule/handlers/staff_handlers.py

@@ -8,6 +8,7 @@
 from telegram.ext import CommandHandler, ContextTypes
 
 from database import session
+from enums import UserStatus, UserRole
 from models import Schedule, User
 from utils import require_staff
 
@@ -17,7 +18,7 @@
 
 @require_staff
 async def users_list(update: Update, _):
-    users = session.query(User).order_by(User.is_teacher).all()
+    users = session.query(User).order_by(User.role).all()
     chunk_size = 15
     user_chunks = [users[i:i + chunk_size] for i in range(0, len(users), chunk_size)]
 
@@ -35,7 +36,7 @@ async def users_stats(update: Update, _):
     await update.message.reply_text(
         f"📊 <b>Статистика пользователей:</b>\n\n"
         f"▪️ Всего пользователей: {len(users)}\n"
-        f"▪️ Преподавателей: {len([i for i in users if i.is_teacher])}\n"
+        f"▪️ Преподавателей: {len([i for i in users if i.role == UserRole.TEACHER])}\n"
         f"▪️ Включена ежедневная рассылка: {len([i for i in users if i.daily_notify])}",
         parse_mode=ParseMode.HTML,
     )
@@ -106,7 +107,7 @@ async def error_handler(update: object, context: ContextTypes.DEFAULT_TYPE) -> N
         f"<pre>{html.escape(tb_string)}</pre>"
     )
 
-    admin_user = session.query(User).filter_by(is_admin=True).first()
+    admin_user = session.query(User).filter_by(status=UserStatus.ADMIN).first()
     if admin_user:
         await context.bot.send_message(
             chat_id=admin_user.id,

asuschedule/models.py

@@ -1,7 +1,8 @@
-from sqlalchemy import Boolean, Column, ForeignKey, Integer, String
+from sqlalchemy import Boolean, Column, ForeignKey, Integer, String, Enum
 from sqlalchemy.orm import declarative_base, relationship
 
 from consts import LESSON_TIMES
+from enums import UserRole, UserStatus
 
 Base = declarative_base()
 
@@ -29,35 +30,32 @@ class User(Base):
     name = Column(String, nullable=False)
     subgroup = Column(Integer, nullable=True)  # Подгруппа (1 или 2)
     group_id = Column(Integer, ForeignKey("groups.id"))
-    is_teacher = Column(Boolean, default=False, nullable=True)
-    is_admin = Column(Boolean, default=False, nullable=True)
+    role = Column(Enum(UserRole), default=UserRole.STUDENT, nullable=False)
+    status = Column(Enum(UserStatus), default=UserStatus.USER, nullable=False)
     daily_notify = Column(Boolean, default=False, nullable=True)
     notify_time = Column(Integer, default=8, nullable=False)  # Время рассылки (8 или 20)
     teacher_name = Column(String, nullable=True)
 
     group = relationship("Group", back_populates="users")
 
-    def is_staff(self) -> bool:
-        return bool(self.is_admin)
-
     def make_teacher(self, teacher_name: str) -> None:
         self.subgroup = None
         self.group_id = None
 
-        self.is_teacher = True
+        self.role = UserRole.TEACHER
         self.teacher_name = teacher_name
 
     def make_student(self, group_id: int, subgroup: int) -> None:
-        self.is_teacher = False
+        self.role = UserRole.STUDENT
         self.teacher_name = None
 
         self.subgroup = subgroup
         self.group_id = group_id
 
     def _get_status_str(self) -> str:
-        if self.is_admin:
+        if self.status == UserStatus.ADMIN:
             return "Администратор"
-        if self.is_teacher:
+        if self.role == UserRole.TEACHER:
             return "Преподаватель"
         return "Пользователь"
 
@@ -66,7 +64,7 @@ def to_text(self) -> str:
         notify_status = "Включена" if self.daily_notify else "Выключена"
         notify_time_str = f"{self.notify_time}:00" if self.daily_notify else "-"
 
-        if self.is_teacher:
+        if self.role == UserRole.TEACHER:
             return (
                 f"👤 Имя пользователя: {self.name}\n"
                 f"🧑‍🏫 Преподаватель: {self.teacher_name or 'Не указано'}\n"
@@ -107,14 +105,14 @@ class Schedule(Base):
 
     group = relationship("Group", back_populates="schedules")
 
-    def to_text(self, is_requesting_teacher: bool = False) -> str:
+    def to_text(self, requesting_role: UserRole) -> str:
         start_time, end_time = LESSON_TIMES.get(self.lesson_number, ("-", "-"))
         details = [
             f"Предмет: {self.subject or 'не указано'}",
             f"Формат: {self.lesson_type or 'не указано'}",
             f"Кабинет: {self.room or 'не указано'}",
         ]
-        if is_requesting_teacher:
+        if requesting_role == UserRole.TEACHER:
             details.append(
                 f"Группа: {self.group.get_short_name() if self.group else '??'}",
             )

asuschedule/schedules/schedules.py

@@ -1,6 +1,7 @@
 from sqlalchemy import or_
 
 from database import session
+from enums import UserRole
 from models import Schedule, User
 
 
@@ -14,7 +15,7 @@ def get_schedules(
         is_even_week=even_week,
         day_of_week=weekday,
     )
-    if user.is_teacher:
+    if user.role == UserRole.TEACHER:
         query = query.filter(
             Schedule.teacher.ilike(f"%{user.teacher_name}%"),
         )

asuschedule/schedules/schedules_text.py

@@ -15,12 +15,12 @@ def _build_schedule_text(
     if not schedules:
         schedule_text += "🎉 Занятий нет."
     for schedule in schedules:
-        schedule_text += f"{schedule.to_text(user.is_teacher)}━━━━━━━━━━━━━━━━━━\n"
+        schedule_text += f"{schedule.to_text(user.role)}━━━━━━━━━━━━━━━━━━\n"
     return schedule_text
 
 
 def get_next_lesson_text(user: User, schedule: Schedule) -> str:
-    return f"<b>🔔 Следующая пара:</b>\n\n{schedule.to_text(user.is_teacher)}"
+    return f"<b>🔔 Следующая пара:</b>\n\n{schedule.to_text(user.role)}"
 
 
 def get_schedule_text(

asuschedule/utils.py

@@ -5,6 +5,7 @@
 
 from config import INVERT_WEEK_PARITY
 from database import session
+from enums import UserRole, UserStatus
 from models import User
 
 
@@ -26,7 +27,7 @@ async def wrapper(
             update: Update, context: ContextTypes.DEFAULT_TYPE, *args, **kwargs,
     ):
         user = session.query(User).filter_by(id=update.effective_user.id).first()
-        if user is None or (not user.is_teacher and user.group_id is None):
+        if user is None or (not user.role == UserRole.TEACHER and user.group_id is None):
             await update.message.reply_text(
                 "Вы не зарегистрированы или не завершили настройку. "
                 "Пожалуйста, начните с команды /start.",
@@ -42,7 +43,7 @@ async def wrapper(
             update: Update, context: ContextTypes.DEFAULT_TYPE, *args, **kwargs,
     ):
         user = session.query(User).filter_by(id=update.effective_user.id).first()
-        if user is None or not user.is_staff():
+        if user is None or not user.status == UserStatus.ADMIN:
             await update.message.reply_text(
                 "⛔ У вас нет доступа к этой команде.",
             )