[Objective] Nomenclature des champs, classes et attributs #43

New Issue

Fred · 2020-10-28T21:42:47+01:00

Fred commented

2020-10-28 21:42:47 +01:00

Hoy,

Dans l'application objective, la nomenclature n'est pas toujours idéale.

models.py

Dans la classe Skill:

rotationType -> rotation_type
simplyNotation -> simple_notation (je suppose) - mais vu la traduction en français que tu proposes, je dirais plutôt simplified_notation. Qu'en dis-tu ?

Dans la classe Routine_Skill:

Il faudrait la renommer RoutineSkill (cf. https://pep8.org/#class-names).

Dans la classe Educative:

longLabel -> long_label
shortLabel -> short_label

(tant qu'à faire, est-ce qu'il existe un medium_label, ou est-ce qu'un des deux champs ci-dessus ne pourrait pas juste être intitulé label ? :-) )

ageBoy -> age_boy
ageGirl -> age_girl
prerequisite -> prerequisites (a priori, c'est un ManyToManyField; il peut donc y avoir plusieurs valeurs. L'attribut doit donc être au pluriel).
educative -> educatives (idem)

admin.py

Dans le fichier admin.py, vu la quantité de champs ajoutés dans la classe SkillAdmin, est-ce qu'il est encore utile de les gérer ? J'ai l'impression qu'ils y sont tous.

vues.py

Il y a beaucoup, beaucoup de commentaires et c'est assez difficile à lire. Est-ce que tu saurais déjà retirer ce qui peut l'être, et dont tu n'aurais plus besoin ?

Au niveau de la nomenclature:

La fonction linkSkillGymnast -> link_skill_to_gymnast
Toujours dans cette fonction, si gymnastid et/ou skillid ne sont pas définis, il faudrait plutôt retourner une erreur http 400 (bad request) que 500 (internal server error)
routine_compose -> compose_routine
del_skill_from_routine -> delete_skill_from_routine
..._detail -> ..._details (au pluriel)

Il y a plusieurs endroits où tu te retrouves à faire un lookup type

MA_CLASSE.objects.filter(
	Q(longLabel__icontains=pattern) | Q(shortLabel__icontains=pattern)
)

Par soucis d'uniformité, tu peux sans doute déplacer ce morceau de code directement au niveau du manager de la classe Educative, qui permettra de faire une recherche sur les long_label et short_label de tous les classes filles.

Hoy, Dans l'application `objective`, la nomenclature n'est pas toujours idéale. ## models.py Dans la classe `Skill`: * rotationType -> rotation_type * simplyNotation -> simple_notation (je suppose) - mais vu la traduction en français que tu proposes, je dirais plutôt `simplified_notation`. Qu'en dis-tu ? Dans la classe `Routine_Skill`: * Il faudrait la renommer `RoutineSkill` (cf. https://pep8.org/#class-names). Dans la classe `Educative`: * longLabel -> long_label * shortLabel -> short_label (tant qu'à faire, est-ce qu'il existe un medium_label, ou est-ce qu'un des deux champs ci-dessus ne pourrait pas juste être intitulé `label` ? :-) ) * ageBoy -> age_boy * ageGirl -> age_girl * prerequisite -> prerequisites (*a priori*, c'est un `ManyToManyField`; il peut donc y avoir plusieurs valeurs. L'attribut doit donc être au pluriel). * educative -> educatives (idem) ## admin.py Dans le fichier `admin.py`, vu la quantité de champs ajoutés dans la classe `SkillAdmin`, est-ce qu'il est encore utile de les gérer ? J'ai l'impression qu'ils y sont tous. ## vues.py Il y a beaucoup, beaucoup de commentaires et c'est assez difficile à lire. Est-ce que tu saurais déjà retirer ce qui peut l'être, et dont tu n'aurais plus besoin ? Au niveau de la nomenclature: * La fonction `linkSkillGymnast` -> `link_skill_to_gymnast` * Toujours dans cette fonction, si `gymnastid` et/ou `skillid` ne sont pas définis, il faudrait plutôt retourner une erreur http 400 (*bad request*) que 500 (*internal server error*) * routine_compose -> compose_routine * del_skill_from_routine -> delete_skill_from_routine * ..._detail -> ..._details (au pluriel) Il y a plusieurs endroits où tu te retrouves à faire un lookup type ```python MA_CLASSE.objects.filter( Q(longLabel__icontains=pattern) | Q(shortLabel__icontains=pattern) ) ``` Par soucis d'uniformité, tu peux sans doute déplacer ce morceau de code directement au niveau du manager de la classe `Educative`, qui permettra de faire une recherche sur les long_label et short_label de tous les classes filles.

Fred added the

enhancement

label 2020-10-28 21:44:37 +01:00

Fred added this to the Revue de l'application `objective` milestone 2020-10-28 21:44:40 +01:00

Sulley was assigned by Fred

2020-10-28 21:44:43 +01:00

Fred referenced this issue

2020-10-28 21:47:09 +01:00

[WIP] Review objectives #36

Sulley referenced this issue from a commit

2021-06-20 18:19:37 +02:00

[WIP] [Objective] Nomenclature des champs, classes et attributs #43