如何在 PyCharm 中使用 WSL 进行 Python 开发

在 PyCharm 中使用 WSL 进行 Python 开发：全面指南

随着 Windows Subsystem for Linux (WSL) 的出现，开发者可以在 Windows 环境中无缝运行 Linux 发行版，极大地提升了跨平台开发的便利性。PyCharm 作为一款强大的 Python IDE，完美支持 WSL，让开发者能够充分利用 Linux 环境的优势进行 Python 项目开发。本文将深入探讨如何在 PyCharm 中配置和使用 WSL，助您构建高效、便捷的开发工作流。

1. WSL 的优势与 PyCharm 的集成

1.1 WSL 的优势

• 原生 Linux 环境: WSL 提供了一个完整的 Linux 内核，允许您直接运行 Linux 二进制文件，无需虚拟机或双启动。这意味着您可以访问 Linux 命令行工具、系统库和开发环境，获得与原生 Linux 系统几乎相同的体验。
• 性能优势: 与虚拟机相比，WSL 占用的系统资源更少，启动速度更快，性能更接近原生 Windows 应用程序。
• 无缝集成: WSL 与 Windows 文件系统紧密集成，您可以轻松访问 Windows 文件和文件夹，反之亦然。这使得在 Windows 和 Linux 环境之间共享文件变得非常容易。
• 开发工具生态: 您可以在 WSL 中安装和使用各种 Linux 开发工具，例如 GCC、Clang、GDB、Valgrind 等，这些工具在 Windows 上可能难以配置或存在兼容性问题。
• 容器化支持: WSL 2 支持 Docker，让您可以在 Linux 环境中轻松构建和运行容器化应用程序。

1.2 PyCharm 与 WSL 的集成

PyCharm 提供了对 WSL 的出色支持，主要体现在以下几个方面：

• 自动检测 WSL: PyCharm 能够自动检测已安装的 WSL 发行版，并允许您选择其中一个作为项目的解释器。
• 远程解释器: 您可以将 WSL 中的 Python 解释器配置为项目的远程解释器，PyCharm 将通过 SSH 连接到 WSL，并在其中执行代码、调试程序、运行测试等。
• 集成终端: PyCharm 的集成终端可以直接访问 WSL shell，您可以在其中执行 Linux 命令、管理软件包、运行脚本等。
• 文件系统同步: PyCharm 会自动同步 Windows 和 WSL 文件系统之间的更改，确保您的项目文件在两个环境中保持一致。
• 调试支持: 您可以在 WSL 中调试 Python 代码，就像在本地 Windows 环境中一样。PyCharm 提供了强大的调试功能，包括断点、单步执行、变量查看等。
• 版本控制集成: PyCharm 与各种版本控制系统（如 Git）无缝集成，您可以在 WSL 环境中进行代码提交、分支管理等操作。

2. 准备工作：安装 WSL 和 Python

在使用 PyCharm 与 WSL 集成之前，您需要先安装 WSL 和 Python。

2.1 安装 WSL

1. 启用 WSL 功能:

   • 以管理员身份打开 PowerShell 或 Windows 命令提示符。
   • 运行以下命令：Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
   • 重新启动计算机。

2. 安装 Linux 发行版:

   • 打开 Microsoft Store。
   • 搜索您喜欢的 Linux 发行版（例如 Ubuntu、Debian、Kali Linux 等）。
   • 点击“获取”按钮进行安装。
   • 安装完成后，您可以从“开始”菜单启动 Linux 发行版。

3. 设置 WSL 2 (可选但推荐):

   • 更新wsl: wsl --update
   • 将 WSL 2 设置为默认版本：wsl --set-default-version 2
   • 将已安装的发行版转换为 WSL 2（例如，对于 Ubuntu）：wsl --set-version Ubuntu 2
   • 如果遇到 WSL 2 requires an update to its kernel component 错误，请按照提示下载并安装 WSL2 Linux 内核更新包。

2.2 在 WSL 中安装 Python

1. 启动 WSL 发行版: 从“开始”菜单启动您安装的 Linux 发行版。
2. 更新软件包列表: 运行以下命令更新软件包列表：
   bash
sudo apt update

3. 安装 Python:

   • 大多数发行版都预装了 Python 3。您可以通过运行 python3 --version 来检查版本。
   • 如果需要安装特定版本的 Python，可以使用以下命令（以 Python 3.9 为例）：
     bash
sudo apt install python3.9 python3.9-venv python3.9-dev
     • python3.9: Python 解释器。
     • python3.9-venv: 用于创建虚拟环境的模块。
     • python3.9-dev: 包含 Python 头文件和库，用于编译 C 扩展。

