PyCharm 2026.1 Help

运行/调试配置

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

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

有两种类型的 运行/调试 配置：

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

  • 永久 — 从模板显式创建，或通过保存临时配置来创建。 永久配置会作为您项目的一部分保留，直至您将其移除。

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

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

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

创建永久的运行/调试配置

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

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

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

    保存临时配置后，它将变为永久配置，并记录在 <项目目录>/.idea/ 目录下的独立 XML 文件中。 例如， MyProject/.idea/Car.xml 。

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

PyCharm 为不同的语言、工具和框架提供运行/调试配置 模板。 可用模板列表取决于已安装并启用的 插件。

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

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

    运行/调试配置弹出窗口

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

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

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

    创建新的运行/调试配置

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

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

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

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

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

    • 要将运行配置保存以便稍后使用，请点击 确定。

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

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

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

      点击以移除该配置

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

      从菜单中选择删除选项

启动前

在此区域中，您可以指定在启动所选运行/调试配置之前要执行的任务。 任务按照其在列表中的顺序执行。

项目

快捷方式

描述

添加按钮

Alt+Insert

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

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

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

  • 运行另一个配置 ：选择执行另一个运行/调试配置，并在启动当前配置之前等待其结束。 如果您想并行运行多个配置，请使用 复合运行/调试配置。

  • 运行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 脚本 对话框中，指定 npm run/debug configuration settings。

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

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

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

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

“移除”按钮

Alt+Delete

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

编辑

Enter

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

上移方法

下移方法

Alt+Up

Alt+Down

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

显示此页面

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

激活工具窗口

默认情况下，该复选框处于选中状态，并且当您启动运行/调试配置时，会打开 运行 或 调试 工具窗口。

否则，如果清除此复选框，将隐藏工具窗口。 但是，当配置正在运行时，您可以按 Alt+4 或 Alt+5 自行为其打开相应的工具窗口。

聚焦工具窗口

选中此复选框可在启动运行/调试配置时，自动将焦点移动到 运行 或 调试 工具窗口。

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

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

    运行/调试配置弹出窗口

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

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

    • 脚本路径

    • 参数

    • 工作目录

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

    向 Python 运行配置添加宏

  5. 点击 INSERT 以添加所选宏。

    参阅 Pass parameters to the running script ，了解在运行/调试配置中使用宏的示例。

启动运行配置

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

  • 如果在 运行小部件 中已选择该运行配置，请点击其旁边的 ，或按 Shift+F10。

    位于运行小部件旁边的 '运行' 按钮

  • 如果您想选择其他运行配置，请点击 运行小部件。 在打开的菜单中，点击要启动的运行配置旁边的 。

    位于运行小部件菜单中某个运行配置旁边的 '运行' 按钮

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

共享运行/调试配置

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

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

基于旧版 .ipr 的项目不支持单个 运行/调试 配置。 在旧版项目中，您只能通过将 .ipr 文件添加到 VCS 来一次性共享所有配置。

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

    运行/调试配置弹出窗口

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

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

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

    /.idea/* !/.idea/runConfigurations

运行/调试配置模板

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

配置模板的默认值

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

    运行/调试配置弹出窗口

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

    运行/调试模板

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

    运行/调试模板

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

运行/调试配置文件夹

当存在多个同类型的 运行/调试 配置时，您可以将它们分组到文件夹中，以便更轻松地访问。

分组的运行配置

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

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

    运行/调试配置弹出窗口

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

    添加配置文件夹

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

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

  5. 应用更改。 如果文件夹为空，则不会保存。

当您不再需要某个文件夹时，您可以删除它 Delete。 归入此文件夹的 运行/调试 配置将移至相应 运行/调试 配置类型的根级。

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

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

将运行/调试配置添加到服务工具窗口

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

  2. 在 服务 工具窗口中，点击 添加服务 ，然后选择 运行配置类型…。

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

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

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

运行/调试配置参数

项目

描述

Python 解释器

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

脚本路径/模块名称

点击该列表选择要运行的目标类型。 然后在相应的字段中，指定要执行的 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\"}"

在此字段中，您可以添加宏，以在运行运行/调试配置时传递各种特定于项目或上下文的值。 点击 + ，然后在列表中选择一个可用宏。 有关详细信息，请参见 向运行/调试配置添加宏。

工作目录

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

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

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

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

项目

点击此列表，从同一 PyCharm 窗口中已打开的项目中选择要使用此运行/调试配置的一个项目。 如果只打开了一个项目，则不显示此字段。

环境变量

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

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

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

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

Variable1 = Value1 Variable2 = Value2

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

".env" 文件路径

此字段显示带有环境变量的 .env 文件的路径。 如果有多个文件，则以分号分隔其路径。

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

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

启动时打开运行/调试工具窗口

使用此选项将在执行配置时自动打开运行/调试工具窗口。

将内容根添加到 PYTHONPATH

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

将源代码根添加到 PYTHONPATH

选中此复选框可将项目的所有 源代码根添加到环境变量 PYTHONPATH。

Docker 容器设置

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

选项

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

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

  • 卷绑定 ：在此字段中指定特殊文件夹（卷 ）与运行 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
2026年 3月 24日
无需任何预先配置即可运行运行并重新运行应用程序