从 Visual Studio Code 迁移到 PyCharm - Python 开发环境切换指南
这份指南是为使用 Visual Studio Code 的 Python 开发者准备的,如果你打算切换到 PyCharm,这里包含了将 Visual Studio Code 项目导入到 PyCharm 的实际操作步骤,以及对两个 IDE 最显著差异的简要解释,包括用户界面、一般工作流和快捷键。
将 Python 项目导入到 PyCharm
要将使用 Visual Studio Code 创建的 Python 项目导入到 PyCharm,只需在 PyCharm 中打开项目目录:
- 选择以下任一操作:点击 文件 -> 打开。在欢迎界面点击 打开。
- 在打开的对话框中,选择包含所需源代码的目录。注意,外部创建的应用程序会带有常规目录图标
。
- 点击 打开(在 Mac 上)或 确定(在 Windows 上)。
- 如果你已经打开了另一个项目,请指定是要在单独的窗口中打开新项目,还是关闭当前项目并使用现有窗口。
配置 Python 解释器
PyCharm 会在源目录中查找虚拟环境。如果检测到,PyCharm 会建议使用它作为项目解释器或配置新的解释器。
如果没有检测到环境,PyCharm 会为项目设置系统解释器。
有关配置其他类型 Python 解释器的信息,请参考以下部分:
- 配置 pipenv 环境
- 配置 Poetry 环境
- 配置 conda 虚拟环境
- 使用 WSL 配置解释器
- 使用 Vagrant 配置解释器
- 使用 SSH 配置解释器
- 使用 Docker 配置解释器
- 使用 Docker Compose 配置解释器
安装所需包
如果导入的项目不包含虚拟环境,你可以配置新的 Python 解释器,然后为它安装所需的包:
- 对于 conda 和 virtualenv 环境,可以从 requirements.txt 安装所需的包。你也可以使用 requirements.txt 创建 virtualenv 环境。
- 对于 pipenv 环境,在创建环境时启用 从 Pipfile 安装包 复选框,或者使用 Pipfile 创建环境。
- 对于 Poetry 环境,在创建环境时启用 从 pyproject.toml 安装包 复选框,或者使用 pyproject.toml 创建环境。
导入运行配置
目前,PyCharm 不支持从 launch.json 导入运行/调试配置。你需要为项目手动创建运行/调试配置:
- 点击 运行 -> 编辑配置。或者,点击运行小部件中的
并从下拉菜单中选择 编辑配置。
- 在运行/调试配置对话框中,点击工具栏上的
或按 Alt + Insert。列表显示运行/调试配置模板。选择 Python。
- 根据 launch.json 中的配置指定运行/调试配置参数。
以下是创建运行/调试配置时,如何将最常见的 launch.json 属性转换为参数:
- name:运行/调试配置的名称。在 名称 字段中指定。
- type:运行/调试配置的类型。在创建配置时选择对应的类型。
- request:指定是启动程序的调试模式还是将调试器附加到已在运行的程序。对于 "request": "launch",无需设置任何配置参数。如果配置中包含 "request": "attach",则无法在 PyCharm 中创建类似的运行/调试配置。有关信息,请参考附加到进程。
- program:配置启动时要运行的可执行文件或文件。从下拉菜单中选择要运行的目标类型,然后指定要执行的 Python 脚本路径或模块名称。
- cwd:用于查找依赖项和其他文件的当前工作目录。在 工作目录 字段中指定。
- args:运行或调试程序时传递给程序的参数。在 脚本参数 字段中指定。在此字段中,可以使用对应于 Visual Studio Code 配置文件中变量的宏。有关信息,请参考传递参数给运行脚本。
- env:环境变量。在 环境变量 字段中指定。有关信息,请参考运行/调试配置。
- envFile:包含环境变量的 dotenv 文件路径。在 .env 文件路径 字段中指定文件路径。有关信息,请参考运行/调试配置。
- console:用于运行或调试程序的控制台。在 PyCharm 中,代码通常在运行工具窗口中执行。调试时,默认会打开调试控制台。不过,你可能需要指定其他执行选项。有关信息,请参考运行/调试配置。
- justMyCode:当省略或设置为 true 时,调试仅限于用户编写的代码。在 PyCharm 中,可以通过在 设置 -> 构建、执行、部署 -> 调试器 -> 逐步执行 中启用或禁用 不要进入库脚本 复选框来配置。有关信息,请参考逐步执行。
用户界面差异
没有工作区
启动 PyCharm 时,你会注意到它没有工作区的概念。这意味着你一次只能处理一个项目。在 Visual Studio Code 中,通常有一组可能相互依赖的项目,而在 PyCharm 中,你有一个由一组模块组成的单个项目。
如果你有多个不相关的项目,可以将它们在单独的窗口中打开。
工具窗口
和 Visual Studio Code 一样,PyCharm 也有工具窗口:
- 项目工具窗口
- 提交工具窗口
- 运行工具窗口
- Python 控制台工具窗口
- 数据库工具窗口
要打开工具窗口,点击对应的工具窗口按钮:
如果你不想使用鼠标,可以按分配给它的快捷键切换到任何工具栏。最重要的快捷键要记住的是:
- 项目:Alt + 1
- 提交:Alt + 0
- 终端:Alt + F12
关于工具窗口的另一件事是,你可以拖动、固定、取消固定、附加和分离它们:
有关更多信息,请参考排列工具窗口和工具窗口视图模式。
为了帮助存储/恢复工具窗口布局,有几个有用的命令:
- 窗口 -> 布局 -> 保存当前布局为新布局:将排列保存为新布局。
- 窗口 -> 布局 -> 恢复当前布局:重置当前布局中的更改。(也可以通过 Shift + F12 使用)
有关更多信息,请参考布局。
多个窗口
PyCharm 中的窗口管理与 Visual Studio Code 稍有不同。你不能在一个项目中打开多个窗口,但可以将任意数量的编辑器选项卡分离到单独的窗口中。要将选项卡移动到单独的窗口,右键单击选项卡并选择将选项卡移动到新窗口(或按 Shift + F4)。
总是选择打开的文件
默认情况下,当你在编辑器选项卡之间切换时,PyCharm 不会在项目工具窗口中导航到文件。不过,你可以在项目工具窗口设置中启用此功能。
一般工作流差异
没有“保存”按钮
PyCharm 没有保存按钮。由于在 PyCharm 中可以撤销重构并从本地历史记录中恢复更改,因此每次都不需要询问你保存更改。
尽管如此,要知道物理保存到磁盘是由某些事件触发的,包括编译、关闭文件、将焦点从 IDE 切换出去等。要更改自动保存行为,按 Ctrl + Alt + S 打开设置,然后导航到外观和行为 -> 系统设置。在系统设置页面,找到自动保存部分。
保存操作
如果你是 Visual Studio Code 的资深用户,你熟悉保存操作:保存时自动触发的操作,例如重新格式化代码、整理导入等。
PyCharm 也有保存操作,你可以在设置 -> 工具 -> 保存时操作中找到并启用。
提交时的操作
当你提交更改时,可以自动运行各种操作。例如,你可以自动运行测试、重新格式化代码、优化导入等。
快捷键
下表显示了顶级 Visual Studio Code 操作(及其快捷键)如何映射到 PyCharm(你可能需要打印出来以便随时查看)。
Visual Studio Code 操作 | Visual Studio Code 快捷键 | PyCharm 对应操作 | PyCharm 快捷键 |
---|---|---|---|
查找文件 | Ctrl + P | 查找文件 | Ctrl + Shift + N |
跳转到定义 | F12 | 跳转到声明 | Ctrl + B |
查找符号 | Ctrl + T | 查找类或函数 | Ctrl + Alt + Shift + N |
查找引用 | Shift + F12 | 查找使用 | Alt + F7 |
重命名符号 | F2 | 重命名 | Shift + F6 |
格式化文档 | Shift + Alt + F | 格式化代码 | Ctrl + Alt + L |
排列导入 | Ctrl + Shift + O | 优化导入 | Ctrl + Alt + O |
查找操作 | Ctrl + Shift + P | 查找操作 | Ctrl + Shift + A |
切换侧边栏 | Ctrl + B | 切换工具窗口栏 | Alt + 0 |
新建终端 | Ctrl + ` | 打开终端 | Alt+ F12` |
注意
如果你选择特定于操作系统的键映射(Windows/Linux 的默认值或 macOS 的 macOS),可能会在 PyCharm 和操作系统之间出现快捷键冲突。为了避免此类冲突,建议调整操作系统的快捷键设置(参考键映射了解更多信息)。
VSCode 键映射
如果你不想学习新的快捷键,可以安装 VSCode 键映射插件。它会为 PyCharm 添加 VSCode 键映射,与 Visual Studio Code 的快捷键非常相似。
查找操作
当你不知道某个操作的快捷键时,尝试使用通过 Ctrl + Shift + A 可用的查找操作功能。开始输入以通过名称查找操作,查看其快捷键或调用它。
更多建议: