mirror of https://gitlab.crans.org/bde/nk20
364 lines
15 KiB
Python
364 lines
15 KiB
Python
# Copyright (C) 2018-2024 by BDE ENS Paris-Saclay
|
||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||
|
||
from functools import lru_cache
|
||
|
||
from django import forms
|
||
from django.db import transaction
|
||
from django.db.models import Q
|
||
|
||
from .base import WEISurvey, WEISurveyInformation, WEISurveyAlgorithm, WEIBusInformation
|
||
from ...models import WEIMembership
|
||
|
||
|
||
buses_descr = [
|
||
[
|
||
"Magi[Kar]p", "#ef5568", 0,
|
||
"""Vous l'aurez compris au nom du bus, l'ambiance est aux jeux et à la culture geek ! Ici, vous trouverez une ambiance
|
||
calme avec une bonne dose d'autodérision et de second degré. Que vous ayez besoin de beaucoup dormir pour tenir la soirée
|
||
du lendemain, ou que vous souhaitiez faire nuit blanche pour jouer toute la nuit, vous pouvez nous rejoindre. Votre voix
|
||
n'y survivra peut-être pas à force de chanter. PS : les meilleurs cocktails du WEI sont chez nous, à déguster, pas à
|
||
siphonner !""",
|
||
],
|
||
[
|
||
"Va[car]me", "#fd7a28", 0,
|
||
"""Ici c'est le bus du bruit. Que ce soit les groupes de musique du Bureau des Arts ou la fanfare, on sera là pour vous
|
||
ambiancer ! On fera en sorte que vous vous souveniez de votre WEI et de son Vacarme !""",
|
||
],
|
||
[
|
||
"[Kar]aïbes", "#a5cfdd", 0,
|
||
"""Bus dans le thème des Caraïbes … 🐬🏴☠️🐬""",
|
||
],
|
||
[
|
||
"[Kar]di [Bus]", "#e46398", 0,
|
||
"""Bienvenue à bord du Kardi Bus, la seul, l’unique, l’inimitable pépite de ce weekend d’intégration ! Inspiré par les
|
||
icônes suprêmes de la pop culture telles les Bratz, les Winx et autres Mean Girls, notre bus est un sanctuaire de style,
|
||
d’audace et de pur plaisir. A nos cotés attends toi à siroter tes meilleurs Cosmo, sex on the Beach et autres cocktails
|
||
de maxi pétasse tout en papotant entre copains copines ! Si tu rejoins le Kardi Bus, tu entres dans un monde où tu
|
||
pourras te déhancher sur du Beyoncé, Britney, Aya et autres reines de la pop ! À très vite, les futures stars du Kardi
|
||
Bus !""",
|
||
],
|
||
[
|
||
"Sparta[bus] 🏉", "#ebdac2", 0,
|
||
"""Dans notre bus, on vous donne un avant goût des plus grandes assos de l'ENS : les Kyottes et l'Aspique (clubs de rugby
|
||
féminin et masculin, mais pas que). Bien entendu, qui dit rugby dit les copaings, le pastaga et la Pena Bayona, mais vous
|
||
verrez par vous même qu'on est ouvert⋅e à toutes propositions quand il s'agit de faire la fête. Pour les casse-cous comme
|
||
pour les plus calmes, vous trouverez au bus Aspique-Kyottes les 2A+ qui vous feront kiffer votre WEI.""",
|
||
],
|
||
[
|
||
"Zanzo[Bus]", "#FFFF", 0,
|
||
"""Dans un entre-trois bien senti entre zinzinerie, enfance et vieillerie, le Zanzo[BUS] est un concentré de fun mêlé à
|
||
de la dinguerie à gogo. N'hésitez plus et rejoignez-nous pour un WEI toujours plus déjanté !""",
|
||
],
|
||
[
|
||
"Bran[Kar] 🥳", "#6da1ac", 3.5,
|
||
"""Si vous ne connaissez pas le Bran[Kar], c’est comme une grande famille qui fait un apéro, qui se bourre un peu la
|
||
gueule en discutant des heures autour d’une table remplie de bouffe et de super bons cocktails (la plupart des
|
||
barmen/barwomen du bus sont les barmans de Shakens), sauf qu’on est un bus du Wei (vous comprendrez bien le nom de notre
|
||
bus en voyant l’état de certain·e·s). Il nous arrive de faire quelques conneries, mais surtout de jouer au Bière-pong en
|
||
musique !""",
|
||
],
|
||
[
|
||
"Techno [kar]ade", "#8065a3", 0,
|
||
"""Avis à tous·tes les gauchos, amoureux·ses de la fête et des manifs : le Techno [kar]ade vous ouvre grand ses bras pour
|
||
finir en beauté votre première inté. Préparez-vous à vous abreuver de cocktails (savamment élaborés) à la vibration d’un
|
||
système son fabriqué pour l’occasion. Des sets technos à « Mon père était tellement de gauche » en passant par « Female
|
||
Body », le car accueillant les meilleures DJs du plateau saura animer le trajet aussi bien que les soirées. Si alcool et
|
||
musique seront au rendez-vous, les maîtres mots sont sécurité et inclusivité. Qui que vous soyez et quelle que soit votre
|
||
manière de vous amuser, notre objectif est que vous vous sentiez à l’aise pour rencontrer au mieux les 1A, les 2A et les
|
||
(nombreux⋅ses) 3A+ qui auront répondu à l’appel. Bref, rejoignez-nous, on est super cools :)"""
|
||
],
|
||
[
|
||
"[Bus]ka-P", "#7c4768", 0,
|
||
"""Booska-p, c’est le « site N°1 du Rap français ». Le [Bus]ka-p ? Le bus N°1 sur l’ambiance au WEI. Les nuits vont être
|
||
courtes, les cocktails vont couler à flots : tout sera réuni pour vivre un week-end dont tu te souviendras toute ta vie.
|
||
Au programme pas un seul temps mort et un maximum de rencontres pour bien commencer ta première année à l’ENS. Et bien
|
||
entendu, le tout accompagné des meilleurs sons, de Jul à Aya, en passant par ABBA et Sexion d’Assaut. Bref, si tu veux
|
||
vivre un WEI d’anthologie et faire la fête, de jour comme de nuit, nous t’accueillons avec plaisir !""",
|
||
],
|
||
]
|
||
|
||
|
||
def print_bus(i):
|
||
return f"""<h1 style="color:{buses_descr[i][1]};-webkit-text-stroke: 2px black;font-size: 50px;">{buses_descr[i][0]}</h1><br>
|
||
<b>Alcoolomètre : {buses_descr[i][2]} / 5 🍻</b><br><br>{buses_descr[i][3]}<br>"""
|
||
|
||
|
||
def print_all_buses():
|
||
liste = [print_bus(i) for i in range(len(buses_descr))]
|
||
return "<br><br><br><br>".join(liste)
|
||
|
||
|
||
def get_number_comment(i):
|
||
if i == 1:
|
||
return "Même pas en rêve"
|
||
elif i == 2:
|
||
return "Pas envie"
|
||
elif i == 3:
|
||
return "Mouais..."
|
||
elif i == 4:
|
||
return "Pourquoi pas !"
|
||
elif i == 5:
|
||
return "Ce bus ou rien !!!"
|
||
else:
|
||
return ""
|
||
|
||
|
||
WORDS = {
|
||
"recap":
|
||
[
|
||
"""<b>Chèr⋅e 1A, te voilà arrivé⋅e au moment fatidique du choix de ton bus !<br><br><br>
|
||
Ton bus est constitué des gens avec qui tu passeras la majorité de ton temps : que ce soit le voyage d'aller et de
|
||
retour et les différentes activité qu'ils pourront te proposer tout au long du WEI donc choisis le bien !
|
||
<br><br>Tu trouveras ci-dessous la liste de tous les bus ainsi qu'une description détaillée de ces derniers.
|
||
Prends ton temps pour étudier chacun d'eux et quand tu te sens prêt⋅e, appuie sur le bouton « J'ai pris connaissance
|
||
des bus » pour continuer
|
||
<br>(pas besoin d'apprendre par cœur chaque bus, la description de chaque bus te sera rappeler avant de lui attribuer
|
||
une note !)</b><br><br><br>""" + print_all_buses(),
|
||
{
|
||
"1": "J'ai pris connaissance des différents bus et me sent fin prêt à choisir celui qui me convient le mieux !",
|
||
}
|
||
]
|
||
}
|
||
|
||
WORDS.update({
|
||
f"bus{id}": [print_bus(id), {i: f"{get_number_comment(i)} ({i}/5)" for i in range(1, 5 + 1)}] for id in range(len(buses_descr))
|
||
})
|
||
|
||
|
||
class WEISurveyForm2024(forms.Form):
|
||
"""
|
||
Survey form for the year 2024.
|
||
Members answer 10 questions, from which we calculate the best associated bus.
|
||
"""
|
||
def set_registration(self, registration):
|
||
"""
|
||
Filter the bus selector with the buses of the current WEI.
|
||
"""
|
||
information = WEISurveyInformation2024(registration)
|
||
|
||
question = information.questions[information.step]
|
||
self.fields[question] = forms.ChoiceField(
|
||
label=WORDS[question][0],
|
||
widget=forms.RadioSelect(),
|
||
)
|
||
answers = [(answer, WORDS[question][1][answer]) for answer in WORDS[question][1]]
|
||
self.fields[question].choices = answers
|
||
|
||
|
||
class WEIBusInformation2024(WEIBusInformation):
|
||
"""
|
||
For each question, the bus has ordered answers
|
||
"""
|
||
scores: dict
|
||
|
||
def __init__(self, bus):
|
||
self.scores = {}
|
||
for question in WORDS:
|
||
self.scores[question] = []
|
||
super().__init__(bus)
|
||
|
||
|
||
class WEISurveyInformation2024(WEISurveyInformation):
|
||
"""
|
||
We store the id of the selected bus. We store only the name, but is not used in the selection:
|
||
that's only for humans that try to read data.
|
||
"""
|
||
|
||
step = 0
|
||
questions = list(WORDS.keys())
|
||
|
||
def __init__(self, registration):
|
||
for question in WORDS:
|
||
setattr(self, str(question), None)
|
||
super().__init__(registration)
|
||
|
||
|
||
class WEISurvey2024(WEISurvey):
|
||
"""
|
||
Survey for the year 2024.
|
||
"""
|
||
|
||
@classmethod
|
||
def get_year(cls):
|
||
return 2024
|
||
|
||
@classmethod
|
||
def get_survey_information_class(cls):
|
||
return WEISurveyInformation2024
|
||
|
||
def get_form_class(self):
|
||
return WEISurveyForm2024
|
||
|
||
def update_form(self, form):
|
||
"""
|
||
Filter the bus selector with the buses of the WEI.
|
||
"""
|
||
form.set_registration(self.registration)
|
||
|
||
@transaction.atomic
|
||
def form_valid(self, form):
|
||
self.information.step += 1
|
||
for question in WORDS:
|
||
if question in form.cleaned_data:
|
||
answer = form.cleaned_data[question]
|
||
setattr(self.information, question, answer)
|
||
self.save()
|
||
|
||
@classmethod
|
||
def get_algorithm_class(cls):
|
||
return WEISurveyAlgorithm2024
|
||
|
||
def is_complete(self) -> bool:
|
||
"""
|
||
The survey is complete once the bus is chosen.
|
||
"""
|
||
for question in WORDS:
|
||
if not getattr(self.information, question):
|
||
return False
|
||
return True
|
||
|
||
@lru_cache()
|
||
def score(self, bus):
|
||
if not self.is_complete():
|
||
raise ValueError("Survey is not ended, can't calculate score")
|
||
|
||
bus_info = self.get_algorithm_class().get_bus_information(bus)
|
||
# Score is the given score by the bus subtracted to the mid-score of the buses.
|
||
s = 0
|
||
for question in WORDS:
|
||
s += bus_info.scores[question][str(getattr(self.information, question))]
|
||
return s
|
||
|
||
@lru_cache()
|
||
def scores_per_bus(self):
|
||
return {bus: self.score(bus) for bus in self.get_algorithm_class().get_buses()}
|
||
|
||
@lru_cache()
|
||
def ordered_buses(self):
|
||
values = list(self.scores_per_bus().items())
|
||
values.sort(key=lambda item: -item[1])
|
||
return values
|
||
|
||
@classmethod
|
||
def clear_cache(cls):
|
||
return super().clear_cache()
|
||
|
||
|
||
class WEISurveyAlgorithm2024(WEISurveyAlgorithm):
|
||
"""
|
||
The algorithm class for the year 2024.
|
||
We use Gale-Shapley algorithm to attribute 1y students into buses.
|
||
"""
|
||
|
||
@classmethod
|
||
def get_survey_class(cls):
|
||
return WEISurvey2024
|
||
|
||
@classmethod
|
||
def get_bus_information_class(cls):
|
||
return WEIBusInformation2024
|
||
|
||
def run_algorithm(self, display_tqdm=False):
|
||
"""
|
||
Gale-Shapley algorithm implementation.
|
||
We modify it to allow buses to have multiple "weddings".
|
||
"""
|
||
surveys = list(self.get_survey_class()(r) for r in self.get_registrations()) # All surveys
|
||
surveys = [s for s in surveys if s.is_complete()] # Don't consider invalid surveys
|
||
# Don't manage hardcoded people
|
||
surveys = [s for s in surveys if not hasattr(s.information, 'hardcoded') or not s.information.hardcoded]
|
||
|
||
# Reset previous algorithm run
|
||
for survey in surveys:
|
||
survey.free()
|
||
survey.save()
|
||
|
||
non_men = [s for s in surveys if s.registration.gender != 'male']
|
||
men = [s for s in surveys if s.registration.gender == 'male']
|
||
|
||
quotas = {}
|
||
registrations = self.get_registrations()
|
||
non_men_total = registrations.filter(~Q(gender='male')).count()
|
||
for bus in self.get_buses():
|
||
free_seats = bus.size - WEIMembership.objects.filter(bus=bus, registration__first_year=False).count()
|
||
# Remove hardcoded people
|
||
free_seats -= WEIMembership.objects.filter(bus=bus, registration__first_year=True,
|
||
registration__information_json__icontains="hardcoded").count()
|
||
quotas[bus] = 4 + int(non_men_total / registrations.count() * free_seats)
|
||
|
||
tqdm_obj = None
|
||
if display_tqdm:
|
||
from tqdm import tqdm
|
||
tqdm_obj = tqdm(total=len(non_men), desc="Non-hommes")
|
||
|
||
# Repartition for non men people first
|
||
self.make_repartition(non_men, quotas, tqdm_obj=tqdm_obj)
|
||
|
||
quotas = {}
|
||
for bus in self.get_buses():
|
||
free_seats = bus.size - WEIMembership.objects.filter(bus=bus, registration__first_year=False).count()
|
||
free_seats -= sum(1 for s in non_men if s.information.selected_bus_pk == bus.pk)
|
||
# Remove hardcoded people
|
||
free_seats -= WEIMembership.objects.filter(bus=bus, registration__first_year=True,
|
||
registration__information_json__icontains="hardcoded").count()
|
||
quotas[bus] = free_seats
|
||
|
||
if display_tqdm:
|
||
tqdm_obj.close()
|
||
|
||
from tqdm import tqdm
|
||
tqdm_obj = tqdm(total=len(men), desc="Hommes")
|
||
|
||
self.make_repartition(men, quotas, tqdm_obj=tqdm_obj)
|
||
|
||
if display_tqdm:
|
||
tqdm_obj.close()
|
||
|
||
# Clear cache information after running algorithm
|
||
WEISurvey2024.clear_cache()
|
||
|
||
def make_repartition(self, surveys, quotas=None, tqdm_obj=None):
|
||
free_surveys = surveys.copy() # Remaining surveys
|
||
while free_surveys: # Some students are not affected
|
||
survey = free_surveys[0]
|
||
buses = survey.ordered_buses() # Preferences of the student
|
||
for bus, current_score in buses:
|
||
if self.get_bus_information(bus).has_free_seats(surveys, quotas):
|
||
# Selected bus has free places. Put student in the bus
|
||
survey.select_bus(bus)
|
||
survey.save()
|
||
free_surveys.remove(survey)
|
||
break
|
||
else:
|
||
# Current bus has not enough places. Remove the least preferred student from the bus if existing
|
||
least_preferred_survey = None
|
||
least_score = -1
|
||
# Find the least student in the bus that has a lower score than the current student
|
||
for survey2 in surveys:
|
||
if not survey2.information.valid or survey2.information.get_selected_bus() != bus:
|
||
continue
|
||
score2 = survey2.score(bus)
|
||
if current_score <= score2: # Ignore better students
|
||
continue
|
||
if least_preferred_survey is None or score2 < least_score:
|
||
least_preferred_survey = survey2
|
||
least_score = score2
|
||
|
||
if least_preferred_survey is not None:
|
||
# Remove the least student from the bus and put the current student in.
|
||
# If it does not exist, choose the next bus.
|
||
least_preferred_survey.free()
|
||
least_preferred_survey.save()
|
||
free_surveys.append(least_preferred_survey)
|
||
survey.select_bus(bus)
|
||
survey.save()
|
||
free_surveys.remove(survey)
|
||
break
|
||
else:
|
||
raise ValueError(f"User {survey.registration.user} has no free seat")
|
||
|
||
if tqdm_obj is not None:
|
||
tqdm_obj.n = len(surveys) - len(free_surveys)
|
||
tqdm_obj.refresh()
|