杰瑞科技汇

macVSCode如何配置Python环境?

总览:配置流程概览

整个过程可以分为以下几个核心步骤:

macVSCode如何配置Python环境?-图1
(图片来源网络,侵删)
  1. 安装必要软件:安装 Python、VS Code 和 Python 扩展。
  2. 选择和配置解释器:告诉 VS Code 使用哪个 Python 环境。
  3. 运行和调试代码:执行你的第一个 Python 程序,并学习如何使用调试器。
  4. 提升开发效率:配置代码格式化、自动补全、Linting 等工具。

第一步:安装必要软件

安装 Python

在 macOS 上,推荐使用 Homebrew 来安装 Python,因为它能帮你管理依赖,并方便地切换不同版本。

  • 检查是否已安装 Python 打开终端(Terminal),输入以下命令:

    python3 --version

    如果已经安装,会显示 Python 的版本号(如 Python 3.11.4),如果提示 command not found,则需要安装。

  • 使用 Homebrew 安装 Python

    macVSCode如何配置Python环境?-图2
    (图片来源网络,侵删)
    1. 如果尚未安装 Homebrew,请在终端中运行以下命令:
      /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
    2. 安装完成后,使用 Homebrew 安装 Python 3:
      brew install python
    3. 安装完成后,再次检查 python3 --version,确保安装成功。

重要提示:macOS 自带一个较旧的 Python 2 版本。强烈建议你始终使用 python3 命令来调用新安装的 Python 3 解释器,为了避免每次都输入 3,你可以创建一个别名(alias),但这不是必须的。

安装 Visual Studio Code

  1. 访问 Visual Studio Code 官网
  2. 点击 "Download for Mac" 下载 .zip 文件。
  3. 解压下载的文件,将 Visual Studio Code.app 拖到你的 Applications 文件夹中。
  4. 打开 VS Code。

安装 Python 扩展

这是 VS Code 支持 Python 开发的核心。

  1. 打开 VS Code。
  2. 点击左侧活动栏的 扩展图标(四个方块组成的图标)。
  3. 在搜索框中输入 Python
  4. 找到由 Microsoft 发布的 Python 扩展,点击 Install(安装)。

第二步:选择和配置 Python 解释器

“解释器”是运行你 Python 代码的程序,VS Code 需要知道要使用哪个解释器。

自动选择解释器

当你安装了 Python 扩展后,VS Code 通常会自动检测到你系统中的 Python 3 解释器,你可以在 VS Code 窗口的右下角看到一个状态栏,它会显示当前选择的 Python 版本。

如果它没有自动选择,或者你选择了错误的版本,可以手动选择。

手动选择解释器

  1. 打开一个包含 Python 文件的文件夹(或者新建一个文件夹,在里面创建一个 .py 文件)。
  2. Cmd + Shift + P 打开命令面板。
  3. 输入 Python: Select Interpreter 并回车。
  4. 在弹出的列表中,选择你想要使用的 Python 解释器,通常它会显示类似 /usr/bin/python3/opt/homebrew/bin/python3 的路径,选择 Homebrew 安装的版本通常是最好的选择。

最佳实践:为每个项目创建虚拟环境 虚拟环境可以为每个项目隔离依赖,避免不同项目之间的库版本冲突,这是专业开发的标准做法。

如何创建和使用虚拟环境:

  1. 打开项目文件夹:在 VS Code 中打开你的 Python 项目文件夹。
  2. 打开终端:VS Code 内置了终端,点击顶部菜单的 终端 -> 新终端,或者使用快捷键 Cmd + \ (反斜杠)。
  3. 创建虚拟环境:在终端中,输入以下命令(假设你的项目文件夹名为 my_project):
    # 在项目根目录下创建名为 venv 的虚拟环境
    python3 -m venv venv
  4. 激活虚拟环境:创建后,激活它。
    # 激活虚拟环境
    source venv/bin/activate

    激活后,你会在终端命令行前面看到 (venv) 的前缀,表示你已在此环境中。

  5. VS Code 自动识别:一旦你在激活了虚拟环境的终端中,VS Code 通常会自动检测到这个新的解释器,并提示你是否切换到它,点击 "Switch to interpreter" 即可,之后,你安装的所有包(如 pip install requests)都会被安装到这个虚拟环境中,而不会污染你的全局 Python 环境。

第三步:运行和调试代码

