如何在Django中创建自定义命令?

在开发Django项目时,有时候需要编写一次性脚本来自动化特定任务。
例如:
1、清理错误的数据列
2、导入初始数据库数据
我们可以通过两种方式在django中运行这些类型的命令。第一是编写一个普通的python脚本,然后可以通过运行python file_name.py来调用它,而另一个方法是使用django-admin命令。这些是通过调用python manage.py command_name运行的。

对于这篇文章,我将通过一个博客应用程序进行演示,该应用程序只有3个数据库表:User,Category和Post。

普通的python脚本方法
对于第一个示例,我们将尝试使用以下脚本列出所有系统用户:

可以命名脚本list_users.py并通过python list_users.py运行它,但运行的时候会遇到如下错误:

可能有人会假设,如果脚本位于django的项目目录中,脚本可以正常运行。然而,这种情况也不对。这是因为脚本不知道该脚本将应用于哪个项目。因为我们可能在一台计算机或虚拟环境中有多个项目。因此,给脚本一些上下文信息很重要。

我们将通过稍微修改脚本来做到这一点。

在这里,我们指定项目的设置,不仅如此,还可以调用django.setup()方法。该方法配置设置,记录日志并填充应用程序注册表。总之,我们要使脚本知道我们的项目上下文。

请注意,导入顺序很重要,不要调整,这里有坑。

如果再次运行脚本,则所有用户都会正常打印到终端,没有报错了。

接下来,我们将通过运行django-admin startapp posts来创建一个名为posts的app应用。

该应用程序将包含我们的博客文章模型

对于此示例,我们将从命令行创建博客帖子的实例。脚本名为create_post.py

在这里,我们正在创建博客帖子的实例。请注意我们要如何处理ForeignKey关系?其实就是确保将相关数据库表的对象实例分配给该字段。

通过运行python create_post.py,然后提示我们进行一些输入。

编写自定义django管理命令方法
文章刚看开始也提到了,django-admin命令是通过运行python manage.py command_name来执行的,我们平时用的有runserver,migrate和collectstatic。如果要获取可用命令的列表,可以运行python manage.py help。这将显示可用命令以及它们所在的django app文件夹的列表。

要注册自定义管理命令,需要在django应用程序文件夹中添加一个management \ commands目录。在我们的例子中,它将位于posts \ management \ commands中。

设置完成后,我们便可以在命令文件夹中初始化自定义脚本。对于第一个示例,我们将编写一个命令,将之前创建的博客文章标记为已发布。

请创建一个文件并将其命名为publish_post.py

Django管理命令由一个名为Command的类组成,该类继承自BaseCommand。

为了接收参数,该类利用argparse。方法add_arguments允许我们的函数接收参数。

在我们的例子中,该函数期望一个参数,该参数将被分配键post_id

然后,handle()函数评估输入并执行我们的逻辑。

在上面的示例中,期望的参数类型称为位置参数,必须提供该参数才能运行该函数。为此,我们运行python manage.py publish_post 1(或任何发布主键)

顾名思义,可以将另一种类型的参数称为可选参数应用于方法,缺少这些参数不会影响函数的执行。

下面提供了一个示例。我们将初始化一个文件并将其命名为edit_post.py。代码如下:

在这里,我们只是在编辑博客文章标题或内容。所以我们可以运行python manage.py edit_post 2 -t“ new title”仅编辑标题

或python manage.py edit_post -c “new content ”仅编辑内容。如果我们希望通过`python manage.py edit_post 2 -t “new title again” -c “new title again”编辑标题和内容,则可以提供两个参数。

原文:https://lewiskori.com/blog/how-to-create-custom-commands-in-django/

github: https://github.com/lewis-kori/django-commands