Programmation en binôme avec l'IA et IBM Bob

Lancer IBM Bob

Lance l'application IBM Bob sur ton ordinateur. Bob est un IDE autonome, pas une extension.

Ouvrir l'interface de chat Bob

Si l'interface de chat Bob n'est pas visible, ouvre-la en sélectionnant l'icône Bob à côté de la barre de navigation, ou utilise le raccourci Option + Command + B (Mac) ou Ctrl + Alt + B (Windows).

Ouvrir un dossier de projet vide

Crée un dossier vide nommé todo-api, puis ouvre-le dans Bob avec Fichier > Ouvrir le dossier. Si Bob te demande si tu fais confiance aux auteurs des fichiers du dossier, sélectionne Oui, je fais confiance aux auteurs.

Bob écrit l'application générée dans ce dossier. Tu n'as pas besoin d'un dépôt existant pour ce tutoriel.

Désactiver l'approbation automatique

Ouvre Permissions et confirme que l'approbation automatique est désactivée. Avec l'approbation automatique désactivée, Bob demande ta permission avant de lire des fichiers, de modifier des fichiers ou d'exécuter des commandes, ce qui te permet de contrôler chaque modification dans ce tutoriel.

Passer en mode Plan

Ouvre le menu déroulant des modes en bas de la barre latérale de Bob et sélectionne Plan.

Les modes appliquent le principe du moindre privilège. Le mode Plan permet à Bob de lire des fichiers et de proposer un plan sans écrire ni exécuter de code, afin que tu puisses réviser l'approche avant qu'aucune modification ne soit apportée.

Définir les exigences de l'application

Dans l'interface de chat Bob, entre le prompt suivant :

Create a simple FastAPI To-Do API.

Requirements:

- Store tasks in a Python list.
- Each task should contain:
    - id
    - task_name

Implement:

- Get all tasks
- Add a task
- Delete a task

Use FastAPI and Pydantic.

Include a requirements.txt and a Dockerfile that run the API on port 8000.

Keep the implementation simple.

Bob analyse les exigences et crée un plan de tâches.

Affiner le plan

Tu peux modifier le plan avant qu'un code soit écrit. Dans l'interface de chat Bob, entre un prompt de suivi :

Update the plan to reject a task whose task_name is empty or longer than 200 characters.

Bob révise le plan pour inclure la validation d'entrée supplémentaire. Révise le plan mis à jour.

Réviser et approuver le plan

Bob affiche les actions qu'il prévoit d'effectuer avant de les exécuter. Par exemple, Bob peut proposer de :

• Créer l'application FastAPI.
• Ajouter un Dockerfile et un fichier requirements.txt.
• Vérifier l'implémentation.

Cette approche avec supervision humaine te laisse responsable des décisions de conception tout en bénéficiant de l'assistance de l'IA.

Passer en mode Agent et exécuter le plan

Ouvre le menu déroulant des modes en bas de la barre latérale de Bob et sélectionne Agent. Puis dis à Bob d'implémenter le plan approuvé :

Implement the plan.

Le mode Agent permet à Bob d'écrire des fichiers et d'exécuter des commandes. Bob demande une approbation avant chaque modification car tu as désactivé l'approbation automatique. Approuve les étapes au fur et à mesure que Bob avance dans le plan.

Réviser l'application générée

Lorsque l'implémentation est terminée, révise le code généré. L'application se compose des parties suivantes.

Modèles de données. Bob génère deux modèles Pydantic : un pour le corps de la requête lors de la création d'une tâche, et un pour une tâche stockée. Le modèle de création applique la règle de longueur que tu as ajoutée lors de la planification :

class TaskCreate(BaseModel):
    task_name: Annotated[str, Field(min_length=1, max_length=200)]


class Task(BaseModel):
    id: int
    task_name: str

Les noms et chemins exacts dépendent de la génération de Bob. Ce tutoriel suppose les modèles Task et TaskCreate et le chemin d'endpoint /tasks. Adapte les prompts suivants si Bob choisit des noms différents.

Magasin de données en mémoire. Bob stocke les tâches dans une liste Python vide et attribue à chaque nouvelle tâche un id incrémental :

tasks: list[dict] = []
id_counter = 0