运行 Python 文件

  1. 在 VS Code 中创建一个新的 Python 文件,hello.py

  2. 输入以下代码:

    print("Hello, VS Code on macOS!")
    name = input("Please enter your name: ")
    print(f"Hello, {name}!")
  3. 运行代码有两种方式:

    • 使用运行按钮
      • 点击右上角的 按钮(Play button)。
      • 首次运行时,VS Code 会提示你选择一个调试器,选择 Python File
    • 使用快捷键
      • Cmd + Shift + B
      • 或者,在代码编辑器中,右键点击,选择 Run Python File in Terminal

    代码会在底部的 终端 窗口中执行,并显示输出。

调试 Python 代码

调试是查找代码错误的关键。

  1. 设置断点:在代码行号的左侧空白处单击,会出现一个红色的圆点,这就是断点,程序执行到这一行时会暂停。

    def add(a, b):
        print(f"Adding {a} and {b}") # 在这一行设置断点
        return a + b
    result = add(5, 3)
    print(f"The result is: {result}")
  2. 启动调试器

    • 点击左侧活动栏的 运行和调试图标(虫子图标)。
    • 或者按快捷键 Cmd + Shift + D
    • 在顶部下拉菜单中选择 Python File,然后点击绿色的 按钮(Play button)。
  3. 使用调试控制台

    • 程序会在断点处暂停。
    • 你可以使用调试控制台顶部的按钮来控制执行:
      • 继续 (F5): 继续执行,直到下一个断点或程序结束。
      • 单步跳过 (F10): 执行当前行,然后跳到下一行。
      • 单步进入 (F11): 如果当前行是一个函数调用,会进入该函数内部。
      • 单步退出 (Shift + F11): 跳出当前函数。
    • VARIABLES 窗口中,你可以查看当前所有变量的值。

第四步:提升开发效率(配置工作区)

这部分让 VS Code 变得更智能、更强大,我们将配置代码格式化、Linting 和自动补全。

创建 .vscode 文件夹和 settings.json

在你的项目根目录下,创建一个名为 .vscode 的文件夹,在这个文件夹里,创建一个 settings.json 文件,这个文件将用于配置当前项目专属的 VS Code 设置。

# 在项目根目录的终端中执行
mkdir .vscode
touch .vscode/settings.json

安装强大的 Python 工具

在终端中(确保虚拟环境已激活),安装以下三个工具:

pip install black isort flake8
  • Black: 代码格式化工具,能自动将你的代码格式化为统一的风格。
  • isort: Python import 语句排序工具,能自动整理 import 语句的顺序。
  • flake8: Linting 工具,能检查代码中的语法错误、风格问题和不规范的地方。

配置 settings.json

打开 .vscode/settings.json 文件,并粘贴以下内容,这些配置会告诉 VS Code 如何使用我们刚刚安装的工具。

{
    // --- Python 解释器设置 ---
    "python.defaultInterpreterPath": "./venv/bin/python", // 指向你的虚拟环境中的解释器
    // --- 代码格式化设置 ---
    "editor.formatOnSave": true, // 保存时自动格式化代码
    // 使用 Black 作为 Python 的默认格式化程序
    "[python]": {
        "editor.defaultFormatter": "ms-python.black-formatter"
    },
    "python.formatting.provider": "black", // 强制使用 Black
    // 使用 isort 来整理 import 语句
    "python.sortImports.args": ["--profile", "black"], // 让 isort 的风格与 Black 兼容
    // --- Linting 设置 ---
    "python.linting.enabled": true, // 启用 Linting
    "python.linting.flake8Enabled": true, // 启用 flake8
    "python.linting.flake8Args": [
        "--max-line-length=88", // 与 Black 的行长度限制保持一致
        "--extend-ignore=E203,W503" // 忽略一些与 Black 冲突的规则
    ]
}

注意"python.defaultInterpreterPath" 的路径是相对于项目根目录的,如果你的虚拟环境文件夹不叫 venv,或者路径不同,请相应修改。

享受成果

当你编写 Python 代码并保存文件时(Cmd + S),VS Code 会自动:

  • 使用 Black 格式化你的代码。
  • 使用 isort 排序你的 import 语句。
  • 使用 flake8 检查代码,并在编辑器的左下角显示问题。

VS Code 的自动补全功能(IntelliSense)也已经就绪,会根据你安装的库和代码上下文提供智能提示。


通过以上四个步骤,你就成功地在 macOS 上配置了一个功能齐全、专业级的 Python 开发环境:

  1. 安装:Python (通过 Homebrew), VS Code, Python 扩展。
  2. 配置解释器:选择 Python 3,并为项目创建和使用虚拟环境。
  3. 运行调试:学会使用运行按钮和强大的调试器。
  4. 提升效率:通过 settings.json 配置 Black, isort, flake8,实现自动化代码格式化和检查。

这个配置流程是现代 Python 开发的最佳实践,能让你将更多精力放在解决问题上,而不是环境配置上,祝你编码愉快!

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