4. 安装 pip (可选):
   如果您的发行版没有预装 pip，可以使用以下命令安装：
   bash
sudo apt install python3-pip

3. 在 PyCharm 中配置 WSL 解释器

安装好 WSL 和 Python 后，您可以在 PyCharm 中配置 WSL 解释器。

1. 打开或创建项目: 在 PyCharm 中打开您现有的 Python 项目，或创建一个新项目。
2. 打开设置:
   • Windows/Linux: File -> Settings
   • macOS: PyCharm -> Preferences
3. 配置解释器:
   • 导航到 Project: [您的项目名称] -> Python Interpreter。
   • 点击右上角的齿轮图标，选择 Add...。
4. 选择 WSL:
   • 在左侧面板中选择 WSL。
   • PyCharm 将自动检测已安装的 WSL 发行版。从下拉列表中选择您要使用的发行版。
   • 在 Python interpreter path 字段中，选择 WSL 中 Python 解释器的路径。通常情况下，PyCharm 会自动检测到正确的路径（例如 /usr/bin/python3.9）。
5. 创建虚拟环境 (可选但强烈推荐):
   • 如果您希望为项目创建一个隔离的虚拟环境，请选中 Create a virtual environment 复选框。
   • 选择虚拟环境的类型（例如 venv、virtualenv、conda）。
   • 指定虚拟环境的名称和位置。
   • 点击 OK。
6. 应用更改: 点击 OK 保存设置。PyCharm 将使用您选择的 WSL 解释器配置项目。

4. 使用 WSL 解释器进行开发

配置好 WSL 解释器后，您可以像在本地 Windows 环境中一样进行 Python 开发。

4.1 运行代码

• 在 PyCharm 中打开您的 Python 文件。
• 右键单击编辑器，选择 Run '[文件名]'。
• PyCharm 将在 WSL 中使用您配置的解释器执行代码。

4.2 调试代码

• 在您希望暂停执行的代码行上设置断点（单击行号左侧的空白区域）。
• 右键单击编辑器，选择 Debug '[文件名]'。
• PyCharm 将在 WSL 中启动调试器，并在遇到断点时暂停执行。您可以使用调试工具栏（通常位于窗口底部）进行单步执行、查看变量值、评估表达式等操作。

4.3 使用集成终端

• 打开 PyCharm 的集成终端：View -> Tool Windows -> Terminal。
• 默认情况下，终端将连接到 WSL shell。您可以在其中执行 Linux 命令，例如：
  • ls: 列出文件和目录。
  • cd: 更改目录。
  • pwd: 显示当前工作目录。
  • pip install [包名]: 安装 Python 包。
  • python [文件名].py: 运行 Python 脚本。

4.4 管理软件包

您可以使用 PyCharm 的软件包管理器或 WSL 终端中的 pip 来安装、更新和卸载 Python 包。

• PyCharm 软件包管理器:
  • 打开设置：File -> Settings (Windows/Linux) 或 PyCharm -> Preferences (macOS)。
  • 导航到 Project: [您的项目名称] -> Python Interpreter。
  • 您将看到已安装的软件包列表。
  • 点击 + 按钮安装新软件包，点击 - 按钮卸载软件包，点击向上箭头按钮更新软件包。
• WSL 终端:
  • 打开 PyCharm 的集成终端。
  • 使用 pip 命令管理软件包，例如：
    • pip install [包名]: 安装软件包。
    • pip uninstall [包名]: 卸载软件包。
    • pip list: 列出已安装的软件包。
    • pip freeze > requirements.txt: 将已安装的软件包列表保存到 requirements.txt 文件中。

4.5 版本控制

PyCharm 与各种版本控制系统（如 Git）无缝集成。您可以在 WSL 环境中进行代码提交、分支管理等操作。

• 配置 Git:
  • 确保已在 WSL 中安装 Git：sudo apt install git。
  • 配置 Git 用户名和邮箱：
    bash
git config --global user.name "您的用户名"
git config --global user.email "您的邮箱"
• 使用 PyCharm 的 Git 集成:
  • PyCharm 会自动检测项目中的 Git 仓库。
  • 您可以使用 PyCharm 的 VCS 工具栏（通常位于窗口顶部）或右键单击项目文件/文件夹来执行 Git 操作，例如：
    • Commit: 提交更改。
    • Push: 推送更改到远程仓库。
    • Pull: 从远程仓库拉取更改。
    • Branch: 创建、切换、合并分支。

