Documentation Développeur du module Assiduité #66

Merged
viennet merged 3 commits from iziram/DocAssiduites:doc-assi-dev into master 2024-07-26 09:41:29 +02:00
Showing only changes of commit c688bf6578 - Show all commits

View File

@ -84,12 +84,37 @@ Cependant suite à une demande des utilisateurs, il existe un **FAUX** module no
!!! warning !!! warning
Ce **FAUX** module n'est pas inscrit dans le `moduleimpl_id` mais dans `external_data`. Ce **FAUX** module n'est pas inscrit dans le `moduleimpl_id` mais dans `external_data`.
Voici le format de `external_data` :
```json
{
"module":"Autre",
"cle-non-scodoc" : "valeur-non-scodoc"
}
```
Des fonctions ont été rédigées pour faciliter la gestion de ce **FAUX** module. Elles sont toutes disponibles dans la classe de l'objet Assiduité. ([voir le code](https://git.scodoc.org/ScoDoc/ScoDoc/src/branch/master/app/models/assiduites.py)) Des fonctions ont été rédigées pour faciliter la gestion de ce **FAUX** module. Elles sont toutes disponibles dans la classe de l'objet Assiduité. ([voir le code](https://git.scodoc.org/ScoDoc/ScoDoc/src/branch/master/app/models/assiduites.py))
- `get_module` : récupère (si existant) le module associé à l'assiduité - `get_module` : récupère (si existant) le module associé à l'assiduité
- Si module `ScoDoc` : renvoie l'objet Module (ou le titre du module si la traduction est active)
- Si module `external_data:Autre` : renvoie la chaîne `Autre module (pas dans la liste)`
- Si module `external_data:?` : renvoie la valeur liée à la clé "module" de external_data
- Si pas de module : renvoie None (ou `Module non spécifié` si la traduction est active)
- `get_moduleimpl_id` : récupère (si existant) le moduleimpl_id associé à l'assiduité (comprend le module autre) - `get_moduleimpl_id` : récupère (si existant) le moduleimpl_id associé à l'assiduité (comprend le module autre)
- Si moduleimpl `ScoDoc` : renvoie l'id du moduleimpl
- Si module dans `external_data` : renvoie la valeur liée à la clé "module" de external_data
- Si pas de module : renvoie None
- `set_moduleimpl_id` : permet de mettre à jour le moduleimpl_id (prend en compte le module autre) - `set_moduleimpl_id` : permet de mettre à jour le moduleimpl_id (prend en compte le module autre)
On peut donner :
- `<int/str:moduleimpl_id>` : l'identifiant d'un moduleimpl
- `"autre"` : le module autre
- `""` : pas de module
### Représentation du Justificatif ### Représentation du Justificatif
@ -133,8 +158,8 @@ Le tableau si dessous reprend la représation des données d'un justificatif.
#### Etudiants #### Etudiants
Chaque justificatif est obligatoirement associée à un étudiant (Identite). Chaque justificatif est obligatoirement associé à un étudiant (Identite).
Il est possible de récupérer toutes les justificatifs d'un étudiant en utilisant la relation à partir du modèle Identite. Il est possible de récupérer tous les justificatifs d'un étudiant en utilisant la relation à partir du modèle Identite.
```py ```py
etudiant : Identite = Identite.get_etud(1234) etudiant : Identite = Identite.get_etud(1234)
@ -199,7 +224,7 @@ L'ensemble des fonctionnalités relatives aux archives justificatives (fichiers
Les archives sont enregistrées dans le dossier `/opt/scodoc-data/archives/`. Les archives sont enregistrées dans le dossier `/opt/scodoc-data/archives/`.
Voici la représentation de l'arboressence des fichiers justificatifs: Voici la représentation de larborescence des fichiers justificatifs:
```text ```text
justificatif/ justificatif/