M

my_pr0ject

Личный кабинет студента

Консольное приложение для студента колледжа: оценки, домашние задания с дедлайнами и расписание — в одном меню.

Проблема

Информация об успеваемости, ДЗ и расписании разрознена и теряется: бумажные журналы, чаты старост, устные объявления.

Возможности (Спринт 1)

  • Просмотр оценок (US-01) ✅
  • Каркас меню и навигация ✅
  • Демо-данные: 6 оценок, 6 ДЗ, 6 пар ✅
  • Дашборд, отметка ДЗ, расписание — в следующих спринтах

Запуск

python -m venv .venv && source .venv/bin/activate
pip install -r requirements.txt
python main.py

Возможности (Спринт 2)

  • Просмотр домашних заданий с дедлайнами ✅
  • Добавление ДЗ с валидацией полей ✅
  • Уникальный ID вида HW-ГГГГ-NNN генерируется автоматически ✅
  • Некорректный ввод не роняет программу ✅
  • 14 автотестов (pytest) ✅

Как добавить ДЗ

  1. Запустите python main.py
  2. Выберите пункт 4
  3. Введите предмет, задание и дедлайн в формате ГГГГ-ММ-ДД
  4. Получите подтверждение с присвоенным ID

Возможности (Спринт 3)

  • Поиск ДЗ по ID или предмету ✅
  • Редактирование дедлайна и статуса ✅
  • Удаление с подтверждением (y/n) ✅
  • Обработка несуществующих ID ✅
  • Полный CRUD ✅
  • 27 автотестов ✅

📖 Пользовательские сценарии

Сценарий 1. Первый запуск

  1. Склонируйте репозиторий, установите зависимости.
  2. Запустите python main.py.
  3. Если папки data/ нет — она создастся, а файлы заполнятся демо-данными.
  4. Выберите пункт 3 — увидите список ДЗ.

Сценарий 2. Добавление и сохранение

  1. Пункт 4 → введите предмет, задание, дедлайн.
  2. Получите ✅ Добавлено: HW-2026-007.
  3. Закройте программу (пункт 0) и запустите снова.
  4. Пункт 3 — новая запись на месте. ✅

Сценарий 3. Повреждённый файл

  1. Откройте data/homework.json в блокноте, удалите закрывающую ].
  2. Запустите программу.
  3. Увидите: ⚠️ Файл повреждён. Резервная копия: data/homework.json.bak-....
  4. Программа продолжает работу на демо-данных. Ваш файл не потерян — он в .bak.

Сценарий 4. Запуск в Docker

docker build -t student-cabinet .
docker run -it student-cabinet


### 5. Приёмочный чек-лист (для QA)

| ID | Проверка | Ожидание |
|----|----------|----------|
| AC-12 | Удалить `data/` → запуск | Папка и файлы созданы, меню работает |
| AC-13 | Добавить ДЗ → выйти → зайти | Запись сохранилась |
| AC-14 | Удалить запись → выйти → зайти | Запись не вернулась |
| AC-15 | Пустой файл (`[]`) | «Домашних заданий пока нет», без ошибок |
| AC-16 | Файл с мусором `{not json` | Создан `.bak`, предупреждение, работа продолжается |
| AC-17 | Файл только для чтения (chmod 444) | Программа не падает, изменения не применяются (или предупреждение) |
| AC-18 | `docker build` + `docker run` | Контейнер собирается и запускает меню |

---

## 💻 LD — Безопасное чтение/запись JSON, авто-создание, обработка ошибок

### `storage.py` — новый модуль (вся файловая логика здесь)

