Usar o GitHub Copilot com Python
Nas unidades anteriores, mostramos a você como configurar o Copilot e mencionamos como ele pode tornar mais rápido o trabalho de um desenvolvedor que está começando a escrever código.
Nesta unidade, discutimos como o Copilot pode ajudar você com projetos existentes e com tarefas mais complicadas.
Desenvolvimento com o GitHub Copilot
Muitas vezes, quando compilamos projetos, precisamos garantir continuamente que nosso código esteja novo e atualizado. Além disso, talvez seja necessário corrigir quaisquer erros que surjam ou adicionar novos recursos para aprimorar a funcionalidade e usabilidade. Vamos explorar algumas maneiras de fazer atualizações com o GitHub Copilot e o GitHub Copilot Chat, uma interface de chat interativa para fazer e receber respostas para perguntas relacionadas ao código.
Engenharia de prompts
Embora o GitHub Copilot possa sugerir código à medida que você digita, você também pode criar prompts para criar sugestões úteis. Um prompt, que é a nossa entrada, é uma coleção de instruções ou diretrizes que ajudam a gerar o código. Um prompt é útil para gerar respostas específicas a partir do Copilot. O prompt pode ser um comentário ou uma entrada ao usar o GitHub Copilot Chat que orienta o Copilot a gerar código em seu nome ou escrever código que o Copilot preenche automaticamente.
A qualidade da saída do Copilot depende de quão bem você elabora seu prompt. Projetar um prompt eficaz é crucial para garantir que você alcance os resultados desejados.
Por exemplo, considere o seguinte prompt:
# Create an API endpoint
Como o prompt é ambíguo e vago, o resultado do GitHub Copilot pode não ser o que você precisa. Por exemplo, ele pode sugerir código que usa uma estrutura que você não conhece ou um ponto de extremidade que exige dados que você não reconhece.
Agora considere este prompt:
# Create an API endpoint using the FastAPI framework that accepts a JSON payload in a POST request
O prompt é específico, claro e permite que o GitHub Copilot entenda a meta e o escopo da tarefa. Você pode fornecer contexto e exemplos para Copilot usando comentários ou código, mas também pode usar a opção de chat do GitHub Copilot Chat para aprimorar seu prompt. Ter um bom prompt garante que o modelo gere uma saída de alta qualidade.
Melhores práticas utilizando o GitHub Copilot
O Copilot aumenta muito sua produtividade, mas exige algumas boas práticas para garantir a qualidade. Algumas das melhores práticas ao usar o Copilot são:
Mantenha seus prompts simples e adicione componentes mais elaborados à medida que prossegue. Por exemplo:
create an HTML form with a text field and button
A seguir, elabore mais sobre o prompt para obter sugestões mais específicas:
Add an event listen to the button to send a POST request to /generate endpoint and display response in a div with id "result"
Alterne entre sugestões. Você pode fazer isso usando Ctrl+Enter (ou Cmd+Enter em um Mac). Você receberá várias sugestões do Copilot e poderá escolher a melhor saída. Opcionalmente, ao usar o GitHub Copilot Chat, você poderá usar a entrada de chat para adicionar seu prompt e interagir com a saída.
Se você não estiver obtendo os resultados que deseja, poderá reformular o prompt ou começar a escrever código para o Copilot preencher automaticamente.
Observação
O GitHub Copilot utiliza os arquivos abertos no seu editor de texto como contexto adicional. Isso ajuda porque fornece informações úteis, além do prompt ou do código que você pode estar escrevendo. Se você precisar que o GitHub Copilot forneça sugestões com base em outros arquivos, poderá abri-los ou usar o @workspace com seu prompt ao usar o GitHub Copilot Chat.