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)

Django – マイグレーション操作

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

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

アプリケーションを作成・登録して、model.pyにモデルクラスを記述した後に実行。再実行の際は一度マイグレーションファイルを消した方がよい模様。

$ python3 manage.py makemigrations

1	$ python3 manage.py makemigrations

状態確認

マイグレーションの状態

$ python3 manage.py showmigrations

1	$ python3 manage.py showmigrations

マイグレーション実行のSQL表示

$ python3 manage.py sqlmigrate (アプリケーション名 マイグレーション名)

1	$ python3 manage.py sqlmigrate (アプリケーション名マイグレーション名)

マイグレーション

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

指定したアプリケーションとマイグレーションが既にマイグレーション済みの場合はロールバックになる点に注意。

$ python3 manage.py migration (アプリケーション名 マイグレーション名)

1	$ python3 manage.py migration (アプリケーション名マイグレーション名)

ロールバック

指定したマイグレーションの手前まで

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

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

0001_initialも含めて全て

$ python3 manage.py migrate アプリケーション名 zero

1	$ python3 manage.py migrate アプリケーション名 zero

マイグレーションファイル削除

migrationsディレクトリー下のマイグレーションファイルとキャッシュを削除。

Django – settings.py – TEMPLATES

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

概要

settings.pyのTEMPLATESは配列・辞書の入れ子になっている。

'DIRS': プロジェクトルート直下のテンプレートディレクトリーを指定する。そのサブディレクトリーも探索される。
'APP_DIRS': アプリケーションディレクトリー下のテンプレートディレクトリー探索を有効にする。そのサブディレクトリーも探索される。

Django – settings.pyへ。

テンプレートの探索場所の詳細についてはこちら。

初期状態

settings.py生成直後のTEMPLATESの内容は以下のとおり。

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]

TEMPLATES = [

{

'BACKEND': 'django.template.backends.django.DjangoTemplates',

'DIRS': [],

'APP_DIRS': True,

'OPTIONS': {

'context_processors': [

'django.template.context_processors.debug',

'django.template.context_processors.request',

'django.contrib.auth.context_processors.auth',

'django.contrib.messages.context_processors.messages',

]

'DIRS': []と設定されていて、プロジェクトルート(この場合はprojectroot/)直下は探索されない。

'APP_DIRS': Trueと設定されていて、各アプリケーションディレクトリー下のtemplatesディレクトリーが探索される。

DIRS

プロジェクトルート直下のテンプレートディレクトリーを指定する。たとえば以下のようにtemplatesディレクトリーを準備した場合。

projectroot/
├── config
│   ├── __init__.py
│   ├── asgi.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
├── manage.py
└── templates

projectroot/

├── config

│ ├── __init__.py

│ ├── asgi.py

│ ├── settings.py

│ ├── urls.py

│ └── wsgi.py

├── manage.py

└── templates

準備したtemplatesを探索させるためには、以下のように設定する。

'DIRS': ['templates']

1	'DIRS': ['templates']

あるいは以下のようにベースディレクトリーからのパスであることを明示する。この場合settings.pyでimport osが必要。

import os
....
'DIRS': [os.path.join(BASE_DIR, 'templates')],

import os

....

'DIRS': [os.path.join(BASE_DIR, 'templates')],

ディレクトリーの指定はサブディレクトリーでもよい。たとえばconfigディレクトリー下のtemplatesディレクトリーとしたければ以下のように記述。

'DIRS': ['config/templates']

1	'DIRS': ['config/templates']

APP_DIRS

APP_DIR=Trueとすると、各アプリケーションディレクトリー下のtemplatesディレクトリーが探索される。そのサブディレクトリーも探索される。

Django – settings.py

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

Djangoの設定ディレクトリー下に生成されるsettings.pyの内容を整理する。個別に設定想定していなければ、ここでは以下の構成を仮定している。

projectroot/
├── config
│   ├── __init__.py
│   ├── asgi.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
└── manage.py

projectroot/

├── config

│ ├── __init__.py

│ ├── asgi.py

│ ├── settings.py

│ ├── urls.py

│ └── wsgi.py

└── manage.py

Django – settings.py – 国際化

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

概要

settings.pyのLANGUAGECODE変数で言語コードを、TIME_ZONE変数でタイムゾーンを指定する。

Django – settings.pyへ。

初期状態

settings.py生成直後の国際化関係の内容は以下のとおり。

# Internationalization
# https://docs.djangoproject.com/en/3.2/topics/i18n/

LANGUAGE_CODE = 'en-us'

TIME_ZONE = 'UTC'

USE_I18N = True

USE_L10N = True

USE_TZ = True

# Internationalization

# https://docs.djangoproject.com/en/3.2/topics/i18n/

LANGUAGE_CODE = 'en-us'

TIME_ZONE = 'UTC'

USE_I18N = True

USE_L10N = True

USE_TZ = True

日本語の場合の設定

言語コード

日本語に設定。

LANGUAGE_CODE = 'ja'

1	LANGUAGE_CODE = 'ja'

タイムゾーン

タイムゾーンを指定、有効化(初期状態のTrueのまま)。

TIME_ZONE = 'Asia/Tokyo'

USE_TZ = True

TIME_ZONE = 'Asia/Tokyo'

USE_TZ = True

Djangoは全ての日付＝datetimeオブジェクトをUTCでデータベースに保存する。タイムゾーンの表現を任意に変更可能。

Django – settings.py – DATABASES

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

概要

Djangoでのデータベース設定は、settings.pyのDATABASES辞書で設定する。

Django – settings.pyへ。

初期状態

settings.py生成直後のDATABASESの内容は以下のとおり。デフォルトでSQLiteが指定されている。

# Database
# https://docs.djangoproject.com/en/3.2/ref/settings/#databases

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': BASE_DIR / 'db.sqlite3',
    }
}

# Database

# https://docs.djangoproject.com/en/3.2/ref/settings/#databases

DATABASES = {

'default': {

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

'NAME': BASE_DIR / 'db.sqlite3',

}

MySQLの場合の設定

MySQLを使う場合は以下のように記述。

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'データベース名',
        'USER': '接続ユーザー名',
        'PASSWORD': 'パスワード',
    }
}

