Comprendre le code par vous-même
- Leçon 15
- 45 min
- Module 5 : Livrer un travail facile à maintenir
Où nous en sommes
Dans les deux dernières leçons, nous avons gardé la modification ciblée et documenté ses décisions avec des preuves. Il reste une étape avant la révision : un assistant a écrit une grande partie du code, mais nous répondons de chaque ligne. Dans cette leçon, nous expliquons sans aide chaque ligne qui change le comportement, montrons quel test la protège et ouvrons une demande de tirage qu'un réviseur peut vérifier seul, comme le cuisinier qui sert le plat.
Leçon 15 sur 15 · Développement logiciel assisté par l'IAComprendre le code par vous-même
1. Mettre en place un environnement de travail sûr
2. Rédiger des tâches exploitables
3. Réviser le travail généré
4. Déboguer et tester avec l'assistant
5. Livrer un travail facile à maintenir
Ce que vous saurez faire
Avant de demander une révision, expliquez sans aide chaque ligne qui change le comportement. Montrez quel test protège chaque ligne. Ouvrez une demande de tirage qu’un réviseur peut vérifier seul. Nommez les décisions qu’une personne doit encore prendre.
Avant de commencerCe qu’il faut savoir et avoir sous la main
Ce que vous devez savoir
- Les demandes de tirage (pull requests) et leur description (« Problème, Changement, Comment j’ai vérifié »), dans Les étapes d’une demande de tirage du cours L’essentiel de Git et du développement en équipe.
- Un dépôt distant sous forme de dépôt nu dans un dossier, dans Synchroniser de façon réfléchie.
- Une copie neuve comme preuve d’une passation réussie, dans Qualité et passation du cours Python pour l’ingénierie de l’IA en pratique.
Ce qu’il vous faut sur votre ordinateur
- Le projet
~/projects/ticket-cleaner-assistaprès la dernière leçon, avec son environnement actif.python -m pytestaffiche42 passed(42 tests réussis), etgit status --shortn’affiche rien. maincontient seulement le point de départ du cours. Vérifiez-le :git diff --stat main...feature/category-option -- ticket_cleaner/se termine par3 files changed, 34 insertions(+), 7 deletions(-)(3 fichiers modifiés, 34 ajouts, 7 suppressions). Sinon, suivez les étapes de réinitialisation sous Vérification du module.- Environ 40 Mo d’espace libre pour une deuxième copie du projet avec son propre environnement.
- Aucun compte, aucun site Web et aucun paiement. Le dépôt distant est un dossier sur votre ordinateur.
Le cuisinier qui sert le plat
Section intitulée « Le cuisinier qui sert le plat »Au restaurant, une personne demande : « Y a-t-il des noix dans cette sauce? » Un aide a préparé la sauce, pas le cuisinier. « Je ne l’ai pas faite » ne donne pas une réponse utile à cette personne. Le cuisinier qui sert le plat répond de chaque ingrédient. Un cuisinier prudent sait donc ce que contient l’assiette avant qu’elle quitte la cuisine.
Une demande de tirage, c’est l’assiette qui quitte la cuisine. L’assistant était l’aide.
Le problème : « les tests passent, fusionnez »
Section intitulée « Le problème : « les tests passent, fusionnez » »Votre branche contient tout le changement de ce cours : l’option, la correction, le réusinage et les documents. Les 42 tests passent. Tomás lit le résultat :
« Quarante-deux tests réussis. Qu’est-ce qu’il reste à expliquer? Ouvrez la demande de tirage. »
Voici un point qu’aucun test ni aucune tâche ne mentionnait. Produisez le rapport pending (en attente) du fichier d’exemple sur main, puis sur votre branche :
git switch mainpython -m ticket_cleaner data/tickets.csv --status pendinggit switch feature/category-optionpython -m ticket_cleaner data/tickets.csv --status pendingOuvrez reports/summary.json après chaque exécution. Voici les résultats de l’auteur :
main: {"LOGIN": 1, "billing": 1}feature/category-option: {"billing": 1, "login": 1}Le fichier d’exemple contient un billet de soutien enregistré sous LOGIN (T-1010, ligne 11 de data/tickets.csv). La correction du module 4 a changé la façon d’enregistrer chaque catégorie. Ce rapport a donc changé aussi. C’est normal : la correction du bogue fait son travail. Mais l’équipe de Grace pourrait comparer le rapport de ce mois avec celui du mois dernier. Une ligne LOGIN qui disparaît semblera être un billet perdu, à moins qu’on les prévienne.
Le test de référence de base ne l’a pas détecté, car il fixe seulement le rapport open (ouvert) par défaut. Donc, « les tests passent » ne vous l’a pas révélé. Il fallait lire la ligne et se demander ce qu’elle touche d’autre.
L’idée : expliquer chaque ligne importante
Section intitulée « L’idée : expliquer chaque ligne importante »Comprendre le code par vous-même signifie pouvoir expliquer votre changement final sans l’assistant, ligne par ligne, à un réviseur qui le demande. Toutes les lignes ne demandent pas la même attention. Une ligne importante change le comportement, un contrat, les données enregistrées ou la sécurité. Par exemple : une condition, une valeur par défaut, une clé du rapport ou une règle de nettoyage. Une ligne vide, une chaîne de documentation ou un appel remis en forme n’est pas une ligne importante. Vous la lisez quand même.
Pour chaque ligne importante, vous pouvez répondre à quatre questions :
- Que fait-elle, avec une entrée concrète?
- Pourquoi est-elle là : quelle exigence ou quel bogue la rend nécessaire?
- Quel test échoue sans elle?
- Que touche-t-elle d’autre?
Les deux premières réponses vont dans un tableau de traçabilité : chaque exigence, le changement qui y répond et la preuve. Vous avez vu sa première moitié dans Problème et critères d’acceptation. La demande de tirage le complète avec les différences et les tests.
Description textuelle du diagramme
| Exigence | Changement (fichier) | Preuve (test) |
|---|---|---|
| 1. Compter seulement les catégories choisies | report.py : build_summary(..., categories) |
test_one_category |
| 2. L’option peut être fournie plusieurs fois | cli.py : action="append" |
test_a_ticket_in_any_chosen_category_counts, test_report_for_some_categories |
| 3. Les majuscules et les espaces ne comptent pas | report.py : clean_category(name) |
test_category_name_ignores_capital_letters_and_spaces |
4. Clé categories seulement avec l’option |
report.py : if chosen is not None |
test_categories_key_only_with_the_option, tests/test_baseline.py |
| 5. Comptes du fichier entier inchangés | report.py : filtre après les totaux |
test_categories_do_not_change_the_whole_file_counts |
| 6. Une catégorie inconnue n’est pas une erreur | (aucun code nécessaire) | test_unknown_category_selects_nothing |
| 7. L’aide et le README décrivent l’option | Aide de cli.py, README.md |
test_help_describes_the_category_option, tests/test_readme.py |
| Bogue : une ligne par équipe | parsing.py : clean_category nettoie d’abord |
test_capital_letters_do_not_make_a_new_category (il échouait avant la correction), test_web_form_export_has_one_line_per_team |
Un petit exemple : briser une ligne volontairement
Section intitulée « Un petit exemple : briser une ligne volontairement »Comment savoir si un test protège vraiment une ligne? Changez la ligne volontairement, lancez les tests, puis rétablissez-la. Si aucun test n’échoue, la ligne n’a pas de protection ou ne fait rien. Les spécialistes des tests appellent une forme systématique de cette méthode les tests par mutation. À la main, pour quelques lignes, cela prend quelques minutes.
Prenez l’exigence 2. Dans ticket_cleaner/cli.py, supprimez une ligne de l’option --category, puis enregistrez :
parser.add_argument( "--category", action="append", metavar="NAME",Prédisez quels tests échoueront. Puis lancez-les :
python -m pytestFAILED tests/test_cli.py::test_report_for_some_categories - ...========================= 1 failed, 41 passed in 0.05s =========================Un seul test. Sans action="append", args.category contient un seul texte plutôt qu’une liste, et le dernier --category l’emporte. Les tests unitaires de test_report.py appellent build_summary() avec une liste. Ils ne peuvent donc pas le voir. Seul le test qui exécute la commande entière le peut. Rétablissez la ligne et vérifiez que rien d’autre n’a changé :
git restore ticket_cleaner/cli.pygit status --shortgit status --short n’affiche rien. L’auteur a fait la même chose pour six lignes importantes :
Description textuelle du diagramme
| Ligne changée volontairement | Résultat |
|---|---|
parsing.py : text = clean_text(value) → str(value).strip() (annuler la correction) |
10 échecs, 32 réussites |
report.py : clean_category(name) → name |
4 échecs, 38 réussites |
report.py : clean_category(name) → name.strip().lower() (la règle du module 4) |
1 échec, 41 réussites : seulement test_web_form_names_work_in_the_category_option |
report.py : la clé categories dans chaque rapport |
2 échecs, 40 réussites : le test de référence de base et test_categories_key_only_with_the_option |
report.py : "valid_records": len(selected) |
4 échecs, 38 réussites |
cli.py : sans action="append" |
1 échec, 41 réussites : seulement test_report_for_some_categories |
Larkfield : la demande de tirage d’exercice
Section intitulée « Larkfield : la demande de tirage d’exercice »Voici la tâche pratique du module : soumettre la fonctionnalité et la correction du défaut dans une demande de tirage facile à réviser. Comme dans le cours sur Git, c’est une simulation locale. Le dépôt distant est un dépôt nu dans un dossier. Vous jouez les deux rôles : Amira, qui ouvre la demande, et Kwame, qui la révise.
-
Regardez tout le changement d’un coup. Deux points listent les commits (changements enregistrés) de la branche. Trois points montrent les changements depuis la création de la branche :
Fenêtre de terminal git log --oneline main..feature/category-optiongit diff --stat main...feature/category-option -- ticket_cleaner/Output (the author's run) 51b4ddf Document the cleaning rule, the limitations and the decisions23d515b Clean the --category names with the same rule as the ticketsb52a2f9 Copy the snapshot end-of-m04ticket_cleaner/cli.py | 8 +++++++-ticket_cleaner/parsing.py | 9 ++++++---ticket_cleaner/report.py | 24 +++++++++++++++++++++---3 files changed, 34 insertions(+), 7 deletions(-)L’auteur a regroupé les modules 1 à 4 dans un seul commit, comme le font les étapes de réinitialisation. Votre liste contient onze commits : neuf des modules 1 à 4, et deux de ce module. La ligne
--statest la même. -
Lisez la partie code, avec le tableau ci-dessus à côté :
Fenêtre de terminal git diff main...feature/category-option -- ticket_cleaner/Pour chaque ligne modifiée, dites à voix haute : ce qu’elle fait, pourquoi, quel test la protège et ce qu’elle touche d’autre. Les lignes 31 à 36 de
cli.pyajoutent l’option. La ligne 71 la transmet. Les lignes 23 et 24 deparsing.pysont la correction. Dansreport.py, la ligne 1 importe l’unique règle de nettoyage. Les lignes 38 à 41 choisissent et filtrent. Les lignes 50 et 51 ajoutent la clécategories. Le reste contient des chaînes de documentation et la nouvelle signature. -
Brisez une ligne volontairement, comme dans le petit exemple. Choisissez une ligne du tableau, mais pas celle de l’exemple. Prédisez le résultat, lancez
python -m pytest, puis rétablissez le fichier avecgit restore. Notez la ligne et le test qui a détecté le changement. Vous les utiliserez dans la vérification de fin de module. -
Rédigez la description de la demande de tirage. Elle se trouve dans le projet, sous
docs/pull-request.md, pour accompagner la branche. Copiez-la depuis l’instantané, puis comparez chaque ligne à vos propres exécutions :Fenêtre de terminal cp ../nextia-learning-labs/C15/snapshots/end-of-m05/docs/pull-request.md docs/Fenêtre de terminal Copy-Item ..\nextia-learning-labs\C15\snapshots\end-of-m05\docs\pull-request.md docs\Elle contient les parties du cours sur Git, et trois autres : le tableau, l’utilisation d’un assistant et les points à réviser. Le texte complet se trouve après ces étapes.
-
Lancez les vérifications promises dans la description, puis enregistrez-la dans un commit :
Fenêtre de terminal python -m pytestruff check .ruff format --check .python -m ticket_cleaner data/web-form-export.csv --category Sign-ingit add docs/pull-request.mdgit commit -m "Describe the pull request"Sortie (extrait) ============================== 42 passed in 0.04s ==============================All checks passed!24 files already formatted[feature/category-option bd7c066] Describe the pull request1 file changed, 45 insertions(+)create mode 100644 docs/pull-request.mdLe rapport de la commande
Sign-in(connexion) contient"by_category": {"login": 4}. -
Créez le dépôt distant à côté du projet. Utilisez un nouveau nom :
team-remote.gitdu cours sur Git contientticket-notes, un autre projet.Fenêtre de terminal cd ..git init --bare ticket-cleaner-remote.gitcd ticket-cleaner-assistgit remote add origin ../ticket-cleaner-remote.gitSortie Initialized empty Git repository in ~/projects/ticket-cleaner-remote.git/Votre sortie montre le chemin complet de votre dossier.
-
Poussez les deux branches. La cible
maindoit exister sur le dépôt distant pour permettre au réviseur de comparer :Fenêtre de terminal git push -u origin maingit push -u origin feature/category-optionSortie To ../ticket-cleaner-remote.git* [new branch] main -> mainbranch 'main' set up to track 'origin/main'.To ../ticket-cleaner-remote.git* [new branch] feature/category-option -> feature/category-optionbranch 'feature/category-option' set up to track 'origin/feature/category-option'.La demande de tirage est
feature/category-option → main, et sa description estdocs/pull-request.md.
Voici la description. Lisez-la comme un réviseur, avec les différences ouvertes :
# Pull request: report by category, and one line per team
Branch: `feature/category-option` → `main`
## What and why
- Grace asked for the report of one or a few categories (`docs/tasks/category-option.md`).- Grace's bug: with the web form's export, one team appeared under several names (`docs/tasks/category-names-bug.md`).
## Requirement → change → evidence
| Requirement | Change (file) | Evidence ||---|---|---|| 1. Count only the chosen categories | `report.py` `build_summary(..., categories)` | `test_one_category` || 2. The option can be given more than once | `cli.py` `action="append"` | `test_a_ticket_in_any_chosen_category_counts`, `test_report_for_some_categories` || 3. Capital letters and spaces do not matter | `report.py` uses `clean_category` | `test_category_name_ignores_capital_letters_and_spaces` || 4. `categories` key only with the option | `report.py` | `test_categories_key_only_with_the_option`, `test_baseline.py` || 5. Whole-file counts unchanged | `report.py` filters after the totals | `test_categories_do_not_change_the_whole_file_counts` || 6. Unknown category is not an error | (no code needed) | `test_unknown_category_selects_nothing` || 7. Help and README describe the option | `cli.py` help, `README.md` | `test_help_describes_the_category_option`, `test_readme.py` || Bug: one line per team | `parsing.py` `clean_category` cleans first | `test_capital_letters_do_not_make_a_new_category` (fails before the fix), `test_web_form_export_has_one_line_per_team` |
## How I checked it
```shpython -m pytest # 42 passedruff check .ruff format --check .python -m ticket_cleaner data/web-form-export.csv --category Sign-in```
## Use of a coding assistant
An assistant suggested the first version of the option and of the fix. I readevery line, ran the tests myself, and changed or rejected some suggestions:see `DECISIONS.md`. The regression test was written first and failed on the oldcode.
## What a reviewer should look at
- `parsing.py`: the fix changes how every category is stored. Reports of older files can change where a category had capital letters (`LOGIN` → `login`).- `CATEGORY_ALIASES` is owned by the web form's team.Deux parties sont nouvelles par rapport au cours sur Git. Utilisation d’un assistant de programmation indique clairement ce que l’assistant a fait et ce que vous avez fait. Elle ne cache pas l’assistant et ne le blâme pas. Points à examiner par le réviseur indique le changement du rapport pending présenté dans le problème ci-dessus. Vous l’avez trouvé; le réviseur n’a plus à le chercher.
Sur GitHub, les étapes sont les mêmes jusqu’à la poussée. Ensuite, Compare & pull request (comparer et ouvrir une demande de tirage) ouvre un formulaire. Collez la description, réglez base (branche cible) sur main, puis sélectionnez Create pull request (créer une demande de tirage). C’est facultatif et ce cours ne l’exige pas.
Kwame révise : un nouveau clone, un nouvel environnement
Section intitulée « Kwame révise : un nouveau clone, un nouvel environnement »Kwame ne se fie pas à « 42 tests réussis » dans une description, même celle d’Amira. Il lance lui-même les vérifications, dans un nouveau clone, avec un nouvel environnement. C’est la vérification de fin de module. Vous la faites maintenant dans le rôle de Kwame.
-
Clonez le dépôt distant dans un nouveau dossier, à côté du projet, puis passez à la branche :
Fenêtre de terminal cd ~/projectsgit clone ticket-cleaner-remote.git kwame-reviewcd kwame-reviewgit switch feature/category-optionSortie Cloning into 'kwame-review'...done.Switched to a new branch 'feature/category-option'branch 'feature/category-option' set up to track 'origin/feature/category-option'. -
Créez un nouvel environnement à partir du fichier de verrouillage. Désactivez d’abord l’ancien avec
deactivate:Fenêtre de terminal python3 -m venv .venvsource .venv/bin/activatepython -m pip install -r requirements-lock.txtFenêtre de terminal python -m venv .venv.venv\Scripts\Activate.ps1python -m pip install -r requirements-lock.txt -
Lancez chaque vérification de la description depuis ce clone :
Fenêtre de terminal python -m pytestruff check .ruff format --check .python -m ticket_cleaner data/web-form-export.csv --category Sign-inpython -m ticket_cleaner data/web-form-export.csvOutput (the author's run, the end of each check) ============================== 42 passed in 0.06s ==============================All checks passed!24 files already formattedLe premier rapport contient
"by_category": {"login": 4}et"categories": ["login"]. Le second, sans l’option, contient{"account": 1, "billing": 3, "login": 4, "shipping": 2}: une ligne par équipe. -
Lisez le changement comme un réviseur :
git diff main...feature/category-option. Kwame pose sa question habituelle : « Que peut toucher ce changement? » Répondez à partir des différences. Il touche deux clés du rapport et une règle de nettoyage appliquée à chaque billet. Il n’ajoute aucun accès aux fichiers ni aucun paquet, et il n’envoie rien à l’extérieur.
Les mêmes résultats dans un nouveau clone prouvent que chaque fichier nécessaire est enregistré dans un commit. Ils prouvent aussi que rien ne dépend de votre propre environnement.
Les points à faire réviser par une personne ou un spécialiste du domaine
Section intitulée « Les points à faire réviser par une personne ou un spécialiste du domaine »Aucun test ne peut répondre à certaines questions, car la réponse se trouve hors du code. Nommez-les dans la demande de tirage et dans DECISIONS.md, avec la personne qui peut répondre :
Description textuelle du diagramme
Amira pousse la branche vers ticket-cleaner-remote.git. Kwame la clone, crée un nouvel environnement depuis le fichier de verrouillage et obtient 42 passed et {"login": 4} pour Sign-in.
Trois questions demandent encore une personne :
- Les anciens rapports changent. Le rapport
pendingdu fichier d’exemple passe de{"LOGIN": 1, "billing": 1}à{"billing": 1, "login": 1}. Grace décide comment l’expliquer à son équipe. - La liste d’alias.
CATEGORY_ALIASESdoit correspondre au formulaire Web. L’équipe de Grace est responsable du formulaire. - Les exportations réelles. Les tests utilisent des données inventées. Une exportation réelle peut contenir d’autres graphies, comme
Log inavec un espace.
Une révision par un spécialiste du domaine reconnaît honnêtement les limites des connaissances du code. Kwame approuve le code, et Grace répond aux trois questions. La branche peut ensuite être fusionnée, comme dans le cours sur Git.
Quand le faire et combien de temps prévoir
Section intitulée « Quand le faire et combien de temps prévoir »Expliquez chaque ligne importante avant chaque demande de tirage, peu importe qui l’a écrite. Avec un assistant, personne d’autre n’a lu le code. Si vous ne pouvez pas expliquer une ligne, comprenez-la ou supprimez-la.
Modifiez volontairement des lignes pour les rendre incorrectes, surtout les plus importantes : une correction, une condition, une clé de sortie. Cela montre quelles lignes n’ont qu’un seul test pour les protéger.
Demandez une révision par une personne du domaine quand la réponse dépend de personnes ou de données hors du projet. Écrivez la question et le nom de la personne. Ne répondez pas au hasard.
Cela demande du temps avant la révision, mais en fait gagner davantage pendant celle-ci. Un tableau de traçabilité permet au réviseur de vérifier une modification en quelques minutes. « Corrections faites, tests réussis » oblige le réviseur à revenir vers vous avec des questions.
Erreur courante
git push : does not appear to be a git repository (ne semble pas être un dépôt Git)
Symptôme : vous poussez la branche pour la première fois, et Git refuse :
fatal: '../ticket-cleaner-remote.git' does not appear to be a git repositoryfatal: Could not read from remote repository.
Please make sure you have the correct access rightsand the repository exists.Cause : le dépôt nu est au mauvais endroit. Ici, git init --bare a été exécuté dans le projet, car l’étape cd .. a été oubliée. Le chemin du dépôt distant, ../ticket-cleaner-remote.git, pointe vers un dossier qui n’existe pas.
Diagnostic : git status --short montre le dépôt nu comme un nouveau dossier dans le projet :
?? ticket-cleaner-remote.git/Correction : supprimez ce dossier dans le projet, après avoir vérifié son nom : rm -rf ticket-cleaner-remote.git (Windows : Remove-Item -Recurse -Force ticket-cleaner-remote.git). Refaites ensuite l’étape 6, en commençant par cd ... N’incluez jamais un dépôt nu dans un commit (enregistrement de modifications) du projet.
Vérification de fin de module
Section intitulée « Vérification de fin de module »La vérification de fin de module : exécutez les vérifications vous-même et expliquez chaque modification importante. Montrez ces éléments :
- Dans
kwame-review, un nouveau clone avec un nouvel environnement, les vérifications réussissent. Vous voyez42 passed(42 tests réussis),All checks passed!(toutes les vérifications ont réussi) et24 files already formatted(24 fichiers déjà formatés), ainsi que les deux rapports des étapes de Kwame. - Pour cinq lignes importantes de
git diff main...feature/category-option -- ticket_cleaner/, donnez les quatre réponses dans vos mots : quoi, pourquoi, quel test, quoi d’autre. Utilisez au moins une ligne de chacun des trois fichiers. - La ligne que vous avez volontairement rendue incorrecte à l’étape 3, et le test qui a détecté le problème.
- Une question à poser à une personne du domaine, pas encore dans la demande de tirage, avec la personne qui peut répondre.
Afficher une solution détaillée
Cinq lignes, quatre réponses chacune :
| Ligne | Quoi | Pourquoi | Quel test | Quoi d’autre |
|---|---|---|---|---|
parsing.py 23 : text = clean_text(value) |
" LOGIN " → "login" avant la recherche d’alias |
le bogue de Grace : une ligne par équipe | test_capital_letters_do_not_make_a_new_category (10 tests échouent sans cette ligne) |
chaque catégorie de chaque fichier, donc les anciens rapports changent (LOGIN → login) |
cli.py 33 : action="append" |
--category billing --category shipping donne une liste contenant les deux catégories |
critère 2 | test_report_for_some_categories (le seul) |
sans cette ligne, la dernière option l’emporte, sans avertissement |
report.py 40 : chosen = sorted({clean_category(name) ...}) |
"Sign-in" → ["login"]; doublons supprimés, liste triée |
critères 3 et 4, et noms du formulaire Web | test_web_form_names_work_in_the_category_option et 3 autres |
la clé categories montre les noms nettoyés, pas ce que l’utilisateur a saisi |
report.py 41 : selected = [... if ticket.category in chosen] |
garde seulement les billets des catégories choisies | critère 1 | test_one_category |
cette ligne s’exécute après filter_by_status(), donc --status s’applique toujours |
report.py 50–51 : if chosen is not None: |
ajoute categories seulement avec l’option |
critère 4, et feuille de calcul de Grace | test_categories_key_only_with_the_option, tests/test_baseline.py |
le rapport sans l’option reste identique à celui d’avant |
Une question pour une personne du domaine : « Autre chose lit-il reports/summary.json, par exemple un script de l’équipe des finances? Si oui, son responsable doit connaître la clé categories. » La personne : Grace, qui sait qui reçoit le rapport.
Vérification du module
Section intitulée « Vérification du module »Vous avez terminé le module quand vous pouvez montrer ces éléments dans votre propre projet :
-
git log --onelinemontre treize commits. Les trois derniers sontDescribe the pull request(décrire la demande de tirage),Document the cleaning rule, the limitations and the decisions(documenter la règle de nettoyage, les limites et les décisions) etClean the --category names with the same rule as the tickets(nettoyer les noms de –category avec la même règle que les billets). Après une réinitialisation, vous avez moins de commits, et c’est normal. -
python -m pytestaffiche42 passed, dans votre projet et danskwame-review. -
git branch -vvmontre les deux branches avec une branche de suivi surorigin. -
Sur macOS et Linux, cette commande n’affiche rien, car votre projet correspond à l’instantané
end-of-m05:Fenêtre de terminal diff -rq . ../nextia-learning-labs/C15/snapshots/end-of-m05 -x .git -x .venv -x reports -x __pycache__ -x .pytest_cache -x .ruff_cache
Réinitialisation. Si votre projet ne fonctionne plus, suivez les étapes de réinitialisation de Contexte et limites. Utilisez l’instantané end-of-m04 au lieu de end-of-m01. Ces étapes gardent main au début du cours, pour que la demande de tirage montre toute la modification. La dernière ligne de python -m pytest est alors 39 passed (39 tests réussis). C’est le projet à la fin du module 4, prêt pour Réusiner de façon sélective. Pour passer à la fin de ce module, utilisez plutôt end-of-m05 : 42 passed. Si ticket-cleaner-remote.git ou kwame-review existent déjà, renommez-les aussi avant l’étape 6.
Vérification des connaissances
Section intitulée « Vérification des connaissances »Vérifiez votre compréhension
Qu'est-ce qui rend une ligne d'une modification « importante »? Donnez une ligne importante et une ligne non importante du code modifié dans ce cours.
Afficher la réponse
Une ligne importante change le comportement, un contrat, les données stockées ou la sécurité. text = clean_text(value) dans parsing.py est importante : elle change la façon de stocker chaque catégorie. La chaîne de documentation de build_summary() ne l’est pas : elle ne change aucun comportement. Une chaîne de documentation incorrecte pourrait toutefois induire le prochain lecteur en erreur, alors vous la lisez quand même. Une vérification utile : si vous rendez volontairement la ligne incorrecte, un test devrait-il échouer? Pour une ligne importante, oui.
Votre réponse contient-elle les points principaux de la nôtre ?
Connectez-vous et inscrivez-vous au cours pour enregistrer vos réponses. Chaque vérification compte pour le certificat.
Vérifiez votre compréhension
Prédisez : vous remettez name.strip().lower() à la ligne 40 de report.py. Combien de tests échouent, et quelle conclusion en tirez-vous?
Afficher la réponse
Un seul : test_web_form_names_work_in_the_category_option, et 1 failed, 41 passed (1 test échoué, 41 réussis). Les autres tests utilisent des noms que les deux règles nettoient de la même façon. Cette ligne a donc exactement un test pour la protéger. Gardez ce test et nommez-le dans la demande de tirage et dans DECISIONS.md, comme le fait la décision 3. Si une modification future le supprime comme « doublon », le bogue des deux règles peut revenir malgré la réussite des autres tests.
Votre réponse contient-elle les points principaux de la nôtre ?
Connectez-vous et inscrivez-vous au cours pour enregistrer vos réponses. Chaque vérification compte pour le certificat.
Vérifiez votre compréhension
Les 42 tests ont réussi dans le dossier d'Amira. Pourquoi Kwame les relance-t-il dans un nouveau clone avec un nouvel environnement, et qu'est-ce qui pourrait différer?
Afficher la réponse
Une exécution réussie dans le dossier de l’auteur peut dépendre d’éléments absents des commits. Par exemple, un fichier jamais ajouté ou une modification jamais incluse dans un commit. Un autre exemple est un paquet présent dans l’environnement de l’auteur, mais absent du fichier de verrouillage. Un nouveau clone contient seulement ce qui a été poussé. Un nouvel environnement contient seulement ce que le fichier de verrouillage indique. Si les mêmes 42 tests y réussissent, la modification est complète et reproductible. C’est la même preuve que la nouvelle copie dans le cours Python pour l’ingénierie de l’IA en pratique.
Votre réponse contient-elle les points principaux de la nôtre ?
Connectez-vous et inscrivez-vous au cours pour enregistrer vos réponses. Chaque vérification compte pour le certificat.
Récapitulatif
Cette leçon
- Comprendre le code par vous-même : vous expliquez chaque ligne importante sans l’assistant. Ce qu’elle fait, pourquoi, quel test échoue sans elle et ce qu’elle touche d’autre.
- Un tableau de traçabilité relie chaque exigence à sa modification et à sa preuve. C’est l’élément central de
docs/pull-request.md. - Rendez volontairement une ligne incorrecte pour voir quel test la protège. Deux lignes de cette modification ont exactement un test.
- La correction change aussi le rapport
pendingdu fichier d’exemple (LOGIN→login). Aucun test ne l’a détecté; la lecture, oui. C’est maintenant dans la demande de tirage. - Le nouveau clone et le nouvel environnement de Kwame :
42 passed. La liste d’alias, les vraies exportations et les anciens rapports ont encore besoin d’une vérification humaine.
Module 5 : Livrer un travail facile à maintenir
- Réusinez seulement là où la modification l’exige : une règle de nettoyage a fait fonctionner
--category Sign-in. Tout le reste est devenu une tâche distincte. - Documentez les décisions avec leurs preuves et n’écrivez aucune affirmation que vous n’avez pas vérifiée.
tests/test_readme.pymaintient deux affirmations du README exactes. - Ouvrez une demande de tirage qu’un réviseur peut vérifier seul : le tableau, les vérifications, l’utilisation d’un assistant et les questions ouvertes.
- Votre projet correspond à
end-of-m05, le projet de fin de cours :42 passed.
Le cours
Vous avez commencé avec un projet, une demande de fonctionnalité et un rapport de bogue. Vous avez préparé un environnement sûr et rédigé une tâche que quelqu’un peut vérifier. Vous avez révisé les modifications générées ligne par ligne, débogué à partir de preuves et livré une modification que vous pouvez expliquer. Ensuite, les études de cas appliquent les mêmes habitudes à deux petits projets nouveaux pour vous, écrits pour le cours. L’un contient un bogue dans du code inconnu; l’autre nécessite une mise à jour de dépendance. Vous devez en terminer un pour obtenir le certificat, avec le travail final.
Leçon suivante : Corriger un bogue dans un code inconnu