このドキュメントでは、Model API の詳細を説明しています。モデル と データベースクエリ ガイドにある説明を前提としていますので、このドキュメントを読む前にこの 2 つを読んでおいた方がよいでしょう。
このリファレンスでは、 データベースクエリガイド で提供された Blogモデルの例 を使用します。
\nモデルの新しいインスタンスを作成するには、他の Python クラスと同様にインスタンス化してください:
\nThe keyword arguments are the names of the fields you've defined on your model.\nNote that instantiating a model in no way touches your database; for that, you\nneed to save().
from_db() メソッドを使うと、データベースから読み込むときのモデルインスタンス作成をカスタマイズできます。
引数 db はモデルを読み込む対象となるデータベースへのエイリアスになります。 field_names は読み込まれるすべてのフィールドの名前を持ち、そして values は field_names 内各フィールドに対応した値を持ちます。 field_names は values と同じ並び順になります。モデルのフィールドが全て存在する場合、 values はその順番が __init__() が期待する順番である事が保障されます。つまり、そのインスタンスは cls(*values) によって生成されます。いずれかのフィールドが遅延評価されている場合、そのフィールドは field_names 内には現れません。その場合、存在しない各フィールドには django.db.models.DEFERRED の値が設定されています。
新しいモデルを作成するだけでなく、from_db() メソッドは新しいインスタンスの _state 属性に adding と db のフラグを設定する必要があります。
以下はデータベースから読み出されたフィールドの初期値をどのように保存しているのかについてを示した例です:
\nfrom django.db.models import DEFERRED\n\n\n@classmethod\ndef from_db(cls, db, field_names, values):\n # Default implementation of from_db() (subject to change and could\n # be replaced with super()).\n if len(values) != len(cls._meta.concrete_fields):\n values = list(values)\n values.reverse()\n values = [\n values.pop() if f.attname in field_names else DEFERRED\n for f in cls._meta.concrete_fields\n ]\n instance = cls(*values)\n instance._state.adding = False\n instance._state.db = db\n # customization to store the original field values on the instance\n instance._loaded_values = dict(\n zip(field_names, (value for value in values if value is not DEFERRED))\n )\n return instance\n\n\ndef save(self, **kwargs):\n # Check how the current values differ from ._loaded_values. For example,\n # prevent changing the creator_id of the model. (This example doesn't\n # support cases where 'creator_id' is deferred).\n if not self._state.adding and (\n self.creator_id != self._loaded_values["creator_id"]\n ):\n raise ValueError("Updating the value of creator isn't allowed")\n super().save(**kwargs)\n上の例ではその機能を明らかにするため from_db() の実装を全て行いました。この実装を行う場合では from_db() メソッドから super() を呼び出してもかまいません。
モデルのインスタンスからあるフィールドを削除した場合、再度アクセスする事でその値をデータベースから再読み込みします:
\n>>> obj = MyModel.objects.first()\n>>> del obj.field\n>>> obj.field # Loads the field from the database\n非同期バージョン: arefresh_from_db()
データベースからモデルの値を再読み込みする必要がある場合は、 refresh_from_db() メソッドを利用できます。引数なしでこのメソッドを呼び出した場合は以下の処理が行われます:
モデル上の遅延評価されない全てのフィールドはその時点でデータベース上に存在する値に更新されます。
キャッシュされたリレーションは、リロードされたインスタンスから消去されます。
データベースからはフィールドのみが再読み込みされます。それ以外のアノテーションのようなデータベース依存の値は更新されません。同様に @cached_property 属性などはどれもクリアされません。
再読み込みはインスタンスを読み込むデータベースから、もしくはインスタンスがデータベースから読み込まれない場合はデフォルトのデータベースから行われます。 using 引数は再読み込みを行うデータベースを強制的に設定する際に使用できます。
読み込むフィールドのセットを強制的に設定するには fields 引数を使用できます。
たとえば、update() の呼び出しによって期待する更新が行われたかをテストするため、以下のようなテストを書くことができます。
def test_update_result(self):\n obj = MyModel.objects.create(val=1)\n MyModel.objects.filter(pk=obj.pk).update(val=F("val") + 1)\n # At this point obj.val is still 1, but the value in the database\n # was updated to 2. The object's updated value needs to be reloaded\n # from the database.\n obj.refresh_from_db()\n self.assertEqual(obj.val, 2)\nWhen a deferred field is loaded on-demand for a single model instance, the\nloading happens through this method. Thus it is possible to customize the way\nthis loading happens. The example below shows how one can reload all of the\ninstance's fields when a deferred field is loaded on-demand:
\nclass ExampleModel(models.Model):\n def refresh_from_db(self, using=None, fields=None, **kwargs):\n # fields contains the name of the deferred field to be\n # loaded.\n if fields is not None:\n fields = set(fields)\n deferred_fields = self.get_deferred_fields()\n # If any deferred field is going to be loaded\n if fields.intersection(deferred_fields):\n # then load all of them\n fields = fields.union(deferred_fields)\n super().refresh_from_db(using, fields, **kwargs)\nfrom_queryset 引数を使用すると、_base_manager から作成されたクエリセットとは異なるクエリセットを使用できます。これにより、モデルの再読み込み方法をより細かく制御できるようになります。例えば、モデルで論理削除を使用している場合、refresh_from_db() を呼び出す際にこれを考慮することができます：
obj.refresh_from_db(from_queryset=MyModel.active_objects.all())\n再読み込みされたインスタンスから通常クリアされる関連オブジェクトをキャッシュすることができます。
\nobj.refresh_from_db(from_queryset=MyModel.objects.select_related("related_field"))\nモデルの値を再読み込みする前に、トランザクションの終了まで行をロックすることができます。
\nobj.refresh_from_db(from_queryset=MyModel.objects.select_for_update())\n対象となるモデルにおいて現在評価を遅延している全てのフィールドの属性名を持った集合を返すヘルパーメソッドです。
\nモデルのバリデーションには 4 つのステップがあります:
\nValidate the model fields - Model.clean_fields()
Validate the model as a whole - Model.clean()
Validate the field uniqueness - Model.validate_unique()
制約を検証する - Model.validate_constraints()
モデルの full_clean() メソッドを使うと、4 つ全てのステップが実行されます。
When you use a ModelForm, the call to\nis_valid() will perform these validation steps for\nall the fields that are included on the form. See the ModelForm\ndocumentation for more information. You should only\nneed to call a model's full_clean() method if you plan to handle\nvalidation errors yourself, or if you have excluded fields from the\nModelForm that require validation.
This method calls Model.clean_fields(), Model.clean(),\nModel.validate_unique() (if validate_unique is True), and\nModel.validate_constraints() (if validate_constraints is True)\nin that order and raises a ValidationError that\nhas a message_dict attribute containing errors from all four stages.
オプションの exclude 引数を指定することで、検証とクリーニングから除外するフィールド名の set を指定できます。ModelForm は、この引数をフォーム上に存在しないフィールドを検証対象から除外するために使います。これは、エラーが発生してもユーザーによって修正できないからです。
Note that full_clean() will not be called automatically when you call\nyour model's save() method. You'll need to call it manually\nwhen you want to run one-step model validation for your own manually created\nmodels. For example:
from django.core.exceptions import ValidationError\n\ntry:\n article.full_clean()\nexcept ValidationError as e:\n # Do something based on the errors contained in e.message_dict.\n # Display them to a user, or handle them programmatically.\n pass\nfull_clean() が行う最初のステップは、個々のフィールドをそれぞれクリーニングすることです。
このメソッドはモデル上の全てのフィールドをバリデーションします。オプションの exclude 引数にはバリデーションの対象から除外したいフィールド名の set を渡すことができます。いずれかのフィールドでバリデーションに失敗した場合は ValidationError が送出されます。
The second step full_clean() performs is to call Model.clean().\nThis method should be overridden to perform custom validation on your model.
このメソッドは、独自のモデルバリデーションを提供するために使い、必要な場合はモデルの属性を修正できます。たとえば、フィールドに対して自動的に値を提供したり、複数のフィールドにアクセスする必要のあるバリデーションを実施できます。
\nimport datetime\nfrom django.core.exceptions import ValidationError\nfrom django.db import models\nfrom django.utils.translation import gettext_lazy as _\n\n\nclass Article(models.Model):\n ...\n\n def clean(self):\n # Don't allow draft entries to have a pub_date.\n if self.status == "draft" and self.pub_date is not None:\n raise ValidationError(_("Draft entries may not have a publication date."))\n # Set the pub_date for published items if it hasn't been set already.\n if self.status == "published" and self.pub_date is None:\n self.pub_date = datetime.date.today()\nNote, however, that like Model.full_clean(), a model's clean()\nmethod is not invoked when you call your model's save() method.
上の例では、Model.clean() により発生した ValidationError 例外は文字列によりインスタンス化されていたので、特別なエラーディクショナリのキー NON_FIELD_ERRORS に保存されます。このキーは、特定のフィールドではなくモデル全体に関連付けられたエラーに使用します:
from django.core.exceptions import NON_FIELD_ERRORS, ValidationError\n\ntry:\n article.full_clean()\nexcept ValidationError as e:\n non_field_errors = e.message_dict[NON_FIELD_ERRORS]\n例外を特定のフィールドにアサインするには、ディクショナリで ValidationError をインスタンス化し、キーにフィールド名を指定してください。上記の例を変更して、pub_date フィールドにエラーをアサインします:
class Article(models.Model):\n ...\n\n def clean(self):\n # Don't allow draft entries to have a pub_date.\n if self.status == "draft" and self.pub_date is not None:\n raise ValidationError(\n {"pub_date": _("Draft entries may not have a publication date.")}\n )\n ...\nModel.clean() 実施中に複数フィールドでエラーを発見した場合、ディクショナリを渡してエラーにフィールド名をマップすることもできます:
raise ValidationError(\n {\n "title": ValidationError(_("Missing title."), code="required"),\n "pub_date": ValidationError(_("Invalid date."), code="invalid"),\n }\n)\nそして、full_clean() でモデル上のユニーク制約をチェックします。
このメソッドは clean_fields() と似ていますが、個別のフィールドの値ではなく Field.unique, Field.unique_for_date, Field.unique_for_month, Field.unique_for_year, Meta.unique_together によって定義されたユニーク制約を検証します。オプションの exclude 引数により、バリデーションから除外するフィールド名の set を指定できます。いずれかのフィールドがバリデーションに失敗した場合、ValidationError を発生させます。
Meta.constraints で定義された UniqueConstraint は Model.validate_constraints() によって検証されます。
validate_unique() で exclude 引数を指定した場合、そのうちの 1 つでも含む unique_together 制限はチェックされません。
最後に、full_clean() でモデル上の他の制約をチェックします。
このメソッドは Meta.constraints で定義された全ての制約を検証します。オプションの exclude 引数で、検証から除外するフィールド名の set を指定できます。制約の検証に失敗した場合、 ValidationError を発生させます。
データベースにオブジェクトを保存し直すには、save() を呼び出します:
非同期バージョン: asave()
force_insert と force_update 引数の詳細については INSERT や UPDATE を強制する を参照してください。引数 update_fields の詳細については どのフィールドを保存するか指定する セクションを参照してください。
保存の動作をカスタマイズしたい場合は、save() メソッドをオーバーライドできます。詳しくは 定義済みのモデルメソッドをオーバーライドする を参照してください。
モデル保存のプロセスには、いくつかの細かな注意点もあります; 以下の各セクションを参照してください。
\nモデルに AutoField (自動インクリメントの主キー) がある場合、最初に save() を呼び出すと、自動インクリメントの値が計算され、オブジェクトの属性として保存されます:
>>> b2 = Blog(name="Cheddar Talk", tagline="Thoughts on cheese.")\n>>> b2.id # Returns None, because b2 doesn't have an ID yet.\n>>> b2.save()\n>>> b2.id # Returns the ID of your new object.\nsave() を呼び出す前に、ID の値がどうなるかを知る方法はありません。 なぜなら、その値は Django ではなくデータベースが計算するからです。
利便性のために、各モデルには id という AutoField がデフォルトで用意されていますが、モデル内のフィールドに primary_key=True を明示的に指定しない限り、 id という名前のフィールドは用意されません。詳しくは AutoField のドキュメントを参照してください。
pk プロパティLink to this heading#自分で主キーのフィールドを定義するか、 Django に用意させるかにかかわらず、各モデルには pk というプロパティがあります。これはモデル上の通常の属性のように振る舞いますが、実際にはそのモデルの主キーを構成するフィールドへのエイリアスです。ほかの属性と同様にこの値を読み書きでき、設定すればモデル内の該当フィールドが正しく更新されます。
モデルが AutoField を持っていて、保存時に新しいオブジェクトの ID を明示的に定義したい場合は、ID の自動割り当てに頼るのではなく、保存前に明示的に定義してください:
>>> b3 = Blog(id=3, name="Cheddar Talk", tagline="Thoughts on cheese.")\n>>> b3.id # Returns 3.\n>>> b3.save()\n>>> b3.id # Returns 3.\n自動主キー値を手動で割り当てる場合は、既に存在する主キー 値を使わないようにしてください！すでにデータベースに存在する明示的な主キー値を使って新しいオブジェクトを作成すると、 Django は新しいレコードを作成するのではなく、既存のレコードを変更するものとみなし ます。
\n上記の 'Cheddar Talk' ブログの例を考えると、この例はデータベースの以前のレコードを上書きします:
b4 = Blog(id=3, name="Not Cheddar", tagline="Anything but cheese.")\nb4.save() # Overrides the previous blog with ID=3!\nこのようなことが起こる理由については、後述の How Django knows to UPDATE vs. INSERT を参照してください。
\n自動主キーの値を明示的に指定することは、主キーの衝突が起きないと確信が持てる場合に、オブジェクトを一括保存するときに便利です。
\nPostgreSQLを使用している場合、主キーに関連付けられたシーケンスを更新する必要があるかもしれません。 自動インクリメントの主キーの値を手動で指定する を参照してください。
\nオブジェクトを保存するとき、Django は以下のステップを実行します:
\npre-save シグナルを発信します。 pre_save シグナルが送られ、そのシグナルを待ち受ける関数が何かできるようになります。
データの前処理。 各フィールドの pre_save() メソッドが呼び出され、必要な自動データ修正を行います。たとえば、日付/時刻フィールドは pre_save() をオーバーライドして auto_now_add と auto_now を実装しています。
データベース用のデータを準備します。 各フィールドの get_db_prep_save() メソッドは、データベースに書き込めるデータ型で現在の値を提供するように要求されます。
ほとんどのフィールドではデータの準備は不要です。整数や文字列のような単純なデータ型は Python オブジェクトとして 'すぐに書けます' 。しかし、より複雑なデータ型はしばしば何らかの変更を必要とします。
\nたとえば、 DateField フィールドは Python の datetime オブジェクトを使ってデータを格納します。データベースは datetime オブジェクトを保存しないので、フィールドの値を ISO 準拠の日付文字列に変換してデータベースに挿入する必要があります。
データベースにデータを挿入します。 前処理され準備されたデータは、データベースに挿入するためのSQL文に構成されます。
post-save シグナルを発信します。 post_save シグナルが送られ、 そのシグナルを待ち受ける関数が何かできるようになります。
Django データベースオブジェクトが、オブジェクトの作成と変更に同じ save() メソッドを使うことにお気づきかもしれません。Django は INSERT や UPDATE といった SQL ステートメントを抽象化しています。具体的には、 save() を呼び出し、オブジェクトの主キー属性に default や db_default が 定義されていない場合 、Django はこのアルゴリズムに従います：
オブジェクトの主キー属性が None 以外に設定された場合、 Django は UPDATE を実行します。
オブジェクトの主キー属性がセット されていない、もしくは UPDATE が何もアップデートしなかった場合 (主キーがデータベースに存在しない値に指定されている場合など) 、Django は INSERT を実行します。
オブジェクトの主キー属性に default や db_default が定義されている場合は既存のモデルインスタンスで、主キーにデータベースに存在する値が指定されていれば、Django は UPDATE を実行します。そうでない場合、 Django は INSERT を実行します。
ここで重要なのは、そのプライマリキーが使われていないことが保証できない場合、新しいオブジェクトを保存するときに明示的にプライマリキーの値を指定しないように気をつけることです。このニュアンスについては、上述の 自動プライマリキーの値を明示的に指定する と下記の INSERT や UPDATE を強制する を参照してください。
\nDjango 1.5 以前のバージョンでは、Django は主キー属性が指定されると SELECT を行いました。 SELECT で行が見つかれば UPDATE を行い、見つからなければ INSERT を行いました。古いアルゴリズムでは、 UPDATE の場合にクエリが 1 つ増えます。まれに、データベースにオブジェクトの主キー値の行があっても、その行が更新されたことを報告しない場合があります。たとえば、PostgreSQLの ON UPDATE トリガは NULL を返します。このような場合、 select_on_save オプションを True に設定することで、古いアルゴリズムに戻すことができます。
In some rare circumstances, it's necessary to be able to force the\nsave() method to perform an SQL INSERT and not fall back to\ndoing an UPDATE. Or vice-versa: update, if possible, but not insert a new\nrow. In these cases you can pass the force_insert=True or\nforce_update=True parameters to the save() method.\nPassing both parameters is an error: you cannot both insert and update at the\nsame time!
マルチテーブル継承 を使用する場合、force_insert に親クラスのタプルを渡すことで、各ベースに対して INSERT ステートメントを強制的に挿入できます。たとえば次のようになります:
Restaurant(pk=1, name="Bob's Cafe").save(force_insert=(Place,))\n\nRestaurant(pk=1, name="Bob's Cafe", rating=4).save(force_insert=(Place, Rating))\nforce_insert=(models.Model,) を渡すことで、すべての親モデルに対して INSERT ステートメントを強制的に挿入できます。デフォルトでは、 force_insert=True は現在のモデルに対してのみ新しい行の挿入を強制します。
これらのパラメータを必要とするのは、まれであるべきです。Django は、ほとんどの場合で正しく処理を行い、オーバーライドしようとすると追跡が難しいエラーの原因となります。この機能は応用的な場合のみに使用してください。
\nupdate_fields を使うと force_update と同じように更新を強制します。
フィールドに対して、現在の値をインクリメントしたりデクリメントしたりするような単純な計算が必要になることがあります。これを実現する1つの方法は、Pythonで次のように計算を行うことです:
\n>>> product = Product.objects.get(name="Venezuelan Beaver Cheese")\n>>> product.number_sold += 1\n>>> product.save()\nデータベースから取得した古い number_sold の値は 10 でした。そして、11 という値がデータベースに書き直されます。
The process can be made robust, avoiding a race condition, as well as slightly faster by expressing\nthe update relative to the original field value, rather than as an explicit\nassignment of a new value. Django provides F() 式 for performing\nthis kind of relative update. Using F() 式, the previous example\nis expressed as:
\n>>> from django.db.models import F\n>>> product = Product.objects.get(name="Venezuelan Beaver Cheese")\n>>> product.number_sold = F("number_sold") + 1\n>>> product.save()\nFor more details, see the documentation on F() 式 and their\nuse in update queries.
\nsave() にキーワード引数 update_fields 内でフィールドリストの名前が渡された場合、このリスト内で指定されたフィールドだけが更新されます。これは、オブジェクトの 1 つないし少数のフィールドだけを更新したい場合に望ましいでしょう。データベースで全てのモデルフィールドを更新しないようにすると、実行速度が少し向上します。例えば:
product.name = "Name changed again"\nproduct.save(update_fields=["name"])\nupdate_fields 引数は文字列を含む任意のイテラブルです。空の update_fields イテラブルは保存をスキップします。 None という値は全てのフィールドを更新します。
update_fields を指定すると更新を強制します。
When saving a model fetched through deferred model loading\n(only() or\ndefer()) only the fields loaded\nfrom the DB will get updated. In effect there is an automatic\nupdate_fields in this case. If you assign or change any deferred field\nvalue, the field will be added to the updated fields.
非同期バージョン: adelete()
Issues an SQL DELETE for the object. This only deletes the object in the\ndatabase; the Python instance will still exist and will still have data in\nits fields, except for the primary key set to None. This method returns the\nnumber of objects deleted and a dictionary with the number of deletions per\nobject type. The return value will count instances from related models if\nDjango is emulating cascade behavior via Python on_delete\nvariants. Otherwise, for database variants such as\nDB_CASCADE, the return value will report only\ninstances of the QuerySet's model.
より詳しく (まとめてオブジェクトを削除する方法を含む) については、オブジェクトを削除する を参照してください。
\n独自の削除動作がほしいときは、delete() メソッドをオーバーライドできます。詳しくは 定義済みのモデルメソッドをオーバーライドする を参照してください。
マルチテーブル継承 では、子モデルのデータだけを削除したい場合があります。keep_parents=True を指定すると、親モデルのデータを保持します。
モデルを pickle 化した時、現在の状態はpickle化された状態です。pickle化を解除すると、現在データベースにあるデータではなく、pickle化した時点のモデルインスタンスが格納されます。
いくつかのオブジェクトメソッドには特別な目的があります。
\n__str__()Link to this heading#オブジェクトに対して str() を呼び出すと、 __str__() メソッドが呼び出されます。Django は多くの場所で str(obj) を使います。特に、 Django の管理サイトでオブジェクトを表示するときや、テンプレートでオブジェクトを表示するときに挿入される値として使われます。したがって、 __str__() メソッドからは、常に人間が読めるようなモデルの表現を返さなければなりません。
例:
\nfrom django.db import models\n\n\nclass Person(models.Model):\n first_name = models.CharField(max_length=50)\n last_name = models.CharField(max_length=50)\n\n def __str__(self):\n return f"{self.first_name} {self.last_name}"\n__eq__()Link to this heading#等式メソッドは次のように定義されています: 同じ主キー値と具体的なクラスを持つインスタンスは等しいと見なされますが、主キー値が None のインスタンスはそれ自身以外のものと等しくありません。プロキシモデルの場合、具体的なクラスはモデルの最初の非プロキシ親として定義されます。他のモデルについては、単純にモデルのクラス自体です。
例:
\nfrom django.db import models\n\n\nclass MyModel(models.Model):\n id = models.AutoField(primary_key=True)\n\n\nclass MyProxyModel(MyModel):\n class Meta:\n proxy = True\n\n\nclass MultitableInherited(MyModel):\n pass\n\n\n# Primary keys compared\nMyModel(id=1) == MyModel(id=1)\nMyModel(id=1) != MyModel(id=2)\n# Primary keys are None\nMyModel(id=None) != MyModel(id=None)\n# Same instance\ninstance = MyModel(id=None)\ninstance == instance\n# Proxy model\nMyModel(id=1) == MyProxyModel(id=1)\n# Multi-table inheritance\nMyModel(id=1) != MultitableInherited(id=1)\n__hash__()Link to this heading#The __hash__() method is based on the instance's primary key value. It\nis effectively hash(obj.pk). If the instance doesn't have a primary key\nvalue then a TypeError will be raised (otherwise the __hash__()\nmethod would return different values before and after the instance is\nsaved), but changing the __hash__() value of an instance is\nforbidden in Python.
get_absolute_url()Link to this heading#オブジェクトに対する正式な URL を計算する方法は、get_absolute_url() で定義します。呼び出し元に対して、このメソッドは文字列を返します。この文字列は HTTP を通じてオブジェクトを参照するために使えるものです。
例:
\ndef get_absolute_url(self):\n return "/people/%i/" % self.id\nWhile this code is correct and simple, it may not be the most portable way\nto write this kind of method. The reverse() function is\nusually the best approach.
例:
\ndef get_absolute_url(self):\n from django.urls import reverse\n\n return reverse("people-detail", kwargs={"pk": self.pk})\nDjango が get_absolute_url() を使う場所の一つが、admin アプリです。オブジェクトにこのメソッドが定義されている場合、オブジェクト編集のページは "View on site" リンクを持つようになり、get_absolute_url() で定義された通りオブジェクトの公開用ビューに直接飛べるようになります。
同様に、Django の他にもいくつか、get_absolute_url() が定義されている場合に使用するものがあります (配信フィードフレームワーク など)。 各モデルインスタンスがユニークな URL を持つことが適切な場合、get_absolute_url() を定義すべきです。
It's good practice to use get_absolute_url() in templates, instead of\nhardcoding your objects' URLs. For example, this template code is bad:
<!-- BAD template code. Avoid! -->\n<a href="/people/{{ object.id }}/">{{ object.name }}</a>\n以下のテンプレートコードは改善例です:
\n<a href="{{ object.get_absolute_url }}">{{ object.name }}</a>\nこのロジックのポイントは、オブジェクトのURL構造を変更する場合、スペルミス修正のような些細な変更であっても、URLが生成される場所すべてを修正する必要がないようにすることです。 get_absolute_url() メソッドでURLを一度定義しておけば、コード全体でそのメソッドを呼び出すだけで済みます。
In addition to save(), delete(), a model object\nmight have some of the following methods:
choices が設定されている全てのフィールドに対して、オブジェクトは get_FOO_display() メソッドを持ちます。このメソッドはフィールドの "人間が読める" 値を返します。
例:
\nfrom django.db import models\n\n\nclass Person(models.Model):\n SHIRT_SIZES = {\n "S": "Small",\n "M": "Medium",\n "L": "Large",\n }\n name = models.CharField(max_length=60)\n shirt_size = models.CharField(max_length=2, choices=SHIRT_SIZES)\n>>> p = Person(name="Fred Flintstone", shirt_size="L")\n>>> p.save()\n>>> p.shirt_size\n'L'\n>>> p.get_shirt_size_display()\n'Large'\nnull=True を持たない DateField と DateTimeField に対して、オブジェクトは get_next_by_FOO() と get_previous_by_FOO() メソッドを持ちます。このメソッドは日付フィールドに関する次のオブジェクトと前のオブジェクトを返し、適切な場合には DoesNotExist 例外を発生させます。
これらのメソッドはどちらもモデルのデフォルトマネージャを使用してクエリを実行します。カスタムマネージャによるフィルタリングをエミュレートする必要がある場合、あるいは単発のカスタムフィルタリングを実行したい場合、どちらのメソッドもオプションのキーワード引数を受け付けます。キーワード引数は フィールドルックアップ で説明されている形式でなければなりません。
\n同じ日付の値の場合、これらのメソッドはプライマリ・キーを同値の判定に使用することに注意してください。これにより、レコードがスキップされたり重複したりしないことが保証されます。つまり、これらのメソッドを未保存のオブジェクトで使用することはできないということです。
\n\n_stateLink to this heading#_state 属性はモデルインスタンスのライフサイクルを追跡する ModelState オブジェクトを参照します。
The ModelState object has three attributes: adding, a flag which is\nTrue if the model has not been saved to the database yet, db, a\nstring referring to the database alias the instance was loaded from or\nsaved to, and fetch_mode, the fetch mode to be used in subsequent field fetches.
Newly instantiated instances have adding=True and db=None,\nsince they are yet to be saved, and fetch_mode=models.FETCH_ONE.\nInstances fetched from a QuerySet will have adding=False, db\nset to the alias of the associated database, and fetch_mode copied\nfrom the queryset's fetch mode.
_is_pk_set()Link to this heading#The _is_pk_set() method returns whether the model instance's pk is\nset. It abstracts the model's primary key definition, ensuring consistent\nbehavior regardless of the specific pk configuration. A\nDatabaseDefault on an unsaved instance is considered unset.