DATABASES = {

'default': {

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

'NAME': 'データベース名',

'USER': '接続ユーザー名',

'PASSWORD': 'パスワード',

}

ただし事前にmysqlクライアントのインストールが必要。

$ pip3 install mysqlclient

1	$ pip3 install mysqlclient

Django – ルーティング – urls.py

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

概要

リクエストされたURLから、Django内部で必要なview関数を呼ぶためのルーティングは、urls.pyで設定する。

urls.pyはプロジェクト設定ディレクトリーの下か、各アプリケーションディレクトリーの下
アプリケーションディレクトリー下のurls.pyは新規に作成し、設定ディレクトリーのurls.pyでincludeする
ルーティングはurls.pyのurlpatterns配列にpath関数で登録する
path関数の引数に、URLパターンとビュー関数を与える

ルーティングの流れについてはこちらも参照。

設定ディレクトリー下のurls.py

プロジェクト構成

djangobasicsプロジェクトを作成。設定ディレクトリーをconfとし、アプリケーションurlincludeを作成・登録した場合のツリーは以下の通り。

/djangobasics/
├── conf
│     ├── __init__.py
│     ├── asgi.py
│     ├── settings.py
│     ├── urls.py
│     └── wsgi.py
├── manage.py
└── urlinclude
       ├── __init__.py
       ├── admin.py
       ├── apps.py
       ├── migrations
       │     └── __init__.py
       ├── models.py
       ├── tests.py
       ├── urls.py
       └── views.py

/djangobasics/

├── conf

│ ├── __init__.py

│ ├── asgi.py

│ ├── settings.py

│ ├── urls.py

│ └── wsgi.py

├── manage.py

└── urlinclude

├── __init__.py

├── admin.py

├── apps.py

├── migrations

│ └── __init__.py

├── models.py

├── tests.py

├── urls.py

└── views.py

ビューとテンプレート

urlinclude/views.pyを以下のように編集する。

from django.shortcuts import render

def index(request):
    return render(request, 'urlinclude/index.html')

from django.shortcuts import render

def index(request):

return render(request, 'urlinclude/index.html')

urlinclude/templates/urlincludeディレクトリーを作成し、その下にindex.htmlを以下の内容で作成。

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>Index</title>
  </head>
  <body>
    <h1>Index</h1>
  </body>
</html>

<!DOCTYPE html>

<head>

<title>Index</title>

</head>

<body>

<h1>Index</h1>

</body>

</html>

pathの登録

設定ディレクトリーconfの下のurls.pyに以下のように追記。以下、このurls.pyを「グローバルなurls.py」と呼ぶ。

from django.contrib import admin
from django.urls import path
from urlinclude import views

urlpatterns = [
    path('admin/', admin.site.urls),
    path('urlinclude', views.index),
]

from django.contrib import admin

from django.urls import path

from urlinclude import views

urlpatterns = [

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

path('urlinclude', views.index),

]

まずアプリケーションのviewsモジュールをインポートしている。

from アプリケーション名 import views

1	from アプリケーション名 import views

そしてホスト名/アプリケーション名でindexビュー関数が呼ばれるようルーティング。

path('アプリケーション名', views.ビュー関数)

1	path('アプリケーション名', views.ビュー関数)

ここでhttp://localhost:8000/urlincludeでブラウザーからアクセスすると、index.htmlの内容が表示される。

アプリケーション下のurls.py

グローバルなurls.pyの問題点

設定ファイル直下のurls.pyでのpath登録は、

デフォルトで作成されたurls.pyを編集すればよい
任意のアプリケーションのルーティング登録ができる

ただし以下のような問題点がある。

登録するビューのアプリケーションをインポートする必要がある
全てのビューを登録するため見通しが悪くなる
アプリケーション間でビューの名前の衝突が起こり得る

このため一般にはアプリケーションごとにurls.pyを作成し、そのモジュールを設定ディレクトリー下のグローバルなurls.pyでincludeする。

ビューとテンプレート

ビューとテンプレートは先の例と同じものを使う。

アプリケーションのurls.pyの準備

アプリケーションディレクトリー下に、以下の内容でurls.pyファイルを作成する。conf/urls.pyのように自動作成されないので、新たに作成する必要がある。

from django.urls import path
from urlinclude import views

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

from django.urls import path

from urlinclude import views

urlpatterns = [

path('index', views.index),

]

ツリーは以下の通り。

/djangobasics/
├── conf
│     ├── __init__.py
│     ├── asgi.py
│     ├── settings.py
│     ├── urls.py
│     └── wsgi.py
├── manage.py
├── startserver.sh
└── urlinclude
       ├── __init__.py
       ├── admin.py
       ├── apps.py
       ├── migrations
       │     ├── __init__.py
       │     └── __pycache__
       │     └── __init__.cpython-36.pyc
       ├── models.py
       ├── templates
       │     └── urlinclude
       │            └── index.html
       ├── tests.py
       ├── urls.py
       └── views.py

/djangobasics/

├── conf

│ ├── __init__.py

│ ├── asgi.py

│ ├── settings.py

│ ├── urls.py

│ └── wsgi.py

├── manage.py

├── startserver.sh

└── urlinclude

├── __init__.py

├── admin.py

├── apps.py

├── migrations

│ ├── __init__.py

│ └── __pycache__

│ └── __init__.cpython-36.pyc

├── models.py

├── templates

│ └── urlinclude

│ └── index.html

├── tests.py

├── urls.py

└── views.py

グローバルなurls.pyの編集

conf/urls.pyを以下のように編集する。

django.urlsパッケージのpathモジュールに加えて、includeモジュールもインポートする
urlpatterns配列にpath関数を追加し、アプリケーションのurls.pyをincludeする

from django.contrib import admin
from django.urls import path, include
#from urlinclude import views

urlpatterns = [
    path('admin/', admin.site.urls),
#    path('urlinclude/', views.index),
    path('urlinclude/', include('urlinclude.urls')),
]

from django.contrib import admin

from django.urls import path, include

#from urlinclude import views

urlpatterns = [

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

# path('urlinclude/', views.index),

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

]

ここでhttp://localhost:8000/urlinclude/indexにアクセスすると、index.htmlがブラウザーに表示される。

アプリケーションの登録

新たにアプリケーションを作成した場合には、プロジェクト共通ディレクトリーのsettings.pyでINSTALLED_APPSに作成したアプリケーションを登録しておく必要がある。

INSTALLED_APPS = [
    ....,
    'urlinclude.apps.UrlincludeConfig',
]

INSTALLED_APPS = [

....,

'urlinclude.apps.UrlincludeConfig',

]

留意点

グローバルなurls.pyでは、個々のアプリケーションのviewsモジュールをインポートする必要はない。

include関数の第1引数はアプリケーション名を使ったディレクトリーで、その後にアプリケーション内で定義したパスが続く。

今回の例では'urlinclude/' + 'index'→'urlinclude/index'
末尾に'/'がないとエラーになる

include関数の引数は、'アプリケーション.urls'の文字列。

文字列にしていないと”名前が見つからない”、とエラーになる

直接テンプレートを表示する

path関数で直接テンプレートを表示させることもできるが、少し手間が必要。

urls.pyでTemplateVierwクラスをインポート
path関数の第2引数にTemplateView.as_view()メソッドを与えてテンプレートを指定

たとえば以下は、index.htmlと同じディレクトリーにexample.htmlを作成し、これを直接path関数から呼び出す例。

from django.urls import path
from urlinclude import views
from django.views.generic.base import TemplateView

urlpatterns = [
    path('index', views.index),
    path('example', TemplateView.as_view(template_name='urlinclude/example.html')),
]

from django.urls import path

from urlinclude import views

from django.views.generic.base import TemplateView

urlpatterns = [

path('index', views.index),

path('example', TemplateView.as_view(template_name='urlinclude/example.html')),

]