PyCharm 2025.2 Help

运行/调试配置：Doctests

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

在 docstrings中：

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

  • 识别 Python 代码的功能可以 开启或关闭。

  • 如果 doctests 以单独文件形式呈现，PyCharm 允许将这些文件作为带有 .rst 扩展名的 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 时将其前置。

添加按钮

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

Edit 按钮

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

删除按钮

点击此按钮可从列表中删除选定的日志条目。

“浏览”按钮

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

通用设置

当您编辑运行配置（但不是运行配置模板）时，您可以指定以下选项：

项目

描述

名称(N)

为运行配置指定一个名称，以便在编辑或运行时能快速识别。

允许多个实例(U)

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

默认情况下，它是禁用的，当您在另一个实例仍在运行时启动此配置时，PyCharm建议停止正在运行的实例并启动另一个实例。 这在运行配置消耗大量资源且没有充足理由运行多个实例时很有帮助。

存储为项目文件(S)

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

默认情况下，它是禁用的，PyCharm 会将运行配置设置存储在 .idea/workspace.xml 。

工具栏

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

项目

快捷键

描述

添加按钮

Alt+Insert

创建运行/调试配置。

"移除"按钮

Alt+Delete

删除选定的运行/调试配置。 请注意，您不能删除默认配置。

复制

Ctrl+D

创建选定运行/调试配置的副本。 请注意，您正在创建默认配置的副本。

保存配置

仅当您选择一个 临时配置时才会显示该按钮。 点击此按钮以将临时配置保存为永久配置。

移动到新文件夹／创建新文件夹

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

要创建文件夹，请选择某个类别中的配置，点击 文件夹 ，并指定文件夹名称。 如果只有一个类别处于焦点状态，则会创建一个空文件夹。

然后，为了将配置移动到文件夹中、文件夹之间或者文件夹外，请使用拖拽或 上移 和 下移 按钮。

要删除分组，请选择一个文件夹，然后点击 删除配置。

排序配置

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

启动前

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

项目

快捷方式

描述

添加按钮

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 自行打开相应的工具窗口。

最后修改日期： 2025年 9月 26日
运行/调试配置：Nosetests运行/调试配置：Twisted Trial