如何在 Visual Studio Code 中使用虚拟环境来调试 Jupyter Notebook

在 VS Code 中为 Jupyter Notebook 配置虚拟环境

该解决方案在 VS Code 中使用 Python 和 Jupyter Notebook 配置，重点关注虚拟环境。

# Solution 1: Using ipykernel to Register Your Virtual Environment
# Step 1: Activate the virtual environment
$ source ç/envs/my-project-env/bin/activate

# Step 2: Install ipykernel inside the virtual environment
(my-project-env) $ pip install ipykernel

# Step 3: Add the virtual environment to Jupyter's kernels
(my-project-env) $ python -m ipykernel install --user --name=my-project-env --display-name "Python (my-project-env)"

# Now, restart VS Code and select the kernel "Python (my-project-env)" from the Jupyter toolbar.

# Step 4: Verify that the kernel uses the correct Python path
# Run the following in a Jupyter Notebook cell:
!which python

# This should point to your virtual environment's Python binary.

使用 VS Code 的 Python 扩展来管理解释器

该方法使用VS Code中的Python扩展来注册虚拟环境。

# Solution 2: Adding the Virtual Environment as a Python Interpreter
# Step 1: Open the Command Palette in VS Code (Ctrl+Shift+P or Cmd+Shift+P on Mac)
# Step 2: Search for "Python: Select Interpreter"
# Step 3: Click "Enter Interpreter Path" and navigate to the Python binary inside your virtual environment.
# Example: /ç/envs/my-project-env/bin/python

# Step 4: Open your Jupyter Notebook in VS Code
# You should now see "Python (my-project-env)" in the kernel dropdown menu.

# Step 5: Verify the interpreter by running a cell with the following command:
!which python
# Ensure it points to your virtual environment's Python binary.

测试和验证解决方案

该脚本通过包含用于验证内核注册和解释器选择的单元测试来确保正确性。

# Unit Test 1: Kernel Availability Test
import os
from subprocess import check_output

def test_kernel_registration():
    kernels = check_output(["jupyter", "kernelspec", "list"]).decode()
    assert "my-project-env" in kernels, "Kernel registration failed!"

test_kernel_registration()

# Unit Test 2: Interpreter Path Validation
def test_python_path():
    python_path = check_output(["which", "python"]).decode().strip()
    expected_path = "/ç/envs/my-project-env/bin/python"
    assert python_path == expected_path, "Interpreter path mismatch!"

test_python_path()

有关 Jupyter 和 VS Code 中虚拟环境的常见问题解答

1. 目的是什么 ipykernel 包裹？
2. 这 ipykernel 包允许 Python 环境充当 Jupyter 内核。这使得 Jupyter Notebooks 能够使用环境的 Python 解释器和库。
3. 如何在 VS Code 中激活虚拟环境？
4. 使用终端命令 source ç/envs/my-project-env/bin/activate。对于 Windows，相当于 my-project-env\Scripts\activate。
5. 为什么我的内核仍然指向全局解释器？
6. 当虚拟环境未正确注册到 Jupyter 时，就会发生这种情况。使用 python -m ipykernel install 将环境注册为内核。
7. 如何在 VS Code 中为 Jupyter 设置环境变量？
8. 修改 settings.json 文件在您的工作区中。添加虚拟环境的路径和任何所需的变量以确保兼容性。
9. 我可以在一个项目中使用多个虚拟环境吗？
10. 是的，但您必须根据需要切换 Jupyter Notebook 中的内核并更新 VS Code 中的解释器。使用 Python: Select Interpreter 为此目的，从命令面板中。

使用 Jupyter 和 VS Code 简化调试

管理 Jupyter Notebook 的虚拟环境需要注意细节，但通过正确的设置可以简化该过程。通过注册内核和配置 Python 解释器，您可以避免许多常见的陷阱并保持开发工作流程的一致性。 🛠️

实现这些技术不仅可以优化性能，还可以确保调试和运行脚本时的兼容性。这种设置虽然最初是技术性的，但对于高效开发来说变得非常宝贵，使其成为 Python 程序员的必备技能。