```python
"""Безопасное чтение/запись JSON с автосозданием и резервными копиями."""
import json
import shutil
from datetime import datetime
from pathlib import Path
from typing import Any

DATA_DIR = Path(__file__).parent / "data"

# Демо-данные для первого запуска
DEMO_HOMEWORK = [
    {"id": "HW-2026-001", "subject": "Математика", "task": "Решить задачи №1–10", "deadline": "2026-12-12", "done": False},
    {"id": "HW-2026-002", "subject": "Физика", "task": "Лабораторная работа №3", "deadline": "2026-12-13", "done": False},
    {"id": "HW-2026-003", "subject": "Программирование", "task": "Калькулятор на Python", "deadline": "2026-12-15", "done": True},
    {"id": "HW-2026-004", "subject": "История", "task": "Эссе «Реформы Петра I»", "deadline": "2026-12-10", "done": False},
    {"id": "HW-2026-005", "subject": "Английский язык", "task": "Unit 4, упражнения 1–5", "deadline": "2026-12-11", "done": True},
]

DEMO_GRADES = [
    {"subject": "Математика", "grade": 5, "date": "2026-11-02", "teacher": "Иванова А.П."},
    {"subject": "Физика", "grade": 4, "date": "2026-11-03", "teacher": "Петров С.И."},
    {"subject": "Программирование", "grade": 5, "date": "2026-11-05", "teacher": "Сидоров К.В."},
    {"subject": "История", "grade": 4, "date": "2026-11-06", "teacher": "Смирнова Е.А."},
    {"subject": "Английский язык", "grade": 5, "date": "2026-11-07", "teacher": "Кузнецова О.Л."},
]

DEMO_SCHEDULE = [
    {"day": "Понедельник", "time": "09:00–10:30", "subject": "Математика", "room": "301", "teacher": "Иванова А.П."},
    {"day": "Понедельник", "time": "10:45–12:15", "subject": "Программирование", "room": "212", "teacher": "Сидоров К.В."},
    {"day": "Вторник", "time": "09:00–10:30", "subject": "Физика", "room": "105", "teacher": "Петров С.И."},
    {"day": "Среда", "time": "09:00–10:30", "subject": "Базы данных", "room": "212", "teacher": "Морозов Д.Н."},
    {"day": "Четверг", "time": "12:30–14:00", "subject": "История", "room": "204", "teacher": "Смирнова Е.А."},
]


def _ensure_dir() -> None:
    DATA_DIR.mkdir(parents=True, exist_ok=True)


def _backup(path: Path) -> Path:
    """Создаёт .bak-копию файла, возвращает путь к ней."""
    ts = datetime.now().strftime("%Y%m%d-%H%M%S")
    bak = path.with_suffix(path.suffix + f".bak-{ts}")
    shutil.copy2(path, bak)
    return bak


def read_json(filename: str, demo: list[dict[str, Any]]) -> list[dict[str, Any]]:
    """
    US-17/19/20: безопасное чтение.
    - нет файла → создаёт с demo
    - пустой / [] → []
    - битый JSON → делает .bak, создаёт с demo, пишет предупреждение
    """
    _ensure_dir()
    path = DATA_DIR / filename

    if not path.exists():
        write_json(filename, demo)
        print(f"ℹ️  Файл {path} не найден — создан с демо-данными")
        return demo

    try:
        text = path.read_text(encoding="utf-8").strip()
        if not text:
            return []
        data = json.loads(text)
        if not isinstance(data, list):
            raise ValueError("Ожидался список записей")
        return data
    except (json.JSONDecodeError, ValueError) as e:
        bak = _backup(path)
        write_json(filename, demo)
        print(f"⚠️  Файл {path.name} повреждён ({e}). Резервная копия: {bak.name}")
        return demo


def write_json(filename: str, data: list[dict[str, Any]]) -> bool:
    """US-18: атомарная запись. Возвращает True при успехе."""
    _ensure_dir()
    path = DATA_DIR / filename
    tmp = path.with_suffix(path.suffix + ".tmp")
    try:
        tmp.write_text(json.dumps(data, ensure_ascii=False, indent=2), encoding="utf-8")
        tmp.replace(path)  # атомарная замена
        return True
    except OSError as e:
        print(f"❌ Ошибка записи {path.name}: {e}")
        return False

        
# 1. «Чистая» копия
git clone <URL> student-cabinet-fresh
cd student-cabinet-fresh

# 2. По шагам README
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
python main.py <<< "0"
# ожидается: меню, выход без ошибок

# 3. Тесты
pytest -q
# ожидается: 35 passed