PyCharm 2025.3 Help

运行/调试配置: Doctests

使用此对话框为 Doctests 创建运行/调试配置。

文档字符串 中:

  • PyCharm 能识别 Python 代码,提供语法高亮、代码补全和解析,以及 Python 检查。

  • 可以将识别 Python 代码的功能 启用或禁用

  • 如果 doctests 以单独文件的形式呈现,PyCharm 允许将此类文件作为带有 .rst 扩展名的 reStructuredText 文件打开。 此类文件会以 包含 reStructuredText 的文件 图标标记,并具备语法高亮。

配置选项卡

项目

描述

测试

点击其中一个单选按钮以定义测试范围(文件夹中的所有测试、脚本中的所有测试、测试类、单个测试方法或函数)。

接下来,指定测试的位置。 本节中的字段会根据在 测试 部分中选择的测试类型启用。

  • 文件夹中的所有测试 :对于此测试范围,请指定以下参数:

    文件夹 :输入包含要执行的测试的目录路径,或点击浏览按钮,然后在 选择路径 对话框中选择所需目录。

    模式 :输入一个或多个用于匹配文件名的模式,以便将这些文件视为测试。 使用逗号作为分隔符。 这些模式应为 Python 正则表达式。

  • 脚本中的测试 :对于此范围,指定包含要执行的测试的脚本名称。

  • 测试类 :对于此范围,指定脚本名称和测试类。

  • 测试方法 :对于此范围,指定脚本名称、测试类和测试方法。

  • 测试函数 :对于此范围,指定脚本名称和测试函数。

环境变量

点击浏览按钮,或按 Shift+Enter ,在环境变量对话框中指定所需的环境变量集。 要创建新变量,请点击 ,并输入所需的名称和值。

Python 解释器

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

解释器选项

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

工作目录

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

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

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

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

将内容根添加到 PYTHONPATH

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

将源根添加到 PYTHONPATH

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

Docker 容器设置

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

选项

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

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

  • 卷绑定 :使用此字段指定特殊文件夹- 与运行 Docker 守护进程的计算机上的文件夹之间的绑定。 对应于 -v 选项。 有关详细信息,请参阅 管理容器中的数据

  • 环境变量 :使用此字段指定环境变量及其值的列表。 对应于 -e 选项。 有关详细信息,请参阅 ENV(环境变量)

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

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

日志

使用这些设置指定在运行或调试时生成的哪些日志文件应在控制台中显示,即在 运行调试工具窗口 的专用选项卡中显示。

有关如何启用 日志 字段的信息,请参阅 设置日志选项

项目

描述

是否处于活动状态

选中此列中的复选框,以在 运行工具窗口调试工具窗口 的相应选项卡中显示日志条目。

日志文件条目

此列中的只读字段列出要显示的日志文件。 列表可以包含:

  • 特定文件的完整路径。

  • 用于替代完整路径或模式的别名。 这些别名也会显示在相应日志文件所在选项卡的标题中。

    如果日志条目模式定义了多个文件,选项卡标题会显示文件名,而不是日志条目别名。

跳过内容

选中此复选框以跳过所选日志的先前内容。

将控制台输出保存到文件

选中此复选框以将控制台输出保存到指定位置。 手动输入路径,或点击浏览按钮,在 打开的对话框 中指向所需位置。

当向标准输出流打印消息时显示控制台

当关联进程写入 Standard.out 时,选中此复选框以激活输出控制台并将其置于前端。

当向标准错误流打印消息时显示控制台

当关联进程写入 Standard.err 时,选中此复选框以激活输出控制台并将其置于前端。

添加按钮

点击此按钮打开 编辑日志文件别名对话框 ,在其中可以选择新的日志条目并为其指定别名。

编辑按钮

点击此按钮在 编辑日志文件别名对话框 中编辑所选日志文件条目的属性。

删除按钮

点击此按钮从列表中移除所选日志条目。

浏览按钮

点击此按钮编辑所选日志文件条目。 仅在选择了条目时,此按钮才可用。

通用设置

在编辑运行配置(而非运行配置模板)时,您可以指定以下选项:

项目

描述

名称(N)

为运行配置指定名称,以便在编辑或运行时能快速将其与其他配置区分。

允许多个实例(U)

允许并行运行此运行配置的多个实例。

默认情况下,该选项处于禁用状态;当在另一个实例仍在运行时启动此配置,PyCharm 会建议停止正在运行的实例并启动另一个实例。 当某个运行配置消耗大量资源且没有充分理由运行多个实例时,这非常有用。

存储为项目文件(S)

保存包含运行配置设置的文件,以便与其他团队成员共享。 默认位置为 .idea/runConfigurations 。 但是,如果您不想共享 .idea 目录,可以将配置保存到项目内的任何其他目录。

默认情况下,该选项处于禁用状态,PyCharm 会将运行配置设置存储在 .idea/workspace.xml 中。

工具栏

运行/调试配置的树形视图包含一个工具栏,可帮助您管理 项目 中可用的配置,并调整默认配置模板。

项目

快捷键

描述

添加按钮

Alt+Insert

创建运行/调试配置。

移除按钮

Alt+Delete

删除所选运行/调试配置。 请注意,无法删除默认配置。

复制

Ctrl+D

创建所选运行/调试配置的副本。 请注意,您可以创建默认配置的副本。

保存配置

仅在选择了 临时配置 时显示此按钮。 点击此按钮将临时配置保存为永久配置。

移入新文件夹 / 创建新文件夹

移入新文件夹 / 创建新文件夹。 您可以通过 将它们放入文件夹 对运行/调试配置进行分组。

要创建文件夹,请在某个类别内选择配置,点击 文件夹 ,并指定文件夹名称。 如果仅选中某个类别,则会创建一个空文件夹。

然后,要将配置移入文件夹、在文件夹之间移动或移出文件夹,请使用拖放,或使用 上移下移 按钮。

要移除分组,请选择一个文件夹并点击 移除配置

对配置排序

点击此按钮按字母顺序对配置进行排序。

启动前

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

项目

快捷键

描述

添加按钮

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 运行/调试配置设置

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

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

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

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

移除按钮

Alt+Delete

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

编辑

Enter

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

上移方法

下移方法

Alt+Up

Alt+Down

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

显示此页面

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

激活工具窗口

默认情况下,将选中此复选框,并且在您启动运行/调试配置时,会打开 运行调试 工具窗口。

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

最后修改日期: 2025年 12月 2日