运行/调试配置
PyCharm 使用运行/调试配置来运行、调试并测试您的代码。 每个配置都是一组具名的启动属性,用于定义要执行的内容以及应使用的参数和环境。
通过不同的启动属性,您可以定义 PyCharm 用于执行您的脚本的不同方式。 例如,您可以使用不同的 Python 解释器执行相同的代码,提供不同的环境变量集合,并从其他文件获取输入值。
有两种类型的 运行/调试 配置:
临时 — 每次运行或调试函数或测试时都会创建。
永久 — 从模板显式创建,或通过保存临时配置来创建。 永久配置会作为您项目的一部分保留,直至您将其移除。
每当您运行、调试或测试代码时,PyCharm 要么使用现有的永久运行/调试配置,要么创建新的临时配置。
永久配置的图标为不透明,临时配置的图标为半透明。 配置图标上的红色叉号表示配置设置存在错误。
临时配置的最大数量为 5。 添加新的临时配置时,较旧的会自动删除。 如有必要,您可以在 中提高此限制。
创建永久的运行/调试配置
PyCharm 提供以下方式来创建永久的运行/调试配置:
从模板创建或复制现有配置。
将临时配置保存为永久配置
在 运行/调试 配置切换器中选择一个临时配置,点击
/
,并选择 保存配置。
保存临时配置后,它将变为永久配置,并记录在 <项目目录>/.idea/ 目录下的独立 XML 文件中。 例如, MyProject/.idea/Car.xml 。
或者,在运行/调试配置对话框中选择一个临时配置,然后在工具栏上点击
。
PyCharm 为不同的语言、工具和框架提供运行/调试配置 模板。 可用模板列表取决于已安装并启用的 插件。
从模板创建运行/调试配置
转到 。 或者,点击
(位于 运行 小部件中),并在下拉菜单中选择 编辑配置(E)。

在 运行/调试配置 对话框中,点击工具栏上的
,或按 Alt+Insert。 该列表显示运行/调试配置模板。 选择 Python。

在 名称 字段中指定运行/调试配置名称。 该名称将用于在列表和菜单中标识运行/调试配置。

配置运行/调试配置参数。 必需参数和可选参数的列表可能因所选的运行/调试配置类型而异。
部分可选参数处于隐藏状态。 要查看并启用它们,请点击 修改选项 链接。

有关 Python 模板的详细说明,请参阅 运行/调试配置参数。
您可以立即运行该配置,或保存该配置以便稍后运行。
要将运行配置保存以便稍后使用,请点击 确定。
要立即运行该配置,请点击 运行。
要删除配置,请执行以下任一操作:
在 运行/调试配置 对话框中,选择该配置,然后点击窗口工具栏上的
删除配置。

在运行/调试配置列表中选择该配置,然后在主工具栏上点击
更多操作。 在菜单中选择 删除。

启动前
在此区域,您可以指定在启动所选运行/调试配置之前要执行的任务。 任务将按照它们在列表中的顺序执行。
项 | 快捷键 | 描述 |
|---|---|---|
Alt+Insert | 点击此图标以添加以下可用任务之一:
| |
Alt+Delete | 点击此图标以从列表中移除所选任务。 | |
Enter | 点击此图标以编辑所选任务。 在打开的对话框中进行必要的更改。 | |
Alt+Up Alt+Down | 点击这些图标可在列表中将所选任务上移或下移一行。 任务将按照它们在列表中的顺序执行。 | |
显示此页面 | 选中此复选框可在实际启动运行/调试配置之前显示运行/调试配置设置。 | |
激活工具窗口 | 默认情况下将选中此复选框,当您启动运行/调试配置时,会打开 运行 或 调试 工具窗口。 否则,如果清除了该复选框,则会隐藏工具窗口。 不过,当配置正在运行时,您可以按 Alt+4 或 Alt+5 自行打开相应的工具窗口。 |
向 Python 运行/调试配置添加宏
转到 。 或者,点击
(位于 运行 小部件中),并在下拉菜单中选择 编辑配置(E)。

在 运行/调试配置 对话框中,从 Python 运行/调试配置列表中选择目标配置。
在以下字段之一中点击
插入宏:
脚本路径
参数
工作目录
从可用宏列表中选择一个宏。

点击 插入 以添加所选宏。
参阅 Pass parameters to the running script ,了解在运行/调试配置中使用宏的示例。
启动运行配置
您可以通过以下任一方式启动现有的运行配置:
共享运行/调试配置
您可能希望共享 运行/调试 配置,以便您的团队成员能够使用相同的配置运行应用程序,或使他们能够远程附加到您正在运行的进程。
PyCharm 提供了一种机制,可将您的 运行/调试 配置存储为项目文件,并通过 VCS 进行共享。 当您希望将配置作为文件发送给他人、为运行/调试配置创建本地备份或从文件导入它们时,也可以使用相同的机制。
基于旧版 .ipr 的项目不支持单个 运行/调试 配置。 在旧版项目中,您只能通过将 .ipr 文件添加到 VCS 来一次性共享所有配置。
转到 。 或者,点击
(位于 运行 小部件中),并在下拉菜单中选择 编辑配置(E)。

