Code source de parcoursup.propositions.AlgoPropositions

#!/usr/bin/env python3
# -*- coding: utf-8; mode: python -*-
""" AlgoPropositions, pour https://github.com/Naereen/ParcourSup.py.

- Auteurs : Lilian Besson, Bastien Trotobas et al, (C) 2018.
- Adresse : https://github.com/Naereen/ParcourSup.py
- Licence : MIT License (http://lbesson.mit-license.org).
"""
__author__ = "Lilian Besson, Bastien Trotobas et al"
__version__ = "0.0.1"

import xml.etree.ElementTree as ET
from pprint import pprint  # DEBUG
from typing import Dict, List, Set
from datetime import datetime

try:
    from tqdm import tqdm  # DEBUG Cf. https://github.com/tqdm/tqdm#usage
except ImportError:
    print("Attention : le module 'tqdm' n'a pas été trouvé, installez le avec :\nsudo pip3 install tqdm")
    def tqdm(iterator, desc=None):
        return iterator


#: En mode débug, on affiche juste le résultat, on n'écrase pas les fichiers de tests.
# DEBUG = True
DEBUG = False


try:
    from .GroupeAffectation import GroupeAffectation
    from .GroupeAffectationUID import GroupeAffectationUID
    from .GroupeInternat import GroupeInternat
    from .GroupeInternatUID import GroupeInternatUID
    from .VerificationsResultats import *
    from .VoeuEnAttente import VoeuEnAttente
    from .VoeuUID import VoeuUID
except ImportError:
    from GroupeAffectation import GroupeAffectation
    from GroupeAffectationUID import GroupeAffectationUID
    from GroupeInternat import GroupeInternat
    from GroupeInternatUID import GroupeInternatUID
    from VerificationsResultats import *
    from VoeuEnAttente import VoeuEnAttente
    from VoeuUID import VoeuUID


[docs]def log(*args, **kwargs): """ Affiche avec une heure.""" now = datetime.now() print(f"{now:%d-%m-%Y %H:%M:%S}", *args, **kwargs)
[docs]def str_de_bool(b: bool) -> str: """ ``True`` ou ``False`` en minuscule.""" return "true" if b else "false"
[docs]class AlgoPropositions(object): """ Stocke les entrées et sorties de l'algorithme de calcul d'ordre d'appel. """
[docs] def __init__(self, groupesAffectations: List[GroupeAffectation]=None, internats: List[GroupeInternat]=None, ): """ Stocke la liste non-vide de classements.""" assert groupesAffectations is not None, f"Erreur : {self.__class__.__name__} le paramètre groupesAffectations doit être non vide, et pas {groupesAffectations}..." # DEBUG #: La liste des groupes d'affectation, contenant leurs voeux respectifs. self.groupesAffectations: List[GroupeAffectation] = groupesAffectations assert internats is not None, f"Erreur : {self.__class__.__name__} le paramètre internats doit être non vide, et pas {internats}..." # DEBUG #: La liste des internats, contenant leurs vœux respectifs. self.internats: List[GroupeInternat] = internats #: Liste des internats, permettant de récupérer les positions max d'admission self.internats_sortie: List[GroupeInternat] = [] self.groupesAMettreAJour: Set[GroupeInternat] = set() #: Liste des propositions à faire. self.propositions: List[VoeuEnAttente] = [] #: Liste des vœux restant en attente. self.enAttentes: List[VoeuEnAttente] = [] self.rangsMaxNouvelArrivant: Dict[GroupeAffectation, int] = dict()
[docs] def verifierIntegrite(self) -> bool: """ Vérifie l'intégrité des données d'entrée, et lève une exception si nécessaire. Propriétés : - a) tous les vœux sont en attente, - b) pas deux vœux distincts avec la même id, - c) pas deux candidats distincts avec le même classement, formation et internat, - d) pas le même candidat avec deux classements distincts, formation et internat, - e) classements positifs, - f) chaque voeu avec internat se retrouve dans l'internat correspondant. .. warning:: Une exception ``AssertionError`` est lancée avec un message commençant par ``a)`` ou ... ou ``f)``. """ # intégrité des classements : un classement == un candidat for groupeAffectation in tqdm(self.groupesAffectations, desc="groupesAffectations"): ordreVersCandidat: Dict[int, int] = dict() candidatVersOrdre: Dict[int, int] = dict() voeuxVus: Set[VoeuUID] = set() for voeu in tqdm(groupeAffectation.voeux, desc="voeux"): assert not (voeu.internatDejaObtenu() and voeu.formationDejaObtenue()), f"a) ce vœu {voeu} n'est pas en attente !" assert voeu.id not in voeuxVus, f"b) deux vœux avec le même identifiant {voeu.id} !" voeuxVus.add(voeu.id) if voeu.ordreAppel in ordreVersCandidat: assert ordreVersCandidat[voeu.ordreAppel] == voeu.id.G_CN_COD, f"c) candidats distincts avec le même classement {voeu.id.G_CN_COD} et {ordreVersCandidat[voeu.ordreAppel]} !" else: ordreVersCandidat[voeu.ordreAppel] = voeu.id.G_CN_COD if voeu.id.G_CN_COD in candidatVersOrdre: assert candidatVersOrdre[voeu.id.G_CN_COD] == voeu.ordreAppel, f"d) candidats distincts avec le même classement { voeu.ordreAppel} et {candidatVersOrdre[voeu.id.G_CN_COD]} !" else: candidatVersOrdre[voeu.id.G_CN_COD] = voeu.ordreAppel assert voeu.ordreAppel > 0, f"e) ordre appel de la formation est négatif = {voeu.ordreAppel} !" # remarque le voeu peut-être marqué "avecInternat" # et en même temps internat==None car c'est un internat sans classement # (obligatoire ou non-sélectif) if voeu.avecClassementInternat(): assert voeu in voeu.internat.voeux, f"f) erreur intégrité données ! Le vœu {voeu} n'est pas dans les vœux de son internat {voeu.internat.voeux} !" # intégrité des classements : un classement == un candidat for internat in tqdm(self.internats, "internats"): ordreVersCandidat: Dict[int, int] = dict() candidatVersOrdre: Dict[int, int] = dict() for voeu in tqdm(internat.voeux, "voeux"): assert voeu.avecInternat(), f"g) erreur intégrité données ! Le voeu {voeu} est dans les vœux de l'internat {internat} mais n'est pas un vœu avec internat !" assert voeu.internat == internat, f"h) erreur intégrité données ! Le voeu {voeu} est dans les vœux de l'internat {internat} mais n'est pas un vœu de cet internat !" assert voeu.rangInternat > 0, f"e) classement internat négatif !" if voeu.rangInternat in ordreVersCandidat: assert ordreVersCandidat[voeu.rangInternat] == voeu.id.G_CN_COD, f"c) candidats distincts avec le même classement, {voeu.id.G_CN_COD} et {ordreVersCandidat[voeu.rangInternat]} !" else: ordreVersCandidat[voeu.rangInternat] = voeu.id.G_CN_COD if voeu.id.G_CN_COD in candidatVersOrdre: assert candidatVersOrdre[voeu.id.G_CN_COD] == voeu.rangInternat, f"d) candidats distincts avec le même classement {voeu.rangInternat} et {candidatVersOrdre[voeu.id.G_CN_COD]} !" else: candidatVersOrdre[voeu.id.G_CN_COD] = voeu.rangInternat
[docs] def calculePropositions(self) -> None: """ Calcule les propositions à envoyer.""" self.verifierIntegrite() log("Début calcul propositions...") # groupes à mettre à jour self.groupesAMettreAJour.update(self.groupesAffectations) # initialisation des positions maximales d'admission dans les internats for internat in self.internats: internat.initialiserPositionAdmission() compteurBoucle = 0 while self.groupesAMettreAJour: # calcul des propositions à effectuer, # étant données les positions actuelles d'admissions aux internats for groupe in self.groupesAMettreAJour: groupe.mettreAJourPropositions() # Test de surcapacité des internats, avec # mise à jour de la position d'admission si nécessaire. # # Baisser la position d'admission d'un internat ne diminue # pas le nombre de candidats dans les autres internats, voire augmente ces nombres, # car les formations devront potentiellement descendre plus bas dans l'ordre d'appel. # # Par conséquent, on peut mettre à jour toutes les positions d'admission # de tous les internats sans mettre à jour systématiquement les propositions: # si un internat est détecté en surcapacité avant la mise # à jour des propositions, il l'aurait été également après la mise à jour des propositions. # (Mais la réciproque est fausse en général). # # De cette manière, on reste bien dans l'ensemble E des vecteurs de positions # d'admission supérieurs sur chaque composante au vecteur de positions d'admission # le plus permissif possible parmi tous ceux respectant les contraintes # de capacité des internats et situés en deçà des positions maximales d'admission. # # Ce vecteur est égal, sur chaque composante, à la valeur minimum de cette # composante parmi les éléments de E. # # La boucle termine quand les contraintes de capacité des internats # sont satisfaites, c'est-à-dire quand ce minimum global est atteint. # # Une propriété de symétrie i.e. d'équité intéressante : le résultat # ne dépend pas de l'ordre dans lequel on itère sur les internats et les formations. self.groupesAMettreAJour.clear() for internat in self.internats: maj = internat.mettreAJourPositionAdmission() if maj: self.groupesAMettreAJour.update(internat.groupesConcernes) compteurBoucle += 1 log(f"Calcul terminé après {compteurBoucle} itération{'(s)' if compteurBoucle > 1 else ''}.") log(f"Vérification des propriétés attendues des propositions pour un des {len(self.groupesAffectations)} groupes d'affectation.") for groupe in tqdm(self.groupesAffectations, desc="groupesAffectations"): verifierRespectOrdreAppelVoeuxSansInternat(groupe) verifierVoeuxAvecInternat(groupe) verifierSurcapaciteEtRemplissage(groupe) log("Vérifications ok (1/2)...") # précalcul des rangs d'appel maximum dans chaque groupe parmi les nouveaux entrants for groupe in tqdm(self.groupesAffectations, desc="groupesAffectations"): rangMax = 0 for voeu in groupe.voeuxTries(): if voeu.estAProposer() and not voeu.formationDejaObtenue(): rangMax = max(rangMax, voeu.ordreAppel) self.rangsMaxNouvelArrivant[groupe] = rangMax log(f"Vérification des propriétés attendues des propositions d'un des {len(self.internats)} internats.") for internat in tqdm(self.internats, desc="internats"): verifierRespectClassementInternat(internat) verifierSurcapaciteEtRemplissage_avec_rangDernierAppeles(internat, self.rangsMaxNouvelArrivant) log("Vérifications ok (2/2)...") log("\n\nPréparation données de sortie...") for groupe in tqdm(self.groupesAffectations, desc="groupesAffectations"): # FIXED? voeu.rangListeAttente ne sont pas mis à jour ! for voeu in groupe.voeux: if voeu.estAProposer(): voeu.rangListeAttente = 0 self.propositions.append(voeu) else: self.enAttentes.append(voeu) for position, voeu in enumerate(sorted(self.enAttentes, key= lambda voeu: voeu.ordreAppel)): voeu.rangListeAttente = position + 1 rangListeAttenteInternat = 0 for internat in tqdm(self.internats, desc="internats"): # FIXED? voeu.rangListeAttenteInternat ne sont pas mis à jour ! for voeu in sorted(internat.voeux, key= lambda voeu: voeu.ordreAppel): if voeu.rangInternat <= internat.positionAdmission: voeu.rangListeAttenteInternat = 0 else: rangListeAttenteInternat += 1 voeu.rangListeAttenteInternat = rangListeAttenteInternat self.internats_sortie.extend(self.internats)
# --- Exporte vers des arbres XML ou un dictionnaire JSON
[docs] def exporteEntree_XML(self) -> ET.Element: """ Converti l'entrée en un arbre XML.""" racine = ET.Element('algoPropositionsEntree') groupesAffectationsXML = ET.Element('groupesAffectations') for groupe in self.groupesAffectations: uid = ET.SubElement(groupesAffectationsXML, 'id') ET.SubElement(uid, 'C_GP_COD').text = str(groupe.id.C_GP_COD) ET.SubElement(uid, 'G_TI_COD').text = str(groupe.id.G_TI_COD) ET.SubElement(uid, 'G_TA_COD').text = str(groupe.id.G_TA_COD) ET.SubElement(groupesAffectationsXML, 'nbPlacesVacantes').text = str(groupe.nbPlacesVacantes()) ET.SubElement(groupesAffectationsXML, 'rangLimite').text = str(groupe.rangLimite) ET.SubElement(groupesAffectationsXML, 'rangDernierAppele').text = str(self.rangsMaxNouvelArrivant.get(groupe, -1)) for voeu in groupe.voeux: voeuXML = ET.Element('voeux') uid = ET.SubElement(voeuXML, 'id') ET.SubElement(uid, 'G_CN_COD').text = str(voeu.id.G_CN_COD) ET.SubElement(uid, 'G_TA_COD').text = str(voeu.id.G_TA_COD) ET.SubElement(uid, 'I_RH_COD').text = str_de_bool(voeu.id.I_RH_COD) ET.SubElement(voeuXML, 'ordreAppel').text = str(voeu.ordreAppel) ET.SubElement(voeuXML, 'rangInternat').text = str(voeu.rangInternat) # FIXME ET.SubElement(voeuXML, 'rangListeAttente').text = str(voeu.rangListeAttente) groupesAffectationsXML.append(voeuXML) racine.append(groupesAffectationsXML) internatsXML = ET.Element('internats') for internat in self.internats: candidatsEnAttente_tries = sorted(list(internat.candidatsEnAttente)) uid = ET.SubElement(internatsXML, 'id') ET.SubElement(uid, 'C_GI_COD').text = str(internat.id.C_GI_COD) ET.SubElement(uid, 'G_TA_COD').text = str(internat.id.G_TA_COD) ET.SubElement(internatsXML, 'contingentAdmission').text = str(internat.contingentAdmission) ET.SubElement(internatsXML, 'positionAdmission').text = str(internat.positionAdmission) ET.SubElement(internatsXML, 'positionMaximaleAdmission').text = str(internat.positionMaximaleAdmission) for voeu in internat.voeux: voeuXML = ET.Element('voeux') uid = ET.SubElement(voeuXML, 'id') ET.SubElement(uid, 'G_CN_COD').text = str(voeu.id.G_CN_COD) ET.SubElement(uid, 'G_TA_COD').text = str(voeu.id.G_TA_COD) ET.SubElement(uid, 'I_RH_COD').text = str_de_bool(voeu.id.I_RH_COD) ET.SubElement(voeuXML, 'ordreAppel').text = str(voeu.ordreAppel) ET.SubElement(voeuXML, 'rangInternat').text = str(voeu.rangInternat) # FIXME ET.SubElement(voeuXML, 'rangListeAttente').text = str(voeu.rangListeAttenteInternat) internatsXML.append(voeuXML) # FIXME for G_CN_COD in candidatsEnAttente_tries: ET.SubElement(internatsXML, 'candidatsEnAttente').text = str(G_CN_COD) racine.append(internatsXML) return racine
[docs] def exporteEntree_JSON(self) -> Dict: """ Converti l'entrée en un dictionnaire.""" racine = { 'algoPropositionsEntree': { 'groupesAffectations': [ { 'id': { 'C_GP_COD': groupe.id.C_GP_COD, 'G_TI_COD': groupe.id.G_TI_COD, 'G_TA_COD': groupe.id.G_TA_COD, }, 'nbPlacesVacantes': groupe.nbPlacesVacantes(), 'rangLimite': groupe.rangLimite, 'rangDernierAppele': self.rangsMaxNouvelArrivant.get(groupe, -1), # XXX pourquoi -1 par défaut ? Il faut sauver l'entrée APRES avoir lancer execute. 'voeux': [ { 'id': { 'G_CN_COD': voeu.id.G_CN_COD, 'G_TA_COD': voeu.id.G_TA_COD, 'I_RH_COD': voeu.id.I_RH_COD, }, 'ordreAppel': voeu.ordreAppel, 'rangInternat': voeu.rangInternat, 'rangListeAttente': voeu.rangListeAttente, } for voeu in groupe.voeux ] } for groupe in self.groupesAffectations ], 'internats': [ { 'id': { 'C_GI_COD': internat.id.C_GI_COD, 'G_TA_COD': internat.id.G_TA_COD, }, 'contingentAdmission': internat.contingentAdmission, 'positionAdmission': internat.positionAdmission, 'positionMaximaleAdmission': internat.positionMaximaleAdmission, 'voeux': [ { 'id': { 'G_CN_COD': voeu.id.G_CN_COD, 'G_TA_COD': voeu.id.G_TA_COD, 'I_RH_COD': voeu.id.I_RH_COD, }, 'ordreAppel': voeu.ordreAppel, 'rangInternat': voeu.rangInternat, 'rangListeAttente': voeu.rangListeAttenteInternat, } for voeu in internat.voeux ], 'candidatsEnAttente': [ G_CN_COD for G_CN_COD in sorted(list(internat.candidatsEnAttente)) # FIXME ] } for internat in self.internats ], } } if DEBUG: pprint(racine) # DEBUG return racine
[docs] def exporteSortie_XML(self) -> ET.Element: """ Converti les résultats de la sortie en un arbre XML.""" racine = ET.Element('algoPropositionsSortie') for els, nom_elXML in zip( [self.propositions, self.enAttentes], ['propositions', 'enAttente'] ): for el in els: elXML = ET.Element(nom_elXML) uid = ET.SubElement(elXML, 'id') ET.SubElement(uid, 'G_CN_COD').text = str(el.id.G_CN_COD) ET.SubElement(uid, 'G_TA_COD').text = str(el.id.G_TA_COD) ET.SubElement(uid, 'I_RH_COD').text = str_de_bool(el.id.I_RH_COD) ET.SubElement(elXML, 'ordreAppel').text = str(el.ordreAppel) ET.SubElement(elXML, 'rangInternat').text = str(el.rangInternat) ET.SubElement(elXML, 'rangListeAttente').text = str(el.rangListeAttente) racine.append(elXML) internatsXML = ET.Element('internats') for internat in self.internats: uid = ET.SubElement(internatsXML, 'id') ET.SubElement(uid, 'C_GI_COD').text = str(internat.id.C_GI_COD) ET.SubElement(uid, 'G_TA_COD').text = str(internat.id.G_TA_COD) ET.SubElement(internatsXML, 'contingentAdmission').text = str(internat.contingentAdmission) ET.SubElement(internatsXML, 'positionAdmission').text = str(internat.positionAdmission) ET.SubElement(internatsXML, 'positionMaximaleAdmission').text = str(internat.positionMaximaleAdmission) for voeu in internat.voeux: voeuXML = ET.Element('voeux') uid = ET.SubElement(voeuXML, 'id') ET.SubElement(uid, 'G_CN_COD').text = str(voeu.id.G_CN_COD) ET.SubElement(uid, 'G_TA_COD').text = str(voeu.id.G_TA_COD) ET.SubElement(uid, 'I_RH_COD').text = str_de_bool(voeu.id.I_RH_COD) ET.SubElement(voeuXML, 'ordreAppel').text = str(voeu.ordreAppel) ET.SubElement(voeuXML, 'rangInternat').text = str(voeu.rangInternat) ET.SubElement(voeuXML, 'rangListeAttente').text = str(voeu.rangListeAttenteInternat) internatsXML.append(voeuXML) # FIXME for G_CN_COD in sorted(list(internat.candidatsEnAttente)): ET.SubElement(internatsXML, 'candidatsEnAttente').text = str(G_CN_COD) racine.append(internatsXML) return racine
[docs] def exporteSortie_JSON(self) -> Dict: """ Converti les résultats de la sortie en un dictionnaire.""" racine = { 'algoPropositionsSortie': { 'propositions': [ { 'id': { 'G_CN_COD': proposition.id.G_CN_COD, 'G_TA_COD': proposition.id.G_TA_COD, 'I_RH_COD': proposition.id.I_RH_COD, }, 'ordreAppel': proposition.ordreAppel, 'rangInternat': proposition.rangInternat, 'rangListeAttente': proposition.rangListeAttente, } for proposition in self.propositions ], 'enAttentes': [ { 'id': { 'G_CN_COD': enAttente.id.G_CN_COD, 'G_TA_COD': enAttente.id.G_TA_COD, 'I_RH_COD': enAttente.id.I_RH_COD, }, 'ordreAppel': enAttente.ordreAppel, 'rangInternat': enAttente.rangInternat, 'rangListeAttente': enAttente.rangListeAttente, } for enAttente in self.enAttentes ], 'internats': [ { 'id': { 'C_GI_COD': internat.id.C_GI_COD, 'G_TA_COD': internat.id.G_TA_COD, }, 'contingentAdmission': internat.contingentAdmission, 'positionAdmission': internat.positionAdmission, 'positionMaximaleAdmission': internat.positionMaximaleAdmission, 'voeux': [ { 'id': { 'G_CN_COD': voeu.id.G_CN_COD, 'G_TA_COD': voeu.id.G_TA_COD, 'I_RH_COD': voeu.id.I_RH_COD, }, 'ordreAppel': voeu.ordreAppel, 'rangInternat': voeu.rangInternat, 'rangListeAttente': voeu.rangListeAttenteInternat, } for voeu in internat.voeux ], 'candidatsEnAttente': [ G_CN_COD for G_CN_COD in sorted(list(internat.candidatsEnAttente)) # FIXME ] } for internat in self.internats ], } } if DEBUG: pprint(racine) # DEBUG return racine