[申請承認アプリ]プロジェクトの初期設定

プロジェクトは作成できたので、続いて初期設定を行います。

プロジェクトフォルダの中にも更にseminarが作成されていて、その中のsettings.pyを編集します。

今回はsetting.pyの中身を全体的に見ていきましょう。

import os

# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

この部分はsettings.pyの場所を取得してそのフォルダの親フォルダ(=プロジェクトフォルダ)をベースディレクトリに設定しています。

この部分を変えることはまず無いでしょう。

# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = '********'

# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True

ALLOWED_HOSTS = []

この部分はセキュリティ関係です。DEBUGモードとallowed hostについては実際のサーバーにデプロイする際に変更しますが、今は説明は省略したいと思います。

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

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

この部分はこのプロジェクトで使うdjangoアプリケーションとミドルウェアを指定します。この記載順はそのままdjango内での読み込み順になるため、他のアプリに依存するようなアプリを追加するときは、記載順序を慎重に考える必要があります。

後ほどアプリを作成した際に、編集します。

ROOT_URLCONF = 'seminar.urls'
→
ROOT_URLCONF = 'config.urls'

この部分は一番最初に読み込むルートurl設定ファイルの場所を設定します。

プロジェクトを作成した際にsettings.pyと同じseminarフォルダにurls.pyも作成されていて、初期設定で既にそれが記載されているので、意図的にファイルの保存場所を変えない限り変更は必要ありません。

ただ、個人的にプロジェクト名のフォルダ名になっているのが非常に見にくいので、フォルダ名をconfigに変えたいと思います。エクスプローラなどでまずはフォルダ名を普通に変更してから上記のように変更します。

なお、記載方法はベースディレクトリから見て、階層の区切りはピリオドで区切ります。ファイルの拡張子の.pyは不要です。

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [os.path.join(BASE_DIR,"templates")],
        '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',
            ],
        },
    },
]

この部分はテンプレートに関する部分です。

        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [os.path.join(BASE_DIR,"templates")],
        'APP_DIRS': True,

この部分はdjangoテンプレートシステムのバックエンドを指定しているのと、DIRSではテンプレートを保存する場所を指定できます。

djangoではテンプレートを探索するときは、まず、DIRSの場所を探します。そこで見つからず、APP_DIRSがtrueになっている場合は各アプリディレクトリ内のtemplatesディレクトリを探しに行きます。

DIRSで指定した場所が最優先になるため、例えば他のアプリのテンプレートを変えたいときは、DIRSで指定した場所に同名のファイルを置くと、それが代わりに適用されます。

初期設定ではDIRSが空欄でAPP_DIRSはtrueなので、テンプレートはアプリディレクトリ内のtemplatesディレクトリに保存することになります。

今回はプロジェクト共通のベーステンプレートを作りたいと思いますので、プロジェクトフォルダ直下にtemplatesフォルダを作成して、DIRSを変更しています。

        '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',
            ],
        },

この部分はテンプレートに関するオプションを設定するところです。

初期設定ではcontext_processorsが指定されています。context_processorsはテンプレートで使うことが出来る共通の変数/データを準備してくれるものです。

例えば、django.template.context_processors.requestが指定されていることで、テンプレート内では特になにも準備しなくても、常に’request’にはrequestオブジェクトが格納されていて利用できます。

他にも、カスタムテンプレートタグやカスタムフィルターを使う場合には、このオプションの中でlibrariesとして指定することで使えるようになります。また、実際に必要になった時に説明したいと思います。

WSGI_APPLICATION = 'config.wsgi.application'

WSGIアプリケーションはdjangoの処理の起点です。実際のサーバーにデプロイする際にはsettings.pyと同じディレクトリに生成されているwsgi.pyの場所をサーバーに伝えてあげる必要があります。

ここの設定はあくまで開発用の組み込みサーバー(manage.py runserverで起動するもの)にwsgi.pyの場所を教えるための設定です。

wsgi.pyの中にapplicationが定義されていますが、それを参照しています。今回はフォルダ名を変更したので、seminar.をconfig.に変えていますが、特にそういった事情がない限りは変える必要はないでしょう。

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

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
    }
}

ここは使用するデータベースの設定です。

初期設定ではsqliteが指定されています。今回は、sqliteを使用するのでそのままとしたいと思います。

# Password validation
# https://docs.djangoproject.com/en/3.0/ref/settings/#auth-password-validators

AUTH_PASSWORD_VALIDATORS = [
    {
        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
    },
]

ここではパスワードのバリデーションに関する設定が記載されています。

djangoでは標準でユーザー認証の機能が提供されますが、ユーザーに設定するパスワードの強度に関するものです。これは管理者(superuser)にも適用されます。

例えば最後のNumericPasswordValidatorがあるとパスワードを全て数字で構成した場合はエラーとなります。もし、数字だけのパスワードを許容するなら、このバリデーターの記載を削除すればOKです。

今回は初期設定のまま進めます。

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

LANGUAGE_CODE = 'en-us'

TIME_ZONE = 'UTC'

USE_I18N = True

USE_L10N = True

USE_TZ = True

ようやく変更すべき箇所がありました。

日本のサイトを作成する場合は下記のように設定すればいいでしょう。

LANGUAGE_CODE = 'ja'
TIME_ZONE = 'Asia/Tokyo'
USE_I18N = True
USE_L10N = True
USE_TZ = False

language codeは言語の設定、time zoneは文字通りデフォルトのタイムゾーン、USE_I18Nはdjangoの多言語化機能、USE_L10Nは日付の表示形式などをロケールに合わせる機能、USE_TZは時間をタイムゾーンに合わせて変換する機能です。

ちなみに、LANGUAGE_CODEをjaにして、USE_I18NをTrueにすると最初に表示したmanage.py runserverのサンプルページは日本語で表示されるようになります。また、admin管理画面はUSE_I18NがTrueになっていないと全て英語表示になってしまいます。

STATIC_URL = '/static/

これは静的ファイルのurlに関する設定です。

最後に下記の設定を最後の行に追加しましょう。djangoの新しいバージョンではprimary keyを明示的に指定せず、かつDEFAULT_AUTO_FIELDを指定しなかった場合、実行時に警告と言うかヒントが表示されます。それが出てくるのは気になるので、ここで指定しておきます。

DEFAULT_AUTO_FIELD = 'django.db.models.AutoField'

他にも設定項目は沢山ありますが、都度必要になった時に追記していきたいと思います。

コメントを残す コメントをキャンセル

コメントを残すコメントをキャンセル