Opérations API. L'application fournit les endpoints suivants :

• GET /tasks
• POST /tasks
• DELETE /tasks/{task_id}

POST /tasks prend uniquement task_name dans le corps de la requête et retourne 201 avec la tâche créée. DELETE /tasks/{task_id} retourne 204 en cas de succès et 404 lorsqu'aucune tâche n'a ce task_id.

Dépendances. Un fichier requirements.txt qui liste FastAPI, Uvicorn et Pydantic.

Conteneur. Un Dockerfile qui installe les dépendances et exécute l'API sur le port 8000 avec Uvicorn.

Étant donné que les grands modèles de langage sont probabilistes, le code généré peut légèrement différer des exemples présentés dans ce tutoriel.

Démarrer une nouvelle fenêtre de contexte

Clique sur Nouvelle tâche dans la zone de chat ou sur + en haut du panneau de chat pour démarrer une nouvelle fenêtre de contexte. La planification, la génération et la révision que tu viens de terminer n'ont plus besoin de rester dans le contexte, et démarrer proprement garde les réponses de Bob ciblées et réduit le coût pour le reste du tutoriel.

Ouvrir le fichier de l'application

Ouvre le fichier main.py que Bob a généré et place ton curseur sur une ligne vide à la fin du fichier, sous le dernier gestionnaire de route.

Activer le mode de codage littéraire

Appuie sur Cmd + I (Mac) ou Ctrl + I (Windows et Linux), ou sélectionne l'icône de baguette magique dans la barre d'outils de l'éditeur.

Écrire l'instruction

Entre l'instruction suivante sur la ligne vide. Elle apparaît surlignée dans une couleur différente du reste du code.

Add an endpoint that updates the task_name of an existing task by its ID, matching the style and conventions of the existing routes.

Bob déduit le chemin de route, le nom du paramètre, la méthode HTTP et la gestion des erreurs du code environnant, donc tu n'as pas besoin de les spécifier.

Générer et accepter le code

Sélectionne Générer sous le code que Bob propose. Bob remplace l'instruction par une implémentation et affiche un diff en ligne.

Révise le diff, puis sélectionne Tout accepter pour appliquer la modification. Sélectionne Quitter pour quitter le mode de codage littéraire.

Démarrer une nouvelle fenêtre de contexte

Clique sur Nouvelle tâche dans la zone de chat ou sur + en haut du panneau de chat pour démarrer une nouvelle fenêtre de contexte.

Demander à Bob d'expliquer le code

Comprendre le code généré est une partie importante de la programmation en binôme avec l'IA. Demande à Bob :

Explain the generated To-Do API.

Bob peut expliquer l'architecture de l'application, le flux de données, les composants FastAPI, les modèles Pydantic, le comportement des endpoints et les décisions de conception. Ces explications t'aident à comprendre comment l'application fonctionne plutôt que de traiter le code généré par l'IA comme une boîte noire.

Exécuter l'application

Demande à Bob de construire et d'exécuter l'API dans un conteneur :

Build the Docker image and run the container with port 8000 mapped to the host. Confirm the API is reachable.

Bob exécute les commandes de construction et de démarrage et signale quand le conteneur est en cours d'exécution. Pour exécuter les commandes toi-même, ouvre un terminal dans le dossier todo-api :

docker build -t todo-api .
docker run -d --name todo-api -p 8000:8000 todo-api

Ouvre http://127.0.0.1:8000/docs dans ton navigateur.

FastAPI sert une interface Swagger UI interactive à /docs. Utilise-la pour explorer chaque endpoint, inspecter les schémas de requête et de réponse, et exécuter des appels API depuis le navigateur.

Valider l'API

Utilise l'interface Swagger UI à /docs pour exercer chaque opération. Pour chaque endpoint, développe sa ligne, sélectionne Try it out, entre les paramètres de chemin ou le corps de requête, sélectionne Execute, puis vérifie le code et le corps de la Server response.

Ajouter une tâche

1. Développe POST /tasks et sélectionne Try it out.

2. Remplace le corps de la requête par :

   {
     "task_name": "My first API item!"
   }

3. Sélectionne Execute. Confirme que le code de réponse est 201 et que le corps de la réponse contient la tâche avec un id attribué. Note l'id ; tu en as besoin dans les étapes de mise à jour et de suppression.

