PyCharm 2025.1 Help

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

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

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

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

Flask 运行/调试配置

填写以下参数:

配置选项卡

项目

描述

模块名称/脚本路径/自定义

选择以下方法之一来构建并传递 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_APP 变量中。 例如,您在应用程序中声明了以下 Flask 类的实例:

app = Flask(__name__);

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

其他选项

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

FLASK_ENV

设置为可能环境之一的环境变量。 默认值为 'development'。

FLASK_DEBUG

选中此复选框以启用内置的 Flask 调试模式。 在此模式下,开发服务器将在任何代码更改时自动重新加载,从而启用持续调试。 有关 Flask 调试器的更多信息,请参阅 Flask 调试模式

项目

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

环境变量

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

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

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

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

Variable1 = Value1 Variable2 = Value2

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

Python 解释器

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

请注意,您可以选择 远程解释器以及本地解释器。

解释器选项

在此字段中,指定要传递给解释器的字符串。 如果需要,请点击 展开组件 ,并在编辑器中键入字符串。

工作目录

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

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

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

将内容根添加到 PYTHONPATH

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

将源根添加到 PYTHONPATH

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

日志选项卡

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

项目

描述

活跃

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

日志文件条目

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

  • 特定文件的完整路径。

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

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

跳过内容

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

将控制台输出保存到文件

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

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

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

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

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

"添加"按钮

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

“编辑”按钮

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

删除按钮

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

"浏览" 按钮

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

通用设置

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

项目

描述

名称(N)

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

允许多个实例(U)

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

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

存储为项目文件(S)

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

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

工具栏

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

项目

快捷键

描述

"添加"按钮

Alt+Insert

创建运行/调试配置。

"移除"按钮

Alt+Delete

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

复制

Ctrl+D

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

保存配置

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

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

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

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

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

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

排序配置

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

启动前

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

项目

快捷键

描述

"添加"按钮

Alt+Insert

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

  • 启动Web 浏览器 :选择此选项即可启动浏览器。 在打开的对话框中,选择浏览器的类型并提供起始 URL。 还需指定是否希望使用 JavaScript 调试器启动浏览器。

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

  • 运行另一个配置 :选择执行另一个运行/调试配置,并等待其完成后再开始当前配置。 如果您想并行运行多个配置,请使用 复合运行/调试配置

  • 运行File Watcher :选择此选项以让 PyCharm 应用所有当前活动的 File Watchers

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

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

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

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

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

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

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

    NPM Script 对话框中,指定 npm run/debug configuration settings

  • Start React Native Bundler :选择此选项以自动运行打包工具,作为运行或调试会话的一部分。 默认情况下,这是通过 react-native start 完成的。

    如果您的应用程序使用 Expo ,您需要通过 start npm 任务运行开发服务器。 为此,请点击 添加 ,然后在 配置 React Native 对话框中,选择 npm 脚本 并从列表中选择 开始

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

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

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

  • 生成CoffeeScript 源映射 :选择此选项以生成 CoffeeScript 源代码的源映射。 在打开的对话框中,指定您的 CoffeeScript 源文件所在的位置。

  • 运行远程外部工具 :添加一个 remote SSH external tool

"移除"按钮

Alt+Delete

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

编辑

Enter

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

方法向上

方法下

Alt+Up

Alt+Down

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

显示此页面

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

激活工具窗口

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

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

最后修改日期: 2025年 4月 23日