PyCharm 2025.2 Help

运行/调试配置

PyCharm 使用运行/调试配置来运行、调试和测试您的代码。 每个配置是一组命名的启动属性，用于定义要执行的内容以及应使用的参数和环境。

通过不同的启动属性，您可以定义 PyCharm 用于执行脚本的不同方式。 例如，您可以使用不同的 Python 解释器执行相同的代码，提供各种环境变量集，并从替代文件中获取输入值。

有两种 运行/调试 配置：

  • 临时 — 每次运行或调试函数或测试时创建。

  • 永久—由模板显式创建或通过保存临时配置创建。 永久配置将作为您项目的一部分，直到您删除它们。

每当您运行、调试或测试代码时，PyCharm 要么使用现有的永久运行/调试配置，要么创建一个新的临时配置。

永久配置的图标是不透明的，而临时配置的图标是半透明的。 配置图标上的红色叉号表示配置设置中存在错误。

临时配置的最大数量为 5。 添加新版本时，旧版本会被自动删除。 如有必要，您可以在 设置 | 高级设置 | 运行/调试 | 临时配置限制 中增加此限制。

创建永久运行/调试配置

PyCharm 提供以下方法来创建永久运行/调试配置：

将临时配置保存为永久配置

  • 在 运行/调试 配置切换器中选择一个临时配置，点击 / 并选择 保存配置。

    一旦您保存了一个临时配置，它就会变成永久配置，并记录在 <project directory>/.idea/ 目录中的一个单独的 XML 文件中。 例如， MyProject/.idea/Car.xml .

  • 或者，在“运行/调试配置”对话框中选择一个临时配置，然后点击工具栏上的 保存。

PyCharm 为不同的语言、工具和框架提供运行/调试配置 模板。 可用模板的列表会因已安装和启用的 plugins 而有所不同。

从模板创建运行/调试配置

  1. 转到 运行 | 编辑配置。 或者，在 运行 小部件中单击 ，并从下拉菜单中选择 编辑配置(E)。

    运行/调试配置弹出窗口

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

    选择新的运行/调试配置模板

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

    创建新的运行/调试配置

  4. 配置运行/调试配置参数。 必需参数和可选参数的列表可能因所选运行/调试配置类型而异。

    某些可选参数是隐藏的。 要查看并启用它们，请单击 修改选项 链接。

    启用 Python 运行配置的可选参数

    有关 Python 模板的详细描述，请参阅 运行/调试配置参数。

  5. 您可以立即运行该配置，也可以保存配置以便稍后运行。

    • 要保存运行配置以供稍后运行，请点击 确定。

    • 若要立即运行此配置，请点击 运行。

  6. 要删除配置，请执行以下操作之一：

    • 在 运行/调试配置 对话框中，选择配置并点击窗口工具栏上的 删除配置删除配置。

      点击以删除配置

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

      从菜单中选择删除选项

启动前

在此区域，您可以指定在开始选定的 run/debug 配置之前要执行的任务。 任务按它们在列表中出现的顺序执行。

项目

快捷方式

描述

"添加"按钮

Alt+Insert

点击此图标以添加以下可用任务之一：

  • 启动Web 浏览器 ：选择此选项即可启动浏览器。 在打开的对话框中，选择浏览器的类型并提供起始 URL。 此外，指定是否希望浏览器以启用 JavaScript 调试器的方式启动。

  • 运行外部工具 ：选择运行外部应用程序。 在打开的对话框中，选择一个或多个您想要运行的应用程序。 如果它在 PyCharm 中尚未定义，请添加其定义。 如需更多信息，请参阅 外部工具 和 外部工具。

  • 运行另一个配置 ：选择执行另一个运行/调试配置，并等待其完成后再开始当前配置。 如果您想并行运行多个配置，请使用 compound run/debug configuration。

  • 运行File Watcher ：选择此选项以让 PyCharm 应用所有当前活动的 文件监视器。

  • 运行远程外部工具 ：添加一个 远程 SSH 外部工具。

  • 运行Grunt 任务 ：选择此选项来运行 Grunt 任务。

    在打开的 Grunt 任务 对话框中，指定定义所需任务的 Gruntfile.js ，选择要执行的任务，并指定要传递给 Grunt 工具的参数。

    指定 Node.js 解释器的位置、要传递给它的参数，以及 grunt-cli 包的路径。

  • 运行gulp 任务 ：选择此选项以运行 Gulp 任务。

    在打开的 Gulp 任务 对话框中，指定定义所需任务的 Gulpfile.js ，选择要执行的任务，并指定要传递给 Gulp 工具的参数。

    指定 Node.js 解释器的位置、传递给解释器的参数以及到 gulp 包的路径。

  • 运行npm 脚本 ：选择此选项来执行一个 npm 脚本。

    在 NPM Script 对话框中，指定 npm run/debug configuration settings。

  • 编译TypeScript ：选择运行内置的 TypeScript 编译器，从而确保您对 TypeScript 代码所做的所有更改都反映在生成的 JavaScript 文件中。 在打开的 TypeScript 编译设置 对话框中，选择或清除此 检查错误 复选框，以配置编译器在检测到错误时的行为:

    • 如果选中了 检查错误 复选框，编译器会显示所有错误，并且运行配置将不会启动。

    • 如果清除了 检查错误 复选框，编译器将显示所有检测到的错误，但运行配置仍将启动。

  • 断开数据源 ：如果您希望在运行/调试配置运行之前中断与数据源的连接，请选择此选项。