Ensuite, confirme les règles de validation que tu as ajoutées lors de la planification en envoyant des entrées invalides et en vérifiant que l'API les rejette :

4. Dans le même corps de requête, définis task_name sur une chaîne vide (""), sélectionne Execute, et confirme que le code de réponse est 422 avec un corps de réponse qui décrit l'erreur de validation.
5. Définis task_name sur une chaîne de plus de 200 caractères, sélectionne Execute, et confirme que le code de réponse est à nouveau 422.

Récupérer les tâches

1. Développe GET /tasks et sélectionne Try it out.
2. Sélectionne Execute. Confirme que le code de réponse est 200 et que le corps de la réponse liste la tâche My first API item! avec l'id attribué lors de son ajout.

Mettre à jour une tâche

1. Développe PUT /tasks/{task_id} et sélectionne Try it out.

2. Entre le task_id de la tâche que tu as créée.

3. Remplace le corps de la requête par :

   {
     "task_name": "Build and ship a To-Do API"
   }

4. Sélectionne Execute. Confirme que le code de réponse est 200 et que la tâche retournée affiche le task_name mis à jour.

5. Modifie task_id pour une valeur qui n'existe pas et sélectionne à nouveau Execute. Confirme que le code de réponse est 404.

Supprimer une tâche

1. Développe DELETE /tasks/{task_id} et sélectionne Try it out.
2. Entre le task_id de la tâche que tu as créée et sélectionne Execute. Confirme que le code de réponse est 204.
3. Développe GET /tasks, sélectionne Execute, et confirme que la tâche n'apparaît plus dans la réponse.
4. Développe à nouveau DELETE /tasks/{task_id}, entre le même task_id, et sélectionne Execute. Confirme que le code de réponse est 404.

Cela confirme que l'implémentation, y compris l'endpoint de mise à jour que tu as ajouté avec le codage littéraire, satisfait les exigences initiales.

Démarrer une nouvelle fenêtre de contexte

Clique sur Nouvelle tâche dans la zone de chat ou sur + en haut du panneau de chat pour démarrer une nouvelle fenêtre de contexte.

Demander à Bob des suggestions d'amélioration

Dans l'interface de chat Bob, entre :

Review the To-Do API and suggest improvements to code quality, error handling, and HTTP status codes.

Bob identifie des lacunes telles qu'un endpoint manquant pour récupérer une seule tâche, un magasin en mémoire qui contient des dictionnaires simples plutôt que des modèles Task validés, et un id_counter au niveau du module qui est difficile à réinitialiser ou à tester.

Appliquer les améliorations

Demande à Bob d'implémenter les suggestions que tu souhaites conserver :

Add a GET /tasks/{task_id} endpoint that returns 404 when the task ID does not exist, and store tasks as Task models instead of dictionaries.

Révise les modifications proposées et approuve pour les appliquer. Demande à Bob de reconstruire l'image et de redémarrer le conteneur, puis répète les étapes de validation. Confirme que GET /tasks/{task_id} retourne 200 avec la tâche pour un ID valide et 404 pour un ID inconnu, et que les endpoints existants se comportent toujours comme avant.

Démarrer une nouvelle fenêtre de contexte

Clique sur Nouvelle tâche dans la zone de chat ou sur + en haut du panneau de chat pour démarrer une nouvelle fenêtre de contexte.

Générer des tests unitaires

Demande à Bob :

Generate pytest unit tests for this application. Add pytest and httpx to a dev requirements file, build a test image, and run the suite in a container.

Bob ajoute les dépendances de test pytest et httpx, construit une image qui les inclut, exécute la suite dans un conteneur et rapporte les résultats. Exécuter les tests dans un conteneur signifie que tu n'as pas besoin d'un environnement Python local. Révise et affine les tests générés.

La révision et la maintenance des tests générés restent de ta responsabilité.

Générer de la documentation technique

Demande à Bob :

Generate technical documentation for this To-Do API.

Bob peut générer une vue d'ensemble de l'application, une description de l'architecture, des résumés des endpoints, des exemples de requêtes et de réponses, et des instructions d'utilisation. Cette documentation complète la documentation API que FastAPI génère automatiquement.