欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

django如何自定義manage.py管理命令

 更新時(shí)間:2021年04月27日 14:58:42   作者:大江狗  
這篇文章主要介紹了django如何自定義manage.py管理命令,幫助大家更好的理解和學(xué)習(xí)使用django框架,感興趣的朋友可以了解下

每次在啟動(dòng)Django服務(wù)之前,我們都會(huì)在終端運(yùn)行python manage.py xxx的管理命令。其實(shí)我們還可以自定義管理命令,這對(duì)于執(zhí)行獨(dú)立的腳本或任務(wù)非常有用,比如清除緩存、導(dǎo)出用戶郵件清單或發(fā)送郵件等等。

自定義的管理命令不僅可以通過(guò)manage.py運(yùn)行,還可以通過(guò)Linux或Celery的crontab服務(wù)將其設(shè)成定時(shí)任務(wù)。本文主要講解如何自定義Django-admin命令,并提供一些演示案例。

自定義Django-admin命令一共分三步:創(chuàng)建文件夾布局、編寫(xiě)命令代碼和測(cè)試使用。

創(chuàng)建文件夾布局

自定義的Django-admin管理命令本質(zhì)上是一個(gè)python腳本文件,它的存放路徑必須遵循一定的規(guī)范,一般位于app/management/commands目錄。整個(gè)文件夾的布局如下所示:

 app01/
    __init__.py
    models.py
    management/
        __init__.py
        commands/
            __init__.py
            _private.py # 以下劃線開(kāi)頭文件不能用作管理命令
            my_commands.py # 這個(gè)就是自定義的管理命令腳本,文件名即為命令名
    tests.py
    views.py

注意:

  • management和commands每個(gè)目錄下都必須有個(gè)__init__.py空文件,表明這是一個(gè)python包。另外以下劃線開(kāi)頭的文件名不能用作管理命令腳本。
  • management/commands目錄可以位于任何一個(gè)app的目錄下,Django都能找到它。
  • 一般建議每個(gè)python腳本文件對(duì)應(yīng)一條管理命令。

編寫(xiě)命令代碼

每一個(gè)自定義的管理命令本質(zhì)是一個(gè)Command類, 它繼承了Django的Basecommand或其子類, 主要通過(guò)重寫(xiě)handle()方法實(shí)現(xiàn)自己的業(yè)務(wù)邏輯代碼,而add_arguments()則用于幫助處理命令行的參數(shù),如果運(yùn)行命令時(shí)不需要額外參數(shù),可以不寫(xiě)這個(gè)方法。

 from django.core.management.base import BaseCommand
 
 class Command(BaseCommand):
     # 幫助文本, 一般備注命令的用途及如何使用。
     help = 'Some help texts'
 
     # 處理命令行參數(shù),可選
     def add_arguments(self, parser):
        pass
 
     # 核心業(yè)務(wù)邏輯
     def handle(self, *args, **options):
         pass

我們現(xiàn)在來(lái)看一個(gè)最簡(jiǎn)單的例子,希望定義一個(gè)名為hello_world的命令。這樣當(dāng)我們運(yùn)行python manage.py hello_world命令時(shí),控制臺(tái)會(huì)打印出Hello World!字樣。在app/management/commands目錄下新建hello_world.py, 添加如下代碼:

 from django.core.management.base import BaseCommand
 
 class Command(BaseCommand):
    # 幫助文本, 一般備注命令的用途及如何使用。
    help = "Print Hello World!"
 
    # 核心業(yè)務(wù)邏輯
    def handle(self, *args, **options):
        self.stdout.write('Hello World!')

注意:當(dāng)你使用管理命令并希望在控制臺(tái)輸出指定信息時(shí),你應(yīng)該使用self.stdout和self.stderr方法,而不能直接使用python的print方法。另外,你不需要在消息的末尾加上換行符,它將被自動(dòng)添加。

此時(shí)當(dāng)你進(jìn)入項(xiàng)目文件夾運(yùn)行python manage.py hello_world命令時(shí),你將得到如下輸出結(jié)果:

現(xiàn)在我們來(lái)增加點(diǎn)難度,來(lái)通過(guò)命令行給hello_world命令傳遞一個(gè)name參數(shù),以實(shí)現(xiàn)運(yùn)行python manage.py helloworld John命令時(shí) 打印出Hello World! John。

現(xiàn)在修改我們的hello_world.py, 添加add_arguments方法,該方法的作用是給自定義的handle方法添加1個(gè)或多個(gè)參數(shù)。

 from django.core.management.base import BaseCommand
 
 class Command(BaseCommand):
    # 幫助文本, 一般備注命令的用途及如何使用。
    help = "Print Hello World!"
 
    # 給命令添加一個(gè)名為name的參數(shù)
    def add_arguments(self, parser):
        parser.add_argument('name')
 
    # 核心業(yè)務(wù)邏輯,通過(guò)options字典接收name參數(shù)值,拼接字符串后輸出
    def handle(self, *args, **options):
        msg = 'Hello World ! '+ options['name']
        self.stdout.write(msg)

