将 GitHub Copilot 与 Python 配合使用
前面的单元介绍了如何设置 Copilot,并提到了它能够如何让开发人员更快地开始编写代码。
在本单元中,我们将讨论 Copilot 如何帮助你处理现有项目以及更复杂的任务。
使用 GitHub Copilot 进行开发
通常,在开发项目时,我们需要持续确保我们的代码是最新且经过更新的。 此外,我们可能需要修复出现的任何 bug 或添加新功能,以改进代码的功能和可用性。 我们来探索一些使用 GitHub Copilot 和 GitHub Copilot Chat 进行更新的方法,后者是一个交互式聊天界面,可用于询问与代码相关的问题并获取答案。
提示工程
GitHub Copilot 可以在你输入代码时提供建议,但你也可以通过构建提示来创建有用的建议。 提示(即输入)是帮助生成代码的指令或准则的集合。 提示对于从 Copilot 生成特定响应非常有用。 当使用 GitHub Copilot Chat 引导 Copilot 代表你生成代码或编写 Copilot 自动完成的代码时,提示可能是注释或输入。
Copilot 输出内容的质量取决于你制作的提示的好坏。 设计有效的提示对于确保实现所需结果至关重要。
例如,以下面的提示为例:
# Create an API endpoint
该提示含混不清,因此 GitHub Copilot 生成的结果可能不符合你的需要。 例如,它可能会在建议中提供使用你不知道的框架的代码,或者提供需要你不了解的数据的终结点。
现在,看一下下面这个提示:
# Create an API endpoint using the FastAPI framework that accepts a JSON payload in a POST request
该提示具体而清晰,因此 GitHub Copilot 能够知道任务的目标和范围。 你可以使用注释或代码向 Copilot 提供上下文和示例,但也可以使用 GitHub Copilot Chat 的聊天选项来增强自己的提示。 合理的提示可确保模型生成高质量的输出。
有关使用 GitHub Copilot 的最佳做法
Copilot 可以大幅提高工作效率,但需要遵循一些良好的做法才能确保质量。 使用 Copilot 时的一些最佳做法包括:
确保提示简单明了,然后在继续操作时添加更详细的组成部分。 例如:
create an HTML form with a text field and button
接下来,进一步详细阐述提示以获取更具体的建议:
Add an event listen to the button to send a POST request to /generate endpoint and display response in a div with id "result"
在建议之间循环。 你可以使用 Ctrl+Enter(或 mac 上的 Cmd+Enter )执行此操作。 可以从 Copilot 获得各种建议,并可以选取最佳输出。 你还可以在使用 GitHub Copilot Chat 时,使用聊天输入以添加提示并与输出交互。
如果未获得所需结果,可以重新组织提示的措辞,或开始编写代码来让 Copilot 自动完成。
注意
GitHub Copilot 使用文本编辑器中已打开的文件作为附加上下文。 这一点很有帮助,因为除了你正在编写的提示或代码之外,它还提供其他有用信息。 如果需要 GitHub Copilot 根据其他文件提供建议,则可以在使用 GitHub Copilot Chat 时打开这些文件或使用 @workspace 提示。