Utiliser GitHub Copilot avec Python
Dans les unités précédentes, nous vous avons montré comment configurer Copilot et mentionné comment il peut vous rendre plus rapide en tant que développeur commençant à écrire du code.
Dans cette unité, nous verrons comment Copilot peut vous aider à réaliser des projets existants et des tâches plus complexes.
Développement avec GitHub Copilot
Souvent, lorsque nous développons des projets, nous devons continuellement nous assurer que notre code est frais et mis à jour. En outre, il se peut que nous devions corriger des bogues ou ajouter de nouvelles caractéristiques afin d’améliorer la fonctionnalité et la facilité d’utilisation. Nous allons explorer quelques façons de faire des mises à jour avec GitHub Copilot et GitHub Copilot Chat, une interface de chat interactive qui vous permet de poser des questions liées au code et d’obtenir des réponses à ces questions.
Ingénierie d’invite
GitHub Copilot peut suggérer du code au fur et à mesure que vous le saisissez, mais vous pouvez également créer des suggestions utiles en élaborant des invites. Une invite, qui est notre entrée, est une collection d’instructions ou de directives qui aident à générer du code. Une invite est utile pour générer des réponses spécifiques de Copilot. Le prompt peut correspondre à un commentaire ou une entrée dans GitHub Copilot Chat, qui indique à Copilot de générer du code à votre place, ou à du code devant faire l’objet d’une autocomplétion par Copilot.
La qualité des résultats de Copilot dépend de la manière dont vous rédigez votre message. La conception d’un message efficace est cruciale pour garantir que vous atteignez le résultat souhaité.
Prenons l’exemple de l’invite suivante :
# Create an API endpoint
L’invite est ambiguë et vague, de sorte que le résultat de GitHub Copilot peut ne pas correspondre à ce dont vous avez besoin. Il pourrait, par exemple, suggérer un code qui utilise un cadre que vous ne connaissez pas, ou un point de terminaison qui nécessite des données que vous ne reconnaissez pas.
Considérons maintenant l’invitation suivante :
# Create an API endpoint using the FastAPI framework that accepts a JSON payload in a POST request
L’invite est spécifique, claire et permet à GitHub Copilot de comprendre l’objectif et l’étendue de la tâche. Vous pouvez fournir du contexte et des exemples à Copilot en utilisant des commentaires ou du code, mais vous pouvez également utiliser l’option de chat de GitHub Copilot Chat pour améliorer votre message. Le fait de disposer d'une bonne invite garantit que le modèle génère un résultat de haute qualité.
Meilleures pratiques en utilisant GitHub Copilot
Copilot augmente votre productivité mais nécessite quelques bonnes pratiques pour garantir la qualité. Voici quelques meilleures pratiques pour l’utilisation de Copilot :
Créez des prompts simples, puis ajoutez des composants plus élaborés au fur et à mesure que vous avancez. Par exemple :
create an HTML form with a text field and button
Ensuite, développez davantage l’invite pour obtenir des suggestions plus spécifiques :
Add an event listen to the button to send a POST request to /generate endpoint and display response in a div with id "result"
Faites un cycle entre les suggestions. Pour ce faire, vous pouvez utiliser Ctrl+Enter (ou Cmd+Enter sur un Mac). Copilot vous propose plusieurs suggestions et vous pouvez choisir la meilleure. Quand vous utilisez GitHub Copilot Chat, vous pouvez éventuellement vous servir de l’entrée de conversation pour ajouter votre prompt, et interagir avec la sortie.
Si vous n’obtenez pas les résultats souhaités, vous pouvez reformuler l’invite ou commencer à écrire du code pour que Copilot s’auto-complète.
Remarque
GitHub Copilot utilise les fichiers ouverts dans votre éditeur de texte comme contexte supplémentaire. C’est utile car cela fournit des informations utiles en plus de l'invite ou du code que vous êtes en train d'écrire. Si vous avez besoin que GitHub Copilot vous fournisse des suggestions basées sur d’autres fichiers, vous pouvez les ouvrir ou utiliser @workspace avec votre prompt quand vous utilisez GitHub Copilot Chat.