django-admin と manage.pyLink to this heading#django-admin は Django において管理者権限の処理を行うためのコマンドラインユーティリティです。本項ではその機能が行える事全般をまとめます。
In addition, manage.py is automatically created in each Django project. It\ndoes the same thing as django-admin but also sets the\nDJANGO_SETTINGS_MODULE environment variable so that it points to your\nproject's settings.py file.
The django-admin script should be on your system path if you installed\nDjango via pip. If it's not in your path, ensure you have your virtual\nenvironment activated.
通常、単体の Django プロジェクトを用いる場合、django-admin よりも manage.py の方が簡単に利用できます。もし複数の Django 設定ファイル間での切り替えが必要な場合は、django-admin を DJANGO_SETTINGS_MODULE もしくは --settings オプションと共に利用してください。
本項ではコマンドラインの実行例は一貫して django-admin を使用しますが、実行例は全て manage.py もしくは python -m django でも同様に利用可能です。
Linux / macOS
$ django-admin <command> [options]\n$ manage.py <command> [options]\n$ python -m django <command> [options]\nWindows
...\\> django-admin <command> [options]\n...\\> manage.py <command> [options]\n...\\> py -m django <command> [options]\ncommand にはこのドキュメントに一覧されたコマンドの1つでなければなりません。options はオプションで、与えられたコマンドで利用できる 0 個以上のオプションを指定します。
Run django-admin help to display usage information and a list of the\ncommands provided by each application.
Run django-admin help --commands to display a list of all available\ncommands.
Run django-admin help <command> to display a description of the given\ncommand and a list of its available options.
Many commands take a list of "app names." An "app name" is the basename of\nthe package containing your models. For example, if your INSTALLED_APPS\ncontains the string 'mysite.blog', the app name is blog.
Run django-admin version to display the current Django version.
The output follows the schema described in PEP 440:
\n1.4.dev17026\n1.4a1\n1.4\nUse --verbosity to specify the amount of notification and debug\ninformation that django-admin prints to the console.
checkLink to this heading#Uses the system check framework to inspect the entire\nDjango project for common problems.
\nBy default, all apps will be checked. You can check a subset of apps by\nproviding a list of app labels as arguments:
\ndjango-admin check auth admin myapp\nThe system check framework performs many different types of checks that are\ncategorized with tags. You can use these\ntags to restrict the checks performed to just those in a particular category.\nFor example, to perform only models and compatibility checks, run:
\ndjango-admin check --tag models --tag compatibility\nSpecifies the database to run checks requiring database access:
\ndjango-admin check --database default --database other\nBy default, these checks will not be run.
\nLists all available tags.
\nActivates some additional checks that are only relevant in a deployment setting.
\nYou can use this option in your local development environment, but since your\nlocal development settings module may not have many of your production settings,\nyou will probably want to point the check command at a different settings\nmodule, either by setting the DJANGO_SETTINGS_MODULE environment\nvariable, or by passing the --settings option:
django-admin check --deploy --settings=production_settings\nOr you could run it directly on a production or staging deployment to verify\nthat the correct settings are in use (omitting --settings). You could even\nmake it part of your integration test suite.
Specifies the message level that will cause the command to exit with a non-zero\nstatus. Default is ERROR.
compilemessagesLink to this heading#Compiles .po files created by makemessages to .mo files for\nuse with the built-in gettext support. See 国際化とローカル化.
Specifies the locale(s) to process. If not provided, all locales are processed.
\nSpecifies the locale(s) to exclude from processing. If not provided, no locales\nare excluded.
\nIncludes fuzzy translations into compiled files.
\n使い方の例:
\ndjango-admin compilemessages --locale=pt_BR\ndjango-admin compilemessages --locale=pt_BR --locale=fr -f\ndjango-admin compilemessages -l pt_BR\ndjango-admin compilemessages -l pt_BR -l fr --use-fuzzy\ndjango-admin compilemessages --exclude=pt_BR\ndjango-admin compilemessages --exclude=pt_BR --exclude=fr\ndjango-admin compilemessages -x pt_BR\ndjango-admin compilemessages -x pt_BR -x fr\nIgnores directories matching the given glob-style pattern. Use\nmultiple times to ignore more.
使い方の例:
\ndjango-admin compilemessages --ignore=cache --ignore=outdated/*/locale\ncreatecachetableLink to this heading#Creates the cache tables for use with the database cache backend using the\ninformation from your settings file. See Django's cache framework for more\ninformation.
\nSpecifies the database in which the cache table(s) will be created. Defaults to\ndefault.
Prints the SQL that would be run without actually running it, so you can\ncustomize it or use the migrations framework.
\ndbshellLink to this heading#Runs the command-line client for the database engine specified in your\nENGINE setting, with the connection parameters\nspecified in your USER, PASSWORD, etc., settings.
For PostgreSQL, this runs the psql command-line client.
For MySQL, this runs the mysql command-line client.
For SQLite, this runs the sqlite3 command-line client.
For Oracle, this runs the sqlplus command-line client.
This command assumes the programs are on your PATH so that a call to\nthe program name (psql, mysql, sqlite3, sqlplus) will find the\nprogram in the right place. There's no way to specify the location of the\nprogram manually.
Specifies the database onto which to open a shell. Defaults to default.
Any arguments following a -- divider will be passed on to the underlying\ncommand-line client. For example, with PostgreSQL you can use the psql\ncommand's -c flag to execute a raw SQL query directly:
Linux / macOS
$ django-admin dbshell -- -c 'select current_user'\n current_user\n--------------\n postgres\n(1 row)\nWindows
...\\> django-admin dbshell -- -c 'select current_user'\n current_user\n--------------\n postgres\n(1 row)\nOn MySQL/MariaDB, you can do this with the mysql command's -e flag:
Linux / macOS
$ django-admin dbshell -- -e "select user()"\n+----------------------+\n| user() |\n+----------------------+\n| djangonaut@localhost |\n+----------------------+\nWindows
...\\> django-admin dbshell -- -e "select user()"\n+----------------------+\n| user() |\n+----------------------+\n| djangonaut@localhost |\n+----------------------+\ndiffsettingsLink to this heading#Displays differences between the current settings file and Django's default\nsettings (or another settings file specified by --default).
Settings that don't appear in the defaults are followed by "###". For\nexample, the default settings don't define ROOT_URLCONF, so\nROOT_URLCONF is followed by "###" in the output of\ndiffsettings.
Displays all settings, even if they have Django's default value. Such settings\nare prefixed by "###".
The settings module to compare the current settings against. Leave empty to\ncompare against Django's default settings.
\nSpecifies the output format. Available values are hash and unified.\nhash is the default mode that displays the output that's described above.\nunified displays the output similar to diff -u. Default settings are\nprefixed with a minus sign, followed by the changed setting prefixed with a\nplus sign.
dumpdataLink to this heading#名前を指定したアプリケーションと関連するデータベースの中のすべてのデータを、標準出力にアウトプットします。
\nアプリケーション名が指定されなかった場合、インストールされたすべてのアプリケーションをダンプします。
\ndumpdata のアウトプットは loaddata に対するインプットして使用できます。
Note that dumpdata uses the default manager on the model for selecting the\nrecords to dump. If you're using a custom manager as\nthe default manager and it filters some of the available records, not all of the\nobjects will be dumped.
Uses Django's base manager, dumping records which might otherwise be filtered\nor modified by a custom manager.
\nSpecifies the serialization format of the output. Defaults to JSON. Supported\nformats are listed in Serialization formats.
\nSpecifies the number of indentation spaces to use in the output. Defaults to\nNone which displays all data on single line.
Prevents specific applications or models (specified in the form of\napp_label.ModelName) from being dumped. If you specify a model name, then\nonly that model will be excluded, rather than the entire application. You can\nalso mix application names and model names.
If you want to exclude multiple applications, pass --exclude more than\nonce:
django-admin dumpdata --exclude=auth --exclude=contenttypes\nSpecifies the database from which data will be dumped. Defaults to default.
Uses the natural_key() model method to serialize any foreign key and\nmany-to-many relationship to objects of the type that defines the method. If\nyou're dumping contrib.auth Permission objects or\ncontrib.contenttypes ContentType objects, you should probably use this\nflag. See the natural keys\ndocumentation for more details on this and the next option.
Omits the primary key in the serialized data of this object since it can be\ncalculated during deserialization.
\nOutputs only the objects specified by a comma separated list of primary keys.\nThis is only available when dumping one model. By default, all the records of\nthe model are output.
\nSpecifies a file to write the serialized data to. By default, the data goes to\nstandard output.
\nWhen this option is set and --verbosity is greater than 0 (the default), a\nprogress bar is shown in the terminal.
flushLink to this heading#Removes all data from the database and re-executes any post-synchronization\nhandlers. The table of which migrations have been applied is not cleared.
\nIf you would rather start from an empty database and re-run all migrations, you\nshould drop and recreate the database and then run migrate instead.
Suppresses all user prompts.
\nSpecifies the database to flush. Defaults to default.
inspectdbLink to this heading#Introspects the database tables in the database pointed-to by the\nNAME setting and outputs a Django model module (a models.py\nfile) to standard output.
You may choose what tables or views to inspect by passing their names as\narguments. If no arguments are provided, models are created for views only if\nthe --include-views option is used. Models for partition tables are\ncreated on PostgreSQL if the --include-partitions option is used.
Use this if you have a legacy database with which you'd like to use Django.\nThe script will inspect the database and create a model for each table within\nit.
\nAs you might expect, the created models will have an attribute for every field\nin the table. Note that inspectdb has a few special cases in its field-name\noutput:
If inspectdb cannot map a column's type to a model field type, it'll\nuse TextField and will insert the Python comment\n'This field type is a guess.' next to the field in the generated\nmodel. The recognized fields may depend on apps listed in\nINSTALLED_APPS. For example, django.contrib.postgres adds\nrecognition for several PostgreSQL-specific field types.
If the database column name is a Python reserved word (such as\n'pass', 'class' or 'for'), inspectdb will append\n'_field' to the attribute name. For example, if a table has a column\n'for', the generated model will have a field 'for_field', with\nthe db_column attribute set to 'for'. inspectdb will insert\nthe Python comment\n'Field renamed because it was a Python reserved word.' next to the\nfield.
This feature is meant as a shortcut, not as definitive model generation. After\nyou run it, you'll want to look over the generated models yourself to make\ncustomizations. In particular, you'll need to rearrange models' order, so that\nmodels that refer to other models are ordered properly.
\nDjango doesn't create database defaults when a\ndefault is specified on a model field.\nSimilarly, database defaults aren't translated to model field defaults or\ndetected in any fashion by inspectdb.
By default, inspectdb creates unmanaged models. That is, managed = False\nin the model's Meta class tells Django not to manage each table's creation,\nmodification, and deletion. If you do want to allow Django to manage the\ntable's lifecycle, you'll need to change the\nmanaged option to True (or remove\nit because True is its default value).
Models are created for materialized views if --include-views is\nused.
Models are created for foreign tables.
Models are created for materialized views if\n--include-views is used.
Models are created for partition tables if\n--include-partitions is used.
Specifies the database to introspect. Defaults to default.
If this option is provided, models are also created for partitions.
\nOnly support for PostgreSQL is implemented.
\nIf this option is provided, models are also created for database views.
\nloaddataLink to this heading#Searches for and loads the contents of the named fixture into the database.
\nSpecifies the database into which the data will be loaded. Defaults to\ndefault.
Ignores fields and models that may have been removed since the fixture was\noriginally generated.
\nSpecifies a single app to look for fixtures in rather than looking in all apps.
\nSpecifies the serialization format (e.g.,\njson or xml) for fixtures read from stdin.
Excludes loading the fixtures from the given applications and/or models (in the\nform of app_label or app_label.ModelName). Use the option multiple\ntimes to exclude more than one app or model.
A fixture is a collection of files that contain the serialized contents of\nthe database. Each fixture has a unique name, and the files that comprise the\nfixture can be distributed over multiple directories, in multiple applications.
\nDjango will search in three locations for fixtures:
\nIn the fixtures directory of every installed application
In any directory named in the FIXTURE_DIRS setting
In the literal path named by the fixture
Django will load any and all fixtures it finds in these locations that match\nthe provided fixture names.
\nIf the named fixture has a file extension, only fixtures of that type\nwill be loaded. For example:
\ndjango-admin loaddata mydata.json\nwould only load JSON fixtures called mydata. The fixture extension\nmust correspond to the registered name of a\nserializer (e.g., json or xml).
If you omit the extensions, Django will search all available fixture types\nfor a matching fixture. For example:
\ndjango-admin loaddata mydata\nwould look for any fixture of any fixture type called mydata. If a fixture\ndirectory contained mydata.json, that fixture would be loaded\nas a JSON fixture.
The fixtures that are named can include directory components. These\ndirectories will be included in the search path. For example:
\ndjango-admin loaddata foo/bar/mydata.json\nwould search <app_label>/fixtures/foo/bar/mydata.json for each installed\napplication, <dirname>/foo/bar/mydata.json for each directory in\nFIXTURE_DIRS, and the literal path foo/bar/mydata.json.
When fixture files are processed, the data is saved to the database as is.\nModel defined save() methods are not called, and\nany pre_save or\npost_save signals will be called with\nraw=True since the instance only contains attributes that are local to the\nmodel. You may, for example, want to disable handlers that access\nrelated fields that aren't present during fixture loading and would otherwise\nraise an exception:
from django.db.models.signals import post_save\nfrom .models import MyModel\n\ndef my_handler(**kwargs):\n # disable the handler during fixture loading\n if kwargs['raw']:\n return\n ...\n\npost_save.connect(my_handler, sender=MyModel)\nYou could also write a decorator to encapsulate this logic:
\nfrom functools import wraps\n\ndef disable_for_loaddata(signal_handler):\n """\n Decorator that turns off signal handlers when loading fixture data.\n """\n @wraps(signal_handler)\n def wrapper(*args, **kwargs):\n if kwargs['raw']:\n return\n signal_handler(*args, **kwargs)\n return wrapper\n\n@disable_for_loaddata\ndef my_handler(**kwargs):\n ...\nJust be aware that this logic will disable the signals whenever fixtures are\ndeserialized, not just during loaddata.
Note that the order in which fixture files are processed is undefined. However,\nall fixture data is installed as a single transaction, so data in\none fixture can reference data in another fixture. If the database backend\nsupports row-level constraints, these constraints will be checked at the\nend of the transaction.
\nThe dumpdata command can be used to generate input for loaddata.
Fixtures may be compressed in zip, gz, or bz2 format. For example:
django-admin loaddata mydata.json\nwould look for any of mydata.json, mydata.json.zip,\nmydata.json.gz, or mydata.json.bz2. The first file contained within a\nzip-compressed archive is used.
Note that if two fixtures with the same name but different\nfixture type are discovered (for example, if mydata.json and\nmydata.xml.gz were found in the same fixture directory), fixture\ninstallation will be aborted, and any data installed in the call to\nloaddata will be removed from the database.
If you're in a multi-database setup, you might have fixture data that\nyou want to load onto one database, but not onto another. In this\nsituation, you can add a database identifier into the names of your fixtures.
\nFor example, if your DATABASES setting has a 'master' database\ndefined, name the fixture mydata.master.json or\nmydata.master.json.gz and the fixture will only be loaded when you\nspecify you want to load data into the master database.
stdinLink to this heading#You can use a dash as the fixture name to load input from sys.stdin. For\nexample:
django-admin loaddata --format=json -\nWhen reading from stdin, the --format option\nis required to specify the serialization format\nof the input (e.g., json or xml).
Loading from stdin is useful with standard input and output redirections.\nFor example:
django-admin dumpdata --format=json --database=test app_label.ModelName | django-admin loaddata --format=json --database=prod -\nmakemessagesLink to this heading#Runs over the entire source tree of the current directory and pulls out all\nstrings marked for translation. It creates (or updates) a message file in the\nconf/locale (in the Django tree) or locale (for project and application)\ndirectory. After making changes to the messages files you need to compile them\nwith compilemessages for use with the builtin gettext support. See\nthe i18n documentation for details.
This command doesn't require configured settings. However, when settings aren't\nconfigured, the command can't ignore the MEDIA_ROOT and\nSTATIC_ROOT directories or include LOCALE_PATHS.
利用可能な全ての言語に対してメッセージファイルを更新します。
\n検査するファイル拡張子のリストを指定します (デフォルト: html、txt、py 、もしくは --domain が js の場合 js).
使い方の例:
\ndjango-admin makemessages --locale=de --extension xhtml\nカンマで複数の拡張子を区切るか、-e や --extension を複数回使ってください:
django-admin makemessages --locale=de --extension=html,txt --extension xml\n処理する場所 (locale) を指定します。
\nSpecifies the locale(s) to exclude from processing. If not provided, no locales\nare excluded.
\n使い方の例:
\ndjango-admin makemessages --locale=pt_BR\ndjango-admin makemessages --locale=pt_BR --locale=fr\ndjango-admin makemessages -l pt_BR\ndjango-admin makemessages -l pt_BR -l fr\ndjango-admin makemessages --exclude=pt_BR\ndjango-admin makemessages --exclude=pt_BR --exclude=fr\ndjango-admin makemessages -x pt_BR\ndjango-admin makemessages -x pt_BR -x fr\nメッセージファイルのドメインを指定します。サポートされているオプションは以下の通りです:
\n*.py、*.html、*.txt ファイルすべてに対して django (デフォルト)
*.js ファイルに対して djangojs
新しい翻訳文字列を探すときに、ディレクトリへのシンボリックリンクをたどります。
\n使い方の例:
\ndjango-admin makemessages --locale=de --symlinks\n与えられた glob スタイルのパターンに一致するファイルやディレクトリを無視します。 何度も無視するためには複数回使用してください。
次のパターンはデフォルトで使われます: 'CVS'、'.*'、'*~'、'*.pyc'。
使い方の例:
\ndjango-admin makemessages --locale=en_US --ignore=apps/* --ignore=secret/*.html\n--ignore のデフォルト値を無効化します。
言語ファイル内で、長いメッセージ行の複数行への分割を無効化します。
\n言語ファイル内に '#: filename:line’ コメント行を書き込むのを抑制します。このオプションを使うと、技術的な翻訳者がそれぞれのメッセージの文脈を理解することが難しくなります。
Controls #: filename:line comment lines in language files. If the option\nis:
full (the default if not given): the lines include both file name and\nline number.
file: the line number is omitted.
never: the lines are suppressed (same as --no-location).
Requires gettext 0.19 or newer.
.po ファイルが作成される前に生成される一時的な .pot ファイルを削除しないようにします。最終的な言語ファイルが生成されるのを妨げるようなエラーをデバッグするために有用です。
makemigrationsLink to this heading#検出されたモデルの変更に基づいて、新しいマイグレーションを作成します。マイグレーションおよびそのアプリとの関係は、詳しくは the migrations documentation1 で説明しています。
\n1つ以上のアプリ名を引数として与えると、作成するマイグレーションを、指定されたアプリとそれに必要な依存関係 (たとえば、外部キーで繋がれた他のテーブルなど) に限定されます。
\nマイグレーションを migrations ディレクトリが存在しないアプリに追加するには、makemigrations にアプリの app_label を付けて実行します。
すべてのユーザープロンプトを抑制します。もし、抑制されたプロンプトが自動的に解決できなかった場合は、エラーコード 3 で終了します。
\n手動で編集するために、指定されたアプリに対する空のマイグレーションを出力します。このオプションは詳しいユーザーのためのもので、マイグレーションのフォーマット、マイグレーションの操作、およびマイグレーション間の依存関係について十分理解していない限り、使うべきではありません。
\n実際にマイグレーションをディスクには書き込まず、作成される予定のマイグレーションを表示します。このオプションを --verbosity 3 オプションと併用することで、書き込まれる予定のマイグレーションファイルの内容そのものを表示することができます。
マイグレーションで発生するコンフリクトの修復を有効にする
\nAllows naming the generated migration(s) instead of using a generated name. The\nname must be a valid Python identifier.
\nGenerate migration files without Django version and timestamp header.
\nマイグレーションが検出されなかったにも関わらずモデルが変更された場合に、makemigrations に 0 以外のエラーコードで終了させます。
migrateLink to this heading#データベースの状態を、現在のモデルとマイグレーションのセットを基づいて同期します。マイグレーションおよびそのアプリとの関係については、詳しくは the migrations documentation で説明しています。
\nこのコマンドの動作は、次のように与えられた引数によって変化します。
\n引数なし: 全てのアプリが、それぞれが持つマイグレーションを全て実行します。
<app_label>: 指定したアプリに最新のマイグレーションまで実行させます。依存関係によっては、他のアプリのマイグレーションも実行される場合もあります
<app_label> <migrationname>: Brings the database schema to a state where\nthe named migration is applied, but no later migrations in the same app are\napplied. This may involve unapplying migrations if you have previously\nmigrated past the named migration. You can use a prefix of the migration\nname, e.g. 0001, as long as it's unique for the given app name. Use the\nname zero to migrate all the way back i.e. to revert all applied\nmigrations for an app.
マイグレートするデータベースを指定します。デフォルトは default です。
Marks the migrations up to the target one (following the rules above) as\napplied, but without actually running the SQL to change your database schema.
\nThis is intended for advanced users to manipulate the\ncurrent migration state directly if they're manually applying changes;\nbe warned that using --fake runs the risk of putting the migration state\ntable into a state where manual recovery will be needed to make migrations\nrun correctly.
Allows Django to skip an app's initial migration if all database tables with\nthe names of all models created by all\nCreateModel operations in that\nmigration already exist. This option is intended for use when first running\nmigrations against a database that preexisted the use of migrations. This\noption does not, however, check for matching database schema beyond matching\ntable names and so is only safe to use if you are confident that your existing\nschema matches what is recorded in your initial migration.
Shows the migration operations that will be performed for the given migrate\ncommand.
Allows creating tables for apps without migrations. While this isn't\nrecommended, the migrations framework is sometimes too slow on large projects\nwith hundreds of models.
\nSuppresses all user prompts. An example prompt is asking about removing stale\ncontent types.
\nMakes migrate exit with a non-zero status when unapplied migrations are\ndetected.
runserverLink to this heading#Starts a lightweight development Web server on the local machine. By default,\nthe server runs on port 8000 on the IP address 127.0.0.1. You can pass in an\nIP address and port number explicitly.
If you run this script as a user with normal privileges (recommended), you\nmight not have access to start a port on a low port number. Low port numbers\nare reserved for the superuser (root).
\nThis server uses the WSGI application object specified by the\nWSGI_APPLICATION setting.
DO NOT USE THIS SERVER IN A PRODUCTION SETTING. It has not gone through\nsecurity audits or performance tests. (And that's how it's gonna stay. We're in\nthe business of making Web frameworks, not Web servers, so improving this\nserver to be able to handle a production environment is outside the scope of\nDjango.)
\nThe development server automatically reloads Python code for each request, as\nneeded. You don't need to restart the server for code changes to take effect.\nHowever, some actions like adding files don't trigger a restart, so you'll\nhave to restart the server in these cases.
\nIf you're using Linux or MacOS and install both pywatchman and the\nWatchman service, kernel signals will be used to autoreload the server\n(rather than polling file modification timestamps each second). This offers\nbetter performance on large projects, reduced response time after code changes,\nmore robust change detection, and a reduction in power usage. Django supports\npywatchman 1.2.0 and higher.
When you start the server, and each time you change Python code while the\nserver is running, the system check framework will check your entire Django\nproject for some common errors (see the check command). If any\nerrors are found, they will be printed to standard output.
You can run as many concurrent servers as you want, as long as they're on\nseparate ports by executing django-admin runserver more than once.
デフォルトの IP アドレス 127.0.0.1 は、同じネットワーク上の他のマシンからはアクセスできないことに注意してください。開発用サーバーを他のマシンから見られるようにするには、ネットワーク上の自分のローカル IP アドレス (例 192.168.2.1) または 0.0.0.0 や :: (IPv6 が有効な場合) を使用してください。
ブラケットで囲まれた IPv6 アドレス (例 [200a::1]:8000) を与えることもできます。その場合には、IPv6 のサポートが自動的に有効になります。
ホスト名には ASCII 文字のみからなる文字列も使用できます。
\nIf the staticfiles contrib app is enabled\n(default in new projects) the runserver command will be overridden\nwith its own runserver command.
Logging of each request and response of the server is sent to the\ndjango.server logger.
\nDisables the auto-reloader. This means any Python code changes you make while\nthe server is running will not take effect if the particular Python modules\nhave already been loaded into memory.
\nDisables use of threading in the development server. The server is\nmultithreaded by default.
\n開発用サーバーで IPv6 を使用します。これにより、デフォルトの IP アドレスが 127.0.0.1 から ::1 に変わります。
IP アドレス 127.0.0.1 上でポート 8000 を使用する場合:
django-admin runserver\nIP アドレス 1.2.3.4 上でポート 8000 を使用する場合:
django-admin runserver 1.2.3.4:8000\nIP アドレス 127.0.0.1 上でポート 7000 を使用する場合:
django-admin runserver 7000\nIP アドレス 1.2.3.4 上でポート 7000 を使用する場合:
django-admin runserver 1.2.3.4:7000\nIPv6 アドレス ::1 上でポート 8000 を使用する場合:
django-admin runserver -6\nIPv6 アドレス ::1 上でポート 7000 を使用する場合:
django-admin runserver -6 7000\nIPv6 アドレス 2001:0db8:1234:5678::9 上でポート 7000 を使用する場合:
django-admin runserver [2001:0db8:1234:5678::9]:7000\nIPv4 アドレスのホスト localhost 上でポート 8000 を使用する場合:
django-admin runserver localhost:8000\nIPv6 アドレスのホスト localhost 上でポート 8000 を使用する場合:
django-admin runserver -6 localhost:8000\nBy default, the development server doesn't serve any static files for your site\n(such as CSS files, images, things under MEDIA_URL and so forth). If\nyou want to configure Django to serve static media, read\n静的ファイル (画像、JavaScript、CSS など) を管理する.
sendtestemailLink to this heading#Sends a test email (to confirm email sending through Django is working) to the\nrecipient(s) specified. For example:
\ndjango-admin sendtestemail foo@example.com bar@example.com\nThere are a couple of options, and you may use any combination of them\ntogether:
\nMails the email addresses specified in MANAGERS using\nmail_managers().
Mails the email addresses specified in ADMINS using\nmail_admins().
shellLink to this heading#Python のインタラクティブ・インタープリタを開始します。
\n使用するシェルを指定します。デフォルトでは、Django はインストールされている場合には IPython または bpython を使用します。両方インストールされている場合には、次のようにして使いたいシェルを指定してください。
\nIPython:
\ndjango-admin shell -i ipython\nbpython:
\ndjango-admin shell -i bpython\nIf you have a "rich" shell installed but want to force use of the "plain"\nPython interpreter, use python as the interface name, like so:
django-admin shell -i python\nDisables reading the startup script for the "plain" Python interpreter. By\ndefault, the script pointed to by the PYTHONSTARTUP environment\nvariable or the ~/.pythonrc.py script is read.
Lets you pass a command as a string to execute it as Django, like so:
\ndjango-admin shell --command="import django; print(django.__version__)"\nYou can also pass code in on standard input to execute it. For example:
\n$ django-admin shell <<EOF\n> import django\n> print(django.__version__)\n> EOF\nOn Windows, the REPL is output due to implementation limits of\nselect.select() on that platform.
showmigrationsLink to this heading#Shows all migrations in a project. You can choose from one of two formats:
\nLists all of the apps Django knows about, the migrations available for each\napp, and whether or not each migration is applied (marked by an [X] next to\nthe migration name). For a --verbosity of 2 and above, the applied\ndatetimes are also shown.
Apps without migrations are also listed, but have (no migrations) printed\nunder them.
This is the default output format.
\n\nShows the migration plan Django will follow to apply migrations. Like\n--list, applied migrations are marked by an [X]. For a --verbosity\nof 2 and above, all dependencies of a migration will also be shown.
app_labels arguments limit the output, however, dependencies of provided\napps may also be included.
Specifies the database to examine. Defaults to default.
sqlflushLink to this heading#Prints the SQL statements that would be executed for the flush\ncommand.
Specifies the database for which to print the SQL. Defaults to default.
sqlmigrateLink to this heading#Prints the SQL for the named migration. This requires an active database\nconnection, which it will use to resolve constraint names; this means you must\ngenerate the SQL against a copy of the database you wish to later apply it on.
\nNote that sqlmigrate doesn't colorize its output.
Generates the SQL for unapplying the migration. By default, the SQL created is\nfor running the migration in the forwards direction.
\nSpecifies the database for which to generate the SQL. Defaults to default.
sqlsequenceresetLink to this heading#Prints the SQL statements for resetting sequences for the given app name(s).
\nSequences are indexes used by some database engines to track the next available\nnumber for automatically incremented fields.
\nUse this command to generate SQL which will fix cases where a sequence is out\nof sync with its automatically incremented field data.
\nSpecifies the database for which to print the SQL. Defaults to default.
squashmigrationsLink to this heading#Squashes the migrations for app_label up to and including migration_name\ndown into fewer migrations, if possible. The resulting squashed migrations\ncan live alongside the unsquashed ones safely. For more information,\nplease read Squashing migrations.
When start_migration_name is given, Django will only include migrations\nstarting from and including this migration. This helps to mitigate the\nsquashing limitation of RunPython and\ndjango.db.migrations.operations.RunSQL migration operations.
Disables the optimizer when generating a squashed migration. By default, Django\nwill try to optimize the operations in your migrations to reduce the size of\nthe resulting file. Use this option if this process is failing or creating\nincorrect migrations, though please also file a Django bug report about the\nbehavior, as optimization is meant to be safe.
\nSuppresses all user prompts.
\nSets the name of the squashed migration. When omitted, the name is based on the\nfirst and last migration, with _squashed_ in between.
Generate squashed migration file without Django version and timestamp header.
\nstartappLink to this heading#Creates a Django app directory structure for the given app name in the current\ndirectory or the given destination.
\nBy default, the new directory contains a\nmodels.py file and other app template files. If only the app name is given,\nthe app directory will be created in the current working directory.
If the optional destination is provided, Django will use that existing\ndirectory rather than creating a new one. You can use '.' to denote the current\nworking directory.
\n例:
\ndjango-admin startapp myapp /Users/jezdez/Code/myapp\nProvides the path to a directory with a custom app template file, or a path to\nan uncompressed archive (.tar) or a compressed archive (.tar.gz,\n.tar.bz2, .tar.xz, .tar.lzma, .tgz, .tbz2, .txz,\n.tlz, .zip) containing the app template files.
For example, this would look for an app template in the given directory when\ncreating the myapp app:
django-admin startapp --template=/Users/jezdez/Code/my_app_template myapp\nDjango will also accept URLs (http, https, ftp) to compressed\narchives with the app template files, downloading and extracting them on the\nfly.
For example, taking advantage of GitHub's feature to expose repositories as\nzip files, you can use a URL like:
\ndjango-admin startapp --template=https://github.com/githubuser/django-app-template/archive/master.zip myapp\nSpecifies which file extensions in the app template should be rendered with the\ntemplate engine. Defaults to py.
Specifies which files in the app template (in addition to those matching\n--extension) should be rendered with the template engine. Defaults to an\nempty list.
The template context used for all matching\nfiles is:
Any option passed to the startapp command (among the command's supported\noptions)
app_name -- the app name as passed to the command
app_directory -- the full path of the newly created app
camel_case_app_name -- the app name in camel case format
docs_version -- the version of the documentation: 'dev' or '1.x'
django_version -- the version of Django, e.g. '2.0.3'
startprojectLink to this heading#Creates a Django project directory structure for the given project name in\nthe current directory or the given destination.
\nBy default, the new directory contains\nmanage.py and a project package (containing a settings.py and other\nfiles).
If only the project name is given, both the project directory and project\npackage will be named <projectname> and the project directory\nwill be created in the current working directory.
If the optional destination is provided, Django will use that existing\ndirectory as the project directory, and create manage.py and the project\npackage within it. Use '.' to denote the current working directory.
例:
\ndjango-admin startproject myproject /Users/jezdez/Code/myproject_repo\nSpecifies a directory, file path, or URL of a custom project template. See the\nstartapp --template documentation for examples and usage.
Specifies which file extensions in the project template should be rendered with\nthe template engine. Defaults to py.
Specifies which files in the project template (in addition to those matching\n--extension) should be rendered with the template engine. Defaults to an\nempty list.
The template context used is:
Any option passed to the startproject command (among the command's\nsupported options)
project_name -- the project name as passed to the command
project_directory -- the full path of the newly created project
secret_key -- a random key for the SECRET_KEY setting
docs_version -- the version of the documentation: 'dev' or '1.x'
django_version -- the version of Django, e.g. '2.0.3'
Please also see the rendering warning as mentioned\nfor startapp.
testLink to this heading#Runs tests for all installed apps. See Django におけるテスト for more\ninformation.
\nStops running tests and reports the failure immediately after a test fails.
\nControls the test runner class that is used to execute tests. This value\noverrides the value provided by the TEST_RUNNER setting.
Suppresses all user prompts. A typical prompt is a warning about deleting an\nexisting test database.
\nThe test command receives options on behalf of the specified\n--testrunner. These are the options of the default test runner:\nDiscoverRunner.
Preserves the test database between test runs. This has the advantage of\nskipping both the create and destroy actions which can greatly decrease the\ntime to run tests, especially those in a large test suite. If the test database\ndoes not exist, it will be created on the first run and then preserved for each\nsubsequent run. Unless the MIGRATE test setting is\nFalse, any unapplied migrations will also be applied to the test database\nbefore running the test suite.
Sorts test cases in the opposite execution order. This may help in debugging\nthe side effects of tests that aren't properly isolated. Grouping by test\nclass is preserved when using this option.
\nSets the DEBUG setting to True prior to running tests. This may\nhelp troubleshoot test failures.
Enables SQL logging for failing tests. If\n--verbosity is 2, then queries in passing tests are also output.
Runs tests in separate parallel processes. Since modern processors have\nmultiple cores, this allows running tests significantly faster.
\nBy default --parallel runs one process per core according to\nmultiprocessing.cpu_count(). You can adjust the number of processes\neither by providing it as the option's value, e.g. --parallel=4, or by\nsetting the DJANGO_TEST_PROCESSES environment variable.
Django distributes test cases — unittest.TestCase subclasses — to\nsubprocesses. If there are fewer test cases than configured processes, Django\nwill reduce the number of processes accordingly.
各プロセスごとに個別のデータベースを持つため、異なるテストケースが同じリソースにアクセスしないように注意が必要です。たとえば、複数のテストケースがファイルシステムにアクセスするような場合には、各テストケースごとに個別に一時ディレクトリを作成するようにしてください。
\n\nThis option requires the third-party tblib package to display tracebacks\ncorrectly:
$ python -m pip install tblib\nThis feature isn't available on Windows. It doesn't work with the Oracle\ndatabase backend either.
\nIf you want to use pdb while debugging tests, you must disable parallel\nexecution (--parallel=1). You'll see something like bdb.BdbQuit if you\ndon't.
Runs only tests marked with the specified tags.\nMay be specified multiple times and combined with test --exclude-tag.
Excludes tests marked with the specified tags.\nMay be specified multiple times and combined with test --tag.
Runs test methods and classes matching test name patterns, in the same way as\nunittest's -k option. Can be specified multiple times.
Spawns a pdb debugger at each test error or failure. If you have it\ninstalled, ipdb is used instead.
Discards output (stdout and stderr) for passing tests, in the same way\nas unittest's --buffer option.
testserverLink to this heading#Runs a Django development server (as in runserver) using data from\nthe given fixture(s).
For example, this command:
\ndjango-admin testserver mydata.json\n...would perform the following steps:
\nCreate a test database, as described in test データベース.
Populate the test database with fixture data from the given fixtures.\n(For more on fixtures, see the documentation for loaddata above.)
Runs the Django development server (as in runserver), pointed at\nthis newly created test database instead of your production database.
This is useful in a number of ways:
\nWhen you're writing unit tests of how your views\nact with certain fixture data, you can use testserver to interact with\nthe views in a Web browser, manually.
Let's say you're developing your Django application and have a "pristine"\ncopy of a database that you'd like to interact with. You can dump your\ndatabase to a fixture (using the dumpdata command, explained\nabove), then use testserver to run your Web application with that data.\nWith this arrangement, you have the flexibility of messing up your data\nin any way, knowing that whatever data changes you're making are only\nbeing made to a test database.
Note that this server does not automatically detect changes to your Python\nsource code (as runserver does). It does, however, detect changes to\ntemplates.
Specifies a different port, or IP address and port, from the default of\n127.0.0.1:8000. This value follows exactly the same format and serves\nexactly the same function as the argument to the runserver command.
例:
\nTo run the test server on port 7000 with fixture1 and fixture2:
django-admin testserver --addrport 7000 fixture1 fixture2\ndjango-admin testserver fixture1 fixture2 --addrport 7000\n(The above statements are equivalent. We include both of them to demonstrate\nthat it doesn't matter whether the options come before or after the fixture\narguments.)
\nTo run on 1.2.3.4:7000 with a test fixture:
django-admin testserver --addrport 1.2.3.4:7000 test\nSuppresses all user prompts. A typical prompt is a warning about deleting an\nexisting test database.
\nSome commands are only available when the django.contrib application that\nimplements them has been\nenabled. This section describes them grouped by\ntheir application.
django.contrib.authLink to this heading#changepasswordLink to this heading#This command is only available if Django's authentication system (django.contrib.auth) is installed.
Allows changing a user's password. It prompts you to enter a new password twice\nfor the given user. If the entries are identical, this immediately becomes the\nnew password. If you do not supply a user, the command will attempt to change\nthe password whose username matches the current user.
\nSpecifies the database to query for the user. Defaults to default.
使い方の例:
\ndjango-admin changepassword ringo\ncreatesuperuserLink to this heading#This command is only available if Django's authentication system (django.contrib.auth) is installed.
superuser アカウント (すべての権限を持ったユーザー) を作成します。このコマンドは、最初に superuser アカウントを作成する場合や、サイトの superuser アカウントをプログラムから自動生成する必要がある場合に便利です。
\nWhen run interactively, this command will prompt for a password for\nthe new superuser account. When run non-interactively, you can provide\na password by setting the DJANGO_SUPERUSER_PASSWORD environment\nvariable. Otherwise, no password will be set, and the superuser account will\nnot be able to log in until a password has been manually set for it.
In non-interactive mode, the\nUSERNAME_FIELD and required\nfields (listed in\nREQUIRED_FIELDS) fall back to\nDJANGO_SUPERUSER_<uppercase_field_name> environment variables, unless they\nare overridden by a command line argument. For example, to provide an email\nfield, you can use DJANGO_SUPERUSER_EMAIL environment variable.
Suppresses all user prompts. If a suppressed prompt cannot be resolved\nautomatically, the command will exit with error code 1.
\nThe username and email address for the new account can be supplied by\nusing the --username and --email arguments on the command\nline. If either of those is not supplied, createsuperuser will prompt for\nit when running interactively.
Specifies the database into which the superuser object will be saved.
\nYou can subclass the management command and override get_input_data() if you\nwant to customize data input and validation. Consult the source code for\ndetails on the existing implementation and the method's parameters. For example,\nit could be useful if you have a ForeignKey in\nREQUIRED_FIELDS and want to\nallow creating an instance instead of entering the primary key of an existing\ninstance.
django.contrib.contenttypesLink to this heading#remove_stale_contenttypesLink to this heading#This command is only available if Django's contenttypes app (django.contrib.contenttypes) is installed.
Deletes stale content types (from deleted models) in your database. Any objects\nthat depend on the deleted content types will also be deleted. A list of\ndeleted objects will be displayed before you confirm it's okay to proceed with\nthe deletion.
\nSpecifies the database to use. Defaults to default.
Deletes stale content types including ones from previously installed apps that\nhave been removed from INSTALLED_APPS. Defaults to False.
django.contrib.gisLink to this heading#ogrinspectLink to this heading#このコマンドは、GeoDjango (django.contrib.gis) がインストールされている場合のみ使用できます。
GeoDjango のドキュメントの description を参照してください。
django.contrib.sessionsLink to this heading#clearsessionsLink to this heading#cron job に設定したり、直接実行することで、期限切れのセッションを削除できます。
\ndjango.contrib.sitemapsLink to this heading#ping_googleLink to this heading#このコマンドは、Sitemaps framework (django.contrib.sitemaps) がインストールされている場合のみ使用できます。
Sitemaps ドのキュメントの description を参照してください。
django.contrib.staticfilesLink to this heading#collectstaticLink to this heading#This command is only available if the static files application (django.contrib.staticfiles) is installed.
Please refer to its description in the\nstaticfiles documentation.
findstaticLink to this heading#This command is only available if the static files application (django.contrib.staticfiles) is installed.
Please refer to its description in the staticfiles documentation.
Although some commands may allow their own custom options, every command\nallows for the following options:
\nAdds the given filesystem path to the Python import search path. If this\nisn't provided, django-admin will use the PYTHONPATH environment\nvariable.
This option is unnecessary in manage.py, because it takes care of setting\nthe Python path for you.
使い方の例:
\ndjango-admin migrate --pythonpath='/home/djangoprojects/myproject'\nSpecifies the settings module to use. The settings module should be in Python\npackage syntax, e.g. mysite.settings. If this isn't provided,\ndjango-admin will use the DJANGO_SETTINGS_MODULE environment\nvariable.
This option is unnecessary in manage.py, because it uses\nsettings.py from the current project by default.
使い方の例:
\ndjango-admin migrate --settings=mysite.settings\nDisplays a full stack trace when a CommandError\nis raised. By default, django-admin will show an error message when a\nCommandError occurs and a full stack trace for any other exception.
使い方の例:
\ndjango-admin migrate --traceback\nSpecifies the amount of notification and debug information that a command\nshould print to the console.
\n0 means no output.
1 means normal output (default).
2 means verbose output.
3 means very verbose output.
使い方の例:
\ndjango-admin migrate --verbosity 2\nDisables colorized command output. Some commands format their output to be\ncolorized. For example, errors will be printed to the console in red and SQL\nstatements will be syntax highlighted.
\n使い方の例:
\ndjango-admin runserver --no-color\nForces colorization of the command output if it would otherwise be disabled\nas discussed in Syntax coloring. For example, you may want to pipe\ncolored output to another command.
\nSkips running system checks prior to running the command. This option is only\navailable if the\nrequires_system_checks command\nattribute is set to True.
使い方の例:
\ndjango-admin migrate --skip-checks\nThe django-admin / manage.py commands will use pretty\ncolor-coded output if your terminal supports ANSI-colored output. It\nwon't use the color codes if you're piping the command's output to\nanother program unless the --force-color option is used.
Under Windows, the native console doesn't support ANSI escape sequences so by\ndefault there is no color output. But you can install the ANSICON\nthird-party tool, the Django commands will detect its presence and will make\nuse of its services to color output just like on Unix-based platforms.
\nThe colors used for syntax highlighting can be customized. Django\nships with three color palettes:
\ndark, suited to terminals that show white text on a black\nbackground. This is the default palette.
light, suited to terminals that show black text on a white\nbackground.
nocolor, which disables syntax highlighting.
You select a palette by setting a DJANGO_COLORS environment\nvariable to specify the palette you want to use. For example, to\nspecify the light palette under a Unix or OS/X BASH shell, you\nwould run the following at a command prompt:
export DJANGO_COLORS="light"\nYou can also customize the colors that are used. Django specifies a\nnumber of roles in which color is used:
\nerror - A major error.
notice - A minor error.
success - A success.
warning - A warning.
sql_field - The name of a model field in SQL.
sql_coltype - The type of a model field in SQL.
sql_keyword - An SQL keyword.
sql_table - The name of a model in SQL.
http_info - A 1XX HTTP Informational server response.
http_success - A 2XX HTTP Success server response.
http_not_modified - A 304 HTTP Not Modified server response.
http_redirect - A 3XX HTTP Redirect server response other than 304.
http_not_found - A 404 HTTP Not Found server response.
http_bad_request - A 4XX HTTP Bad Request server response other than 404.
http_server_error - A 5XX HTTP Server Error response.
migrate_heading - A heading in a migrations management command.
migrate_label - A migration name.
Each of these roles can be assigned a specific foreground and\nbackground color, from the following list:
\nblack
red
green
yellow
blue
magenta
cyan
white
Each of these colors can then be modified by using the following\ndisplay options:
\nbold
underscore
blink
reverse
conceal
A color specification follows one of the following patterns:
\nrole=fg
role=fg/bg
role=fg,option,option
role=fg/bg,option,option
where role is the name of a valid color role, fg is the\nforeground color, bg is the background color and each option\nis one of the color modifying options. Multiple color specifications\nare then separated by a semicolon. For example:
export DJANGO_COLORS="error=yellow/blue,blink;notice=magenta"\nwould specify that errors be displayed using blinking yellow on blue,\nand notices displayed using magenta. All other color roles would be\nleft uncolored.
\nColors can also be specified by extending a base palette. If you put\na palette name in a color specification, all the colors implied by that\npalette will be loaded. So:
\nexport DJANGO_COLORS="light;error=yellow/blue,blink;notice=magenta"\nwould specify the use of all the colors in the light color palette,\nexcept for the colors for errors and notices which would be\noverridden as specified.
\nIf you use the Bash shell, consider installing the Django bash completion\nscript, which lives in extras/django_bash_completion in the Django source\ndistribution. It enables tab-completion of django-admin and\nmanage.py commands, so you can, for instance...
まず、django-admin とタイプします。
[TAB] キーをクリックし、利用できるオプション一覧を表示します。
sql とタイプし、[TAB] キーを押すと、名前が sql で始まるオプション一覧が表示されます。
独自のカスタムアクションを追加したい場合は、カスタム django-admin コマンドの実装 を読んでください。
\nTo call a management command from code use call_command.
namethe name of the command to call or a command object. Passing the name is\npreferred unless the object is required for testing.
\n*argsa list of arguments accepted by the command. Arguments are passed to the\nargument parser, so you can use the same style as you would on the command\nline. For example, call_command('flush', '--verbosity=0').
**optionsnamed options accepted on the command-line. Options are passed to the command\nwithout triggering the argument parser, which means you'll need to pass the\ncorrect type. For example, call_command('flush', verbosity=0) (zero must\nbe an integer rather than a string).
例:
\nfrom django.core import management\nfrom django.core.management.commands import loaddata\n\nmanagement.call_command('flush', verbosity=0, interactive=False)\nmanagement.call_command('loaddata', 'test_data', verbosity=0)\nmanagement.call_command(loaddata.Command(), 'test_data', verbosity=0)\nNote that command options that take no arguments are passed as keywords\nwith True or False, as you can see with the interactive option above.
Named arguments can be passed by using either one of the following syntaxes:
\n# Similar to the command line\nmanagement.call_command('dumpdata', '--natural-foreign')\n\n# Named argument similar to the command line minus the initial dashes and\n# with internal dashes replaced by underscores\nmanagement.call_command('dumpdata', natural_foreign=True)\n\n# `use_natural_foreign_keys` is the option destination variable\nmanagement.call_command('dumpdata', use_natural_foreign_keys=True)\nSome command options have different names when using call_command() instead\nof django-admin or manage.py. For example, django-admin\ncreatesuperuser --no-input translates to call_command('createsuperuser',\ninteractive=False). To find what keyword argument name to use for\ncall_command(), check the command's source code for the dest argument\npassed to parser.add_argument().
Command options which take multiple options are passed a list:
\nmanagement.call_command('dumpdata', exclude=['contenttypes', 'auth'])\nThe return value of the call_command() function is the same as the return\nvalue of the handle() method of the command.
Note that you can redirect standard output and error streams as all commands\nsupport the stdout and stderr options. For example, you could write:
with open('/path/to/command_output', 'w') as f:\n management.call_command('dumpdata', stdout=f)\n