PyCharm 2025.3 Help

运行/调试配置:Flask 服务器

使用此对话框为 Flask 服务器 创建运行/调试配置,并自定义 PyCharm 执行您的 Flask 应用的方式。

有关在 PyCharm 中使用 Flask 的更多详细信息,请参阅 使用 Flask 创建 Web 应用程序

在主菜单中选择 运行 | 编辑配置(E) ,然后点击 添加新配置 并选择 Flask 服务器 模板。

Flask 运行/调试配置

配置运行/调试配置参数。 某些可选参数被隐藏。 要查看并启用它们,请点击 修改选项 链接。

可选参数

配置设置

说明

Python 解释器

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

请注意,除了本地解释器之外,您还可以选择 远程解释器

模块/脚本/自定义

从下拉列表中选择以下方法之一,以构造并将 FLASK_APP 变量传递给 Flask:

  • 模块 – 使用 Python 模块名和 Flask 类实例。

  • 脚本 – 使用指向 Python 文件的路径。

  • 自定义 – 使用路径、模块与 Flask 类实例的任意组合。

有关 FLASK_APP 变量的更多信息,请参阅 Flask CLI 文档

目标

根据您先前选择的方法,您可以指定以下值:

  • Python 文件的路径,例如, /Users/jetbrains/MyFlaskProject/app.py 。 您可以输入该路径,或点击 浏览按钮 按钮在项目结构中定位该文件。

  • Flask 项目中的模块名,例如, access_management。 您可以输入模块名,或点击 浏览按钮 按钮按名称搜索目标模块,或在项目结构中定位它。

  • 模块、脚本与 Flask 类实例的自定义组合,例如, access_management.access:app2 ,其中:

    • access_management – 模块名

    • access – 模块中的目标文件

    • app2access 中的 Flask 类实例。

Flask 应用

要执行的目标 Flask 类实例。 在执行期间,此值将被放入 FLASK_APP 变量。 例如,您已在应用中声明了如下 Flask 类的实例:

app = Flask(__name__);

然后,您可以将 app 添加到 应用程序 字段中。 它通常用于 模块名称 目标类型。 对于 脚本路径 ,仅在 Flask 0.13 及更高版本中才会启用 Application 字段。 自定义 目标类型会禁用此字段,因为您可以在添加到 目标 字段的组合中指定所需实例。

其他选项

flask run 命令的参数。

--host – 运行您的 Flask 应用的 Web 服务器的 IP 地址。 默认值为 '127.0.0.1'。 要使您的 Web 服务器对外可见,请将此参数设为 '0.0.0.0'。

--port – Web 服务器的端口。 默认值为 5000,或为 SERVER_NAME 配置变量中设置的端口号。

示例: --host=127.0.0.2 --port=1234

工作目录

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

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

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

环境变量

此字段显示环境变量列表。 如果列表包含多个变量,则以分号分隔。

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

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

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

Variable1 = Value1 Variable2 = Value2

只需从文本文件中复制变量列表,然后在 环境变量 对话框中点击 粘贴粘贴)。 变量将添加到表中。 点击 确定 以完成该任务。 您可以随时在 环境变量 对话框中选择所有变量,点击 复制 复制 ,并将它们粘贴到一个文本文件中。

".env" 文件的路径

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

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

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

Flask 环境

设置为某个可用环境的环境变量。 默认值为 'development'。

通用设置

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

说明

名称(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 应用所有当前处于活动状态的 File Watchers

  • 运行远程外部工具 :添加一个 远程 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 自行打开相应的工具窗口。

日志

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

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

说明

是否活动

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

日志文件条目

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

  • 特定文件的完整路径。

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

    如果某个日志条目模式定义了多个文件,则选项卡标题显示文件名,而非日志条目的别名。

跳过内容

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

将控制台输出保存到文件

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

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

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

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

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

添加按钮

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

编辑按钮

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

删除按钮

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

浏览按钮

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

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