杰瑞科技汇

如何在VSCode中高效编写Python代码?

VS Code Python 使用教程:从入门到精通

本教程将分为以下几个部分:

如何在VSCode中高效编写Python代码?-图1
(图片来源网络,侵删)
  1. 第一步:安装必要软件
  2. 第二步:配置 VS Code
  3. 第三步:创建和运行你的第一个 Python 程序
  4. 第四步:使用强大的调试器
  5. 第五步:提升效率:代码补全、格式化和 Linting
  6. 第六步:进阶:使用虚拟环境
  7. 第七步:总结与推荐插件

第一步:安装必要软件

在开始之前,你需要确保你的电脑上安装了以下两样东西:

安装 Python

VS Code 本身不包含 Python 解释器,你需要先安装它。

  • 下载地址:访问 Python 官方网站
  • 安装步骤
    • 运行下载的安装包。
    • 最重要的一步:在安装界面,务必勾选 "Add Python to PATH" 或 "Add python.exe to PATH" 选项,这能让你在命令行中直接使用 python 命令。
    • 点击 "Install Now" 进行默认安装即可。
  • 验证安装
    • 打开命令提示符 或终端。
    • 输入 python --versionpython3 --version(取决于你的系统配置)。
    • 如果看到版本号(如 Python 3.11.4),则说明安装成功。

安装 Visual Studio Code

  • 下载地址:访问 VS Code 官方网站
  • 安装步骤:根据你的操作系统(Windows, macOS, Linux)下载并运行安装程序,按照提示完成安装即可。

第二步:配置 VS Code

安装完成后,我们需要对 VS Code 进行一些基础配置,让它更好地支持 Python 开发。

安装 Python 插件

VS Code 的强大之处在于其丰富的扩展,对于 Python 开发,官方插件是必不可少的。

如何在VSCode中高效编写Python代码?-图2
(图片来源网络,侵删)
  • 打开 VS Code。
  • 点击左侧活动栏的 扩展图标(四个方块组成的图标)。
  • 在搜索框中输入 Python
  • 找到由 Microsoft 发布的 Python 插件,点击 安装

这个插件会自动安装很多有用的工具,包括代码补全、Linting、调试器支持等。

选择解释器

一个电脑上可能安装了多个 Python 版本(Python 2.7, Python 3.8, Python 3.11),你需要告诉 VS Code 你想在当前项目中使用哪一个。

  • 方法一(推荐):打开你的项目文件夹,VS Code 通常会自动在右下角检测并显示一个 Python 版本,点击它,就可以在弹出的列表中选择你想要的解释器。
  • 方法二:使用命令面板。
    • Ctrl+Shift+P (Windows/Linux) 或 Cmd+Shift+P (macOS) 打开命令面板。
    • 输入 Python: Select Interpreter 并选择。
    • 从列表中选择一个解释器。

为什么这很重要? 这确保了你的项目使用正确的依赖包,避免版本冲突。


第三步:创建和运行你的第一个 Python 程序

让我们动手写代码!

如何在VSCode中高效编写Python代码?-图3
(图片来源网络,侵删)

创建工作区

  • 在 VS Code 中,选择 文件 > 打开文件夹,创建一个用于存放你项目的文件夹(my-python-project)。
  • 在资源管理器中,点击 新建文件 图标,创建一个文件,命名为 hello.py

编写代码

hello.py 文件中,输入以下代码:

print("Hello, VS Code!")
name = input("请输入你的名字: ")
print(f"你好, {name}! 欢迎使用 VS Code 进行 Python 开发。")

运行代码

VS Code 提供了多种运行 Python 文件的方式:

  • 使用运行按钮

    • 打开 hello.py 文件后,编辑器右上角会出现一个播放按钮 。
    • 点击它,代码就会在终端中运行。
  • 使用命令面板

    • Ctrl+Shift+P (Windows/Linux) 或 Cmd+Shift+P (macOS) 打开命令面板。
    • 输入 Python: Run Python File in Terminal 并选择,这会在集成终端中运行你的文件,并可以看到输入/输出。
  • 直接在终端中运行

    • VS Code 集成了终端,点击底部面板的 终端 标签,打开一个新终端。
    • 确保终端路径是你的项目文件夹(cd my-python-project)。
    • 输入命令 python hello.py 并按回车。

运行后,你会在终端看到输出,并根据提示输入你的名字。


第四步:使用强大的调试器

print() 语句适合简单调试,但对于复杂的程序,一个图形化的调试器是必不可少的,它能让你设置断点、查看变量值、单步执行代码。

设置断点

断点是程序暂停执行的位置。

  • 在代码编辑器中,点击你想要暂停的代码行号左侧的空白区域,会出现一个红点,这就是断点。
  • hello.pyprint(f"你好, {name}!") 这一行设置一个断点。

