ScoDoc/app/models/formations.py

"""ScoDoc8 models : Formations (hors BUT)
"""
from typing import Any

from app import db
from app.models import APO_CODE_STR_LEN
from app.models import SHORT_STR_LEN


class NotesFormation(db.Model):
    """Programme pédagogique d'une formation"""

    __tablename__ = "notes_formations"
    __table_args__ = (db.UniqueConstraint("acronyme", "titre", "version"),)

    id = db.Column(db.Integer, primary_key=True)
    formation_id = db.synonym("id")
    acronyme = db.Column(db.String(SHORT_STR_LEN), nullable=False)
    titre = db.Column(db.Text(), nullable=False)
    version = db.Column(db.Integer, default=1)
    formation_code = db.Column(db.String(SHORT_STR_LEN), nullable=False)
    type_parcours = db.Column(db.Integer, default=0)
    code_specialite = db.Column(db.String(SHORT_STR_LEN))

    def __init__(self, **kwargs):
        super(NotesFormation, self).__init__(**kwargs)
        if self.formation_code is None:
            # génère formation_code à la création
            self.formation_code = f"FCOD{self.id:03d}"


class NotesUE(db.Model):
    """Unité d'Enseignement"""

    __tablename__ = "notes_ue"

    id = db.Column(db.Integer, primary_key=True)
    ue_id = db.synonym("id")
    formation_id = db.Column(db.Integer, db.ForeignKey("notes_formations.id"))
    acronyme = db.Column(db.String(SHORT_STR_LEN), nullable=False)
    numero = db.Column(db.Integer)  # ordre de présentation
    titre = db.Column(db.Text())
    # Type d'UE: 0 normal ("fondamentale"), 1 "sport", 2 "projet et stage (LP)",
    # 4 "élective"
    type = db.Column(db.Integer, default=0)
    ue_code = db.Column(db.String(SHORT_STR_LEN), nullable=False)
    ects = db.Column(db.Float)  # nombre de credits ECTS
    is_external = db.Column(db.Boolean(), nullable=False, default=False)
    # id de l'element pedagogique Apogee correspondant:
    code_apogee = db.Column(db.String(APO_CODE_STR_LEN))
    # coef UE, utilise seulement si l'option use_ue_coefs est activée:
    coefficient = db.Column(db.Float)

    def __init__(self, **kwargs):
        super(NotesUE, self).__init__(**kwargs)
        if self.ue_code is None:
            # génère code à la création
            self.ue_code = f"UCOD{self.ue_id:03d}"


class NotesMatiere(db.Model):
    """Matières: regroupe les modules d'une UE
    La matière a peu d'utilité en dehors de la présentation des modules
    d'une UE.
    """

    __tablename__ = "notes_matieres"
    __table_args__ = (db.UniqueConstraint("ue_id", "titre"),)

    id = db.Column(db.Integer, primary_key=True)
    matiere_id = db.synonym("id")
    ue_id = db.Column(db.Integer, db.ForeignKey("notes_ue.id"))
    titre = db.Column(db.Text())
    numero = db.Column(db.Integer)  # ordre de présentation


class NotesModule(db.Model):
    """Module"""

    __tablename__ = "notes_modules"

    id = db.Column(db.Integer, primary_key=True)
    module_id = db.synonym("id")
    titre = db.Column(db.Text())
    abbrev = db.Column(db.Text())  # nom court
    code = db.Column(db.String(SHORT_STR_LEN), nullable=False)
    heures_cours = db.Column(db.Float)
    heures_td = db.Column(db.Float)
    heures_tp = db.Column(db.Float)
    coefficient = db.Column(db.Float)  # coef PPN
    ue_id = db.Column(db.Integer, db.ForeignKey("notes_ue.id"))
    formation_id = db.Column(db.Integer, db.ForeignKey("notes_formations.id"))
    matiere_id = db.Column(db.Integer, db.ForeignKey("notes_matieres.id"))
    # pas un id mais le numéro du semestre: 1, 2, ...
    semestre_id = db.Column(db.Integer, nullable=False, default=1)
    numero = db.Column(db.Integer)  # ordre de présentation
    # id de l'element pedagogique Apogee correspondant:
    code_apogee = db.Column(db.String(APO_CODE_STR_LEN))
    module_type = db.Column(db.Integer)  # NULL ou 0:defaut, 1: malus (NOTES_MALUS)


class NotesTag(db.Model):
    """Tag sur un module"""

    __tablename__ = "notes_tags"

    id = db.Column(db.Integer, primary_key=True)
    tag_id = db.synonym("id")
    title = db.Column(db.String(SHORT_STR_LEN), nullable=False, unique=True)


# Association tag <-> module
notes_modules_tags = db.Table(
    "notes_modules_tags",
    db.Column("tag_id", db.Integer, db.ForeignKey("notes_tags.id")),
    db.Column("module_id", db.Integer, db.ForeignKey("notes_modules.id")),
)