Travail final
- Après les études de cas
- environ 3 h
Où nous en sommes
Dans ce cours, vous avez appris à travailler en toute sécurité avec un assistant de programmation : préparer un cadre propre, écrire une tâche que tout le monde peut vérifier, réviser chaque ligne générée, déboguer à partir de preuves et livrer une modification que vous pouvez expliquer. Maintenant, Grace envoie deux courriels : une demande de fonctionnalité et un défaut. Dans ce travail, vous traitez les deux par vous-même, avec les preuves dont un réviseur a besoin.
Ce que vous saurez faire
Appliquez tout le cours à un nouveau travail, par vous-même. Vous ajoutez une fonctionnalité et corrigez un défaut, avec un assistant ou les transcriptions fournies. Vous conservez les preuves nécessaires à un réviseur. Il s’agit d’un énoncé de tâche clair, de différences ciblées et révisées, de vérifications du comportement et des raisons de chaque suggestion acceptée ou rejetée.
Avant de commencerCe qu’il faut savoir et avoir sous la main
Ce que vous devez savoir
- Vous avez terminé les modules 1 à 5. Chaque partie ci-dessous nomme les leçons qu’elle utilise.
- Vous n’avez pas besoin des études de cas pour ce travail. Le certificat exige d’en faire au moins une.
Ce qu’il vous faut sur votre ordinateur
- Le clone des laboratoires
~/projects/nextia-learning-labs, avecC15/snapshots/etC15/transcripts/. Pour obtenir la version la plus récente, exécutezgit -C nextia-learning-labs pulldans~/projects. - Python 3.14 et Git, comme dans le cours.
- Un assistant de programmation est facultatif. L’option 1 ci-dessous utilise votre propre assistant. L’option 2 utilise les séances enregistrées et ne nécessite ni assistant, ni compte, ni argent.
Testé sur macOS (Apple silicon) avec Python 3.14.6. Les commandes Windows sont rédigées, mais non testées.
La situation
Section intitulée « La situation »Grace envoie deux courriels à Amira le lundi matin. Les deux sont construits pour le cours.
La demande. « Pour la réunion de lundi, je dois voir le degré d’urgence des billets ouverts. Le rapport peut-il aussi compter les billets de chaque priorité, 1, 2 et 3? J’ai toujours besoin du rapport normal tel quel : mon tableur le lit. »
Le signalement du bogue. « Sam a enregistré l’exportation de cette semaine depuis le formulaire Web sous le nom
WEEK.CSV, et le programme s’arrête :cannot read WEEK.CSV: use a .csv or .json file(impossible de lire WEEK.CSV : utilisez un fichier .csv ou .json). C’est un fichier CSV normal. Avec le nomweek.csv, ça fonctionne. »
Vous êtes Amira. Vous livrez les deux changements sur une seule branche, avec une seule demande de tirage (pull request).
Choisir votre option
Section intitulée « Choisir votre option »Les deux options sont évaluées avec le même tableau, sous Vérifier vos preuves.
| Option 1 : votre propre assistant | Option 2 : les transcriptions fournies | |
|---|---|---|
| Projet | une copie de end-of-m05, le projet de fin de cours |
une copie de start, le premier instantané du cours |
| Fonctionnalité | les comptes par priorité de Grace, ci-dessus | l’option --category, dans C15/emails/grace-feature-request.md |
| Défaut | le bogue de WEEK.CSV, ci-dessus |
le bogue des noms de catégories de Grace, dans C15/emails/grace-bug-report.md |
| Suggestions | vos propres séances, avec vos propres requêtes (prompts) | les séances enregistrées et leurs fichiers .patch dans C15/transcripts/ |
Dans l’option 2, vous connaissez déjà une bonne réponse grâce au cours. Les preuves reposent donc sur vos décisions. Rédigez vos propres énoncés, choisissez parmi les suggestions enregistrées et expliquez chaque choix. Ne copiez pas les fichiers des instantanés suivants : un réviseur le verrait dans vos différences.
Les parties ci-dessous décrivent l’option 1. Chaque partie indique ce qui diffère dans l’option 2.
Préparer l’environnement
Section intitulée « Préparer l’environnement »-
Copiez l’instantané, puis créez l’environnement et le dépôt :
Fenêtre de terminal cd ~/projectscp -R nextia-learning-labs/C15/snapshots/end-of-m05 ticket-cleaner-finalcd ticket-cleaner-finalpython3 -m venv .venvsource .venv/bin/activatepython -m pip install -r requirements-lock.txtgit initgit add -Agit commit -m "Start"git switch -c final/priority-and-csv-namepython -m pytestFenêtre de terminal cd ~\projectsCopy-Item -Recurse nextia-learning-labs\C15\snapshots\end-of-m05 ticket-cleaner-finalcd ticket-cleaner-finalpython -m venv .venv.venv\Scripts\Activate.ps1python -m pip install -r requirements-lock.txtgit initgit add -Agit commit -m "Start"git switch -c final/priority-and-csv-namepython -m pytestLa dernière ligne est
42 passed(42 tests réussis). Dans l’option 2, copiez plutôtstart, et la dernière ligne est24 passed(24 tests réussis). -
Créez le fichier de preuves à côté du projet, hors du dépôt, pour éviter de l’inclure accidentellement dans un commit (enregistrement des changements) :
~/projects/final-evidence.md. Après chaque partie, copiez-y ce qu’elle demande.
Règles pour chaque partie
Section intitulée « Règles pour chaque partie »- Travaillez sur la branche. Faites un commit avant chaque séance avec l’assistant pour pouvoir l’annuler avec
git restore ., comme dans Contexte et limites. - Fournissez
ASSISTANT-SCOPE.mdà l’assistant avec chaque tâche. Il modifie seulement les fichiers nécessaires à la tâche, et vous exécutezgit commitvous-même. Dans l’option 2,startn’a pas encore de fichier de limites : rédigez-en un d’abord. - Aucune nouvelle dépendance. Si un assistant en propose une, vérifiez-la comme dans Vérifier les dépendances, et consignez votre décision.
- Ne collez jamais
.env, un jeton ou de vraies données de clients dans une requête. - Conservez chaque requête envoyée et la réponse de l’assistant, ou le nom de la transcription utilisée.
Partie 1 : deux énoncés de tâche
Section intitulée « Partie 1 : deux énoncés de tâche »Utilise Problème et critères d’acceptation et Fournir le contexte utile.
-
Rédigez
docs/tasks/by-priority.mdà partir de la demande de Grace. Indiquez le problème, les limites (ce qui ne fait pas partie de la tâche) et des critères d’acceptation numérotés. Chaque critère nomme la commande ou le test qui le démontrera. La dernière phrase de Grace est aussi un critère. -
Reproduisez le bogue avant de le décrire. Copiez l’exportation sous un nouveau nom, puis exécutez le programme avec ce fichier :
Fenêtre de terminal cp data/web-form-export.csv data/WEEK.CSVpython -m ticket_cleaner data/WEEK.CSVSortie ERROR ticket_cleaner: cannot read the tickets from data/WEEK.CSV: cannot read WEEK.CSV: use a .csv or .json fileLe code de sortie est 1. Déterminez si le problème vient de l’environnement ou du code. Utilisez les vérifications de Reproduire d’abord. Supprimez ensuite
data/WEEK.CSV(Windows :Remove-Item data\WEEK.CSV). -
Rédigez
docs/tasks/csv-name-bug.md: les étapes de reproduction, le résultat observé, le résultat attendu, l’environnement et les preuves d’achèvement. Faites un commit des deux énoncés.
Option 2 : rédigez l’énoncé et le signalement du bogue à partir des deux courriels de Grace dans C15/emails/, sans consulter les versions du cours.
Preuves pour la partie 1 : les deux énoncés et une phrase expliquant comment vous avez tranché entre « environnement ou code ».
Partie 2 : corriger le défaut
Section intitulée « Partie 2 : corriger le défaut »Utilise Demander des preuves et Choisir des vérifications utiles.
- Demandez à votre assistant une hypothèse avec la ligne de code, et un test qui la démontrerait. Ne demandez pas encore de correction.
- Ajoutez un test de non-régression qui échoue avec le code actuel, pour la raison prévue par l’hypothèse. Exécutez-le et conservez la sortie.
- Demandez la plus petite correction possible. Révisez les différences avant d’exécuter le code. Exécutez ensuite tous les tests, ruff et le cas de Grace.
- Vérifiez le test : remettez le fichier non corrigé de
mainavecgit restore --source=main, exécutez les tests, puis restaurez le fichier corrigé. - Faites un commit du test et de la correction ensemble.
Option 2 : comparez les séances enregistrées bug-fix-blind, bug-fix-blind-small, bug-fix-blind-no-map et bug-fix-evidence, ainsi que les séances de tests tests-mirror et tests-failing-first. Choisissez ce que vous conservez et appliquez-le avec git apply ou à la main.
Preuves pour la partie 2 : les requêtes (ou les transcriptions utilisées), la sortie du test qui échoue, la sortie avec le fichier non corrigé de main et le résultat de git show --stat pour votre commit.
Partie 3 : ajouter la fonctionnalité
Section intitulée « Partie 3 : ajouter la fonctionnalité »Utilise Découper le travail en étapes, Examiner les différences et Réusiner de façon sélective.
- Fournissez à l’assistant votre énoncé et les fichiers nécessaires. Demandez d’abord un plan si la tâche touche plus de deux fichiers.
- Révisez les différences ligne par ligne avec
docs/review-checklist.md. Marquez chaque changement comme nécessaire, sans rapport ou risqué. Annulez ce dont la tâche n’a pas besoin, même si cela semble être une amélioration. - Rédigez ou corrigez les tests pour que chaque critère d’acceptation en ait un. Les valeurs attendues viennent de la demande de Grace et des données, jamais d’une exécution du nouveau code.
- Exécutez toutes les vérifications et faites un commit.
Option 2 : comparez feature-vague, feature-bounded, feature-bounded-small, feature-plan-first et refactor-grows à votre énoncé. Utilisez la liste de vérification de Examiner les différences. Certaines différences enregistrées échouent à ruff format --check, et refactor-grows contient un test qui dépend de la largeur du terminal. Décidez quoi faire pour chaque cas.
Preuves pour la partie 3 : votre révision des différences (les marques et ce que vous avez annulé), le test de chaque critère et les sorties de python -m pytest, ruff check . et ruff format --check ..
Partie 4 : expliquer, documenter et transmettre
Section intitulée « Partie 4 : expliquer, documenter et transmettre »Utilise Documenter les décisions et Comprendre le code par vous-même.
- Mettez à jour le README et ajoutez une décision à
DECISIONS.mdpour chaque choix qu’une personne raisonnable pourrait faire autrement. Fournissez les preuves de chaque affirmation. - Rédigez
docs/pull-request.mdavec le tableau exigence → changement → preuve. Ajoutez Utilisation d’un assistant de programmation : ses suggestions, ce que vous avez accepté, modifié ou rejeté, et pourquoi. - Brisez volontairement une ligne importante. Notez le test qui échoue, puis restaurez la ligne.
- Poussez les deux branches vers un nouveau dépôt distant nu, clonez-le dans un nouveau dossier et créez un nouvel environnement. Exécutez-y toutes les vérifications de la description.
Preuves pour la partie 4 : docs/pull-request.md, les nouvelles décisions, la ligne brisée et le test qui l’a détectée, ainsi que les sorties du nouveau clone.
Erreur courante
Le test de référence de base échoue après l'ajout de la fonctionnalité
Symptôme : après le changement de l’assistant, python -m pytest affiche FAILED tests/test_baseline.py::test_report_of_the_sample_file_is_unchanged (échec du test vérifiant que le rapport du fichier exemple reste inchangé). L’assistant propose de mettre à jour le rapport attendu dans le test.
Cause : le changement ajoute les comptes par priorité à tous les rapports. Grace a demandé de garder le rapport normal tel quel, car son tableur le lit. Le test de référence de base de Préparer le dépôt fixe exactement ce comportement.
Correction : ne modifiez pas le test de référence de base pour le faire réussir. Changez le code pour afficher les comptes seulement sur demande, et testez aussi ce comportement. Si l’équipe décide de modifier le rapport normal, cette décision doit se prendre avec Grace. Consignez-la dans DECISIONS.md, puis seulement après, changez la référence de base.
Erreur courante
Le test du README échoue après l'ajout d'une option
Symptôme : FAILED tests/test_readme.py::test_every_option_of_the_command_is_in_the_readme (échec du test vérifiant que chaque option de la commande figure dans le README), avec 1 failed, 44 passed (1 test échoué, 44 réussis) lors de l’exécution de l’équipe du cours.
Cause : la nouvelle option figure dans --help (aide), mais pas dans le tableau des options du README. Le test de Documenter les décisions a détecté l’écart.
Correction : ajoutez la ligne au tableau dans le même commit que l’option. Ne supprimez pas le test.
Vérifier vos preuves
Section intitulée « Vérifier vos preuves »Pour chaque élément exigé, choisissez le résultat qui correspond à vos preuves. Le cours est terminé quand les quatre éléments sont démontrés. Sinon, corrigez la partie concernée et vérifiez-la de nouveau, autant de fois que nécessaire.
| Élément exigé | Démontré | Partiellement démontré | Pas encore démontré |
|---|---|---|---|
| Énoncé de tâche clair | Les deux énoncés donnent le problème et les limites. Chaque critère d’acceptation nomme la commande ou le test qui le démontre, dont « garder le rapport normal ». Le signalement du bogue contient une entrée minimale, les sorties observée et attendue, ainsi que la vérification de l’environnement. | Les énoncés sont clairs, mais un critère n’a pas de vérification, ou le signalement n’a pas d’entrée minimale. | Un énoncé répète seulement le courriel, ou le travail a commencé avant la rédaction d’un énoncé. |
| Différences ciblées et révisées | git diff --stat main liste seulement les fichiers nécessaires aux deux tâches. Vous pouvez montrer vos marques sur les différences de l’assistant et ce que vous avez annulé. Chaque commit a un seul objectif. |
Les différences sont ciblées, mais la révision n’est pas consignée, ou un commit mélange la correction et la fonctionnalité. | Les différences contiennent des modifications sans rapport, une nouvelle dépendance sans décision ou un changement que vous ne pouvez pas expliquer. |
| Validation fondée sur le comportement | Le test de non-régression échouait avant la correction et réussit après, comme le démontre le fichier non corrigé de main. Chaque critère a un test dont la valeur attendue vient de l’exigence. Les tests de référence de base et du README réussissent sans modification, et les vérifications réussissent dans un nouveau clone. |
Les tests réussissent, mais l’échec initial de l’un d’eux n’a pas été démontré, ou une valeur attendue provient d’une exécution. | Les tests ont été modifiés pour correspondre au code, le test de référence de base a été modifié sans décision, ou aucune exécution dans un nouveau clone n’a été faite. |
| Explication des suggestions acceptées et rejetées | La demande de tirage nomme chaque suggestion acceptée, modifiée ou rejetée, avec la raison et les preuves. Vous pouvez expliquer chaque ligne importante et nommer ce qui nécessite encore la révision de Grace. | L’explication couvre les changements acceptés, mais pas ceux rejetés, ou une raison n’a pas de preuve. | La demande de tirage dit « l’assistant l’a fait », ou présente des affirmations qu’aucune exécution n’a vérifiées. |
Certains travaux restent pas encore démontrés, même si le reste est correct : un secret ou des données de clients envoyés à un assistant, ou un changement inconnu exécuté hors d’une copie jetable.
Afficher les preuves modèles pour l’option 1
Voici la solution modèle de l’équipe du cours, rédigée sans assistant. La vôtre peut être différente et tout de même être démontrée.
Le défaut. La cause se trouve dans read_rows(), dans ticket_cleaner/files.py. Le code compare exactement path.suffix à ".csv", donc .CSV mène à l’erreur. Le problème vient du code, pas de l’environnement : la même commande échoue dans une nouvelle copie. Le message concerne le nom du fichier, pas un module. Le test de non-régression :
def test_csv_name_in_capital_letters(tmp_path): # Grace's colleague saved the export as WEEK.CSV. path = tmp_path / "WEEK.CSV" path.write_text("id,status\nT-1001,open\n", encoding="utf-8") assert read_rows(path) == [{"id": "T-1001", "status": "open"}]La correction compare path.suffix.lower(), pour .csv et pour .json. Après la correction, les tests donnent 43 passed (43 tests réussis), et WEEK.CSV donne 12 rows: 12 valid, 0 rejected. (12 lignes : 12 valides, 0 rejetée). À la fin de la tâche, avec files.py remis depuis main, les tests donnent 1 failed, 44 passed : FAILED tests/test_files.py::test_csv_name_in_capital_letters (échec du test du nom CSV en majuscules).
La fonctionnalité. Une option --by-priority ajoute une clé by_priority avec les comptes des billets sélectionnés pour "1", "2" et "3", même quand un compte vaut 0. Sans l’option, le rapport reste inchangé, donc le test de référence de base réussit tel quel. Les sorties réelles :
data/tickets.csv: {"1": 1, "2": 2, "3": 1}data/web-form-export.csv: {"1": 3, "2": 5, "3": 2}data/web-form-export.csv --category login: {"1": 2, "2": 2, "3": 0}Le fichier exemple contient 4 billets ouverts, et l’exportation en contient 10. La solution modèle ajoute deux tests de ligne de commande (la clé seulement avec l’option; les comptes avec --category login) et une ligne au README.
Le changement complet : 45 passed (45 tests réussis), All checks passed! (toutes les vérifications ont réussi), 24 files already formatted (24 fichiers déjà formatés).
README.md | 1 + tests/test_cli.py | 18 ++++++++++++++++++ tests/test_files.py | 7 +++++++ ticket_cleaner/cli.py | 9 ++++++++- ticket_cleaner/files.py | 5 +++-- ticket_cleaner/report.py | 8 ++++++++ 6 files changed, 45 insertions(+), 3 deletions(-)Pour une révision métier : le tableur de Grace fonctionne-t-il encore si quelqu’un utilise l’option par erreur? Seule Grace le sait. Et les priorités vont-elles toujours de 1 à 3? Les règles rejettent les autres valeurs actuellement. Une nouvelle priorité nécessiterait un changement des règles et une décision.
Travail supplémentaire facultatif
Section intitulée « Travail supplémentaire facultatif »Ces tâches ne sont pas requises pour terminer le cours.
- Faites aussi l’autre option et comparez les deux demandes de tirage.
- Demandez la fonctionnalité à deux assistants différents, ou deux fois au même assistant. Comparez les différences avec la même liste de vérification et consignez celles qui ont eu de l’importance.
Récapitulatif
Dans ce cours, vous avez appris à :
- préparer un environnement sûr pour un assistant : une branche propre, des vérifications de référence de base et des limites écrites;
- transformer une demande en énoncé de tâche avec des critères d’acceptation et des preuves pour chacun;
- réviser un changement généré ligne par ligne, vérifier ses dépendances et sa façon de traiter les données;
- déboguer à partir de preuves : reproduire d’abord, puis formuler une hypothèse, créer un test qui échoue et corriger;
- livrer un changement que vous pouvez expliquer, avec ses décisions et une demande de tirage qu’un réviseur peut vérifier seul.
Si vous n’en avez pas encore fait, choisissez une étude de cas pour le certificat : Corriger un bogue dans un code inconnu ou Mettre à jour une dépendance en toute sécurité.