Djangoの設定ファイルには、インストールしたDjangoの全ての設定が含まれています。このドキュメントでは、各設定の役割と、どのような設定を利用できるか説明していきます。
\n設定ファイルはモジュールレベルの変数が記述された、ただのPythonモジュールです。
\n設定例を幾つか示します:
\nALLOWED_HOSTS = ['www.example.com']\nDEBUG = False\nDEFAULT_FROM_EMAIL = 'webmaster@example.com'\n設定ファイルはPythonのモジュールなので、以下のような性質を備えています。
\nPythonの構文エラーになってはいけません。
通常の Pythonの構文を使って、動的に値を設定する事ができます。例えば:
\nMY_SETTING = [str(i) for i in range(30)]\n他の設定ファイルから値を import できます。
When you use Django, you have to tell it which settings you're using. Do this\nby using an environment variable, DJANGO_SETTINGS_MODULE.
The value of DJANGO_SETTINGS_MODULE should be in Python path syntax,\ne.g. mysite.settings. Note that the settings module should be on the\nPython import search path.
django-admin ユーティリティLink to this heading#django-admin を使う場合、環境変数を予め指定しておくか、ユーティリティを起動する度に設定モジュールを明示的に渡します。
\n例 (Unix Bash シェル):
\nexport DJANGO_SETTINGS_MODULE=mysite.settings\ndjango-admin runserver\n例(Windows コマンドプロンプト):
\nset DJANGO_SETTINGS_MODULE=mysite.settings\ndjango-admin runserver\nコマンドライン引数で設定モジュールを指定するには、 --settings を使用します:
django-admin runserver --settings=mysite.settings\nmod_wsgi) の設定Link to this heading#実際のサーバ環境では、 WSGI アプリケーションにどの設定ファイルを使うのか教えてあげる必要があります。これには os.environ:: を使います。
import os\n\nos.environ['DJANGO_SETTINGS_MODULE'] = 'mysite.settings'\nさらなる情報や他のDjango WSGI アプリケーションでの共通の設定は Django mod_wsgi ドキュメント を参照してください。
\nDjango の設定ファイルでは、特に必要のない限り設定をおこなう必要はありません。 各々の設定には注意深く決められたデフォルト値が入っています。デフォルト値は django/conf/global_settings.py に記述されています。
Django が設定をコンパイルする際には、以下のようなアルゴリズムを使います:
\nglobal_settings.py から設定を読みだす。
指定された設定ファイルから設定を読み込み、グローバルな設定を必要に応じて上書きします。
設定ファイルから global_settings を読み込むのは冗長なのでやらないでください。
The command python manage.py diffsettings displays differences between the\ncurrent settings file and Django's default settings.
詳しくは diffsettings のドキュメントを参照してください。
自作のDjangoアプリケーションからは django.conf.settings をimportすることで設定を参照できます。例:
from django.conf import settings\n\nif settings.DEBUG:\n # Do something\ndjango.conf.settings はモジュールではなく、ただのオブジェクトです。そのため個々の設定は別々にimportできません。
from django.conf.settings import DEBUG # This won't work.\nまた global_settings や自作の設定ファイルをimportしてはいけません。 django.conf.settings はデフォルト設定とサイト固有の設定を抽象化し、単一のインタフェースを提供しています。また設定を使うコードと設定ファイルの場所を分離しています。
アプリケーションの実行中に設定を変えてはいけません。例えば、viewの中で以下の実装を行ってはいけません。
\nfrom django.conf import settings\n\nsettings.DEBUG = True # Don't do this!\n設定を変えて良いのは、設定ファイルの中だけです。
\nBecause a settings file contains sensitive information, such as the database\npassword, you should make every attempt to limit access to it. For example,\nchange its file permissions so that only you and your web server's user can\nread it. This is especially important in a shared-hosting environment.
\n利用可能な設定は settings リファレンス を参照してください。
\nThere's nothing stopping you from creating your own settings, for your own\nDjango apps, but follow these guidelines:
\nSetting names must be all uppercase.
既存の設定の再発明はやめましょう。
設定値をシーケンスにする際は、リストを使ってください。ただしこれはDjangoの慣習です。
\nDJANGO_SETTINGS_MODULELink to this heading#In some cases, you might want to bypass the DJANGO_SETTINGS_MODULE\nenvironment variable. For example, if you're using the template system by\nitself, you likely don't want to have to set up an environment variable\npointing to a settings module.
こういったケースのため、Djangoでは以下の関数を呼ぶことで手動で設定できるようになっています。
\n実装例:
\nfrom django.conf import settings\n\nsettings.configure(DEBUG=True)\nPass configure() as many keyword arguments as you'd like, with each keyword\nargument representing a setting and its value. Each argument name should be all\nuppercase, with the same name as the settings described above. If a particular\nsetting is not passed to configure() and is needed at some later point,\nDjango will use the default setting value.
Configuring Django in this fashion is mostly necessary -- and, indeed,\nrecommended -- when you're using a piece of the framework inside a larger\napplication.
\nしたがって、settings.configure() を介して設定された場合、Djangoはプロセス環境変数を変更しません (これが通常発生する理由については、TIME_ZONE のドキュメントを参照してください)。これらの場合、すでに環境を完全に制御していることが前提となります。
If you'd like default values to come from somewhere other than\ndjango.conf.global_settings, you can pass in a module or class that\nprovides the default settings as the default_settings argument (or as the\nfirst positional argument) in the call to configure().
In this example, default settings are taken from myapp_defaults, and the\nDEBUG setting is set to True, regardless of its value in\nmyapp_defaults:
from django.conf import settings\nfrom myapp import myapp_defaults\n\nsettings.configure(default_settings=myapp_defaults, DEBUG=True)\nThe following example, which uses myapp_defaults as a positional argument,\nis equivalent:
settings.configure(myapp_defaults, DEBUG=True)\nNormally, you will not need to override the defaults in this fashion. The\nDjango defaults are sufficiently tame that you can safely use them. Be aware\nthat if you do pass in a new default module, it entirely replaces the Django\ndefaults, so you must specify a value for every possible setting that might be\nused in that code you are importing. Check in\ndjango.conf.settings.global_settings for the full list.
configure() or DJANGO_SETTINGS_MODULE is requiredLink to this heading#If you're not setting the DJANGO_SETTINGS_MODULE environment\nvariable, you must call configure() at some point before using any code\nthat reads settings.
If you don't set DJANGO_SETTINGS_MODULE and don't call\nconfigure(), Django will raise an ImportError exception the first time\na setting is accessed.
If you set DJANGO_SETTINGS_MODULE, access settings values somehow,\nthen call configure(), Django will raise a RuntimeError indicating\nthat settings have already been configured. There is a property for this\npurpose:
例:
\nfrom django.conf import settings\nif not settings.configured:\n settings.configure(myapp_defaults, DEBUG=True)\nAlso, it's an error to call configure() more than once, or to call\nconfigure() after any setting has been accessed.
It boils down to this: Use exactly one of either configure() or\nDJANGO_SETTINGS_MODULE. Not both, and not neither.
django.setup() is required for "standalone" Django usageLink to this heading#If you're using components of Django "standalone" -- for example, writing a\nPython script which loads some Django templates and renders them, or uses the\nORM to fetch some data -- there's one more step you'll need in addition to\nconfiguring settings.
\nAfter you've either set DJANGO_SETTINGS_MODULE or called\nconfigure(), you'll need to call django.setup() to load your\nsettings and populate Django's application registry. For example:
import django\nfrom django.conf import settings\nfrom myapp import myapp_defaults\n\nsettings.configure(default_settings=myapp_defaults, DEBUG=True)\ndjango.setup()\n\n# Now this script or any imported module can use any part of Django it needs.\nfrom myapp import models\nNote that calling django.setup() is only necessary if your code is truly\nstandalone. When invoked by your web server, or through django-admin, Django will handle this for you.