Django-Tutorial-pollsアプリケーション

2022-03-21 / tau / コメントする

概要

Djangoドキュメントのチュートリアルに従って、mysiteプロジェクトを作成し、その中にpollsアプリケーションを作成する。

プロジェクトの作成

プロジェクトの作成はdjango-adminで実行する。チュートリアルのプロジェクト構成ではmysiteディレクトリーの下にmysiteサブディレクトリーとしているが、ここではmysite/configという構成にした。

$ mkdir mysite && cd mysite
$ django-admin startproject config .

1 2	$ mkdir mysite && cd mysite $ django-admin startproject config .

ディレクトリー構成は以下のようになっている。

$ tree mysite/
mysite/
├── config
│   ├── __init__.py
│   ├── asgi.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
└── manage.py

$ tree mysite/

mysite/

├── config

│ ├── __init__.py

│ ├── asgi.py

│ ├── settings.py

│ ├── urls.py

│ └── wsgi.py

└── manage.py

settings.pyを以下のように編集する（初期設定の詳細はこちら）。

ローカルサーバーでの開発のため、ALLOWED_HOSTSに'localhost'を設定
DATABASESはMySQL用に設定
その他、言語コードやタイムゾーンの設定

  ....

ALLOWED_HOSTS = ['localhost']

  ....

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'django_tutorial',
        'USER': 'root',
        'PASSWORD': '********',
    }
}

  ....

LANGUAGE_CODE = 'ja'

TIME_ZONE = 'Asia/Tokyo'

  ....

....

ALLOWED_HOSTS = ['localhost']

....

