このドキュメントには、Django が提供する field options と field types を含む、Field の全ての API リファレンスが記載されています。
以下の引数は全てのフィールドタイプで有効です。全て省略可能です。
\nnullLink to this heading#True``の場合、Django はデータベース内に ``NULL として空の値を保持します。デフォルトは False です。
空の文字列値は常に NULL ではなく空の文字列として保持されるため、文字列ベースのフィールド (CharField や TextField) で null を使うことは避けてください。文字列ベースのフィールドが null=True を持つ場合、"データなし" に対する 2 種類の値があり得ます: NULL と空の文字列です。ほとんどの場合、"データなし" に対して 2 種類の値を持つのは無駄なことです; Django の慣習では、NULL ではなく空の文字列を使います。
文字列ベースと非文字列ベースのフィールドのどちらでも、フォーム内で空の値を許容したい場合には、blank=True をセットすることも必要となります。これは、null パラメータはデータベーストレー時のみに影響するためです (blank を参照してください)。
BooleanField で null 値を許容したい場合、代わりに NullBooleanField を使ってください。
blankLink to this heading#True の場合、フィールドはブランクになることが許容されます。デフォルトは False です。
null とは異なる点に注意してください。null が純粋にデータベースに関連する一方で、blank はバリデーションに関連します。フィールドが blank=True を持つ場合、フォームバリデーションは空の値のエントリーを許容します。blank=False を持つ場合、フィールドは必須となります。
choicesLink to this heading#フィールドに対する選択肢として使うための 2 項目の iterable 自体で構成される ([(A, B), (A, B) ...]) iterable (例: リストやタプル) です。これが与えられた場合は、デフォルトのフォームウィジェットは、標準のテキストフィールドの代わりに、選択肢を伴ったセレクトボックスになります。
各タプルの最初の要素は、モデル上でセットするための実際の値です。2 番目の要素は人間が読むための名前です。例えば:
\nYEAR_IN_SCHOOL_CHOICES = (\n ('FR', 'Freshman'),\n ('SO', 'Sophomore'),\n ('JR', 'Junior'),\n ('SR', 'Senior'),\n)\n一般的に、モデルクラスの内部で選択肢を定義し、それぞれの値に適切に名前づけられた定数を定義するのがベストです:
\nfrom django.db import models\n\nclass Student(models.Model):\n FRESHMAN = 'FR'\n SOPHOMORE = 'SO'\n JUNIOR = 'JR'\n SENIOR = 'SR'\n YEAR_IN_SCHOOL_CHOICES = (\n (FRESHMAN, 'Freshman'),\n (SOPHOMORE, 'Sophomore'),\n (JUNIOR, 'Junior'),\n (SENIOR, 'Senior'),\n )\n year_in_school = models.CharField(\n max_length=2,\n choices=YEAR_IN_SCHOOL_CHOICES,\n default=FRESHMAN,\n )\n\n def is_upperclass(self):\n return self.year_in_school in (self.JUNIOR, self.SENIOR)\nモデルクラスの外部で選択肢のリストを定義して参照することもできますが、モデルの内部でそれぞれの選択肢の値と名前を定義することは、全ての情報をクラスとともに維持し、選択肢を参照しやすくします (例: Student.SOPHOMORE は、Student モデルがインポートされたあらゆる場所で使うことができます)。
組織化する目的に使用できる、名前付きグループに利用可能な選択肢を収集することもできます。
\nMEDIA_CHOICES = (\n ('Audio', (\n ('vinyl', 'Vinyl'),\n ('cd', 'CD'),\n )\n ),\n ('Video', (\n ('vhs', 'VHS Tape'),\n ('dvd', 'DVD'),\n )\n ),\n ('unknown', 'Unknown'),\n)\n各タプルの最初の要素はグループに適用するための名前です。2 番目の要素は 2- タプルの iterale です。値とオプションのための人間が読むための名前を含んだ 各 2- タプルを伴います。グループ化されたオプションは、1 つのリストの中でグループ化されていないオプションと結合することができます (例えば、この例の unknown オプションです)。
\nchoices がセットされているモデルフィールドごとに、Django はフィールドの現在の値に対して人間が読める名前を取得するメソッドを追加します。データベース API ドキュメントの get_FOO_display() を参照してください。
選択肢はどんな iterable オブジェクトも取り得る -- 必ずしもリストやタプルではない -- ことに注意してください。これにより、選択肢を動的に構成することができます。しかし、choices を動的にするためいろいろと工夫するぐらいなら、ForeignKey を使って適切なデータベーステーブルを使用する方が良いでしょう。 choices は、ごく稀にしか変化しない静的なデータを意味しています。
blank=False が default とともにフィールド上にセットされない限り、"---------" を含むラベルがセレクトボックスに表示されます。この動作をオーバーライドするためには、None を含む choices にタプルを追加してください; 例えば (None, '表示専用の文字列'). もしくは、None の代わりに空の文字列を使うこともできます。これは特に CharField などに適しています。
db_columnLink to this heading#The name of the database column to use for this field. If this isn't given,\nDjango will use the field's name.
\nIf your database column name is an SQL reserved word, or contains\ncharacters that aren't allowed in Python variable names -- notably, the\nhyphen -- that's OK. Django quotes column and table names behind the\nscenes.
\ndb_indexLink to this heading#True の場合、データベースインデックスがこのフィールドのために生成されます。
db_tablespaceLink to this heading#The name of the database tablespace to use for\nthis field's index, if this field is indexed. The default is the project's\nDEFAULT_INDEX_TABLESPACE setting, if set, or the\ndb_tablespace of the model, if any. If the backend doesn't\nsupport tablespaces for indexes, this option is ignored.
defaultLink to this heading#そのフィールドのデフォルト値です。このオプションには特定の値もしくは呼び出し可能オブジェクトを渡すことができます。もし渡した値が呼び出し可能であれば新しくオブジェクトが生成される度に呼び出されます。
\nThe default can't be a mutable object (model instance, list, set, etc.),\nas a reference to the same instance of that object would be used as the default\nvalue in all new model instances. Instead, wrap the desired default in a\ncallable. For example, if you want to specify a default dict for\nJSONField, use a function:
def contact_default():\n return {"email": "to1@example.com"}\n\ncontact_info = JSONField("ContactInfo", default=contact_default)\nlambdas can't be used for field options like default because they\ncan't be serialized by migrations. See that\ndocumentation for other caveats.
For fields like ForeignKey that map to model instances, defaults\nshould be the value of the field they reference (pk unless\nto_field is set) instead of model instances.
The default value is used when new model instances are created and a value\nisn't provided for the field. When the field is a primary key, the default is\nalso used when the field is set to None.
editableLink to this heading#If False, the field will not be displayed in the admin or any other\nModelForm. They are also skipped during model\nvalidation. Default is True.
error_messagesLink to this heading#The error_messages argument lets you override the default messages that the\nfield will raise. Pass in a dictionary with keys matching the error messages you\nwant to override.
Error message keys include null, blank, invalid, invalid_choice,\nunique, and unique_for_date. Additional error message keys are\nspecified for each field in the Field types section below.
help_textLink to this heading#フォームウィジェットと共に表示される "補助" テキストになります。この値はフィールドがフォームとして利用されない場合でもドキュメント化する際に有用です。
\nNote that this value is not HTML-escaped in automatically-generated\nforms. This lets you include HTML in help_text if you so\ndesire. For example:
help_text="Please use the following format: <em>YYYY-MM-DD</em>."\nAlternatively you can use plain text and\ndjango.utils.html.escape() to escape any HTML special characters. Ensure\nthat you escape any help text that may come from untrusted users to avoid a\ncross-site scripting attack.
primary_keyLink to this heading#True の場合、設定したフィールドはそのモデルの主キーとなります。
If you don't specify primary_key=True for any field in your model, Django\nwill automatically add an AutoField to hold the primary key, so you\ndon't need to set primary_key=True on any of your fields unless you want to\noverride the default primary-key behavior. For more, see\nAutomatic primary key fields.
primary_key=True implies null=False and\nunique=True. Only one primary key is allowed on an\nobject.
The primary key field is read-only. If you change the value of the primary\nkey on an existing object and then save it, a new object will be created\nalongside the old one.
\nuniqueLink to this heading#True の場合、そのフィールドはテーブル上で一意となる制約を受けます。
This is enforced at the database level and by model validation. If\nyou try to save a model with a duplicate value in a unique\nfield, a django.db.IntegrityError will be raised by the model's\nsave() method.
This option is valid on all field types except ManyToManyField,\nOneToOneField, and FileField.
Note that when unique is True, you don't need to specify\ndb_index, because unique implies the creation of an index.
unique_for_dateLink to this heading#Set this to the name of a DateField or DateTimeField to\nrequire that this field be unique for the value of the date field.
For example, if you have a field title that has\nunique_for_date="pub_date", then Django wouldn't allow the entry of two\nrecords with the same title and pub_date.
Note that if you set this to point to a DateTimeField, only the date\nportion of the field will be considered. Besides, when USE_TZ is\nTrue, the check will be performed in the current time zone at the time the object gets saved.
This is enforced by Model.validate_unique() during model validation\nbut not at the database level. If any unique_for_date constraint\ninvolves fields that are not part of a ModelForm (for\nexample, if one of the fields is listed in exclude or has\neditable=False), Model.validate_unique() will\nskip validation for that particular constraint.
unique_for_monthLink to this heading#Like unique_for_date, but requires the field to be unique with\nrespect to the month.
unique_for_yearLink to this heading#Like unique_for_date and unique_for_month.
verbose_nameLink to this heading#A human-readable name for the field. If the verbose name isn't given, Django\nwill automatically create it using the field's attribute name, converting\nunderscores to spaces. See Verbose field names.
\nvalidatorsLink to this heading#A list of validators to run for this field. See the validators\ndocumentation for more information.
\nField implements the lookup registration API.\nThe API can be used to customize which lookups are available for a field class, and\nhow lookups are fetched from a field.
AutoFieldLink to this heading#利用可能な ID に応じて、自動的にインクリメントする IntegerField です。通常は直接使う必要はありません; 指定しない場合は、主キーのフィールドが自動的にモデルに追加されます。Automatic primary key fields も参照してください。
BigAutoFieldLink to this heading#64 ビットの数値です。1 から 9223372036854775807 までの数を扱える以外は、AutoField と同じです。
BigIntegerFieldLink to this heading#64 ビットの数値です。-9223372036854775808 から 9223372036854775807 を扱える以外は IntegerField と同じです。このフィールドのデフォルトのフォームウィジェットは TextInput です。
BinaryFieldLink to this heading#生のバイナリデータを保持するためのフィールドです。bytes` のアサインメントのみをサポートします。このフィールドには機能制限があります。例えば、BinaryField の値でクエリセットをフィルタすることはできません。また、BinaryField を ModelForm に含めることもできません。
BooleanFieldLink to this heading#true/false のフィールドです。
\nこのフィールドのデフォルトのフォームウィジェットは CheckboxInput です。
null 値を受け入れる必要があるときは、代わりに NullBooleanField を使ってください。
Field.default が定義されていないときの BooleanField のデフォルト値は None です。
CharFieldLink to this heading#小 - 大サイズの文字列のフィールドです。
\n多量のテキストを扱うときは TextField を使ってください。
このフィールドのデフォルトのフォームウィジェットは TextInput です。
CharField には追加的な必須の引数があります:
フィールドの (文字列の) 最大文字数です。max_length はデータベースレベルと Django のバリデーションで施行されます。
\nCommaSeparatedIntegerFieldLink to this heading#カンマによって区切られた数値のフィールドです。CharField と同じく、max_length 引数が必須で、そこで説明したデータベースの可搬性についての注意を考慮する必要があります。
DateFieldLink to this heading#Python で datetime.date インスタンスによって表される日付です。多少の追加的な省略可能な引数を持ちます:
オブジェクトが保存される度に自動的に現在の日付をセットします。"最後の変更" タイムスタンプに役立ちます。現在の日付が常に使われる点に注意してください; オーバーライドできる単なるデフォルト値ではありません。
\nModel.save() が呼ばれたとき、フィールドは自動的に更新されるだけです。QuerySet.update() のような別の方法で他のフィールドに更新を加えるとき、フィールドは更新されません。あのように更新の中でフィールドの独自の値を指定できるとしてもです。
オブジェクトが最初に作成されるとき、自動的にフィールドに現在の日付をセットします。タイムスタンプの作成に役立ちます。現在の日付が 常に 使われる点に注意してください; オーバーライドできる単なるデフォルト値ではありません。たとえオブジェクトを作成するときに値をセットしたとしても無視されます。このフィールドを修正できるようにしておきたい場合は、auto_now_add=True の代わりに以下をセットしてください:
DateField に対して: default=date.today - datetime.date.today() より
DateTimeField に対して: default=timezone.now - django.utils.timezone.now() より
このフィールドのデフォルトのフォームウィジェットは TextInput です。admin は JavaScript カレンダーと "今日" のショートカットを加えます。追加の invalid_date エラーメッセージキーを含みます。
オプション auto_now_add、auto_now、default` は相互に排他的です。これらのオプションを組み合わせるとエラーが発生します。
DateTimeFieldLink to this heading#Python で datetime.datetime インスタンスによって表される日付と時刻です。DateField と同じくいくつかの追加的な引数を持ちます:
このフィールドのデフォルトのフォームウィジェットは単一の TextInput です。admin は JavaScript ショートカットとともに 2 つの別々の TextInput ウィジェットを使います。
DecimalFieldLink to this heading#Python で Decimal インスタンスによって表される固定精度の小数です。2 つの 必須の 引数があります:
数値内で使える桁数の最大値です。 decimal_places 以上でなければならない点に注意してください。
数値とともに保持される小数点以下の位の数です。
\n例えば、小数点以下第2位の精度で 999 までの数値を保持するためには、以下を指定します:
models.DecimalField(..., max_digits=5, decimal_places=2)\n小数点以下第10位の精度で約10億までを保持するには:
\nmodels.DecimalField(..., max_digits=19, decimal_places=10)\nこのフィールドのデフォルトのフォームウィジェットは、localize が False のとき NumberInput で、そうでなければ TextInput となります。
DurationFieldLink to this heading#時刻の期間を保持するフィールドで、 Python の timedelta によってモデル化されます。PostgreSQL で使われるときに用いられるデータ型は interval で、Oracle でのデータ型は INTERVAL DAY(9) TO SECOND(6)``です。 それ以外では、マイクロ秒の ``bigint が使われます。
EmailFieldLink to this heading#値が有効な E メールアドレスかチェックする CharField です。EmailValidator を使ってインプットを検証します。
FileFieldLink to this heading#ファイルアップロードのフィールドです。
\n\n2 つの省略可能な引数があります:
\nこの属性は、アップロードディレクトリとファイル名を設定する方法を提供し、2 つの方法でセットできます。どちらの場合も、値は Storage.save() メソッドに渡されます。
If you specify a string value, it may contain strftime()\nformatting, which will be replaced by the date/time of the file upload (so\nthat uploaded files don't fill up the given directory). For example:
class MyModel(models.Model):\n # file will be uploaded to MEDIA_ROOT/uploads\n upload = models.FileField(upload_to='uploads/')\n # or...\n # file will be saved to MEDIA_ROOT/uploads/2015/01/30\n upload = models.FileField(upload_to='uploads/%Y/%m/%d/')\nIf you are using the default\nFileSystemStorage, the string value\nwill be appended to your MEDIA_ROOT path to form the location on\nthe local filesystem where uploaded files will be stored. If you are using\na different storage, check that storage's documentation to see how it\nhandles upload_to.
upload_to may also be a callable, such as a function. This will be\ncalled to obtain the upload path, including the filename. This callable must\naccept two arguments and return a Unix-style path (with forward slashes)\nto be passed along to the storage system. The two arguments are:
Argument | \n説明 | \n
|---|---|
| \nAn instance of the model where the\n In most cases, this object will not have been\nsaved to the database yet, so if it uses the\ndefault | \n
| \nThe filename that was originally given to the\nfile. This may or may not be taken into account\nwhen determining the final destination path. | \n
For example:
\ndef user_directory_path(instance, filename):\n # file will be uploaded to MEDIA_ROOT/user_<id>/<filename>\n return 'user_{0}/{1}'.format(instance.user.id, filename)\n\nclass MyModel(models.Model):\n upload = models.FileField(upload_to=user_directory_path)\nA storage object, which handles the storage and retrieval of your\nfiles. See Managing files for details on how to provide this object.
\nこのフィールドのデフォルトのフォームウィジェットは ClearableFileInput です。
モデル内で a FileField や ImageField (後述) 使うにはいくつかのステップを取ります:
設定ファイル内で MEDIA_ROOT を指定します。この値は、Django がアップロードされたファイルを置く場所にします (パフォーマン ス上の理由から、ファイルをデータベースに置くことはありません)。 MEDIA_URL をそのディレクトリの公開 URL にします。ディレク トリは Web サーバのユーザアカウントに対して書き込み可能にしておかねばなりません。
Add the FileField or ImageField to your model, defining\nthe upload_to option to specify a subdirectory of\nMEDIA_ROOT to use for uploaded files.
All that will be stored in your database is a path to the file\n(relative to MEDIA_ROOT). You'll most likely want to use the\nconvenience url attribute\nprovided by Django. For example, if your ImageField is called\nmug_shot, you can get the absolute path to your image in a template with\n{{ object.mug_shot.url }}.
For example, say your MEDIA_ROOT is set to '/home/media', and\nupload_to is set to 'photos/%Y/%m/%d'. The '%Y/%m/%d'\npart of upload_to is strftime() formatting;\n'%Y' is the four-digit year, '%m' is the two-digit month and '%d' is\nthe two-digit day. If you upload a file on Jan. 15, 2007, it will be saved in\nthe directory /home/media/photos/2007/01/15.
If you wanted to retrieve the uploaded file's on-disk filename, or the file's\nsize, you could use the name and\nsize attributes respectively; for more\ninformation on the available attributes and methods, see the\nFile class reference and the Managing files\ntopic guide.
The uploaded file's relative URL can be obtained using the\nurl attribute. Internally,\nthis calls the url() method of the\nunderlying Storage class.
Note that whenever you deal with uploaded files, you should pay close attention\nto where you're uploading them and what type of files they are, to avoid\nsecurity holes. Validate all uploaded files so that you're sure the files are\nwhat you think they are. For example, if you blindly let somebody upload files,\nwithout validation, to a directory that's within your Web server's document\nroot, then somebody could upload a CGI or PHP script and execute that script by\nvisiting its URL on your site. Don't allow that.
\nAlso note that even an uploaded HTML file, since it can be executed by the\nbrowser (though not by the server), can pose security threats that are\nequivalent to XSS or CSRF attacks.
\nFileField instances are created in your database as varchar\ncolumns with a default max length of 100 characters. As with other fields, you\ncan change the maximum length using the max_length argument.
FileField と FieldFileLink to this heading#モデル上の FileField にアクセスするとき、元となるファイルにアアクセスするためのプロキシとして、FieldFile のインスタンスが与えられます。
FieldFile の API は File の API を反映していますが、主な違いが 1 つあります: クラスによってラップされたオブジェクトは必ずしも Python のビルトインのファイルオブジェクトのラッパーであるとは限りません。 代わりに、Storage.open() メソッドの結果を包むラッパーで、これは File オブジェクトもしくは File API の独自ストレージの実装となります。
class:~django.core.files.File から継承する API (read() や write()) に加えて、FieldFile 元となるファイルと相互にやりとりするための複数のメソッドを含んでいます:
関連する FileField の Storage のルートからの相対パスを含むファイル名です。
元となる Storage.size() メソッドの結果です。
元となる Storage クラス の url() メソッドを呼ぶことによって、ファイルの相対 URL にアクセスするための読み取り専用プロパティです。
このインスタンスに関連付けられたファイルを、指定された モード で開くか、開き直します。標準の Python の open() メソッドとは違い、ファイルのデスクリプタを返しません。
元となるファイルはアクセスするときに暗黙的に開かれるので、元となるファイルにポインタをリセットするためか モード を変更するため以外には、このメソッドを呼ぶ必要はないでしょう。
標準の Python の file.close() メソッドのように動作し、このインスタンスに関連付けられたファイルを閉じます。
このメソッドは、ファイル名とファイルの内容を取り、それらをフィールドのストレージクラスに渡し、格納されたファイルをモデルフィールドに関連付けます。 手動でファイルデータをモデル上の FileField インスタンスに関連付けるには、save() メソッドを使用してそのファイルデータを保持します。
2 つの必要な引数をとります: name はファイルの名前で、content はファイルの内容を含むオブジェクトです。 省略可能な save 引数は、このフィールドに関連付けられたファイルが変更された後にモデルインスタンスが保存されるかどうかをコントロールします。 デフォルトは True です。
content 引数は、Python のビルトインのファイルオブジェクトではなく、django.core.files.File のインスタンスでなければならないことに注意してください。 以下のように、既存の Python ファイルオブジェクトから File を構築することができます:
from django.core.files import File\n# Open an existing file using Python's built-in open()\nf = open('/path/to/hello.world')\nmyfile = File(f)\nもしくは、以下のように Python の文字列から構築することもできます:
\nfrom django.core.files.base import ContentFile\nmyfile = ContentFile("hello world")\nより詳しくは Managing files をご覧ください。
\nこのインスタンスに関連付けられているファイルを削除し、フィールドのすべての属性をクリアします。 注: このメソッドは、delete() が呼び出されたときにファイルが開いた場合、ファイルを閉じます。
省略可能な save 引数は、このフィールドに関連付けられたファイルが削除された後にモデルインスタンスを保存するかどうかをコントロールします。 デフォルトは True です。
モデルを削除するとき、関連ファイルは削除されない点に注意してください。 孤立したファイルをクリーンアップする必要がある場合、自分で処理する必要があります (例えば、手動で実行したり、例えば cron などを通して定期的に実行される、独自の管理コマンドです)。
\nFilePathFieldLink to this heading#ファイルシステム上の特定のディレクトリ内のファイル名に選択肢が制限されている CharField です。3 つの特別な引数があり、最初の 1 つは 必須 です:
必須です。FilePathField が選択肢から取得するディレクトリへの、ファイルシステムの絶対パスです。例: "/home/images"。
省略可能です。正規表現で、文字列として、FilePathField がファイル名をフィルタリングするために使用します。 正規表現は、フルパスではなくベースファイル名に適用される点に注意してください。 例: "foo.*\\.txt$"。これは foo23.txt とは合致しますが、bar.txt や foo23.png とは合致しません。
省略可能です。True か False のどちらかを取り、デフォルトは False です。path の全てのサブディレクトリを含むかどうかを指定します。
省略可能です。True か False を取り、デフォルトは True です。指定された場所にあるファイルを含むかどうかを指定します。 これか allow_folders のどちらかを True にする必要があります。
省略可能です。True か False を取り、デフォルトは False です。指定した場所にあるフォルダーを含むかどうかを指定します。これか allow_files のどちらかを True にする必要があります。
もちろん、これらの引数は同時に使うことができます。
\n1つの可能性は、フルパスではなく、ベースファイル名に match が適用されることです。 したがって、この例:
FilePathField(path="/home/images", match="foo.*", recursive=True)\n...は、/home/images/foo/bar.png ではなく /home/images/foo.png とマッチします。これは、match がベースのファイル名に適用されるからです (foo.png と bar.png)。
FilePathField のインスタンスは、デフォルトが最大 100 文字の varchar カラムとして、データベース上に生成されます。他のフィールドと同様に、max_length 引数を使って最大文字数を変更することができます。
FloatFieldLink to this heading#float インスタンスによって表される Python の浮動小数点数です。
このフィールドのデフォルトのフォームウィジェットは、localize が False のとき NumberInput で、そうでなければ TextInput となります。
ImageFieldLink to this heading#FileField から全ての属性とメソッドを継承して、さらにアップロードされたオブジェクトが有効な画像であることを検証します。
FileField で使える専用の属性に加えて、ImageField には height と width 属性があります。
これらの属性の照会を容易にするために、ImageField には 2 つの追加的な省略可能な引数があります:
モデルインスタンスが保存される度に画像の高さで自動入力される、モデルフィールドの名前です。
\nモデルインスタンスが保存される度に画像の幅で自動入力される、モデルフィールドの名前です。
\nPillow ライブラリを必要とします。
\nImageField のインスタンスは、デフォルトが最大 100 文字の varchar カラムとして、データベース上に生成されます。他のフィールドと同様に、max_length 引数を使って最大文字数を変更することができます。
このフィールドのデフォルトのフォームウィジェットは ClearableFileInput です。
IntegerFieldLink to this heading#数値です。-2147483648 から 2147483647 までの値は、Django でサポートされているデータベース内では安全です。このフィールドのデフォルトのフォームウィジェットは、localize が False のときには NumberInput で、そうでなければ TextInput となります。
GenericIPAddressFieldLink to this heading#IPv4 か IPv6 のアドレスで、文字列フォーマットです (例: 192.0.2.30 ないし 2a02:42fe::4)。このフィールドのデフォルトのフォームウィジェットは TextInput です。
IPv6 アドレスは、 RFC 4291 Section 2.2 section 2.2 (同セクションの paragraph 3 で提案された IPv4 のフォーマットの使用を含む) にしたがって、 ::ffff:192.0.2.0 のように正規化します。たとえば、 2001:0::0:01 は 2001::1 と正規化され、 ::ffff:0a0a:0a0a は ::ffff:10.10.10.10 と正規化されます。そして、すべての文字は小文字に変換されます。
有効なインプットを、指定したプロトコルに制限します。 使用可能な値は 'both' (デフォルト)、'IPv4'、'IPv6' のどれかです。マッチングは大文字と小文字を区別しません。
IPv4 にマッピングされた ::ffff:192.0.2.1 のようなアドレスをアンパックします。このオプションを有効にすると、このアドレスは 192.0.2.1 とアンパックされます。デフォルトは無効です。protocol が 'both' に設定されている場合にだけ使用できます。
ブランク値を要する場合、ブランク値は null として保持されるため、null 値を許容する必要があります。
\nNullBooleanFieldLink to this heading#BooleanField とほぼ同じですが、オプションの 1 つとして NULL を許容します。BooleanField を null=True で使う代わりにこれを使ってください。このフィールドのデフォルトのフォームウィジェットは NullBooleanSelect です。
PositiveIntegerFieldLink to this heading#IntegerField とほぼ同じですが、正の値かゼロ (0) でなければなりません。Django によってサポートされる全てのデータベースで、0 から 2147483647 までの値は安全です。後方互換性の理由から、値 0 が有効となっています。
PositiveSmallIntegerFieldLink to this heading#PositiveIntegerField とほぼ同じですが、特定の (データベースに依存した) ポイントより下の値のみを許容します。Django でサポートされている全てのデータベースで、0 から 32767 までの値は安全です。
SlugFieldLink to this heading#Slug は新聞の用語です。 スラグは、文字、数字、アンダースコア、またはハイフンのみを含む短いラベルです。 一般的に URL 内で使用されます。
\nCharField のように、max_length を指定することもできます (データベースの可搬性についてのノートとそのセクションの max_length も参照してください)。max_length が指定されていないとき、Django はデフォルトの文字数 50 を使います。
暗黙的に Field.db_index を True にセットします。
It is often useful to automatically prepopulate a SlugField based on the value\nof some other value. You can do this automatically in the admin using\nprepopulated_fields.
If True, the field accepts Unicode letters in addition to ASCII\nletters. Defaults to False.
SmallIntegerFieldLink to this heading#IntegerField とほぼ同じですが、特定の (データベースに依存した) ポイントより下の値のみを許容します。Django でサポートされている全てのデータベースで、-32768 から 32767 までの値は安全です。
TextFieldLink to this heading#多量のテキストのフィールドです。このフィールドのデフォルトのフォームウィジェットは Textarea です。
max_length 属性を指定した場合、自動生成されたフォームフィールドの Textarea ウィジェット内で反映されます。ただし、モデルやデータベースのレベルでは施行されません。そのためには CharField を使用してください。
TimeFieldLink to this heading#Python で datetime.time インスタンスによって表される時刻です。DateField と同じ自動入力されるオプションを受け入れます。
このフィールドのデフォルトのフォームウィジェットは TextInput です。admin がいくつかの JavaScript ショートカットを加えます.
URLFieldLink to this heading#URL のための CharField です。
このフィールドのデフォルトのフォームウィジェットは TextInput です。
全ての CharField サブクラスと同じく、URLField は省略可能な max_length 引数を取ります。max_length を指定しない場合、デフォルトの 200 が使われます。
UUIDFieldLink to this heading#UUID (Universally Unique Identifier) を保持するためのフィールドです。Python's UUID クラスを使います。 PostgreSQL 上で使われるとき、uuid データ型の中に保持します。それ以外は char(32) の中に保持します。
UUID は attr:~Field.primary_key に代わる AutoField への良い選択肢です。 データベースはあなたのための UUID を生成しないため、default を使うことが推奨されます:
import uuid\nfrom django.db import models\n\nclass MyUUIDModel(models.Model):\n id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)\n # other fields\nCallable (括弧が省略されている場合) は UUID のインスタンスではなく、default に渡されます。
Field is an abstract class that represents a database table column.\nDjango uses fields to create the database table (db_type()), to map\nPython types to database (get_prep_value()) and vice-versa\n(from_db_value()).
A field is thus a fundamental piece in different Django APIs, notably,\nmodels and querysets.
In models, a field is instantiated as a class attribute and represents a\nparticular table column, see モデル. It has attributes\nsuch as null and unique, and methods that Django uses to\nmap the field value to database-specific values.
A Field is a subclass of\nRegisterLookupMixin and thus both\nTransform and\nLookup can be registered on it to be used\nin QuerySets (e.g. field_name__exact="foo"). All built-in\nlookups are registered by default.
All of Django's built-in fields, such as CharField, are particular\nimplementations of Field. If you need a custom field, you can either\nsubclass any of the built-in fields or write a Field from scratch. In\neither case, see Writing custom model fields.
A verbose description of the field, e.g. for the\ndjango.contrib.admindocs application.
The description can be of the form:
\ndescription = _("String (up to %(max_length)s)")\nwhere the arguments are interpolated from the field's __dict__.
To map a Field to a database-specific type, Django exposes several\nmethods:
Returns a string naming this field for backend specific purposes.\nBy default, it returns the class name.
\nSee Emulating built-in field types for usage in custom fields.
\nReturns the database column data type for the Field, taking\ninto account the connection.
See Custom database types for usage in custom fields.
\nReturns the database column data type for fields such as ForeignKey\nand OneToOneField that point to the Field, taking\ninto account the connection.
See Custom database types for usage in custom fields.
\nThere are three main situations where Django needs to interact with the\ndatabase backend and fields:
\nwhen it queries the database (Python value -> database backend value)
when it loads data from the database (database backend value -> Python\nvalue)
when it saves to the database (Python value -> database backend value)
When querying, get_db_prep_value() and get_prep_value() are used:
value is the current value of the model's attribute, and the method\nshould return data in a format that has been prepared for use as a\nparameter in a query.
See Converting Python objects to query values for usage.
\nConverts value to a backend-specific value. By default it returns\nvalue if prepared=True and get_prep_value() if is\nFalse.
See Converting query values to database values for usage.
\nWhen loading data, from_db_value() is used:
Converts a value as returned by the database to a Python object. It is\nthe reverse of get_prep_value().
This method is not used for most built-in fields as the database\nbackend already returns the correct Python type, or the backend itself\ndoes the conversion.
\nSee Converting values to Python objects for usage.
\n\nWhen saving, pre_save() and get_db_prep_save() are used:
Same as the get_db_prep_value(), but called when the field value\nmust be saved to the database. By default returns\nget_db_prep_value().
Method called prior to get_db_prep_save() to prepare the value\nbefore being saved (e.g. for DateField.auto_now).
model_instance is the instance this field belongs to and add\nis whether the instance is being saved to the database for the first\ntime.
It should return the value of the appropriate attribute from\nmodel_instance for this field. The attribute name is in\nself.attname (this is set up by Field).
See Preprocessing values before saving for usage.
\nFields often receive their values as a different type, either from\nserialization or from forms.
\nConverts the value into the correct Python object. It acts as the\nreverse of value_to_string(), and is also called in\nclean().
See Converting values to Python objects for usage.
\nBesides saving to the database, the field also needs to know how to\nserialize its value:
\nConverts obj to a string. Used to serialize the value of the field.
See Converting field data for serialization for usage.
\nWhen using model forms, the Field\nneeds to know which form field it should be represented by:
Returns the default django.forms.Field of this field for\nModelForm.
By default, if both form_class and choices_form_class are\nNone, it uses CharField. If the field has\nchoices and choices_form_class\nisn't specified, it uses TypedChoiceField.
See Specifying the form field for a model field for usage.
\nReturns a 4-tuple with enough information to recreate the field:
\nThe name of the field on the model.
The import path of the field (e.g. "django.db.models.IntegerField").\nThis should be the most portable version, so less specific may be better.
A list of positional arguments.
A dict of keyword arguments.
This method must be added to fields prior to 1.7 to migrate its data\nusing マイグレーション.
\nEvery Field instance contains several attributes that allow\nintrospecting its behavior. Use these attributes instead of isinstance\nchecks when you need to write code that depends on a field's functionality.\nThese attributes can be used together with the Model._meta API to narrow down a search for specific field types.\nCustom model fields should implement these flags.
Boolean flag that indicates if the field was automatically created, such\nas the OneToOneField used by model inheritance.
Boolean flag that indicates if the field has a database column associated\nwith it.
\nBoolean flag that indicates if a field is used to back another non-hidden\nfield's functionality (e.g. the content_type and object_id fields\nthat make up a GenericForeignKey). The hidden flag is used to\ndistinguish what constitutes the public subset of fields on the model from\nall the fields on the model.
Boolean flag that indicates if a field contains references to one or\nmore other models for its functionality (e.g. ForeignKey,\nManyToManyField, OneToOneField, etc.).
Returns the model on which the field is defined. If a field is defined on\na superclass of a model, model will refer to the superclass, not the\nclass of the instance.
These attributes are used to query for the cardinality and other details of a\nrelation. These attribute are present on all fields; however, they will only\nhave boolean values (rather than None) if the field is a relation type\n(Field.is_relation=True).
Boolean flag that is True if the field has a many-to-many relation;\nFalse otherwise. The only field included with Django where this is\nTrue is ManyToManyField.
Boolean flag that is True if the field has a many-to-one relation, such\nas a ForeignKey; False otherwise.
Boolean flag that is True if the field has a one-to-many relation, such\nas a GenericRelation or the reverse of a ForeignKey; False\notherwise.
Boolean flag that is True if the field has a one-to-one relation, such\nas a OneToOneField; False otherwise.
Points to the model the field relates to. For example, Author in\nForeignKey(Author, on_delete=models.CASCADE). The related_model for\na GenericForeignKey is always None.