"移除"按钮

Alt+Delete

点击此图标可将所选任务从列表中移除。

编辑

Enter

点击此图标可编辑选定的任务。 在打开的对话框中进行必要的更改。

方法向上

方法 down

Alt+Up

Alt+Down

点击这些图标以在列表中将所选任务上移或下移一行。 任务将按照它们在列表中出现的顺序执行。

显示此页面

选择此复选框，以便在实际启动运行/调试配置之前显示运行/调试配置设置。

激活工具窗口

默认情况下，此复选框处于选中状态，并且在您启动 run/debug 配置时， Run 或 Debug 工具窗口会打开。

否则，如果复选框未选中，工具窗口将被隐藏。 但是，在配置运行时，您可以通过按 Alt+4 或 Alt+5 自行打开相应的工具窗口。

向 Python 运行/调试配置添加宏

  1. 转到 运行 | 编辑配置。 或者，在 运行 小部件中单击 ，并从下拉菜单中选择 编辑配置(E)。

    运行/调试配置弹出窗口

  2. 在 运行/调试配置 对话框中，从 Python 运行/调试配置列表中选择目标配置。

  3. 点击 插入宏 在以下字段之一中：

    • 脚本路径

    • 参数

    • 工作目录

  4. 从可用宏列表中选择一个宏。

    向 Python 运行配置添加宏

  5. 点击 插入 以添加所选宏。

    请参阅 将参数传递给运行脚本 ，了解在运行/调试配置中使用宏的示例。

启动运行配置

您可以通过以下方式之一启动已有的运行配置：

  • 如果运行配置已在 Run widget中选择，请单击其旁边的 或按 Shift+F10。

    运行小部件旁的“Run”按钮

  • 如果您想选择另一个运行配置，请单击 Run widget。 在打开的菜单中，单击您想启动的运行配置旁的 。

    运行小部件菜单中运行配置旁的“Run”按钮

  • 按下 Alt+Shift+F10。 在打开的菜单中，点击您想启动的运行配置。

共享运行/调试配置

您可能希望共享您的 运行/调试 配置，以便您的团队成员可以使用相同的配置运行应用程序，或者使他们能够远程附加到您正在运行的进程。

PyCharm 提供了一种机制，可以将您的 运行/调试 配置存储为项目文件并通过 VCS 共享。 当您希望将配置作为文件发送给其他人、创建运行/调试配置的本地备份或从文件导入它们时，也可以使用相同的机制。