5. 高级配置和技巧

5.1 使用不同的 WSL 发行版

如果您安装了多个 WSL 发行版，可以在 PyCharm 中为不同的项目配置不同的解释器。只需在配置解释器时选择不同的发行版即可。

5.2 在 WSL 中使用图形界面应用程序

如果您需要在 WSL 中运行图形界面应用程序（例如 Matplotlib 绘图），可以安装 X 服务器并在 PyCharm 中配置 DISPLAY 环境变量。

1. 安装 X 服务器:
   • 在 Windows 上安装 X 服务器，例如 VcXsrv 或 Xming。
2. 配置 DISPLAY 环境变量:
   • 在 PyCharm 中打开设置：File -> Settings (Windows/Linux) 或 PyCharm -> Preferences (macOS)。
   • 导航到 Build, Execution, Deployment -> Console -> Python Console。
   • 在 Environment variables 字段中，添加以下变量：
     DISPLAY=localhost:0.0
   • 设置 Run -> Edit Configurations中的Emulate terminal in output console
3. 启动 X 服务器:
   • 启动您安装的 X 服务器。
4. 在 WSL 中运行图形界面应用程序:
   • 在 PyCharm 的集成终端中运行您的 Python 代码，图形界面将显示在 X 服务器窗口中。

5.3 使用 Docker

WSL 2 支持 Docker，让您可以在 Linux 环境中轻松构建和运行容器化应用程序。您可以在 PyCharm 中配置 Docker 集成，以便在 WSL 中管理 Docker 容器和镜像。

1. 在 WSL 中安装 Docker:
   bash
sudo apt update
sudo apt install docker.io
sudo usermod -aG docker $USER
   • 注销并重新登录以使更改生效。
2. 配置 PyCharm Docker 集成:
   • 打开设置：File -> Settings (Windows/Linux) 或 PyCharm -> Preferences (macOS)。
   • 导航到 Build, Execution, Deployment -> Docker。
   • 点击 + 按钮，选择 Docker for Windows。
   • PyCharm 将自动检测 WSL 中的 Docker 引擎。
   • 点击 OK 保存设置。

5.4 性能优化

• 使用 WSL 2: WSL 2 比 WSL 1 具有更好的性能，建议使用 WSL 2。
• 将项目文件存储在 WSL 文件系统中: 将项目文件存储在 WSL 文件系统中（例如 /home/[用户名]/projects）可以提高文件访问速度。避免将项目文件存储在 Windows 文件系统中（例如 C:\Users\[用户名]\projects），因为跨文件系统访问会降低性能。
• 调整 PyCharm 内存设置: 如果您有足够的内存，可以增加 PyCharm 的内存分配，以提高 IDE 的性能。

6. 常见问题解答

• 问：我无法在 PyCharm 中找到 WSL 解释器。

  答：确保您已正确安装 WSL 并启用了 WSL 功能。在 PyCharm 中配置解释器时，选择 WSL 选项，PyCharm 应该会自动检测已安装的发行版。
  * 问：我在 WSL 中安装的 Python 包在 PyCharm 中无法识别。

  答：确保您已将 WSL 中的 Python 解释器配置为项目的解释器。如果使用了虚拟环境，请确保已激活虚拟环境。
  * 问：我无法在 WSL 中运行图形界面应用程序。

  答：确保您已安装 X 服务器并在 PyCharm 中配置了 DISPLAY 环境变量。
  * 问：我无法在 WSL 中使用 Docker。

  答：确保您使用的是 WSL 2，并在 WSL 中正确安装了 Docker。在 PyCharm 中配置 Docker 集成时，选择 Docker for Windows。
  * 问：我的 WSL 终端的默认路径是Windows路径，如何改成 Linux路径
  答：
  * 打开设置：File -> Settings (Windows/Linux) 或 PyCharm -> Preferences (macOS)。
  * 导航到Tools -> Terminal
  * 修改Start directory 为你想要的目录。
  * 重新打开终端生效。

7. 总结

PyCharm 与 WSL 的集成为 Python 开发者提供了一个强大而灵活的开发环境。通过将 PyCharm 与 WSL 结合使用，您可以充分利用 Linux 环境的优势，同时享受 PyCharm 提供的丰富功能和便捷性。本文详细介绍了如何在 PyCharm 中配置和使用 WSL 进行 Python 开发，希望能够帮助您构建高效、愉悦的开发工作流。不断探索和实践，您将发现更多提升开发效率的技巧和方法。