ScoDoc/app/scodoc/sco_modalites.py

# -*- mode: python -*-
# -*- coding: utf-8 -*-

##############################################################################
#
# Gestion scolarite IUT
#
# Copyright (c) 1999 - 2024 Emmanuel Viennet.  All rights reserved.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
#   Emmanuel Viennet      emmanuel.viennet@viennet.net
#
##############################################################################

"""Modalites des semestres

La "modalite" est utilisee pour organiser les listes de semestres sur la page d'accueil.

Elle n'est pas utilisée pour les parcours, ni pour rien d'autre
(c'est donc un attribut "cosmétique").

"""
import collections
import app.scodoc.notesdb as ndb
from app import log
from app.models import FormSemestre


def list_formsemestres_modalites(formsemestres: list[FormSemestre]) -> list[dict]:
    """Liste ordonnée des modalités présentes dans ces formsemestres"""
    modalites = {}
    for formsemestre in formsemestres:
        if formsemestre.modalite not in modalites:
            m = do_modalite_list(args={"modalite": formsemestre.modalite})[0]
            modalites[m["modalite"]] = m
    modalites = list(modalites.values())
    modalites.sort(key=lambda x: x["numero"])
    return modalites


def group_formsemestres_by_modalite(
    formsemestres: list[FormSemestre],
) -> dict[str, list[FormSemestre]]:
    """Given the list of formsemestre, group them by modalite,
    sorted in each one by semestre id and date
    """
    sems_by_mod = collections.defaultdict(list)
    modalites = list_formsemestres_modalites(formsemestres)
    sems_by_mod = {
        modalite["modalite"]: [
            formsemestre
            for formsemestre in formsemestres
            if formsemestre.modalite == modalite["modalite"]
        ]
        for modalite in modalites
    }
    # tri dans chaque modalité par indice de semestre et date debut
    for modalite in modalites:
        sems_by_mod[modalite["modalite"]].sort(
            key=lambda x: (
                x.semestre_id if x.semestre_id > 0 else -1000 * x.semestre_id,
                x.date_debut,
            )
        )

    return sems_by_mod, modalites


# ------ Low level interface (database) ------

_modaliteEditor = ndb.EditableTable(
    "notes_form_modalites",
    "form_modalite_id",
    ("form_modalite_id", "modalite", "titre", "numero"),
    sortkey="numero",
    output_formators={"numero": ndb.int_null_is_zero},
)


def do_modalite_list(*args, **kw):
    """Liste des modalites"""
    cnx = ndb.GetDBConnexion()
    return _modaliteEditor.list(cnx, *args, **kw)


def do_modalite_create(args):
    "create a modalite"
    cnx = ndb.GetDBConnexion()
    r = _modaliteEditor.create(cnx, args)
    return r


def do_modalite_delete(oid):
    "delete a modalite"
    cnx = ndb.GetDBConnexion()
    log("do_modalite_delete: form_modalite_id=%s" % oid)
    _modaliteEditor.delete(cnx, oid)


def do_modalite_edit(*args, **kw):  # unused
    "edit a modalite"
    cnx = ndb.GetDBConnexion()
    # check
    _ = do_modalite_list({"form_modalite_id": args[0]["form_modalite_id"]})[0]
    _modaliteEditor.edit(cnx, *args, **kw)