【PyCharm教程】PyCharm 运行/调试配置:Flask 服务器

使用此对话框为Flask 服务器创建运行/调试配置并自定义 PyCharm 执行 Flask 应用程序的方式。
选择运行 | 从主菜单编辑配置,然后单击并选择Flask模板。
填写以下参数:
配置选项卡
物品 | 描述 |
---|---|
模块名称/脚本路径/自定义 | 选择以下方法之一来构造FLASK_APP 变量并将其传递给 Flask:模块名称——通过使用 Python 模块名称和Flask 类实例。脚本路径——通过使用 Python 文件的路径。自定义Flask ——通过使用路径、模块和类实例的任意组合。 |
目标 | 根据所选的Target type,您可以指定以下值:Python 文件的路径,例如/Users /jetbrains /MyFlaskProject /app.py。您可以输入路径或单击按钮在项目结构中定位文件。access_management . 您可以输入模块名称或单击Flask 类实例的自定义组合,例如 ,access_management.access:app2 其中:access_management – 模块名称access – 模块中的目标文件app2 – 中的Flask 类实例access 。 |
应用 | Flask 要执行的目标类实例。该值将在执行期间放入FLASK_APP 变量中。例如,您Flask 在应用程序中声明了以下类的实例:app = Flask(__name__); 然后您可以添加app 到应用程序字段中。它通常用于模块名称目标类型。对于Script path,该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 | 设置为可能环境之一的环境变量。默认值为“开发”。 |
FLASK_DEBUG | 选中此复选框以启用内置的 Flask 调试模式。使用此模式,开发服务器将在任何代码更改时自动重新加载,从而实现持续调试。 |
项目 | 单击此列表以选择在同一 PyCharm 窗口中打开的项目之一,应使用此运行/调试配置。如果只有一个打开的项目,则不显示该字段。 |
环境变量 | 此字段显示环境变量列表。如果列表包含多个变量,则它们用分号分隔。默认情况下,该字段包含PYTHONUNBUFFERED 设置为 1 的变量。要填写列表,请单击浏览按钮,或在“环境变量”对话框中按Shift+Enter并指定所需的环境变量集。要创建新变量,请单击Variable1 = Value1 Variable2 = Value2 只需从文本文件中复制变量列表,然后单击环境变量对话框中的粘贴( |
Python 解释器 | 从列表中选择一个预配置的Python 解释器。请注意,您可以选择远程解释器以及本地解释器。 |
口译员选项 | 在此字段中,指定要传递给解释器的字符串。如有必要,单击 |
工作目录 | 指定正在运行的任务要使用的目录。Ctrl+Shift+F10当通过键盘快捷键或从脚本的上下文菜单中选择运行来创建默认运行/调试配置时,工作目录就是包含可执行脚本的目录。此目录可能与项目目录不同。当此字段留空时,将使用 PyCharm 安装的bin目录。 |
将内容根添加到 PYTHONPATH | 选中此复选框可将项目的所有内容根添加到环境变量 PYTHONPATH; |
将源根目录添加到 PYTHONPATH | 选中此复选框可将项目的所有源根添加到环境变量 PYTHONPATH; |
日志选项卡
使用此选项卡可指定在运行或调试时生成的日志文件应显示在控制台中,即运行或调试工具窗口的专用选项卡上。
物品 | 描述 |
---|---|
活跃 | 选中此列中的复选框以使日志条目显示在运行工具窗口或调试工具窗口的相应选项卡中。 |
日志文件条目 | 此列中的只读字段列出了要显示的日志文件。该列表可以包含:特定文件的完整路径。替代完整路径或模式的别名。这些别名也显示在显示相应日志文件的选项卡的标题中。如果日志条目模式定义了多个文件,则选项卡标题会显示文件的名称而不是日志条目别名。 |
跳过内容 | 选中此复选框可跳过所选日志的先前内容。 |
将控制台输出保存到文件 | 选中此复选框可将控制台输出保存到指定位置。手动键入路径,或单击浏览按钮并在打开的对话框中指向所需位置。 |
将消息打印到标准输出流时显示控制台 | 选中此复选框可激活输出控制台并在关联进程写入 Standard.out 时将其提前。 |
将消息打印到标准错误流时显示控制台 | 选中此复选框以激活输出控制台并在关联进程写入 Standard.err 时将其提前。 |
单击此按钮可打开“编辑日志文件别名”对话框,您可以在其中选择新的日志条目并为其指定别名。 | |
单击此按钮可在“编辑日志文件别名”对话框中编辑所选日志文件条目的属性。 | |
单击此按钮可从列表中删除选定的日志条目。 | |
单击此按钮可编辑选择日志文件条目。该按钮仅在选择条目时可用。 |
常用设置
当您编辑运行配置(但不是运行配置模板)时,您可以指定以下选项:
姓名 | 为运行/调试配置指定一个名称,以便在编辑或运行配置时快速识别它,例如,从运行弹出窗口Alt+Shift+F10中。 |
允许并行运行 | 选择以允许并行运行此运行配置的多个实例。默认情况下,它是禁用的,当您在另一个实例仍在运行时启动此配置时,PyCharm 建议停止正在运行的实例并启动另一个实例。当运行/调试配置消耗大量资源并且没有充分理由运行多个实例时,这很有帮助。 |
存储为项目文件 | 使用运行配置设置保存文件以与其他团队成员共享。默认位置是.idea/runConfigurations。但是,如果您不想共享.idea目录,您可以将配置保存到项目中的任何其他目录。默认情况下,它被禁用,并且 PyCharm 将运行配置设置存储在.idea/workspace.xml中。 |
工具栏
运行/调试配置的树视图有一个工具栏,可帮助您管理项目中可用的配置以及调整默认配置模板。
物品 | 捷径 | 描述 |
---|---|---|
Alt+Insert | 创建运行/调试配置。 | |
Alt+Delete | 删除选定的运行/调试配置。请注意,您不能删除默认配置。 | |
Ctrl+D | 创建所选运行/调试配置的副本。请注意,您会创建默认配置的副本。 | |
仅当您选择临时配置时才会显示该按钮。单击此按钮可将临时配置保存为永久配置。 | ||
移动到新文件夹/创建新文件夹。您可以通过将运行/调试配置放入文件夹来对它们进行分组。要创建文件夹,请选择类别中的配置,单击 | ||
单击此按钮可按字母顺序对配置进行排序。 |
发射前
在此区域中,您可以指定在开始选定的运行/调试配置之前要执行的任务。任务按照它们在列表中出现的顺序执行。
物品 | 捷径 | 描述 |
---|---|---|
Alt+Insert | 单击此图标可添加以下可用任务之一:运行外部工具:选择运行外部应用程序。在打开的对话框中,选择一个或多个要运行的应用程序。如果尚未在 PyCharm 中定义,请添加其定义。运行另一个配置:选择以执行另一个运行/调试配置并等待它完成,然后再开始当前配置。如果要并行运行多个配置,请使用复合运行配置。启动 Web 浏览器:选择此选项以启动浏览器。在打开的对话框中,选择浏览器类型并提供起始 URL。此外,指定是否希望使用 JavaScript 调试器启动浏览器。运行文件观察器:选择此选项让 PyCharm 应用所有当前活动的文件观察器。运行 Grunt 任务:选择此选项以运行 Grunt 任务。在打开的Grunt 任务对话框中,指定定义所需任务的Gruntfile.js,选择要执行的任务,并指定要传递给 Grunt 工具的参数。指定 Node.js 解释器的位置、传递给它的参数以及grunt-cli包的路径。运行 gulp 任务:选择此选项以运行 Gulp 任务。在打开的Gulp 任务对话框中,指定定义所需任务的Gulpfile.js,选择要执行的任务,并指定要传递给 Gulp 工具的参数。指定 Node.js 解释器的位置、传递给它的参数以及gulp包的路径。运行 npm 脚本:选择此选项以执行 npm 脚本。在打开的NPM 脚本对话框中,指定npm 运行/调试配置设置。启动 React Native Bundler:选择此选项以自动运行捆绑器,作为运行或调试会话的一部分。默认情况下,这是通过react-native start .如果您的应用程序使用Expo,您需要通过start npm 任务运行开发服务器。为此,请单击 | |
Alt+Delete | 单击此图标可从列表中删除选定的任务。 | |
Enter | 单击此图标可编辑选定的任务。在打开的对话框中进行必要的更改。 | |
Alt+Up/Alt+Down | 单击这些图标可在列表中将所选任务向上或向下移动一行。任务按照它们在列表中出现的顺序执行。 | |
显示此页面 | 选中此复选框可在实际启动运行/调试配置之前显示运行/调试配置设置。 | |
激活工具窗口 | 默认情况下,此复选框处于选中状态,当您启动运行/调试配置时,运行或调试工具窗口将打开。否则,如果清除该复选框,则隐藏工具窗口。但是,在配置运行时,您可以通过按Alt+4或自行为其打开相应的工具窗口Alt+5。 |