启动调试

  • 切换到 调试 视图(左侧活动栏的虫子图标)。
  • 点击绿色的 启动调试 按钮(一个播放图标)。
  • 或者,直接按 F5 键。

程序会启动,并在遇到断点时暂停。

使用调试控制台

当程序暂停时,你可以:

  • 查看变量:在左侧的 变量 窗口中,你可以看到当前所有变量的值,你会发现 name 变量的值是你刚刚输入的字符串。
  • 单步执行
    • F10 (Step Over):执行当前行,然后停在下一行。
    • F11 (Step Into):如果当前行是一个函数调用,则进入该函数内部。
    • Shift+F11 (Step Out):跳出当前函数,回到调用它的地方。
  • 继续执行:按 F5,程序会继续运行,直到遇到下一个断点或程序结束。

第五步:提升效率:代码补全、格式化和 Linting

VS Code + Python 插件能极大地提升你的编码体验。

智能代码补全

你只需要输入几个字母,VS Code 就会自动提示可能的函数、变量或代码片段,这是最基础也是最强大的功能。

代码格式化**

整洁的代码易于阅读和维护,我们使用 black 这款流行的代码格式化工具。

  • 安装 black:在终端中运行 pip install black
  • 配置 VS Code
    • Ctrl+Shift+P (Windows/Linux) 或 Cmd+Shift+P (macOS) 打开命令面板。
    • 输入 Preferences: Open Settings (JSON) 并选择。
    • 在打开的 settings.json 文件中,添加以下配置:
      {
          "python.formatting.provider": "black",
          "editor.formatOnSave": true
      }
  • 使用:每次你保存文件 (Ctrl+S) 时,代码都会自动按照 black 的风格进行格式化。

Linting (代码检查)

Linting 可以帮你发现代码中的错误、风格问题和潜在 bug,我们使用 flake8

  • 安装 flake8:在终端中运行 pip install flake8
  • 配置 VS Code:Python 插件会自动检测到你安装了 flake8,并开始工作,你会在代码的左侧看到波浪线,鼠标悬停即可看到具体的问题。
  • 配置:你同样可以在 settings.json 中配置 Linter,
    {
        "python.linting.enabled": true,
        "python.linting.flake8Enabled": true,
        "python.linting.flake8Args": ["--max-line-length=88"]
    }

第六步:进阶:使用虚拟环境

为了避免不同项目之间的库冲突,强烈建议为每个项目创建一个独立的虚拟环境。

创建虚拟环境

  • 在 VS Code 的 终端 中,确保你的项目文件夹是当前目录。
  • 运行以下命令:
    • Windows: python -m venv venv
    • macOS/Linux: python3 -m venv venv
  • 这会在你的项目中创建一个名为 venv 的文件夹,里面包含了独立的 Python 环境。

激活虚拟环境

  • Windows: 在终端中输入 .\venv\Scripts\activate
  • macOS/Linux: 在终端中输入 source venv/bin/activate
  • 激活后,你会在终端提示符前看到 (venv) 字样,表示你已在此环境中。

在虚拟环境中安装包

当你使用 pip install 安装的包,只会被安装到这个 venv 环境中,不会影响你系统的 Python 环境。

  • pip install requests numpy

VS Code 自动选择虚拟环境的解释器**

当你激活了虚拟环境后,VS Code 通常会自动检测到它,并在右下角显示 (venv),如果没自动检测,你可以按照 第二步 中的方法手动选择 venv 文件夹下的 python.exepython


第七步:总结与推荐插件

通过以上步骤,你已经掌握了在 VS Code 中进行 Python 开发的核心流程:

  1. 安装 Python 和 VS Code。
  2. 安装 Python 扩展。
  3. 选择 正确的 Python 解释器。
  4. 编写 代码并使用 运行 按钮快速执行。
  5. 使用 调试器 (F5) 进行深度调试。
  6. 通过 格式化Linting 保持代码质量。
  7. 使用 虚拟环境 管理项目依赖。

推荐插件

除了核心的 Python 插件,以下插件也能极大提升你的开发体验:

  • Pylance: 由 Microsoft 提供的 Python 语言服务器,提供更强大的代码补全、类型检查和导航功能,Python 插件通常会自动安装它。
  • Jupyter: 如果你进行数据科学或机器学习,这个插件让你可以在 VS Code 中直接使用 Jupyter Notebook。
  • GitLens: 强大的 Git 工具,可以让你轻松地查看代码的修改历史、 blame 信息等。
  • Bracket Pair Colorizer: 用不同颜色高亮显示匹配的括号,让代码结构一目了然。
  • indent-rainbow: 用不同颜色显示代码的缩进层级,非常直观。

祝你使用愉快,编码高效!

分享:
扫描分享到社交APP
上一篇
下一篇