此時(shí)當(dāng)你再次運(yùn)行python manage.py hello_world John命令時(shí),你將得到如下輸出結(jié)果:

如果你直接運(yùn)行命令而不攜帶參數(shù),將會(huì)報(bào)錯(cuò),如下所示:

實(shí)際應(yīng)用場(chǎng)景

前面的案例過(guò)于簡(jiǎn)單,我們現(xiàn)在來(lái)看兩個(gè)自定義管理命令的實(shí)際應(yīng)用案例。

案例1:檢查數(shù)據(jù)庫(kù)連接是否已就緒

無(wú)論你使用常規(guī)方式還是Docker在生產(chǎn)環(huán)境中部署Django項(xiàng)目,你需要確保數(shù)據(jù)庫(kù)連接已就緒后才進(jìn)行數(shù)據(jù)庫(kù)遷移(migrate)的命令(Docker-compose的depends選項(xiàng)并不能確保這點(diǎn)),否則Django應(yīng)用程序會(huì)出現(xiàn)報(bào)錯(cuò)。

這時(shí)你可以自定義一個(gè)wait_for_db的命令,如下所示:

 # app/management/commands/wait_for_db.py
 
 import time
 from django.db import connections
 from django.db.utils import OperationalError
 from django.core.management import BaseCommand
 
 
 class Command(BaseCommand):
     help = 'Run data migrations until db is available.'
 
     def handle(self, *args, **options):
         self.stdout.write('Waiting for database...')
         db_conn = None
         while not db_conn:
             try:
                 # 嘗試連接
                 db_conn = connections['default']
             except OperationalError:
                 # 連接失敗,就等待1秒鐘
                 self.stdout.write('Database unavailable, waiting 1 second...')
                 time.sleep(1)
 
         self.stdout.write(self.style.SUCCESS('Database available!'))

定義好這個(gè)命令后每次在運(yùn)行python manage.py migrate命令前先運(yùn)行python manage.py wait_for_db即可。

案例2:周期性發(fā)送郵件

如果你是網(wǎng)站管理員,你肯定希望知道每天有多少新用戶已注冊(cè),這時(shí)你可以自定義一條mail_admin的管理命令,將每天新注冊(cè)用戶數(shù)量以郵件形式發(fā)給自己,如下所示:

 # app/management/commands/mail_admin.py
 
 #-*- coding:utf-8 -*-
 from datetime import timedelta, time, datetime
 from django.core.mail import mail_admins
 from django.core.management import BaseCommand
 from django.utils import timezone
 from django.contrib.auth import get_user_model
 
 User = get_user_model()
 
 today = timezone.now()
 yesterday = today - timedelta(1)
 
 
 class Command(BaseCommand):
     help = "Send The Daily Count of New Users to Admins"
 
     def handle(self, *args, **options):
         # 獲取過(guò)去一天注冊(cè)用戶數(shù)量
         user_count =User.objects.filter(date_joined__range=(yesterday, today)).count()
         
         # 當(dāng)注冊(cè)用戶數(shù)量多余1個(gè),才發(fā)送郵件給管理員
         if user_count >= 1:
             message = "You have got {} user(s) in the past 24 hours".format(user_count)
 
             subject = (
                 f"New user count for {today.strftime('%Y-%m-%d')}: {user_count}"
            )
 
             mail_admins(subject=subject, message=message, html_message=None)
 
             self.stdout.write("E-mail was sent.")
         else:
             self.stdout.write("No new users today.")

如果你在終端運(yùn)行python manage.py mail_admin命令,你將得到如下輸出結(jié)果:

注意:真正發(fā)送郵件成功需要設(shè)置Email后臺(tái)及管理員,測(cè)試環(huán)境下可以使用如下簡(jiǎn)單配置:

 EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend"
 DEFAULT_FROM_EMAIL = "noreply@example.com"
 ADMINS = [("大江狗", "yunbo.shi@example.com"), ]

但是如果每天都要進(jìn)入終端運(yùn)行這個(gè)命令實(shí)在太麻煩了,我們完全可以使用Linux的crontab服務(wù)或Celery-Beat將其設(shè)成周期性定時(shí)任務(wù)task,這時(shí)只需要調(diào)用Django的call_command方法即可。

 # app/tasks.py, 可以任一app目錄下新建task
 from celery import shared_task
 from django.core.management import call_command
 
 @shared_task
 def mail_admin():
     call_command("mail_admin", )