传统 .ipr -based 项目不支持单独的 运行/调试 配置。 对于传统项目，您只能通过将 .ipr 文件添加到 VCS 来一次性共享所有配置。

  1. 转到 运行 | 编辑配置。 或者，在 运行 小部件中单击 ，并从下拉菜单中选择 编辑配置(E)。

    运行/调试配置弹出窗口

  2. 请选择您要共享的 运行/调试 配置，启用 存储为项目文件(S) 选项，并指定配置文件的存储位置。

    您可以配置任何位置，除非需要与 PyCharm 2019.3 及更早版本兼容。 为了与这些版本兼容，请将文件存储在建议的位置。

  3. （可选）如果将 .idea 目录添加到 VCS 忽略文件中，那么 .idea/runConfigurations 子文件夹也将被忽略。 如果项目使用 Git，您可以共享 .idea/runConfigurations 并保留 .idea 被忽略，通过修改 .gitignore 如下：

    /.idea/* !/.idea/runConfigurations

运行/调试配置模板

所有运行/调试配置都基于模板，这些模板实现了启动逻辑，定义参数列表及其默认值。 安装中预定义了 可用模板列表 ，只能通过 插件进行扩展。 但是，您可以编辑每个模板中的默认参数值，以便于新运行/调试配置的设置。

配置模板的默认值

  1. 转到 运行 | 编辑配置。 或者，在 运行 小部件中单击 ，并从下拉菜单中选择 编辑配置(E)。

    运行/调试配置弹出窗口

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

    运行/调试模板

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

    运行/调试模板

  4. 请指定所需的默认参数，然后点击 确定 以保存模板。

运行/调试配置文件夹

当有许多相同类型的 运行/调试 配置时，您可以将它们分组到文件夹中以便于访问。

分组运行配置

为运行/调试配置创建一个文件夹

  1. 转到 运行 | 编辑配置。 或者，在 运行 小部件中单击 ，并从下拉菜单中选择 编辑配置(E)。

    运行/调试配置弹出窗口

  2. 在 运行/调试配置 对话框中，选择配置类型并在工具栏上点击 新建文件夹图标。 已创建一个新的空文件夹用于所选类型。

    添加配置文件夹

  3. 请在右侧的文本框中指定文件夹名称或接受默认名称。

  4. 选择所需的 运行/调试 配置并将它们移动到目标文件夹下。

  5. 应用这些更改。 如果一个文件夹是空的，它将不会被保存。

当您不再需要文件夹时，可以将其删除 Delete。 此文件夹下的 运行/调试 配置将被移动到相应 运行/调试 配置类型的根目录下。

服务工具窗口中的运行/调试配置

您可以在 服务 工具窗口中管理多个 run/debug 配置。 例如，您可以启动、暂停和停止多个应用程序，跟踪它们的状态，并检查特定于应用程序的详细信息。

将运行/调试配置添加到 服務 窗口

  1. 从主菜单中选择 视图 | 工具窗口 | 服务 或按 Alt+8。

  2. 在 服务 工具窗口中，点击 添加服务 ，然后选择 Run Configuration Type…。

    服务工具窗口：添加运行配置

  3. 从列表中选择运行/调试配置类型，将此类型的所有配置添加到窗口。

    请注意，工具窗口将仅显示您已 创建 一个或多个配置的配置类型。

运行/调试配置参数

项目

描述

脚本路径/模块名称

点击列表以选择要运行的目标类型。 然后，在相应字段中指定要执行的 Python 脚本路径或模块名称。

您可以在此字段中使用 路径变量。

参数

在此字段中，指定要传递给 Python 脚本的参数。

在指定脚本参数时，请遵循以下规则：

  • 使用空格分隔单个脚本参数。

  • 包含空格的脚本参数应使用双引号括起来，例如 some"&#xa0;"param 或 "some&#xa0;param"。

  • 如果脚本参数包含双引号，请使用反斜杠转义双引号，例如：

    -s"main.snap_source_dirs=[\"pcomponents/src/main/python\"]" -s"http.cc_port=8189" -s"backdoor.port=9189" -s"main.metadata={\"location\": \"B\", \"language\": \"python\"}"

在此字段中，您可以添加宏以在运行运行/调试配置时传递各种项目或上下文相关的值。 点击 + 并从列表中选择一个可用的宏。 有关详细信息，请参阅 将宏添加到运行/调试配置。

允许多个实例(U)

选择此选项以允许同时运行多个配置实例。 如果禁用此选项，尝试重新运行配置将终止活动会话。

环境

项目

点击此列表以选择在同一 PyCharm 窗口中打开的项目之一，该运行/调试配置应在其中使用。 如果只有一个打开的项目，则不会显示此字段。

环境变量

此字段显示环境变量列表。 如果列表包含多个变量，它们使用分号分隔。

默认情况下，此字段包含变量 PYTHONUNBUFFERED ，其值为 1。 要填写列表，请点击浏览按钮，或按 Shift+Enter 并在 环境变量 对话框中指定所需的环境变量集。

要创建新变量，请点击 添加按钮 ，然后输入所需的名称和值。

您可能希望用存储为文本文件中一系列记录的变量来填充列表，例如：

Variable1 = Value1 Variable2 = Value2

只需从文本文件中复制变量列表，然后点击 粘贴 （粘贴 ）在 环境变量 对话框中。 这些变量将被添加到表格中。 点击 确定 完成任务。 您可以随时在 环境变量 对话框中选择所有变量，点击 复制 复制 ，然后将它们粘贴到文本文件中。

“.env”文件的路径

此字段显示带有环境变量的 .env 文件的路径。 如果有多个文件，它们的路径将用分号分隔。

要管理 .env 文件的列表，请点击 选择 ".env" 文件。 在打开的 环境文件 对话框中，使用 添加 和 移除 添加和删除文件。

您还可以使用 和 更改 .env 文件的加载顺序。

Python 解释器

从列表中选择一个预配置的 Python 解释器。

解释器选项

在此字段中，指定要传递给解释器的 命令行选项。 如有必要，点击 展开字段 ，并在编辑器中输入字符串。

工作目录

指定运行任务时要使用的目录。

  • 当通过键盘快捷键 Ctrl+Shift+F10 或从脚本的上下文菜单中选择 运行 创建默认运行/调试配置时，工作目录是包含可执行脚本的目录。 此目录可能与项目目录不同。

  • 当该字段留空时，将使用 PyCharm 安装的 bin 目录。

您可以在此字段中使用 路径变量。

将内容根添加到 PYTHONPATH

选中此复选框以将项目的所有 内容根 添加到环境变量 PYTHONPATH；

将源代码根添加到 PYTHONPATH

选中此复选框以将项目的所有 源根 添加到环境变量 PYTHONPATH；

执行

在输出控制台中模拟终端

启用在输出控制台中以模拟终端模式运行脚本或模块。 此模式对于无法通过标准输出控制台实现的任务可能很有帮助，例如，当您的脚本执行回车操作时（print(i, flush=True , end='\r'）。

请注意，在输出控制台中模拟终端与运行 终端不同，后者是用于运行系统 shell 命令的单独工具窗口。

使用 Python 控制台运行

启用使用 Python 控制台运行脚本或模块。

重定向输入来源

使数据从文本文件重定向到标准输入。 如果您的脚本需要一些输入，并且您希望自动提交值而不是在 运行 控制台中手动输入，请使用此选项。 要启用重定向，请选择复选框并指定目标文本文件的路径。

Docker 容器设置

点击 “浏览”按钮 打开对话框并指定以下设置：

选项

  • 发布所有端口 ：将所有容器端口暴露给主机。 这对应于 --publish-all 选项。

  • 端口绑定 ：指定 端口绑定的列表。 与使用 -p 选项 docker run 类似。

  • 卷绑定 ：使用此字段指定特殊文件夹 卷 与运行 Docker 守护程序的计算机中的文件夹之间的绑定关系。 这对应于 -v 选项。 有关更多信息，请参阅 管理容器中的数据。

  • 环境变量 ：使用此字段指定环境变量及其值的列表。 这对应于选项 -e。 有关更多信息，请参阅 ENV（环境变量）。

  • 运行选项 ：使用此字段指定 Docker 命令行选项。

点击 以展开表格。 点击 、 或 以组成列表。

Docker Compose

命令和选项

您可以使用 Docker Compose 命令行界面的以下命令：

命令

支持的选项

up ：为服务构建、创建、启动并附加到容器。

  • --abort-on-container-exit

  • --build

  • --exit-code-from SERVICE

  • --scale SERVICE=NUM...

  • --timeout TIMEOUT

run ：针对服务运行一次性命令。

  • --entrypoint CMD

  • -l, --label KEY=VAL

  • --name NAME

  • -p, --publish=[]

  • --rm

  • --service-ports

  • --use-aliases

  • -u, --user=""

  • -v, --volume=[]

exec ：在您的服务中运行任意命令。

  • --index=index

  • --privileged

  • -u, --user USER

命令预览

使用此字段预览完整的命令字符串。

例如， up --build exec --user jetbrains 和 命令和选项 字段中的组合会在预览中生成以下输出：

docker compose -f C:\PyCharm-2019.2\Demos\djangodocker-master\docker-compose.yml <override configuration file> up --build exec --user jetbrains
最后修改日期： 2025年 9月 26日
无需任何先前配置即可运行运行和重新运行应用程序