[Django]カスタムコマンドの作成方法と便利なコード

Djangoでは manage.py の後にコマンドを入力するといろいろな操作を行うことができます。

今回はそんなカスタムコマンドを作成する方法と、作成が簡単になるサンプルコードの紹介です。

調べながらやると数分から、ハマると数時間かかる内容がコピペで一瞬でできるようになります。

カスタムコマンドの作成方法

Djangoプロジェクトの中のアプリケーションの中に`management`フォルダを作成します。
その中に`commands`というフォルダを作成します。
“それぞれ”のフォルダの中に`__init__.py`という空のPythonファイルを作成します。
manage.pyで「実行したいコマンド名.py」でPythonファイルを作成します。

※上記の例ではsend_mail.pyというカスタムコマンド用のファイルを作成しています。

タダのPythonファイルだとpython manage.py ファイル名では実行できないのでBaseCommandをインポートします。
from django.core.management import BaseCommand

そして、Djangoのモデルを利用したい場合はDjangoをセットアップする必要があるのでsettingsファイルを読み込みます。

import django,os os.environ.setdefault("DJANGO_SETTINGS_MODULE", "プロジェクト名.settings") django.setup()

あとはPythonファイルを単体で実行したときとmanage.pyから実行した時どちらからでも実行できるようにmain()関数でまとめたものを追加します。

最終的にできあがったのがこちらのファイルです。

カスタムコマンド用チートファイル

いろいろ説明しましたが下記のファイルの「プロジェクト名」と「アプリ名」を置き換えて、実行したいコマンドを書くだけで大丈夫です。

Python


from django.core.management import BaseCommand
import django,os
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "プロジェクト名.settings")
django.setup()

from アプリ名.models import *

def main():
    # ここに実行したいコマンドを記述
    pass


class Command(BaseCommand):
    def handle(self, *args, **options):
        main()

if __name__ == '__main__':
    main()