關(guān)于Django項(xiàng)目中如何使用Celery執(zhí)行異步和周期性任務(wù),請(qǐng)參加下篇Django進(jìn)階-異步和周期任務(wù)篇。

以上就是django如何自定義manage.py管理命令的詳細(xì)內(nèi)容,更多關(guān)于django 自定義manage.py管理命令的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!

相關(guān)文章

  • Windows下Pycharm遠(yuǎn)程連接虛擬機(jī)中Centos下的Python環(huán)境(圖文教程詳解)

    Windows下Pycharm遠(yuǎn)程連接虛擬機(jī)中Centos下的Python環(huán)境(圖文教程詳解)

    由于最近學(xué)習(xí)tensorflow的需要,tensorflow是在Linux環(huán)境下,使用的是Python。為了方便程序的調(diào)試,嘗試在Windows下的Pycharm遠(yuǎn)程連接到虛擬機(jī)中Centos下的Python環(huán)境,感興趣的朋友跟隨小編看看吧
    2020-03-03
  • 使用OpenCV實(shí)現(xiàn)迷宮解密的全過(guò)程

    使用OpenCV實(shí)現(xiàn)迷宮解密的全過(guò)程

    同學(xué)發(fā)了我張迷宮圖片,讓我走迷宮來(lái)緩解暴躁,于是乎就碼了一個(gè)程序出來(lái),下面這篇文章主要給大家介紹了關(guān)于使用OpenCV實(shí)現(xiàn)迷宮解密的相關(guān)資料,需要的朋友可以參考下
    2022-10-10
  • OpenCV半小時(shí)掌握基本操作之傅里葉變換

    OpenCV半小時(shí)掌握基本操作之傅里葉變換

    這篇文章主要介紹了OpenCV基本操作之傅里葉變換,本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下
    2021-09-09
  • Python中模塊(Module)和包(Package)的區(qū)別詳解

    Python中模塊(Module)和包(Package)的區(qū)別詳解

    這篇文章主要介紹了Python中模塊(Module)和包(Package)的區(qū)別詳解,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧
    2019-08-08
  • python創(chuàng)建多個(gè)logging日志文件的方法實(shí)現(xiàn)

    python創(chuàng)建多個(gè)logging日志文件的方法實(shí)現(xiàn)

    本文主要介紹了python創(chuàng)建多個(gè)logging日志文件的方法實(shí)現(xiàn),文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧
    2023-07-07
  • Python實(shí)現(xiàn)利用最大公約數(shù)求三個(gè)正整數(shù)的最小公倍數(shù)示例

    Python實(shí)現(xiàn)利用最大公約數(shù)求三個(gè)正整數(shù)的最小公倍數(shù)示例

    這篇文章主要介紹了Python實(shí)現(xiàn)利用最大公約數(shù)求三個(gè)正整數(shù)的最小公倍數(shù),涉及Python數(shù)學(xué)運(yùn)算相關(guān)操作技巧,需要的朋友可以參考下
    2017-09-09
  • python中的tkinter庫(kù)彈窗messagebox詳解

    python中的tkinter庫(kù)彈窗messagebox詳解

    這篇文章主要介紹了python中的tkinter庫(kù)彈窗messagebox,包括消息提示框、消息警告框、錯(cuò)誤消息框,通過(guò)代碼給大家介紹的非常詳細(xì),需要的朋友可以參考下
    2021-06-06
  • Python函數(shù)any()和all()的用法及區(qū)別介紹

    Python函數(shù)any()和all()的用法及區(qū)別介紹

    any函數(shù):any(x),只要x中有一個(gè)不為空,0,false就返回True,否則返回False。all(x)函數(shù)必須x中的所有元素均不為空,0,false才會(huì)返回True,否則返回False。接下來(lái)通過(guò)本文給大家介紹Python函數(shù)any()和all()的用法及區(qū)別介紹,需要的朋友參考下吧
    2018-09-09
  • 文件上傳服務(wù)器-jupyter 中python解壓及壓縮方式

    文件上傳服務(wù)器-jupyter 中python解壓及壓縮方式

    這篇文章主要介紹了文件上傳服務(wù)器-jupyter 中python解壓及壓縮方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧
    2020-04-04
  • Python 字符串大小寫(xiě)轉(zhuǎn)換的簡(jiǎn)單實(shí)例

    Python 字符串大小寫(xiě)轉(zhuǎn)換的簡(jiǎn)單實(shí)例

    下面小編就為大家?guī)?lái)一篇Python 字符串大小寫(xiě)轉(zhuǎn)換的簡(jiǎn)單實(shí)例。小編覺(jué)得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧
    2017-01-01

最新評(píng)論