运行 Django 任务
Django 6.0 引入了内置的 任务框架 ,用于在请求-响应周期之外运行代码。 PyCharm 支持从编辑器将任务加入队列,并将设置保存到 Django 任务 运行/调试配置中。
从编辑器将任务加入队列
点击使用
@task装饰的函数旁边的装订区域图标,然后选择 运行 'Enqueue <函数名称>'。或者,将文本光标置于函数名称上,右键点击,然后选择 运行 'Enqueue <函数名称>'。
如果任务包含必需参数且尚未指定实参,请在 指定任务实参 对话框中输入实参,然后点击 确定。 使用 Python 调用语法,例如
["admin@example.com"], subject="Report"。
PyCharm 会为该任务创建 Django 任务 运行/调试配置,或重用现有配置,然后运行它。
任务如何加入队列
当运行 Django 任务 配置时,PyCharm 会运行 manage.py 的 shell 命令,该命令会导入任务,并使用指定的实参调用其 enqueue() 方法。 PyCharm 不会启动工作进程。 接下来会发生什么取决于 Django 设置中配置的 任务后端:
使用默认的
ImmediateBackend时,任务会立即在同一进程中运行,其输出会显示在 运行 工具窗口中。对于其他后端,请单独启动工作进程来处理已加入队列的任务。
Django 任务配置选项
创建:
常用选项
项目 | 描述 |
|---|---|
名称 | 为运行配置指定名称,便于在编辑或运行时快速识别。 |
允许多个实例。 | 允许并行运行此运行配置的多个实例。 默认情况下,该选项处于禁用状态。当您在另一个实例仍在运行时启动此配置,PyCharm 会建议先停止正在运行的实例,再启动另一个实例。 当某个运行配置占用大量资源且没有充分理由运行多个实例时,这将很有帮助。 |
存储为项目文件 | 将包含运行配置设置的文件保存下来,以便与团队其他成员共享。 默认位置是 .idea/runConfigurations 。 但是,如果您不想共享 .idea 目录,可以将该配置保存到项目内的任何其他目录。 默认情况下,该选项处于禁用状态,并且 PyCharm 会将运行配置设置存储在 .idea/workspace.xml 中。 |
特定于 Django 任务的配置选项
项目 | 描述 |
|---|---|
Python 解释器 | 从列表中选择预配置的 Python 解释器之一。 |
任务路径 | 指定包含该任务的模块的导入路径,例如 |
任务名称 | 指定任务函数的名称。 |
参数 | 指定要传递给任务的实参,使用 Python 调用语法,例如 |
工作目录 | 指定正在运行的任务要使用的目录。
您可以在此字段中使用 路径变量。 |
环境变量 | 此字段显示环境变量列表。 如果列表包含多个变量,则它们用分号分隔。 默认情况下,此字段包含变量 要创建新变量,请点击 您可能希望使用存储在文本文件中的一系列记录来填充该列表,例如:
Variable1 = Value1
Variable2 = Value2
只需从文本文件复制变量列表,然后在 环境变量 对话框中点击 粘贴 ( |
".env" 文件路径 | 此字段显示带有环境变量的 .env 文件的路径。 如果有多个文件,则以分号分隔其路径。 若要管理 .env 文件列表,请点击 您还可以使用 |
其他选项
点击 修改选项 ,然后选择要添加到对话框中的选项。
操作系统
项目 | 描述 |
|---|---|
允许多个实例。 | 允许并行运行此运行配置的多个实例。 默认情况下,该选项处于禁用状态。当您在另一个实例仍在运行时启动此配置,PyCharm 会建议先停止正在运行的实例,再启动另一个实例。 当某个运行配置占用大量资源且没有充分理由运行多个实例时,这将很有帮助。 |
Python
日志
以下选项与记录此配置的执行相关。 有关更多信息,请参见 设置日志选项。
项目 | 描述 |
|---|---|
指定要在控制台中显示的日志 | 指定在运行应用程序时显示哪些日志文件。 点击
对于表格中的日志,您可以配置以下选项:
|
保存控制台输出到文件 | 将控制台输出保存到指定位置。 手动输入路径,或点击浏览按钮,然后在 打开的对话框 中指向所需位置。 |
在向 stdout 打印消息时显示控制台 | 当应用程序写入标准输出流时激活控制台。 |
在向 stderr 打印消息时显示控制台 | 当应用程序写入标准错误流时激活控制台。 |
启动前
项目 | 描述 |
|---|---|
启动时打开运行/调试工具窗口 | 默认情况下,该选项处于选中状态,并且当您启动运行/调试配置时,会打开 运行 或 调试 工具窗口。 否则,工具窗口将被隐藏。 但是,当配置正在运行时,您可以按 Alt+4 或 Alt+5 自行为其打开相应的工具窗口。 |
启动时聚焦运行/调试工具窗口 | |
开始前显示运行/调试配置设置 | 选中此选项,在实际启动运行/调试配置之前显示其设置。 |
添加启动前任务 | 选择此选项以添加以下可用任务之一:
|