选择要共享的 运行/调试 配置,启用 存储为项目文件(S) 选项,并指定配置文件的存储位置。
除非需要与 PyCharm 2019.3 及更早版本兼容,否则您可以配置任意位置。 为与这些版本兼容,请将该文件存储在建议的位置。
(可选)如果将 .idea 目录添加到 VCS 忽略的文件中,则 .idea/runConfigurations 子文件夹也会被忽略。 如果项目使用 Git,您可以共享 .idea/runConfigurations ,并通过如下方式修改 .gitignore ,使 .idea 保持忽略状态:
/.idea/* !/.idea/runConfigurations
运行/调试配置模板
所有运行/调试配置都基于模板,模板实现启动逻辑,定义参数列表及其默认值。 安装中预定义了 可用模板列表 ,只能通过 插件 进行扩展。 不过,您可以编辑每个模板中的默认参数值,以便于设置新的运行/调试配置。
配置模板的默认值
转到 。 或者,点击
(位于 运行 小部件中),并在下拉菜单中选择 编辑配置(E)。

在 运行/调试 配置对话框的左侧窗格中,点击 编辑配置模板…。

在打开的 运行/调试配置模板 对话框中,选择一个配置类型。

指定所需的默认参数,然后点击 确定 保存模板。
运行/调试配置文件夹
当存在多个同类型的 运行/调试 配置时,您可以将它们分组到文件夹中,以便更轻松地访问。

为运行/调试配置创建文件夹
转到 。 或者,点击
(位于 运行 小部件中),并在下拉菜单中选择 编辑配置(E)。

在 运行/调试配置 对话框中,选择一个配置类型,然后点击工具栏上的
。 会为所选类型创建一个新的空文件夹。

在右侧的文本字段中指定文件夹名称,或接受默认名称。
选择所需的 运行/调试 配置,并将其移动到目标文件夹下。
应用更改。 如果文件夹为空,则不会保存。
当您不再需要某个文件夹时,您可以删除它 Delete。 归入此文件夹的 运行/调试 配置将移至相应 运行/调试 配置类型的根级。
服务工具窗口中的运行/调试配置
您可以在 服务 工具窗口中管理多个运行/调试配置。 例如,您可以启动、暂停和停止多个应用程序,跟踪其状态,并检查特定于应用程序的详细信息。
将运行/调试配置添加到服务工具窗口
在主菜单中选择 ,或按 Alt+8。
在 服务 工具窗口中,点击 添加服务 ,然后选择 Run Configuration Type…。

从列表中选择一个运行/调试配置类型,以将该类型的所有配置添加到窗口。
请注意,工具窗口只会显示您已 创建一个或多个配置的配置类型。
运行/调试配置参数
项 | 描述 | ||||||||
|---|---|---|---|---|---|---|---|---|---|
脚本路径/模块名称 | 点击该列表选择要运行的目标类型。 然后在相应的字段中,指定要执行的 Python 脚本路径或模块名称。 您可以在此字段中使用 路径变量。 | ||||||||
参数 | 在此字段中,指定传递给 Python 脚本的参数。 指定脚本参数时,请遵循以下规则:
在此字段中,您可以添加宏,在运行运行/调试配置时传递各种项目或上下文特定的值。 点击 + ,并从列表中选择一个可用的宏。 有关更多详细信息,请参阅 向运行/调试配置添加宏。 | ||||||||
允许多个实例(U) | 如果您希望允许该配置的多个实例同时运行,请选择此选项。 如果禁用此选项,尝试重新运行该配置将终止活动会话。 | ||||||||
环境 | |||||||||
项目 | 点击此列表,选择在同一 PyCharm 窗口中打开的某个项目,以在其中使用此运行/调试配置。 如果仅打开一个项目,则不显示此字段。 | ||||||||
环境变量 | 此字段显示环境变量列表。 如果列表包含多个变量,则使用分号分隔。 默认情况下,此字段包含变量 要创建新变量,请点击 您可能希望使用存储在文本文件中的一系列记录来填充该列表中的变量,例如:
Variable1 = Value1
Variable2 = Value2
只需从文本文件中复制变量列表,然后在 环境变量 对话框中点击 粘贴 ( | ||||||||
".env" 文件的路径 | 此字段显示包含环境变量的 .env 文件的路径。 如果有多个文件,则使用分号分隔它们的路径。 要管理 .env 文件列表,请点击 您还可以使用 | ||||||||
Python 解释器 | 从列表中选择一个预先配置的 Python 解释器。 | ||||||||
解释器选项 | 在此字段中,指定要传递给解释器的 命令行选项。 如有必要,点击 | ||||||||
工作目录 | 指定运行任务要使用的目录。
您可以在此字段中使用 路径变量。 | ||||||||
将内容根添加到 PYTHONPATH | 选中此复选框可将项目的所有 内容根 添加到环境变量 PYTHONPATH; | ||||||||
将源根添加到 PYTHONPATH | 选中此复选框可将项目的所有 源根 添加到环境变量 PYTHONPATH; | ||||||||
执行 | |||||||||
使用 'uv run' 运行 | 启用使用 uv 运行您的脚本或模块。 对于由 | ||||||||
在输出控制台中模拟终端 | 启用在输出控制台中以模拟终端模式运行您的脚本或模块。 对于无法使用标准输出控制台实现的任务,此模式会有所帮助,例如当您的脚本执行回车操作( | ||||||||
使用 Python 控制台运行 | 启用使用 Python 控制台运行您的脚本或模块。 | ||||||||
从以下位置重定向输入 | 启用将文本文件中的数据重定向到标准输入。 如果您的脚本需要输入,且您希望自动提交这些值,而不是在 运行 控制台中手动键入,请使用此选项。 若要启用重定向,请选中复选框并指定目标文本文件的路径。 | ||||||||
Docker 容器设置 点击 | |||||||||
选项 |
点击 | ||||||||
Docker Compose | |||||||||
命令和选项 | 您可以使用 Docker Compose 命令行界面的以下命令:
| ||||||||
命令预览 | 使用此字段预览完整命令字符串。 例如,在 命令和选项 字段中的
docker compose
-f C:\PyCharm-2019.2\Demos\djangodocker-master\docker-compose.yml
<override configuration file>
up --build exec --user jetbrains
| ||||||||

