ScoDoc/app/comp/res_common.py

456 lines
19 KiB
Python
Raw Normal View History

2021-12-24 00:08:25 +01:00
##############################################################################
# ScoDoc
2023-01-02 13:16:27 +01:00
# Copyright (c) 1999 - 2023 Emmanuel Viennet. All rights reserved.
2021-12-24 00:08:25 +01:00
# See LICENSE
##############################################################################
2022-04-02 13:30:26 +02:00
"""Résultats semestre: méthodes communes aux formations classiques et APC
"""
from collections import Counter, defaultdict
2022-07-18 17:48:10 +02:00
from collections.abc import Generator
2021-12-24 00:08:25 +01:00
from functools import cached_property
import numpy as np
import pandas as pd
from flask import g, url_for
2022-02-06 16:09:17 +01:00
from app.comp import res_sem
2022-09-05 13:54:35 +02:00
from app.comp.res_cache import ResultatsCache
from app.comp.jury import ValidationsSemestre
2022-01-07 10:37:48 +01:00
from app.comp.moy_mod import ModuleImplResults
from app.models import FormSemestre, FormSemestreUECoef
from app.models import Identite
from app.models import ModuleImpl, ModuleImplInscription
from app.models import ScolarAutorisationInscription
2022-01-08 19:56:09 +01:00
from app.models.ues import UniteEns
2021-12-24 00:08:25 +01:00
from app.scodoc.sco_cache import ResultatsSemestreCache
from app.scodoc.codes_cursus import UE_SPORT
from app.scodoc.sco_exceptions import ScoValueError
from app.scodoc import sco_utils as scu
2021-12-24 00:08:25 +01:00
# Il faut bien distinguer
# - ce qui est caché de façon persistente (via redis):
# ce sont les attributs listés dans `_cached_attrs`
# le stockage et l'invalidation sont gérés dans sco_cache.py
#
# - les valeurs cachées durant le temps d'une requête
# (durée de vie de l'instance de ResultatsSemestre)
# qui sont notamment les attributs décorés par `@cached_property``
#
2022-02-06 16:09:17 +01:00
class ResultatsSemestre(ResultatsCache):
"""Les résultats (notes, ...) d'un formsemestre
Classe commune à toutes les formations (classiques, BUT)
"""
2021-12-24 00:08:25 +01:00
_cached_attrs = (
2022-04-02 13:30:26 +02:00
"bonus",
"bonus_ues",
"dispense_ues",
"etud_coef_ue_df",
2021-12-30 23:58:38 +01:00
"etud_moy_gen_ranks",
"etud_moy_gen",
2021-12-24 00:08:25 +01:00
"etud_moy_ue",
2021-12-30 23:58:38 +01:00
"modimpl_inscr_df",
2021-12-26 19:15:47 +01:00
"modimpls_results",
"moyennes_matieres",
2021-12-24 00:08:25 +01:00
)
2021-12-30 23:58:38 +01:00
def __init__(self, formsemestre: FormSemestre):
2022-02-06 16:09:17 +01:00
super().__init__(formsemestre, ResultatsSemestreCache)
2021-12-26 19:15:47 +01:00
# BUT ou standard ? (apc == "approche par compétences")
self.is_apc: bool = formsemestre.formation.is_apc()
2022-01-07 10:37:48 +01:00
# Attributs "virtuels", définis dans les sous-classes
2022-04-02 13:30:26 +02:00
self.bonus: pd.Series = None # virtuel
"Bonus sur moy. gen. Series de float, index etudid"
self.bonus_ues: pd.DataFrame = None # virtuel
"DataFrame de float, index etudid, columns: ue.id"
self.dispense_ues: set[tuple[int, int]] = set()
"""set des dispenses d'UE: (etudid, ue_id), en APC seulement."""
2022-01-08 19:56:09 +01:00
# ResultatsSemestreBUT ou ResultatsSemestreClassic
2021-12-26 19:15:47 +01:00
self.etud_moy_ue = {}
2022-01-08 19:56:09 +01:00
"etud_moy_ue: DataFrame columns UE, rows etudid"
self.etud_moy_gen: pd.Series = None
2021-12-26 19:15:47 +01:00
self.etud_moy_gen_ranks = {}
2022-02-13 13:58:09 +01:00
self.etud_moy_gen_ranks_int = {}
2022-05-23 10:59:43 +02:00
self.moy_gen_rangs_by_group = None # virtual
self.modimpl_inscr_df: pd.DataFrame = None
"Inscriptions: row etudid, col modimlpl_id"
2022-01-07 10:37:48 +01:00
self.modimpls_results: ModuleImplResults = None
2022-02-06 16:09:17 +01:00
"Résultats de chaque modimpl: dict { modimpl.id : ModuleImplResults(Classique ou BUT) }"
2022-01-16 23:47:52 +01:00
self.etud_coef_ue_df = None
2022-02-06 16:09:17 +01:00
"""coefs d'UE effectifs pour chaque étudiant (pour form. classiques)"""
self.modimpl_coefs_df: pd.DataFrame = None
"""Coefs APC: rows = UEs (sans bonus), columns = modimpl, value = coef."""
self.validations = None
self.autorisations_inscription = None
self.moyennes_matieres = {}
"""Moyennes de matières, si calculées. { matiere_id : Series, index etudid }"""
2021-12-24 00:08:25 +01:00
def __repr__(self):
return f"<{self.__class__.__name__}(formsemestre='{self.formsemestre}')>"
2021-12-24 00:08:25 +01:00
def compute(self):
"Charge les notes et inscriptions et calcule toutes les moyennes"
# voir ce qui est chargé / calculé ici et dans les sous-classes
2021-12-26 19:15:47 +01:00
raise NotImplementedError()
2021-12-24 00:08:25 +01:00
2022-01-16 23:47:52 +01:00
def get_inscriptions_counts(self) -> Counter:
"""Nombre d'inscrits, défaillants, démissionnaires.
Exemple: res.get_inscriptions_counts()[scu.INSCRIT]
Result: a collections.Counter instance
"""
return Counter(ins.etat for ins in self.formsemestre.inscriptions)
2021-12-24 00:08:25 +01:00
@cached_property
2022-01-16 23:47:52 +01:00
def etuds(self) -> list[Identite]:
"Liste des inscrits au semestre, avec les démissionnaires et les défaillants"
2021-12-30 23:58:38 +01:00
# nb: si la liste des inscrits change, ResultatsSemestre devient invalide
2022-01-16 23:47:52 +01:00
return self.formsemestre.get_inscrits(include_demdef=True)
2021-12-24 00:08:25 +01:00
@cached_property
2022-01-16 23:47:52 +01:00
def etud_index(self) -> dict[int, int]:
2021-12-24 00:08:25 +01:00
"dict { etudid : indice dans les inscrits }"
return {e.id: idx for idx, e in enumerate(self.etuds)}
def etud_ues_ids(self, etudid: int) -> list[int]:
"""Liste des UE auxquelles l'etudiant est inscrit, sans bonus
(surchargée en BUT pour prendre en compte les parcours)
"""
# Pour les formations classiques, etudid n'est pas utilisé
# car tous les étudiants sont inscrits à toutes les UE
return [ue.id for ue in self.ues if ue.type != UE_SPORT]
2022-07-18 17:48:10 +02:00
def etud_ues(self, etudid: int) -> Generator[UniteEns]:
"""Liste des UE auxquelles l'étudiant est inscrit
(sans bonus, en BUT prend en compte le parcours de l'étudiant)."""
2022-07-18 17:48:10 +02:00
return (UniteEns.query.get(ue_id) for ue_id in self.etud_ues_ids(etudid))
def etud_ects_tot_sem(self, etudid: int) -> float:
"""Le total des ECTS associées à ce semestre (que l'étudiant peut ou non valider)"""
etud_ues = self.etud_ues(etudid)
return sum([ue.ects or 0 for ue in etud_ues]) if etud_ues else 0.0
2022-04-02 13:30:26 +02:00
def modimpl_notes(self, modimpl_id: int, ue_id: int) -> np.ndarray:
"""Les notes moyennes des étudiants du sem. à ce modimpl dans cette ue.
Utile pour stats bottom tableau recap.
Résultat: 1d array of float
"""
# différent en BUT et classique: virtuelle
raise NotImplementedError
2022-01-09 21:02:07 +01:00
@cached_property
2022-01-16 23:47:52 +01:00
def etuds_dict(self) -> dict[int, Identite]:
"""dict { etudid : Identite } inscrits au semestre,
avec les démissionnaires et defs."""
2022-01-09 21:02:07 +01:00
return {etud.id: etud for etud in self.etuds}
2021-12-24 00:08:25 +01:00
@cached_property
2022-01-16 23:47:52 +01:00
def ues(self) -> list[UniteEns]:
2022-01-25 10:45:13 +01:00
"""Liste des UEs du semestre (avec les UE bonus sport)
2022-02-06 16:09:17 +01:00
(indices des DataFrames).
Note: un étudiant n'est pas nécessairement inscrit dans toutes ces UEs.
2022-01-09 21:02:07 +01:00
"""
return self.formsemestre.query_ues(with_sport=True).all()
2021-12-24 00:08:25 +01:00
@cached_property
def ressources(self):
"Liste des ressources du semestre, triées par numéro de module"
return [
2022-01-25 10:45:13 +01:00
m
for m in self.formsemestre.modimpls_sorted
if m.module.module_type == scu.ModuleType.RESSOURCE
2021-12-24 00:08:25 +01:00
]
@cached_property
def saes(self):
"Liste des SAÉs du semestre, triées par numéro de module"
2022-01-25 10:45:13 +01:00
return [
m
for m in self.formsemestre.modimpls_sorted
if m.module.module_type == scu.ModuleType.SAE
]
2021-12-24 00:08:25 +01:00
2023-02-10 23:43:16 +01:00
def get_etudids_attente(self) -> set[int]:
"""L'ensemble des etudids ayant au moins une note en ATTente"""
return set().union(
*[mr.etudids_attente for mr in self.modimpls_results.values()]
)
# --- JURY...
def get_formsemestre_validations(self) -> ValidationsSemestre:
"""Load validations if not already stored, set attribute and return value"""
2022-09-05 13:54:35 +02:00
if not self.validations:
self.validations = res_sem.load_formsemestre_validations(self.formsemestre)
return self.validations
def get_autorisations_inscription(self) -> dict[int : list[int]]:
"""Les autorisations d'inscription venant de ce formsemestre.
Lit en base et cache le résultat.
Resultat: { etudid : [ indices de semestres ]}
Note: les etudids peuvent ne plus être inscrits ici.
Seuls ceux avec des autorisations enregistrées sont présents dans le résultat.
"""
if not self.autorisations_inscription:
autorisations = ScolarAutorisationInscription.query.filter_by(
origin_formsemestre_id=self.formsemestre.id
)
self.autorisations_inscription = defaultdict(list)
for aut in autorisations:
self.autorisations_inscription[aut.etudid].append(aut.semestre_id)
return self.autorisations_inscription
2022-02-06 16:09:17 +01:00
def get_etud_ue_validables(self, etudid: int) -> list[UniteEns]:
"""Liste des UEs du semestre qui doivent être validées
Rappel: l'étudiant est inscrit à des modimpls et non à des UEs.
- En BUT: on considère que l'étudiant va (ou non) valider toutes les UEs des modules
du parcours.
2022-02-06 16:09:17 +01:00
- En classique: toutes les UEs des modimpls auxquels l'étudiant est inscrit sont
2022-02-06 16:09:17 +01:00
susceptibles d'être validées.
Les UE "bonus" (sport) ne sont jamais "validables".
2022-01-08 19:56:09 +01:00
"""
2022-02-06 16:09:17 +01:00
if self.is_apc:
return list(self.etud_ues(etudid))
# Formations classiques:
# restreint aux UE auxquelles l'étudiant est inscrit (dans l'un des modimpls)
ues = {
modimpl.module.ue
for modimpl in self.formsemestre.modimpls_sorted
if self.modimpl_inscr_df[modimpl.id][etudid]
}
ues = sorted(list(ues), key=lambda x: x.numero or 0)
return ues
2022-01-08 19:56:09 +01:00
def modimpls_in_ue(self, ue: UniteEns, etudid, with_bonus=True) -> list[ModuleImpl]:
2022-03-12 09:38:48 +01:00
"""Liste des modimpl de cette UE auxquels l'étudiant est inscrit.
Utile en formations classiques, surchargée pour le BUT.
Inclus modules bonus le cas échéant.
2022-03-12 09:38:48 +01:00
"""
# Utilisée pour l'affichage ou non de l'UE sur le bulletin
# Méthode surchargée en BUT
modimpls = [
modimpl
for modimpl in self.formsemestre.modimpls_sorted
if modimpl.module.ue.id == ue.id
and self.modimpl_inscr_df[modimpl.id][etudid]
]
if not with_bonus:
return [
modimpl for modimpl in modimpls if modimpl.module.ue.type != UE_SPORT
]
return modimpls
2022-01-08 19:56:09 +01:00
@cached_property
def ue_au_dessus(self, seuil=10.0) -> pd.DataFrame:
"""DataFrame columns UE, rows etudid, valeurs: bool
Par exemple, pour avoir le nombre d'UE au dessus de 10 pour l'étudiant etudid
nb_ues_ok = sum(res.ue_au_dessus().loc[etudid])
"""
return self.etud_moy_ue > (seuil - scu.NOTES_TOLERANCE)
def apply_capitalisation(self):
"""Recalcule la moyenne générale pour prendre en compte d'éventuelles
UE capitalisées.
"""
# Supposant qu'il y a peu d'UE capitalisées,
# on recalcule les moyennes gen des etuds ayant des UEs capitalisées.
self.get_formsemestre_validations()
ue_capitalisees = self.validations.ue_capitalisees
for etudid in ue_capitalisees.index:
recompute_mg = False
# ue_codes = set(ue_capitalisees.loc[etudid]["ue_code"])
# for ue_code in ue_codes:
# ue = ue_by_code.get(ue_code)
# if ue is None:
# ue = self.formsemestre.query_ues.filter_by(ue_code=ue_code)
# ue_by_code[ue_code] = ue
# Quand il y a une capitalisation, vérifie toutes les UEs
sum_notes_ue = 0.0
sum_coefs_ue = 0.0
for ue in self.formsemestre.query_ues():
ue_cap = self.get_etud_ue_status(etudid, ue.id)
if ue_cap is None:
continue
if ue_cap["is_capitalized"]:
recompute_mg = True
coef = ue_cap["coef_ue"]
if not np.isnan(ue_cap["moy"]) and coef:
sum_notes_ue += ue_cap["moy"] * coef
sum_coefs_ue += coef
if recompute_mg and sum_coefs_ue > 0.0:
# On doit prendre en compte une ou plusieurs UE capitalisées
# et donc recalculer la moyenne générale
self.etud_moy_gen[etudid] = sum_notes_ue / sum_coefs_ue
# Ajoute le bonus sport
if self.bonus is not None and self.bonus[etudid]:
self.etud_moy_gen[etudid] += self.bonus[etudid]
self.etud_moy_gen[etudid] = max(
0.0, min(self.etud_moy_gen[etudid], 20.0)
)
2022-04-02 13:30:26 +02:00
def get_etud_etat(self, etudid: int) -> str:
"Etat de l'etudiant: 'I', 'D', DEF ou '' (si pas connu dans ce semestre)"
2023-02-23 22:42:19 +01:00
ins = self.formsemestre.etuds_inscriptions.get(etudid)
2022-04-02 13:30:26 +02:00
if ins is None:
return ""
return ins.etat
def _get_etud_ue_cap(self, etudid: int, ue: UniteEns) -> dict:
"""Donne les informations sur la capitalisation de l'UE ue pour cet étudiant.
Résultat:
Si pas capitalisée: None
Si capitalisée: un dict, avec les colonnes de validation.
"""
capitalisations = self.validations.ue_capitalisees.loc[etudid]
if isinstance(capitalisations, pd.DataFrame):
ue_cap = capitalisations[capitalisations["ue_code"] == ue.ue_code]
if ue_cap.empty:
return None
if isinstance(ue_cap, pd.DataFrame):
# si plusieurs fois capitalisée, prend le max
cap_idx = ue_cap["moy_ue"].values.argmax()
ue_cap = ue_cap.iloc[cap_idx]
else:
if capitalisations["ue_code"] == ue.ue_code:
ue_cap = capitalisations
else:
return None
# converti la Series en dict, afin que les np.int64 reviennent en int
# et remplace les NaN (venant des NULL en base) par des None
ue_cap_dict = ue_cap.to_dict()
if ue_cap_dict["formsemestre_id"] is not None and np.isnan(
ue_cap_dict["formsemestre_id"]
):
ue_cap_dict["formsemestre_id"] = None
if ue_cap_dict["compense_formsemestre_id"] is not None and np.isnan(
ue_cap_dict["compense_formsemestre_id"]
):
ue_cap_dict["compense_formsemestre_id"] = None
return ue_cap_dict
def get_etud_ue_status(self, etudid: int, ue_id: int) -> dict:
"""L'état de l'UE pour cet étudiant.
Result: dict, ou None si l'UE n'est pas dans ce semestre.
"""
ue = UniteEns.query.get(ue_id)
2022-02-09 00:36:50 +01:00
if ue.type == UE_SPORT:
return {
"is_capitalized": False,
2022-02-13 15:50:16 +01:00
"was_capitalized": False,
2022-02-09 00:36:50 +01:00
"is_external": False,
"coef_ue": 0.0,
"cur_moy_ue": 0.0,
"moy": 0.0,
"event_date": None,
"ue": ue.to_dict(),
"formsemestre_id": None,
"capitalized_ue_id": None,
"ects_pot": 0.0,
"ects": 0.0,
"ects_ue": ue.ects,
2022-02-09 00:36:50 +01:00
}
2022-02-12 10:31:52 +01:00
if not ue_id in self.etud_moy_ue:
return None
if not self.validations:
self.validations = res_sem.load_formsemestre_validations(self.formsemestre)
cur_moy_ue = self.etud_moy_ue[ue_id][etudid]
moy_ue = cur_moy_ue
2022-02-13 15:50:16 +01:00
is_capitalized = False # si l'UE prise en compte est une UE capitalisée
# s'il y a precedemment une UE capitalisée (pas forcement meilleure):
was_capitalized = False
if etudid in self.validations.ue_capitalisees.index:
ue_cap = self._get_etud_ue_cap(etudid, ue)
if ue_cap and not np.isnan(ue_cap["moy_ue"]):
2022-02-13 15:50:16 +01:00
was_capitalized = True
if ue_cap["moy_ue"] > cur_moy_ue or np.isnan(cur_moy_ue):
moy_ue = ue_cap["moy_ue"]
is_capitalized = True
# Coef l'UE dans le semestre courant:
if self.is_apc:
# utilise les ECTS comme coef.
coef_ue = ue.ects
else:
# formations classiques
coef_ue = self.etud_coef_ue_df[ue_id][etudid]
if (not coef_ue) and is_capitalized: # étudiant non inscrit dans l'UE courante
if self.is_apc:
# Coefs de l'UE capitalisée en formation APC: donné par ses ECTS
ue_capitalized = UniteEns.query.get(ue_cap["ue_id"])
coef_ue = ue_capitalized.ects
if coef_ue is None:
orig_sem = FormSemestre.query.get(ue_cap["formsemestre_id"])
raise ScoValueError(
2022-04-02 13:30:26 +02:00
f"""L'UE capitalisée {ue_capitalized.acronyme}
du semestre {orig_sem.titre_annee()}
n'a pas d'indication d'ECTS.
2022-04-02 13:30:26 +02:00
Corrigez ou faite corriger le programme
<a href="{url_for('notes.ue_table', scodoc_dept=g.scodoc_dept,
formation_id=ue_capitalized.formation_id)}">via cette page</a>.
"""
)
else:
# Coefs de l'UE capitalisée en formation classique:
# va chercher le coef dans le semestre d'origine
coef_ue = ModuleImplInscription.sum_coefs_modimpl_ue(
ue_cap["formsemestre_id"], etudid, ue_cap["ue_id"]
)
return {
"is_capitalized": is_capitalized,
2022-02-13 15:50:16 +01:00
"was_capitalized": was_capitalized,
"is_external": ue_cap["is_external"] if is_capitalized else ue.is_external,
"coef_ue": coef_ue,
"ects_pot": ue.ects or 0.0,
"ects": self.validations.decisions_jury_ues.get(etudid, {})
.get(ue.id, {})
.get("ects", 0.0)
if self.validations.decisions_jury_ues
else 0.0,
"ects_ue": ue.ects,
"cur_moy_ue": cur_moy_ue,
"moy": moy_ue,
"event_date": ue_cap["event_date"] if is_capitalized else None,
"ue": ue.to_dict(),
"formsemestre_id": ue_cap["formsemestre_id"] if is_capitalized else None,
"capitalized_ue_id": ue_cap["ue_id"] if is_capitalized else None,
}
2022-04-02 13:30:26 +02:00
def compute_etud_ue_coef(self, etudid: int, ue: UniteEns) -> float:
"Détermine le coefficient de l'UE pour cet étudiant."
# calcul différent en classique et BUT
2022-04-02 13:30:26 +02:00
raise NotImplementedError()
def get_etud_ue_cap_coef(self, etudid, ue, ue_cap): # UNUSED in ScoDoc 9
"""Calcule le coefficient d'une UE capitalisée, pour cet étudiant,
injectée dans le semestre courant.
ue : ue du semestre courant
ue_cap = resultat de formsemestre_get_etud_capitalisation
{ 'ue_id' (dans le semestre source),
'ue_code', 'moy', 'event_date','formsemestre_id' }
"""
# 1- Coefficient explicitement déclaré dans le semestre courant pour cette UE ?
ue_coef_db = FormSemestreUECoef.query.filter_by(
formsemestre_id=self.formsemestre.id, ue_id=ue.id
).first()
if ue_coef_db is not None:
return ue_coef_db.coefficient
# En APC: somme des coefs des modules vers cette UE
# En classique: Capitalisation UE externe: quel coef appliquer ?
# En ScoDoc 7, calculait la somme des coefs dans l'UE du semestre d'origine
# ici si l'étudiant est inscrit dans le semestre courant,
# somme des coefs des modules de l'UE auxquels il est inscrit
return self.compute_etud_ue_coef(etudid, ue)