DATABASES = {

'default': {

'ENGINE': 'django.db.backends.mysql',

'NAME': 'django_tutorial',

'USER': 'root',

'PASSWORD': '********',

}

....

LANGUAGE_CODE = 'ja'

TIME_ZONE = 'Asia/Tokyo'

....

開発用サーバーを起動して、"Congratulations!"の画面を確認。

pollsアプリケーションの作成

startappコマンドでpollsアプリケーションを作成。

$ python3 manage.py startapp polls

1	$ python3 manage.py startapp polls

manage.pyは実行可能ファイルなので、以下でも作成できる。

$ ./manage.py startapp polls

1	$ ./manage.py startapp polls

pollsアプリケーション作成後の構成は以下の通り。

$ tree mysite/
mysite/
├── config
│   ├── __init__.py
│   ├── asgi.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
├── manage.py
└── polls
     ├── __init__.py
     ├── admin.py　　→管理者関係の設定ファイル
     ├── apps.py 　　→アプリケーション構成クラス定義(PollsConfig)
     ├── migrations　→マイグレーションファイル保存ディレクトリー
     │   └── __init__.py
     ├── models.py 　→モデルクラス定義
     ├── tests.py　　→テスト用設定ファイル
     ├── urls.py 　　→URL conf：ルーティング
     └── views.py　　→view関数定義ファイル

$ tree mysite/

mysite/

├── config

│ ├── __init__.py

│ ├── asgi.py

│ ├── settings.py

│ ├── urls.py

│ └── wsgi.py

├── manage.py

└── polls

├── __init__.py

├── admin.py　　→管理者関係の設定ファイル

├── apps.py 　　→アプリケーション構成クラス定義(PollsConfig)

├── migrations　→マイグレーションファイル保存ディレクトリー

│ └── __init__.py

├── models.py 　→モデルクラス定義

├── tests.py　　→テスト用設定ファイル

├── urls.py 　　→URL conf：ルーティング

└── views.py　　→view関数定義ファイル

view関数の定義

view関数はMTVの構成要素の一つで、URLからルーティングされ、モデルのデータ操作やブラウザー表示のための様々な処理を実装するもの。MVCモデルのコントローラーに相当する。

一般的にはview関数の戻り値にはブラウザー表示のためのテンプレートを渡すが、ここでは最も単純に、単に文字列だけを返すようにする。

HttpResponseモジュールをインポート
view関数index()を定義
HttpResponseのコンストラクターの引数に文字列を渡し、そのインスタンスを戻り値とする

from django.shortcuts import render
from django.http import HttpResponse

def index(request):
    return HttpResponse("Hello, world. You're at the polls index.")

from django.shortcuts import render

from django.http import HttpResponse

def index(request):

return HttpResponse("Hello, world. You're at the polls index.")

URL conf～ルーティング

URLからview関数index()へのルーティングを設定する。pollsアプリケーションのビューなのでpolls/urls.pyで定義する。アプリケーションのurls.pyはデフォルトでは作成されないので、新たに作成して次の内容とする。

from django.urls import path
from polls import views

urlpatterns = [
    path('', views.index, name='index')
]

from django.urls import path

from polls import views

urlpatterns = [

path('', views.index, name='index')

]

pollsアプリケーションのurlsモジュールをプロジェクトに認識させるため、conf/urls.pyに記述を追加する。

django.urlsパッケージのincludeモジュールを追加でインポート
path関数でアプリケーションのurls関数をインポートし、アプリケーションのURLに紐づけ

from django.contrib import admin
from django.urls import path, include

urlpatterns = [
    path('admin/', admin.site.urls),
    path('polls/', include('polls.urls'))
]

from django.contrib import admin

from django.urls import path, include

urlpatterns = [

path('admin/', admin.site.urls),

path('polls/', include('polls.urls'))

]

確認

サーバーが起動した状態で、サブディレクトリーpolls/にアクセスする。今の構成ではlocalhost:8000/polls。

ブラウザーの画面には、以下のテキストが表示される。

Hello, world. You're at the polls index.

1	Hello, world. You're at the polls index.

Django – Tutorial – admin

2022-03-21 / tau / コメントする

概要

Djangoのチュートリアル、管理者ページの部分を整理。

管理者ログインページ

Djangoのデフォルトの状態で、既に管理者の環境が準備されている。サーバーを起動してadmin/サブディレクトリーでアクセスすると、以下のような管理者ログイン画面が表示される。

管理者の作成

createsuperuserコマンドで管理者を作成する。

$ ./manage.py createsuperuser

1	$ ./manage.py createsuperuser

管理者のユーザー名、メールアドレス、パスワードを登録し、管理者アカウント作成。プロンプトの一部が日本語になっている。

(django32) mysite:$ ./manage.py createsuperuser
ユーザー名 (leave blank to use 'vagrant'): admin
メールアドレス: admin@mail.com
Password:
Password (again):
このパスワードは ユーザー名 と似すぎています。
Bypass password validation and create user anyway? [y/N]: y
Superuser created successfully.

(django32) mysite:$ ./manage.py createsuperuser

ユーザー名 (leave blank to use 'vagrant'): admin

メールアドレス: admin@mail.com

Password:

Password (again):

このパスワードはユーザー名と似すぎています。

Bypass password validation and create user anyway? [y/N]: y

Superuser created successfully.

パスワードを'admin'という文字列を含むかなり簡単なものにしたため「ユーザー名と似すぎています」という警告が出たが、ここはyesにしておいた。

管理者ログイン・インデックスページ表示

作成した管理者アカウントでログインすると管理者インデックスページへ。この段階では、pollsアプリケーションが管理者で操作できるようにはなっていない。

管理者へのアプリケーションの登録

管理者がpollsアプリケーションを操作できるようにするために、polls/admin.pyに記述を追加する。

Qustionモデルのインポート
adminサイトにQuestionモデルを登録

admin.pyがpollsパッケージ内にあるのでfrom .models ...としているが、from polls.models ...でもよい。

from django.contrib import admin
from .models import Question

admin.site.register(Question)

from django.contrib import admin

from .models import Question

admin.site.register(Question)

インデックスページを再表示させると、今度はQuestionsが見られるようになった。

データの内容表示

インデックスページのQustionsをクリックすると、登録済みデータが表示される。What’s up?と表示されているのは、models.pyのQuestionクラスで__str__メソッドを定義したおかげで、デフォルトの状態だとQuestion object (1)と表示される。

What’s upをクリックすると、フィールド内容の編集画面に移る。

フィールド名のQustion textとDate publishedは、models.pyのQuestionクラスで定義したフィールド名になっている。

Question textは、クラス定義のプロパティーquestion_textのアンダースコアがスペースに、先頭が大文字に変換されたもの
Date publishedはDateTimeFieldの引数に指定した'date published'の先頭が大文字に変換されたもの

class Question(models.Model):
    question_text = models.CharField(max_length=200)
    pub_date = models.DateTimeField('date published')

    ....

class Question(models.Model):

question_text = models.CharField(max_length=200)

pub_date = models.DateTimeField('date published')

....

たとえば上記の3行目をDateTimeField()とすると、画面表示は元のプロパティー名に即してPub dateとなる。

データの編集

Qustion textとDate publishedの内容を変更して「保存して編集を続ける」ボタンを押すと、変更した内容が反映される。

もちろんデータベース上でも変更されている。

mysql> select* from questions;
+----+---------------+----------------------------+
| id | question_text | pub_date                   |
+----+---------------+----------------------------+
|  1 | What's up??   | 2022-03-20 09:36:26.000000 |
+----+---------------+----------------------------+
1 row in set (0.00 sec)

mysql> select* from questions;

+----+---------------+----------------------------+

| id | question_text | pub_date |

+----+---------------+----------------------------+

| 1 | What's up?? | 2022-03-20 09:36:26.000000 |

+----+---------------+----------------------------+

1 row in set (0.00 sec)

変更履歴

画面右上の「履歴」ボタンを押すと変更履歴画面に移り、Question textとDate publishedが変更された履歴が表示される。

Django Tutorial – Pythonシェル

2022-03-20 / tau / コメントする

概要

Pythonシェルの環境下でモデル操作をしてみる。Pythonドキュメントのチュートリアルの流れに沿っている。Laravelのtinkerでの操作と似ている。

シェルの起動・終了

シェルの起動はmanage.pyのshellコマンド。終了はexit()。

$ ./manage.py shell
Python 3.6.8 (default, Nov 16 2020, 16:55:22)
[GCC 4.8.5 20150623 (Red Hat 4.8.5-44)] on linux
Type "help", "copyright", "credits" or "license" for more information.
(InteractiveConsole)
>>> exit()
$

$ ./manage.py shell

Python 3.6.8 (default, Nov 16 2020, 16:55:22)

[GCC 4.8.5 20150623 (Red Hat 4.8.5-44)] on linux

Type "help", "copyright", "credits" or "license" for more information.

(InteractiveConsole)

>>> exit()

モデルの操作

準備・確認

モデル操作の開始時にモデルのインポートが必要。

from アプリケーション.models import モデルクラス

>>> from polls.models import Choice, Question

1	>>> from polls.models import Choice, Question

タイムゾーン表示のためにtimezoneオブジェクトをインポート。

>>> from django.utils import timezone

1	>>> from django.utils import timezone

timezone.now()で現在時刻を表示してみる。内部的にはUTCで扱われているので、その時点の日本時間とは9時間ずれている。

>>> timezone.now()
datetime.datetime(2022, 3, 18, 8, 52, 16, 897846, tzinfo=<UTC>)

1 2	>>> timezone.now() datetime.datetime(2022, 3, 18, 8, 52, 16, 897846, tzinfo=<UTC>)

モデルの全データの取得。まだデータは登録されていない。

>>> Question.objects.all()
<QuerySet []>

1 2	>>> Question.objects.all() <QuerySet []>

データの作成・保存・編集

作成

Questionモデルのコンストラクターでデータを作成。この段階ではメモリー上に作成されただけで、データベースには保存されていない。

>>> q = Question(question_text="What's new?", pub_date=timezone.now())

1	>>> q = Question(question_text="What's new?", pub_date=timezone.now())

pprintとvarsでデータの内容を確認してみる。

>>> import pprint
>>> pprint.pprint(vars(q))
{'_state': <django.db.models.base.ModelState object at 0x7f423cecf048>,
 'id': None,
 'pub_date': datetime.datetime(2022, 3, 18, 8, 53, 29, 990021, tzinfo=<UTC>),
 'question_text': "What's new?"}

>>> import pprint

>>> pprint.pprint(vars(q))

{'_state': <django.db.models.base.ModelState object at 0x7f423cecf048>,

'id': None,

'pub_date': datetime.datetime(2022, 3, 18, 8, 53, 29, 990021, tzinfo=<UTC>),

'question_text': "What's new?"}

各フィールドを見てみる。まだデータベースに登録されていないので、idは空になっている。

>>> q.id
>>> q.question_text
"What's new?"
>>> q.pub_date
datetime.datetime(2022, 3, 18, 8, 53, 29, 990021, tzinfo=<UTC>)

>>> q.id

>>> q.question_text

"What's new?"

>>> q.pub_date

datetime.datetime(2022, 3, 18, 8, 53, 29, 990021, tzinfo=<UTC>)

保存

save()メソッドでデータベースに保存。

>>> q.save()

1	>>> q.save()

MySQLでテーブルへの保存を確認。

mysql> select * from questions;
+----+---------------+----------------------------+
| id | question_text | pub_date                   |
+----+---------------+----------------------------+
|  1 | What's new?   | 2022-03-18 08:53:29.990021 |
+----+---------------+----------------------------+
1 row in set (0.00 sec)

mysql> select * from questions;

+----+---------------+----------------------------+

| id | question_text | pub_date |

+----+---------------+----------------------------+

| 1 | What's new? | 2022-03-18 08:53:29.990021 |

+----+---------------+----------------------------+

1 row in set (0.00 sec)

データベースに保存されたのでidがセットされた。

>>> q.id
1

1 2	>>> q.id 1

編集

データのquestion_textの内容を書き替えてデータベースに保存。

>>> q.question_text="What's up?"
>>> q.save()

1 2	>>> q.question_text="What's up?" >>> q.save()

データベースを確認して内容が変更されていることを確認。

mysql> select * from questions;
+----+---------------+----------------------------+
| id | question_text | pub_date                   |
+----+---------------+----------------------------+
|  1 | What's up?    | 2022-03-18 08:53:29.990021 |
+----+---------------+----------------------------+
1 row in set (0.00 sec)

mysql> select * from questions;

+----+---------------+----------------------------+

| id | question_text | pub_date |

+----+---------------+----------------------------+

| 1 | What's up? | 2022-03-18 08:53:29.990021 |

+----+---------------+----------------------------+

1 row in set (0.00 sec)

データの取得

Managerオブジェクト

個別のモデルごとにManagerクラスのインスタンスが生成され、モデルのobjectsメンバーとして準備される。データの取得やフィルタリングなど操作は、このインスタンスのメソッドによって行われる。

モデル.objects

all()による全データの読み込み

all()メソッドによってテーブルに登録された全データを読み込める。

モデルクラス.objects.all()

Qustionには1つだけデータが登録されている。

>>> Question.objects.all()
<QuerySet [<Question: Question object (1)>]>

1 2	>>> Question.objects.all() <QuerySet [<Question: Question object (1)>]>

strの定義

データ表示が殺風景なオブジェクトの表示になっているが、これを変更してquestion_textやchoice_textを表示させるようにする。具体的には各モデルに__str__メソッドを定義する。

from django.db import models

class Question(models.Model):
    question_text = models.CharField(max_length=200)
    pub_date = models.DateTimeField('date published')

    def __str__(self):
        return self.question_text
py
    class Meta:
        db_table = 'questions'

class Choice(models.Model):
    question = models.ForeignKey(Question, on_delete=models.CASCADE)
    choice_text = models.CharField(max_length=200)
    votes = models.IntegerField(default=0)

    def __str_(self):
        return self.choice_text

    class Meta:
        db_table = 'choices'

from django.db import models

class Question(models.Model):

question_text = models.CharField(max_length=200)

pub_date = models.DateTimeField('date published')

def __str__(self):

return self.question_text

class Meta:

db_table = 'questions'

class Choice(models.Model):

question = models.ForeignKey(Question, on_delete=models.CASCADE)

choice_text = models.CharField(max_length=200)

votes = models.IntegerField(default=0)

def __str_(self):

return self.choice_text

class Meta:

db_table = 'choices'

これでデータ内容の表示がわかりやすくなった。

>>> Question.objects.all()
<QuerySet [<Question: What's up?>]>

1 2	>>> Question.objects.all() <QuerySet [<Question: What's up?>]>

get()による1つのデータの抽出

get()メソッドで条件を指定してデータを1つ取り出せる。

モデルクラス.objects.get(条件)

idが1のデータを取り出す。

>>> Question.objects.get(id=1)
<Question: What's up?>

1 2	>>> Question.objects.get(id=1) <Question: What's up?>

該当するデータがない場合はModel.DoesNotExist例外、複数のデータが存在する場合はModelMultipuleObjectsReturned例外。以下はDoesNotExistの例。

>>> Question.objects.get(id=2)
Traceback (most recent call last):
  ....
polls.models.Question.DoesNotExist: Question matching query does not exist.

>>> Question.objects.get(id=2)

Traceback (most recent call last):

....

polls.models.Question.DoesNotExist: Question matching query does not exist.

主キー(primary key)を指定してでも取り出せる。Djangoではprimary keyのショートカットとしてpkが準備されている。

>>> Question.objects.get(pk=1)
<Question: What's up?>

1 2	>>> Question.objects.get(pk=1) <Question: What's up?>

フィルターによる抽出

filter()メソッドでデータを抽出できる

モデルクラス.objects.filter(条件)

以下はid=1の条件で抽出した結果で、今回の例の場合はデータを1つ含むQuerySetが得られる。

>>> Question.objects.filter(id=1)
<QuerySet [<Question: What's up?>]>

1 2	>>> Question.objects.filter(id=1) <QuerySet [<Question: What's up?>]>

存在しないidで抽出すると空のQuerySetが得られる。

>>> Question.objects.filter(id=2)
<QuerySet []>

1 2	>>> Question.objects.filter(id=2) <QuerySet []>

文字列の前方一致の抽出例。引数のフィールドにアンダースコアを2つ(‘__‘)連ねて様々な条件を指定できる。フィルターの条件の書き方はこちらに整理した。

フィールド__条件=値

ここではフィールド__startswith='文字列'として、フィールドが指定した文字列で始まるデータを抽出している。

>>> Question.objects.filter(question_text__startswith='What')
<QuerySet [<Question: What's up?>]>

1 2	>>> Question.objects.filter(question_text__startswith='What') <QuerySet [<Question: What's up?>]>

登録の年が同じデータを抽出する例。まず現在日時の年を取り出して変数current_yearにセットして、pub_dateの年がこれに等しいデータをフィルタリング。datetime型のフィールドの年の条件でフィルタリングするにはフィールド名__year=年とする。__yearのアンダースコアは2つ。

>>> current_year = timezone.now().year
>>> Question.objects.filter(pub_date__year=current_year)
<QuerySet [<Question: What's up?>]>

>>> current_year = timezone.now().year

>>> Question.objects.filter(pub_date__year=current_year)

リレーションがあるモデル

親データに属する子データ群

親データに属する(これを参照している)データのManagerオブジェクトを取り出すには以下のように書く。

親データ.小文字の子モデル名_set

たとえば変数qが Questionモデルのid=1のデータを指している状態で、これに属するChoiceデータ群の全てを取り出すと以下のようになる。まだChoiceデータを1つも登録していないので結果は空。

>>> q.choice_set.all()
<QuerySet []>

1 2	>>> q.choice_set.all() <QuerySet []>

親データに属する子データの作成

親データに関連付けられた子データを新たに作成するときは以下のように書く。

親データ.小文字の子モデル名_set.create(...)

qに関連付けられたChoiceデータを3つ登録。

>>> q.choice_set.create(choice_text='Not much', votes=0)
<Choice: Not much>
>>> q.choice_set.create(choice_text='The sky', votes=0)
<Choice: The sky>
>>> q.choice_set.create(choice_text='Just hacking again')
<Choice: Just hacking again>

>>> q.choice_set.create(choice_text='Not much', votes=0)

<Choice: Not much>

>>> q.choice_set.create(choice_text='The sky', votes=0)

<Choice: The sky>

>>> q.choice_set.create(choice_text='Just hacking again')

<Choice: Just hacking again>

MySQLでテーブルの内容を確認すると、Questionテーブルのid=1のデータを参照する3つのデータが登録されている。

mysql> select * from choices;
+----+--------------------+-------+-------------+
| id | choice_text        | votes | question_id |
+----+--------------------+-------+-------------+
|  1 | Not much           |     0 |           1 |
|  2 | The sky            |     0 |           1 |
|  3 | Just hacking again |     0 |           1 |
+----+--------------------+-------+-------------+
3 rows in set (0.00 sec)

mysql> select * from choices;

+----+--------------------+-------+-------------+

+----+--------------------+-------+-------------+

| 1 | Not much | 0 | 1 |

| 2 | The sky | 0 | 1 |

| 3 | Just hacking again | 0 | 1 |

+----+--------------------+-------+-------------+

3 rows in set (0.00 sec)

＜閑話休題＞
“What’s up?”はくだけた言い方の挨拶で「調子はどう？」、「何か(変わりは)あったかい？」といった感じ。”Not much.”は「普通だよ」とか「特にないね」といった常套句のようだ。”The sky.”はupにひっかけて「(上は)空さ」というジョーク表現（無理やり日本語字幕にするなら「何かあったかい？」「暖かいね」とかなどと考えたが単なる駄洒落か・・・）。”Just hacking again.”はよくわからなかった。

子データのall/count/filter

登録されたデータをallメソッドで取り出してみる。

>>> q.choice_set.all()
<QuerySet [<Choice: Not much>, <Choice: The sky>, <Choice: Just hacking again>]>

1 2	>>> q.choice_set.all() <QuerySet [<Choice: Not much>, <Choice: The sky>, <Choice: Just hacking again>]>

データの個数はcountメソッドで。

>>> q.choice_set.count()
3

1 2	>>> q.choice_set.count() 3

子データ群のフィルタリングは通常と同じように指定。

>>> q.choice_set.filter(choice_text__startswith='Not')
<QuerySet [<Choice: Not much>]>
>>> q.choice_set.filter(votes=0)
<QuerySet [<Choice: Not much>, <Choice: The sky>, <Choice: Just hacking again>]>

>>> q.choice_set.filter(choice_text__startswith='Not')

>>> q.choice_set.filter(votes=0)

親データの条件によるフィルタリング

親データの条件でフィルタリングする場合、filter()の中で小文字の親モデル名を使うが、直接以下のように書くとエラーになる。

filter(小文字の親モデル名_フィールド__条件)→エラー

以下の例では、Choiceの親データquestionのquestion_textフィールドの条件でフィルタリング仕様としてエラーになっている。

>>> q.choice_set.filter(question_question_text__startswith='What')
Traceback (most recent call last):
  ....
django.core.exceptions.FieldError: Cannot resolve keyword 'question_question_text' into field.
Choices are: choice_text, id, question, question_id, votes

>>> q.choice_set.filter(question_question_text__startswith='What')

Traceback (most recent call last):

....

django.core.exceptions.FieldError: Cannot resolve keyword 'question_question_text' into field.

Choices are: choice_text, id, question, question_id, votes

親データのフィールドの条件の場合、親データとフィールドの間のアンダーラインを2つにする。

親データ.子データ_set.filter(親データ__フィールド__条件)

たとえばQuestionとChoiceの場合は以下のようになる。

q.choice_set.filter(question__フィールド__条件)

以下はテキストが'What'で始まる親データに属する子データを抽出している。

>>> q.choice_set.filter(question__question_text__startswith='What')
<QuerySet [<Choice: Not much>, <Choice: The sky>, <Choice: Just hacking again>]>

1 2	>>> q.choice_set.filter(question__question_text__startswith='What') <QuerySet [<Choice: Not much>, <Choice: The sky>, <Choice: Just hacking again>]>

以下は登録年が今年の親データに属する子データを抽出している。

>>> q.choice_set.filter(question__pub_date__year=current_year)
<QuerySet [<Choice: Not much>, <Choice: The sky>, <Choice: Just hacking again>]>

1 2	>>> q.choice_set.filter(question__pub_date__year=current_year) <QuerySet [<Choice: Not much>, <Choice: The sky>, <Choice: Just hacking again>]>

データの削除

まずテキストに'huck'(大文字小文字を問わない)を含むchoiceデータをデータベースから得る。

>>> c = q.choice_set.get(choice_text__icontains='hack')
>>> pprint.pprint(vars(c))
{'_state': <django.db.models.base.ModelState object at 0x7efcb4a041d0>,
 'choice_text': 'Just hacking again',
 'id': 3,
 'question_id': 1,
 'votes': 0}

>>> c = q.choice_set.get(choice_text__icontains='hack')

>>> pprint.pprint(vars(c))

{'_state': <django.db.models.base.ModelState object at 0x7efcb4a041d0>,

'choice_text': 'Just hacking again',

'id': 3,

'question_id': 1,

'votes': 0}

そのデータをdeleteメソッドでデータベースから削除。

モデル.delete()

>>> c.delete()
(1, {'polls.Choice': 1})

1 2	>>> c.delete() (1, {'polls.Choice': 1})

MySQLで削除されていることを確認。

mysql> select * from choices;
+----+-------------+-------+-------------+
| id | choice_text | votes | question_id |
+----+-------------+-------+-------------+
|  1 | Not much    |     0 |           1 |
|  2 | The sky     |     0 |           1 |
+----+-------------+-------+-------------+
2 rows in set (0.00 sec)

mysql> select * from choices;

+----+-------------+-------+-------------+

+----+-------------+-------+-------------+

| 1 | Not much | 0 | 1 |

| 2 | The sky | 0 | 1 |

+----+-------------+-------+-------------+

2 rows in set (0.00 sec)

Django – filterの条件

2022-03-19 / tau / コメントする

一致

Case Sensitive

`BINARY field=値` `field=BINARY 値`	`field=値`
	`field__exact=値`

Case Insensitive

field=値 field__iexact=値

大小比較

`field>値`	`field__gt=値`
`field>=値`	`field__gte=値`
`field<値`	`field__lt=値`
`field<=値`	`field__lte=値`

部分一致～LIKE

Case Sensitive

`field LIKE BINARY 'text%'`	`field__startswith='text'`
`field LIKE BINARY '%text'`	`field__endswith='text'`
`field LIKE BINARY '%text%'`	`field__contains='text'`

Case Insensitive

`field LIKE 'text%'`	`field__istartswith='text'`
`field LIKE '%text'`	`field__iendswith='text'`
`field LIKE '%text%'`	`field__icontains='text'`

何れかに一致～IN

field IN (...) field__in=[...]

範囲～BETWEEN

field BETWEEN min AND max field__range=[min, max]

日付の年・月・日の一致

`DATE_FORMAT(date, '%Y') = 'year'`	`date__year=year`
`DATE_FORMAT(date, '%m') = 'month'`	`date__month=month`
`DATE_FORMAT(date, '%d') = 'day'`	`date__day=day`

NULLとの比較

`field IS NULL`	`field__isnull=True`
`field IS NOT NULL`	`field__isnull=False`

Django – django-adminとmanage.pyの基本コマンド

2022-03-18 / tau / コメントする

実行方法

manage.py

プロジェクトルート直下、manage.pyファイルのある場所で実行

$ python3 manage.py コマンド　オプション

または

$ ./manage.py コマンド　オプション

$ python3 manage.py コマンド　オプション

または

$ ./manage.py コマンド　オプション

コマンド

作成・起動

startproject

$ django-admin startproject プロジェクト名

プロジェクト作成

startapp

$ ./manage.py startapp アプリケーション名

アプリケーション作成

runserver

$ ./manage.py runserver [IPアドレス[:ポート]]

開発用サーバーの起動

シェル

shell

$ ./manage.py shell

Pythonシェル起動

dbshell

$ ./manage.py dbshell

settings.pyのDATABASESで設定したDBMSのシェル起動

チェック・確認

check

$ ./manage.py check

プロジェクトの不具合有無のチェック

dumpdata

$ ./manage.py dumpdata

データベースの内容をダンプ

inspectdb

$ ./manage.py inspectdb

モデルクラスの内容を表示

マイグレーション

makemigrations

$ ./manage.py makemigrations

models.pyに基づくマイグレーションファイルの作成

showmigrations

$ ./manage.py showmigrations

マイグレーションファイル・状態の表示

migrate

$ ./manage.py migrate

マイグレーション実行

migrate～ロールバック

$ ./manage.py migrate アプリケーション名　マイグレーション名

アプリケーションのマイグレーションが実行済みのときは手前までロールバック
未実行の時はマイグレーション

その他

$ ./manage.py makemessages

$ ./manage.py compilemessages

$ ./manage.py createsuperuser

$ ./manage.py changepassword

・・・

Django – マイグレーションのテーブル名指定

2022-03-18 / tau / コメントする

概要

Djangoのマイグレーションでテーブルを生成すると、テーブル名は、アプリケーション名とスネークケース化されたモデル名がアンダースコアで繋がれた名前になる。

たとえばアプリケーション名がmy_app、モデル名がMyModelのときのテーブル名はmy_app_mymodelとなる(モデル・テーブル等の名前)。

これが次のような点で気持ち悪い。

単数形のモデル名のままでテーブル名も単数形になる
モデル名がスネークケースにならず区切りがなくなる

この自動で付与されるテーブル名を変更する方法があることを知った(参考サイト：Django モデルのメタクラス)。

クラス定義にclass Metaを加える

アプリケーションとモデルを以下の設定とする。

アプリケーション名	`warehouse`
モデルクラス名	`StockItem`、`ShippingOrder`

これでマイグレーションを実行すると、テーブル名はwarehouse_stockitem、warehose_shippingorderのようになる。これをstock_items、shipping_ordersのように変更したい場合、クラス定義に以下のように追記する。

from django.db import models

class StockItem(models.Model):
    name = models.CharField(max_length=20)
    number = models.IntegerField(default=0)

    class Meta:
        db_table='stock_items'

class ShippingOrder(models.Model):
    stock_item = models.ForeignKey(MyModel1, on_delete=models.CASCADE)
    name = models.CharField(max_length=20)
    number = models.IntegerField(default=0)

    class Meta:
        db_table='shipping_orders'

from django.db import models

class StockItem(models.Model):

name = models.CharField(max_length=20)

number = models.IntegerField(default=0)

class Meta:

db_table='stock_items'

class ShippingOrder(models.Model):

stock_item = models.ForeignKey(MyModel1, on_delete=models.CASCADE)

name = models.CharField(max_length=20)

number = models.IntegerField(default=0)

class Meta:

db_table='shipping_orders'

マイグレーションを実行。

$ python3 manage.py makemigrations
Migrations for 'warehouse':
  my_app/migrations/0001_initial.py
    - Create model StockItem
    - Create model ShippingOrder
$ python3 manage.py migrate
Operations to perform:
  Apply all migrations: admin, auth, contenttypes, my_app, warehouse, sessions
Running migrations:
  Applying my_app.0001_initial... OK

$ python3 manage.py makemigrations

Migrations for 'warehouse':

my_app/migrations/0001_initial.py

- Create model StockItem

- Create model ShippingOrder

$ python3 manage.py migrate

Operations to perform:

Apply all migrations: admin, auth, contenttypes, my_app, warehouse, sessions

Running migrations:

Applying my_app.0001_initial... OK

テーブル確認。

mysql> show tables;
+----------------------------+
| Tables_in_django_tutorial  |
+----------------------------+
| auth_group                 |
| auth_group_permissions     |
| auth_permission            |
| auth_user                  |
| auth_user_groups           |
| auth_user_user_permissions |
| choices                    |
| django_admin_log           |
| django_content_type        |
| django_migrations          |
| django_session             |
| questions                  |
| shipping_orders            |
| stock_items                |
+----------------------------+
14 rows in set (0.00 sec)

mysql> show tables;

+----------------------------+

| Tables_in_django_tutorial |

+----------------------------+

| auth_group |

| auth_group_permissions |

| auth_permission |

| auth_user |

| auth_user_groups |

| auth_user_user_permissions |

| choices |

| django_admin_log |

| django_content_type |

| django_migrations |

| django_session |

| questions |

| shipping_orders |

| stock_items |

+----------------------------+

14 rows in set (0.00 sec)

Django – モデル・テーブル等の名前

2022-03-18 / tau / コメントする

目的

Djangoでアプリケーションとモデルを作成し、マイグレーションした場合の、テーブル名、フィールド名などを確認。アプリケーション名をmy_app、モデルクラス名をMyModel1、MyModel2とする。

なお、自動付与されるテーブル名は変更することが可能。

手順

アプリケーション作成

アプリケーション名はスネークケース(my_app)

$ python3 manage.py startapp my_app

1	$ python3 manage.py startapp my_app

アプリケーション構成クラス名の確認

from django.apps import AppConfig


class MyAppConfig(AppConfig):
    default_auto_field = 'django.db.models.BigAutoField'
    name = 'my_app'

from django.apps import AppConfig

class MyAppConfig(AppConfig):

default_auto_field = 'django.db.models.BigAutoField'

name = 'my_app'

アプリケーション名がスネークケースの場合、アプリケーション構成クラス名はアッパーキャメルケースになり、Configが付加される。

my_app　→　MyAppConfig

アプリケーション登録

settings.pyのINSTALL_APPSにアプリケーション構成クラスを追加。ここではアプリケーション構成クラスを追加している。

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'my_app.apps.MyAppConfig',
]

INSTALLED_APPS = [

'django.contrib.admin',

'django.contrib.auth',

'django.contrib.contenttypes',

'django.contrib.sessions',

'django.contrib.messages',

'django.contrib.staticfiles',

'my_app.apps.MyAppConfig',

]

モデル定義

my_apps/models.pyファイルで2つのモデルクラスMyModel1、MyModel2を定義。MyModel2にはMyModel1への参照キーを設定する。

from django.db import models

class MyModel1(models.Model):
    name = models.CharField(max_length=20)

class MyModel2(models.Model):
    my_model1 = models.ForeignKey(MyModel1, on_delete=models.CASCADE)
    name = models.CharField(max_length=20)

from django.db import models

class MyModel1(models.Model):

name = models.CharField(max_length=20)

class MyModel2(models.Model):

my_model1 = models.ForeignKey(MyModel1, on_delete=models.CASCADE)

name = models.CharField(max_length=20)

マイグレーションファイル作成

$ python3 manage.py makemigrations my_app
Migrations for 'my_app':
  my_app/migrations/0001_initial.py
    - Create model MyModel1
    - Create model MyModel2

$ python3 manage.py makemigrations my_app

Migrations for 'my_app':

my_app/migrations/0001_initial.py

- Create model MyModel1

- Create model MyModel2

マイグレーション

マイグレーションを実行してテーブルを生成させる。

$ python3 manage.py migrate
Operations to perform:
  Apply all migrations: admin, auth, contenttypes, my_app, sessions
Running migrations:
  Applying my_app.0001_initial... OK

$ python3 manage.py migrate

Operations to perform:

Apply all migrations: admin, auth, contenttypes, my_app, sessions

Running migrations:

Applying my_app.0001_initial... OK

テーブル確認

テーブル名は’アプリケーション名_小文字化されたモデル名‘となる。キャメルケースのモデル名をスネークケースにはしてくれない。

my_app + MyModel1　→　my_app_mymodel1
my_app + MyModel2　→　my_app_mymodel2

mysql> show tables;
+----------------------------+
| Tables_in_django_tutorial  |
+----------------------------+
| auth_group                 |
| auth_group_permissions     |
| auth_permission            |
| auth_user                  |
| auth_user_groups           |
| auth_user_user_permissions |
| choices                    |
| django_admin_log           |
| django_content_type        |
| django_migrations          |
| django_session             |
| my_app_mymodel1            |
| my_app_mymodel2            |
| questions                  |
+----------------------------+
14 rows in set (0.00 sec)

mysql> show tables;

+----------------------------+

| Tables_in_django_tutorial |

+----------------------------+

| auth_group |

| auth_group_permissions |

| auth_permission |

| auth_user |

| auth_user_groups |

| auth_user_user_permissions |

| choices |

| django_admin_log |

| django_content_type |

| django_migrations |

| django_session |

| my_app_mymodel1 |

| my_app_mymodel2 |

| questions |

+----------------------------+

14 rows in set (0.00 sec)

テーブル構造を確認。

MyModel2の外部キーは、’参照先モデル名(スネークケース)_id‘となる。この場合は参照先がMyModel1なので、

MyModel1　→　my_model1_id

mysql> describe my_app_mymodel1;
+-------+-------------+------+-----+---------+----------------+
| Field | Type        | Null | Key | Default | Extra          |
+-------+-------------+------+-----+---------+----------------+
| id    | bigint      | NO   | PRI | NULL    | auto_increment |
| name  | varchar(20) | NO   |     | NULL    |                |
+-------+-------------+------+-----+---------+----------------+
2 rows in set (0.01 sec)

mysql> describe my_app_mymodel2;
+--------------+-------------+------+-----+---------+----------------+
| Field        | Type        | Null | Key | Default | Extra          |
+--------------+-------------+------+-----+---------+----------------+
| id           | bigint      | NO   | PRI | NULL    | auto_increment |
| name         | varchar(20) | NO   |     | NULL    |                |
| my_model1_id | bigint      | NO   | MUL | NULL    |                |
+--------------+-------------+------+-----+---------+----------------+
3 rows in set (0.00 sec)

mysql> describe my_app_mymodel1;

+-------+-------------+------+-----+---------+----------------+

+-------+-------------+------+-----+---------+----------------+

| id | bigint | NO | PRI | NULL | auto_increment |

+-------+-------------+------+-----+---------+----------------+

2 rows in set (0.01 sec)

mysql> describe my_app_mymodel2;

+--------------+-------------+------+-----+---------+----------------+

+--------------+-------------+------+-----+---------+----------------+

| id | bigint | NO | PRI | NULL | auto_increment |

+--------------+-------------+------+-----+---------+----------------+

3 rows in set (0.00 sec)

まとめ

これを表で整理すると以下のようになる。

	`my_app`
アプリケーション構成クラス名（生成）	`MyAppConfig`
モデルクラス名（定義）	`MyModel1`	`MyModel2`
テーブル名（マイグレーション）	`my_app_mymodel1`	`my_app_mymodel2`
外部キー名（マイグレーション）		`my_model1_id`

これを何とか図にすると、以下のようになる。

アプリケーション：my_app　→　MyAppConfig
　　　　　　　　　｜
　　　　　　　　　└──┐
　　　　　　　　　　　　↓
モデルクラス：MyModel1　─→　テーブル：my_app_mymodel1　─┐
　　　　　　　　　　　　　　　　　　　　　　　　　　　　　 ↓　
モデルクラス：MyModel2　─→　テーブル：my_app_mymodel2　──→　外部キー：my_model1_id

アプリケーション：my_app　→　MyAppConfig

　　　　　　　　　｜

　　　　　　　　　└──┐

　　　　　　　　　　　　↓

モデルクラス：MyModel1　─→　テーブル：my_app_mymodel1　─┐

　　　　　　　　　　　　　　　　　　　　　　　　　　　　　 ↓　

モデルクラス：MyModel2　─→　テーブル：my_app_mymodel2　──→　外部キー：my_model1_id

まとめると以下のようになる。

アプリケーション名：スネークケース
→アプリケーション構成クラス名：アッパーキャメルケース
モデルクラス名：アッパーキャメルケース
テーブル名：アプリケーション名_小文字化されたアプリケーション構成クラス名
外部キー名：参照先のモデル名(スネークケース)_id

Django – settings.py – INSTALLED_APPS

2022-03-18 / tau / コメントする

概要

settings.pyのINSTALLED_APPS配列でアプリケーションを登録する。

Django – settings.pyへ。

デフォルトの内容

プロジェクト作成直後のsettings.pyにおけるINSTALLED_APPSの内容は以下の通り。コメントはこちらで追記。

INSTALLED_APPS = [
    'django.contrib.admin',        // 管理者サイト
    'django.contrib.auth',         // 認証システム、Userモデル
    'django.contrib.contenttypes', // ContentTypeモデル
    'django.contrib.sessions',     // セッションフレームワーク、Sssionモデル
    'django.contrib.messages',     // メッセージフレームワーク、
    'django.contrib.staticfiles',  // 静的ファイルのフレームワーク
]

INSTALLED_APPS = [

'django.contrib.admin', // 管理者サイト

'django.contrib.auth', // 認証システム、Userモデル

'django.contrib.contenttypes', // ContentTypeモデル

'django.contrib.sessions', // セッションフレームワーク、Sssionモデル

'django.contrib.messages', // メッセージフレームワーク、

'django.contrib.staticfiles', // 静的ファイルのフレームワーク

]

アプリケーションの登録

アプリケーション登録のためには、アプリケーション構成クラスを登録するが、書き方には2通りある。登録するアプリケーションをmy_appとすると、以下の通り。

'my_app.apps.MyAppConfig',
'my_app',

1の書き方は、明示的にアプリケーション構成クラスを書く方法。

manage.pyでアプリケーションを作成するとmy_appディレクトリ下にapps.pyファイルが作成され、アプリケーション構成クラスが定義される。

from django.apps import AppConfig


class MyAppConfig(AppConfig):
    default_auto_field = 'django.db.models.BigAutoField'
    name = 'my_app'

from django.apps import AppConfig

class MyAppConfig(AppConfig):

default_auto_field = 'django.db.models.BigAutoField'

name = 'my_app'

アプリケーション構成クラス(MyAppConfig)はAppConfigを継承している。またアプリケーション名のスネークケースがクラス名ではアッパーキャメルケースになり、Configが付加されている(モデル・テーブル等の名前を参照)。

2の書き方は、アプリケーションパッケージ名を書く方法。

この場合Djangoはmy_appパッケージのmy_app/__init__.py内のdefault_app_config変数で設定されたアプリケーション構成クラスを使う。

デフォルト状態で__init__.pyが空の場合、AppConfigクラスが使われる
__init__.pyにdefault_app_config='my_app.apps.MyAppConfig'が設定されていれば、apps.py内のMyAppConfigが使われる

参考サイト：Django アプリケーションの登録

Django – migration – 初期状態

2022-03-18 / tau / コメントする

概要

プロジェクト作成直後のマイグレーションを記録。

初期状態

プロジェクト作成直後のマイグレーションの状態は以下のとおりで、INSTALLED_APPSで設定されたアプリケーションに対応したマイグレーションファイルが準備されている。

$ python3 manage.py showmigrations
admin
 [ ] 0001_initial
 [ ] 0002_logentry_remove_auto_add
 [ ] 0003_logentry_add_action_flag_choices
auth
 [ ] 0001_initial
 [ ] 0002_alter_permission_name_max_length
 [ ] 0003_alter_user_email_max_length
 [ ] 0004_alter_user_username_opts
 [ ] 0005_alter_user_last_login_null
 [ ] 0006_require_contenttypes_0002
 [ ] 0007_alter_validators_add_error_messages
 [ ] 0008_alter_user_username_max_length
 [ ] 0009_alter_user_last_name_max_length
 [ ] 0010_alter_group_name_max_length
 [ ] 0011_update_proxy_permissions
 [ ] 0012_alter_user_first_name_max_length
contenttypes
 [ ] 0001_initial
 [ ] 0002_remove_content_type_name
sessions
 [ ] 0001_initial

$ python3 manage.py showmigrations

admin

[ ] 0001_initial

[ ] 0002_logentry_remove_auto_add

[ ] 0003_logentry_add_action_flag_choices

auth

[ ] 0001_initial

[ ] 0002_alter_permission_name_max_length

[ ] 0003_alter_user_email_max_length

[ ] 0004_alter_user_username_opts

[ ] 0005_alter_user_last_login_null

[ ] 0006_require_contenttypes_0002

[ ] 0007_alter_validators_add_error_messages

[ ] 0008_alter_user_username_max_length

[ ] 0009_alter_user_last_name_max_length

[ ] 0010_alter_group_name_max_length

[ ] 0011_update_proxy_permissions

[ ] 0012_alter_user_first_name_max_length

contenttypes

[ ] 0001_initial

[ ] 0002_remove_content_type_name

sessions

[ ] 0001_initial

マイグレーション実行

初期状態でマイグレーションを実行。

$ python3 manage.py migrate
Operations to perform:
  Apply all migrations: admin, auth, contenttypes, sessions
Running migrations:
  Applying contenttypes.0001_initial... OK
  Applying auth.0001_initial... OK
  Applying admin.0001_initial... OK
  Applying admin.0002_logentry_remove_auto_add... OK
  Applying admin.0003_logentry_add_action_flag_choices... OK
  Applying contenttypes.0002_remove_content_type_name... OK
  Applying auth.0002_alter_permission_name_max_length... OK
  Applying auth.0003_alter_user_email_max_length... OK
  Applying auth.0004_alter_user_username_opts... OK
  Applying auth.0005_alter_user_last_login_null... OK
  Applying auth.0006_require_contenttypes_0002... OK
  Applying auth.0007_alter_validators_add_error_messages... OK
  Applying auth.0008_alter_user_username_max_length... OK
  Applying auth.0009_alter_user_last_name_max_length... OK
  Applying auth.0010_alter_group_name_max_length... OK
  Applying auth.0011_update_proxy_permissions... OK
  Applying auth.0012_alter_user_first_name_max_length... OK
  Applying sessions.0001_initial... OK

$ python3 manage.py migrate

Operations to perform:

Apply all migrations: admin, auth, contenttypes, sessions

Running migrations:

Applying contenttypes.0001_initial... OK

Applying auth.0001_initial... OK

Applying admin.0001_initial... OK

Applying admin.0002_logentry_remove_auto_add... OK

Applying admin.0003_logentry_add_action_flag_choices... OK

Applying contenttypes.0002_remove_content_type_name... OK

Applying auth.0002_alter_permission_name_max_length... OK

Applying auth.0003_alter_user_email_max_length... OK

Applying auth.0004_alter_user_username_opts... OK

Applying auth.0005_alter_user_last_login_null... OK

Applying auth.0006_require_contenttypes_0002... OK

Applying auth.0007_alter_validators_add_error_messages... OK

Applying auth.0008_alter_user_username_max_length... OK

Applying auth.0009_alter_user_last_name_max_length... OK

Applying auth.0010_alter_group_name_max_length... OK

Applying auth.0011_update_proxy_permissions... OK

Applying auth.0012_alter_user_first_name_max_length... OK

Applying sessions.0001_initial... OK

作成されるテーブル

mysql> show tables;
+----------------------------+
| Tables_in_django_tutorial  |
+----------------------------+
| auth_group                 |
| auth_group_permissions     |
| auth_permission            |
| auth_user                  |
| auth_user_groups           |
| auth_user_user_permissions |
| django_admin_log           |
| django_content_type        |
| django_migrations          |
| django_session             |
+----------------------------+
10 rows in set (0.00 sec)

mysql> show tables;

+----------------------------+

| Tables_in_django_tutorial |

+----------------------------+

| auth_group |

| auth_group_permissions |

| auth_permission |

| auth_user |

| auth_user_groups |

| auth_user_user_permissions |

| django_admin_log |

| django_content_type |

| django_migrations |

| django_session |

+----------------------------+

10 rows in set (0.00 sec)

マイグレーションの状態

初期状態で確認したマイグレーションが実行されている。

$ python3 manage.py showmigrations
admin
 [X] 0001_initial
 [X] 0002_logentry_remove_auto_add
 [X] 0003_logentry_add_action_flag_choices
auth
 [X] 0001_initial
 [X] 0002_alter_permission_name_max_length
 [X] 0003_alter_user_email_max_length
 [X] 0004_alter_user_username_opts
 [X] 0005_alter_user_last_login_null
 [X] 0006_require_contenttypes_0002
 [X] 0007_alter_validators_add_error_messages
 [X] 0008_alter_user_username_max_length
 [X] 0009_alter_user_last_name_max_length
 [X] 0010_alter_group_name_max_length
 [X] 0011_update_proxy_permissions
 [X] 0012_alter_user_first_name_max_length
contenttypes
 [X] 0001_initial
 [X] 0002_remove_content_type_name
sessions
 [X] 0001_initial

$ python3 manage.py showmigrations

admin

[X] 0001_initial

[X] 0002_logentry_remove_auto_add

[X] 0003_logentry_add_action_flag_choices

auth

[X] 0001_initial

[X] 0002_alter_permission_name_max_length

[X] 0003_alter_user_email_max_length

[X] 0004_alter_user_username_opts

[X] 0005_alter_user_last_login_null

[X] 0006_require_contenttypes_0002

[X] 0007_alter_validators_add_error_messages

[X] 0008_alter_user_username_max_length

[X] 0009_alter_user_last_name_max_length

[X] 0010_alter_group_name_max_length

[X] 0011_update_proxy_permissions

[X] 0012_alter_user_first_name_max_length

contenttypes

[X] 0001_initial

[X] 0002_remove_content_type_name

sessions

[X] 0001_initial

Django Tutorial – モデルの作成とマイグレーション

2022-03-18 / tau / コメントする

概要

Djangoのモデル作成について、チュートリアルに沿って進めた内容の整理。mysiteプロジェクトのpollアプリケーションのモデルを作成する手順。

前提

mysiteプロジェクト作成・初期設定済み
pollsアプリケーション作成済み

手順

models.pyを編集し、モデルクラスを記述
- models.pyはアプリケーションディレクトリー下
- モデルクラスの内容＝テーブルのフィールド構成
settings.pyのINSTALLED_APPSにアプリケーション登録
- アプリケーション構成クラスを追加
manage.py makemigrationsコマンドでマイグレーションファイルの準備
- 必要ならmanage.py sqlmigrateでSQLを確認
マイグレーション実行

models.pyの編集

モデルはデータベースの操作をラップし、DBMSによる差異を吸収する。

Djangoでは、モデルはアプリケーションごとに作成する
モデルの構造はPythonのクラスとして記述する
モデルの記述場所はアプリケーションディレクトリー下のmodels.py

以下のツリーでmodels.pyの場所を確認しておく。

mysite
├── config
│   ├── __init__.py
│   ├── asgi.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
├── manage.py
└── polls
     ├── __init__.py
     ├── admin.py
     ├── apps.py
     ├── migrations
     │   ├── 0001_initial.py
     │   └── __init__.py
     ├── models.py
     ├── tests.py
     ├── urls.py
     └── views.py

mysite

├── config

│ ├── __init__.py

│ ├── asgi.py

│ ├── settings.py

│ ├── urls.py

│ └── wsgi.py

├── manage.py

└── polls

├── __init__.py

├── admin.py

├── apps.py

├── migrations

│ ├── 0001_initial.py

│ └── __init__.py

├── models.py

├── tests.py

├── urls.py

└── views.py

アプリケーション作成直後のmodels.pyファイルの内容は以下のとおり。モデルが継承するmodelsパッケージをインポートしている。

from django.db import models

# Create your models here.

from django.db import models

# Create your models here.

QustionモデルとChoiceモデルを作成するため、models.pyを以下のように編集。

from django.db import models

class Question(models.Model):
    question_text = models.CharField(max_length=200)
    pub_date = models.DateTimeField('date published')

class Choice(models.Model):
    question = models.ForeignKey(Question, on_delete=models.CASCADE)
    choice_text = models.CharField(max_length=200)
    votes = models.IntegerField(default=0)

from django.db import models

class Question(models.Model):

question_text = models.CharField(max_length=200)

pub_date = models.DateTimeField('date published')

class Choice(models.Model):

question = models.ForeignKey(Question, on_delete=models.CASCADE)

choice_text = models.CharField(max_length=200)

votes = models.IntegerField(default=0)

要点は以下のとおり。

モデル名は単数形でQustionとChoiceの2つ
各モデルはdjango.db.models.Modelクラスを継承
各モデルクラスのフィールドはmodelsパッケージのField関係クラスのインスタンス
- たとえばCharFieldは文字列フィールド、DateTimeFieldはdatetime型のフィールドなど
こちらで定義したquestion_text、pub_dateなどのフィールド名はPythonのコードで扱われるとともに、データベースのフィールド名としても使われる
各Fieldコンストラクターの第1引数では、より人が読みやすいフィールド名を付けることができる
- 上の例では'date published'
Fieldによっては必須の引数があり、たとえばCharFieldのmax_lengthは必須であり、データベースフィールド定義のほか、バリデーションにも使われる
ForeignKeyは外部キーであり、Choiceモデルのquestionフィールドは1つのQuestionモデルを参照する
- また参照元の削除に伴って削除される設定もされている

なお、自動作成されるテーブル名を変更したい場合はここを参照。

アプリケーションの追加

pollsアプリケーションを作成してモデルを定義したが、これらはまだDjangoのプロジェクトには認識されていない。プロジェクトとしてモデルとデータベースを結びつけるマイグレーションのためには、アプリケーションをプロジェクトに登録する必要がある。

アプリケーション登録のために、settings.pyのINSTALLED_APPSに記述を加える。ここではアプリケーション構成クラスを追加する。

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'polls.apps.PollsConfig',
]

INSTALLED_APPS = [

'django.contrib.admin',

'django.contrib.auth',

'django.contrib.contenttypes',

'django.contrib.sessions',

'django.contrib.messages',

'django.contrib.staticfiles',

'polls.apps.PollsConfig',

]

ここではpollsアプリケーションのPollsConfigクラスを登録している。このクラスはアプリケーション作成時にDjangoにより生成、アプリケーションのapps.pyファイルで定義されていて、AppConfigクラスを継承している。

pollsアプリケーションの場合はpolls.apps.PollsConfigとして参照される。

from django.apps import AppConfig


class PollsConfig(AppConfig):
    default_auto_field = 'django.db.models.BigAutoField'
    name = 'polls'

from django.apps import AppConfig

class PollsConfig(AppConfig):

default_auto_field = 'django.db.models.BigAutoField'

name = 'polls'

マイグレーションファイル作成

マイグレーションファイルの作成は以下のコマンドで実行。

$ python3 manage.py makemigrations アプリケーション

1	$ python3 manage.py makemigrations アプリケーション

以下はpollsアプリケーションの実行結果で、アプリケーションのmigrationsディレクトリーにマイグレーションファイル(0001_initial.py)が作成され、マイグレーションによりQuestionとChoiceの2つのモデルが作成されることが表示されている。

$ python3 manage.py makemigrations polls
Migrations for 'polls':
  polls/migrations/0001_initial.py
    - Create model Question
    - Create model Choice

$ python3 manage.py makemigrations polls

Migrations for 'polls':

polls/migrations/0001_initial.py

- Create model Question

- Create model Choice

0001_initial.pyファイルの内容を見てみる。

# Generated by Django 3.2.12 on 2022-03-17 05:08

from django.db import migrations, models
import django.db.models.deletion


class Migration(migrations.Migration):

    initial = True

    dependencies = [
    ]

    operations = [
        migrations.CreateModel(
            name='Question',
            fields=[
                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                ('question_text', models.CharField(max_length=200)),
                ('pub_date', models.DateTimeField(verbose_name='date published')),
            ],
        ),
        migrations.CreateModel(
            name='Choice',
            fields=[
                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                ('choice_text', models.CharField(max_length=200)),
                ('votes', models.IntegerField(default=0)),
                ('question', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='polls.question')),
            ],
        ),
    ]

# Generated by Django 3.2.12 on 2022-03-17 05:08

from django.db import migrations, models

import django.db.models.deletion

class Migration(migrations.Migration):

initial = True

dependencies = [

]

operations = [

migrations.CreateModel(

name='Question',

fields=[

('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),

('question_text', models.CharField(max_length=200)),

('pub_date', models.DateTimeField(verbose_name='date published')),

migrations.CreateModel(

name='Choice',

fields=[

('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),

('choice_text', models.CharField(max_length=200)),

('votes', models.IntegerField(default=0)),

('question', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='polls.question')),

]

2つのモデルとも、クラス定義にはなかったidフィールドが追加されている。これらのフィールドはAUTO_INCREMENTタイプで自動的に作成され、主キー(primary_key)として設定されている。

SQLの確認

マイグレーションファイルの内容でデータベースのテーブルを作成する際のSQLも確認することができる。

$ python3 manage.py sqlmigrate アプリケーション 番号

1	$ python3 manage.py sqlmigrate アプリケーション番号

以下はpollsアプリケーションのマイグレーションファイルをSQLで確認した結果。

$ python3 manage.py sqlmigrate polls 0001
--
-- Create model Question
--
CREATE TABLE `polls_question` (`id` bigint AUTO_INCREMENT NOT NULL PRIMARY KEY, `question_text` varchar(200) NOT NULL, `pub_date` datetime(6) NOT NULL);
--
-- Create model Choice
--
CREATE TABLE `polls_choice` (`id` bigint AUTO_INCREMENT NOT NULL PRIMARY KEY, `choice_text` varchar(200) NOT NULL, `votes` integer NOT NULL, `question_id` bigint NOT NULL);
ALTER TABLE `polls_choice` ADD CONSTRAINT `polls_choice_question_id_c5b4b260_fk_polls_question_id` FOREIGN KEY (`question_id`) REFERENCES `polls_question` (`id`);

$ python3 manage.py sqlmigrate polls 0001

-- Create model Question

CREATE TABLE `polls_question` (`id` bigint AUTO_INCREMENT NOT NULL PRIMARY KEY, `question_text` varchar(200) NOT NULL, `pub_date` datetime(6) NOT NULL);

-- Create model Choice

CREATE TABLE `polls_choice` (`id` bigint AUTO_INCREMENT NOT NULL PRIMARY KEY, `choice_text` varchar(200) NOT NULL, `votes` integer NOT NULL, `question_id` bigint NOT NULL);

ALTER TABLE `polls_choice` ADD CONSTRAINT `polls_choice_question_id_c5b4b260_fk_polls_question_id` FOREIGN KEY (`question_id`) REFERENCES `polls_question` (`id`);

読み易いように整形した結果。

--
-- Create model Question
--
CREATE TABLE `polls_question` (
    `id` bigint AUTO_INCREMENT NOT NULL PRIMARY KEY,
    `question_text` varchar(200) NOT NULL,
    `pub_date` datetime(6) NOT NULL
);
--
-- Create model Choice
--
CREATE TABLE `polls_choice` (
    `id` bigint AUTO_INCREMENT NOT NULL PRIMARY KEY,
    `choice_text` varchar(200) NOT NULL,
    `votes` integer NOT NULL,
    `question_id` bigint NOT NULL
);
ALTER TABLE `polls_choice`
    ADD CONSTRAINT `polls_choice_question_id_c5b4b260_fk_polls_question_id`
    FOREIGN KEY (`question_id`)
    REFERENCES `polls_question` (`id`);

-- Create model Question

CREATE TABLE `polls_question` (

`id` bigint AUTO_INCREMENT NOT NULL PRIMARY KEY,

`question_text` varchar(200) NOT NULL,

`pub_date` datetime(6) NOT NULL

);

-- Create model Choice

CREATE TABLE `polls_choice` (

`id` bigint AUTO_INCREMENT NOT NULL PRIMARY KEY,

`choice_text` varchar(200) NOT NULL,

`votes` integer NOT NULL,

`question_id` bigint NOT NULL

);

ALTER TABLE `polls_choice`

ADD CONSTRAINT `polls_choice_question_id_c5b4b260_fk_polls_question_id`

FOREIGN KEY (`question_id`)

REFERENCES `polls_question` (`id`);

MySQLの場合、

自動的に作成されたidのAUTO_INCREMENT、PRIMARY KEYが設定されている
CharField(max_length=200)がvarchar(200)となっている
datetime(6)の引数6は秒未満の小数部の桁数
モデルクラスではChoice.questionがQuestionを参照するよう定義したが、SQLではpolls_choiceテーブルのquestion_idがpolls_questionテーブルのidを参照するという風に、IDを介して参照している

マイグレーション実行

生成されたマイグレーションファイルに基づいて、以下のコマンドでマイグレーションを実行。

$ python3 manage.py migrate (アプリケーション)

1	$ python3 manage.py migrate (アプリケーション)

以下は今回の例で実行した結果。

$ python3 manage.py migrate
Operations to perform:
  Apply all migrations: admin, auth, contenttypes, polls, sessions
Running migrations:
  Applying polls.0001_initial... OK

$ python3 manage.py migrate

Operations to perform:

Apply all migrations: admin, auth, contenttypes, polls, sessions

Running migrations:

Applying polls.0001_initial... OK

manage.py showmigrationsで、pollsアプリケーションのマイグレーションファイルが実行されているのが確認できる。

$ python3 manage.py showmigrations
admin
 [X] 0001_initial
 [X] 0002_logentry_remove_auto_add
 [X] 0003_logentry_add_action_flag_choices
auth
 [X] 0001_initial
 [X] 0002_alter_permission_name_max_length
 [X] 0003_alter_user_email_max_length
 [X] 0004_alter_user_username_opts
 [X] 0005_alter_user_last_login_null
 [X] 0006_require_contenttypes_0002
 [X] 0007_alter_validators_add_error_messages
 [X] 0008_alter_user_username_max_length
 [X] 0009_alter_user_last_name_max_length
 [X] 0010_alter_group_name_max_length
 [X] 0011_update_proxy_permissions
 [X] 0012_alter_user_first_name_max_length
contenttypes
 [X] 0001_initial
 [X] 0002_remove_content_type_name
polls
 [X] 0001_initial
sessions
 [X] 0001_initial

$ python3 manage.py showmigrations

admin

[X] 0001_initial

[X] 0002_logentry_remove_auto_add

[X] 0003_logentry_add_action_flag_choices

auth

[X] 0001_initial

[X] 0002_alter_permission_name_max_length

[X] 0003_alter_user_email_max_length

[X] 0004_alter_user_username_opts

[X] 0005_alter_user_last_login_null

[X] 0006_require_contenttypes_0002

[X] 0007_alter_validators_add_error_messages

[X] 0008_alter_user_username_max_length

[X] 0009_alter_user_last_name_max_length

[X] 0010_alter_group_name_max_length

[X] 0011_update_proxy_permissions

[X] 0012_alter_user_first_name_max_length

contenttypes

[X] 0001_initial

[X] 0002_remove_content_type_name

polls

[X] 0001_initial

sessions

[X] 0001_initial

MySQL側でテーブルを確認。2つのテーブルpolls_question、polls_choiceが作成されている。

mysql> show tables;
+----------------------------+
| Tables_in_django_tutorial  |
+----------------------------+
| auth_group                 |
| auth_group_permissions     |
| auth_permission            |
| auth_user                  |
| auth_user_groups           |
| auth_user_user_permissions |
| django_admin_log           |
| django_content_type        |
| django_migrations          |
| django_session             |
| polls_choice               |
| polls_question             |
+----------------------------+
12 rows in set (0.00 sec)

mysql> show tables;

+----------------------------+

| Tables_in_django_tutorial |

+----------------------------+

| auth_group |

| auth_group_permissions |

| auth_permission |

| auth_user |

| auth_user_groups |

| auth_user_user_permissions |

| django_admin_log |

| django_content_type |

| django_migrations |

| django_session |

| polls_choice |

| polls_question |

+----------------------------+

12 rows in set (0.00 sec)

2つのテーブルの定義を確認。

mysql> describe polls_question;
+---------------+--------------+------+-----+---------+----------------+
| Field         | Type         | Null | Key | Default | Extra          |
+---------------+--------------+------+-----+---------+----------------+
| id            | bigint       | NO   | PRI | NULL    | auto_increment |
| question_text | varchar(200) | NO   |     | NULL    |                |
| pub_date      | datetime(6)  | NO   |     | NULL    |                |
+---------------+--------------+------+-----+---------+----------------+
3 rows in set (0.00 sec)

mysql> describe polls_choice;
+-------------+--------------+------+-----+---------+----------------+
| Field       | Type         | Null | Key | Default | Extra          |
+-------------+--------------+------+-----+---------+----------------+
| id          | bigint       | NO   | PRI | NULL    | auto_increment |
| choice_text | varchar(200) | NO   |     | NULL    |                |
| votes       | int          | NO   |     | NULL    |                |
| question_id | bigint       | NO   | MUL | NULL    |                |
+-------------+--------------+------+-----+---------+----------------+
4 rows in set (0.00 sec)

mysql> describe polls_question;

+---------------+--------------+------+-----+---------+----------------+

+---------------+--------------+------+-----+---------+----------------+

| id | bigint | NO | PRI | NULL | auto_increment |

+---------------+--------------+------+-----+---------+----------------+

3 rows in set (0.00 sec)

mysql> describe polls_choice;

+-------------+--------------+------+-----+---------+----------------+

+-------------+--------------+------+-----+---------+----------------+

| id | bigint | NO | PRI | NULL | auto_increment |

| votes | int | NO | | NULL | |

+-------------+--------------+------+-----+---------+----------------+

4 rows in set (0.00 sec)

概要

プロジェクトの作成

pollsアプリケーションの作成

view関数の定義

URL conf～ルーティング

確認

概要

管理者ログインページ

管理者の作成

管理者ログイン・インデックスページ表示

管理者へのアプリケーションの登録

データの内容表示

データの編集

変更履歴

概要

シェルの起動・終了

モデルの操作

準備・確認

データの作成・保存・編集

作成

保存

編集

データの取得

Managerオブジェクト

all()による全データの読み込み

__str__の定義

get()による1つのデータの抽出

フィルターによる抽出

リレーションがあるモデル

親データに属する子データ群

親データに属する子データの作成

子データのall/count/filter

親データの条件によるフィルタリング

データの削除

一致

Case Sensitive

Case Insensitive

大小比較

部分一致～LIKE

Case Sensitive

Case Insensitive

何れかに一致～IN

範囲～BETWEEN

日付の年・月・日の一致

NULLとの比較

実行方法

manage.py

コマンド

作成・起動

シェル

チェック・確認

マイグレーション

その他

概要

クラス定義にclass Metaを加える

目的

手順

アプリケーション作成

アプリケーション構成クラス名の確認

アプリケーション登録

モデル定義

マイグレーションファイル作成

マイグレーション

テーブル確認

まとめ

概要

デフォルトの内容

アプリケーションの登録

概要

初期状態

マイグレーション実行

作成されるテーブル

マイグレーションの状態

概要

models.pyの編集

アプリケーションの追加

マイグレーションファイル作成

SQLの確認

マイグレーション実行

strの定義