模型

模型是你的數(shù)據(jù)的唯一的、權(quán)威的信息源。它包含你所儲存數(shù)據(jù)的必要字段和行為。通常，每個模型對應(yīng)數(shù)據(jù)庫中唯一的一張表。

基礎(chǔ)：

• 每個模型都是django.db.models.Model 的一個Python 子類。
• 模型的每個屬性都表示數(shù)據(jù)庫中的一個字段。
• Django 提供一套自動生成的用于數(shù)據(jù)庫訪問的API；詳見執(zhí)行查詢。

簡短的例子

這個例子定義一個Person模型，它有first_name 和last_name 兩個屬性：

from django.db import models class Person(models.Model):first_name = models.CharField(max_length=30)last_name = models.CharField(max_length=30)

first_name和last_name是模型的兩個字段。每個字段都被指定成一個類屬性，每個屬性映射到一個數(shù)據(jù)庫的列。

上面的Person 模型會在數(shù)據(jù)庫中創(chuàng)建這樣一張表：

CREATE TABLE myapp_person ("id" serial NOT NULL PRIMARY KEY,"first_name" varchar(30) NOT NULL,"last_name" varchar(30) NOT NULL );

一些技術(shù)上的注意事項：

• 這個表的名稱myapp_person，是根據(jù) 模型中的元數(shù)據(jù)自動生成的，也可以覆寫為別的名稱，詳見Table names。
• id?字段是自動添加的，但這個行為可以被重寫。詳見自增主鍵字段。
• 這個例子中的CREATE TABLE SQL 語句使用PostgreSQL 語法格式，要注意的是Django 會根據(jù)設(shè)置文件 中指定的數(shù)據(jù)庫類型來使用相應(yīng)的SQL 語句。

使用模型

定義好模型之后，你需要告訴Django 使用這些模型。你要做的就是修改配置文件中的INSTALLED_APPS?設(shè)置，在其中添加models.py所在應(yīng)用的名稱。

例如，如果你的應(yīng)用的模型位于myapp.models模塊（manage.py startapp 腳本為一個應(yīng)用創(chuàng)建的包結(jié)構(gòu)），INSTALLED_APPS部分看上去應(yīng)該是：

INSTALLED_APPS = (#...'myapp',#... )

當你在INSTALLED_APPS 中添加新的應(yīng)用名時，請確保運行命令manage.py migrate，可以首先使用manage.py makemigrations 來為它們生成遷移腳本。

字段

模型中不可或缺且最為重要的，就是字段集，它是一組數(shù)據(jù)庫字段的列表。字段被指定為類屬性。 要注意選擇的字段名稱不要和模型 API 沖突，比如clean、save 或者delete。

例如：

from django.db import models class Musician(models.Model):first_name = models.CharField(max_length=50)last_name = models.CharField(max_length=50)instrument = models.CharField(max_length=100)class Album(models.Model):artist = models.ForeignKey(Musician)name = models.CharField(max_length=100)release_date = models.DateField()num_stars = models.IntegerField()

字段類型

模型中的每個字段都是 Field 子類的某個實例。Django 根據(jù)字段類的類型確定以下信息：

• 數(shù)據(jù)庫當中的列類型 (比如，?INTEGER, VARCHAR)。
• 渲染表單時使用的默認HTML 部件（例如，<input type="text">, <select>）。
• 最低限度的驗證需求，它被用在 Django 管理站點和自動生成的表單中。

Django 自帶數(shù)十種內(nèi)置的字段類型；完整字段類型列表可以在模型字段參考 中找到。如果內(nèi)置類型仍不能滿足你的要求，你可以自由地編寫符合你要求的字段類型； 詳見編寫自定義的模型字段。

字段選項

每個字段有一些特有的參數(shù)，詳見模型字段參考。例如，CharField（和它的派生類）需要max_length 參數(shù)來指定VARCHAR 數(shù)據(jù)庫字段的大小。

還有一些適用于所有字段的通用參數(shù)。?這些參數(shù)在參考中有詳細定義，這里我們只簡單介紹一些最常用的：

null

如果為True，Django 將用NULL 來在數(shù)據(jù)庫中存儲空值。 默認值是 False.

blank

如果為True，該字段允許不填。默認為False。

要注意，這與 null?不同。null純粹是數(shù)據(jù)庫范疇的，而 blank 是數(shù)據(jù)驗證范疇的。如果一個字段的blank=True，表單的驗證將允許該字段是空值。如果字段的blank=False，該字段就是必填的。

choices

由二元組組成的一個可迭代對象（例如，列表或元組），用來給字段提供選擇項。 如果設(shè)置了choices ，默認的表單將是一個選擇框而不是標準的文本框，而且這個選擇框的選項就是choices 中的選項。

這是一個關(guān)于 choices 列表的例子：

YEAR_IN_SCHOOL_CHOICES = (('FR', 'Freshman'),('SO', 'Sophomore'),('JR', 'Junior'),('SR', 'Senior'),('GR', 'Graduate'), )

每個元組中的第一個元素，是存儲在數(shù)據(jù)庫中的值；第二個元素是在管理界面或 ModelChoiceField 中用作顯示的內(nèi)容。 在一個給定的 model 類的實例中，想得到某個 choices 字段的顯示值，就調(diào)用 get_FOO_display 方法(這里的 FOO 就是 choices 字段的名稱 )。例如：

from django.db import models class Person(models.Model):SHIRT_SIZES = (('S', 'Small'),('M', 'Medium'),('L', 'Large'),)name = models.CharField(max_length=60)shirt_size = models.CharField(max_length=1, choices=SHIRT_SIZES) >>> p = Person(name="Fred Flintstone", shirt_size="L") >>> p.save() >>> p.shirt_size 'L' >>> p.get_shirt_size_display() 'Large'

default

字段的默認值。可以是一個值或者可調(diào)用對象。如果可調(diào)用 ，每有新對象被創(chuàng)建它都會被調(diào)用。

help_text

表單部件額外顯示的幫助內(nèi)容。即使字段不在表單中使用，它對生成文檔也很有用。

primary_key

如果為True，那么這個字段就是模型的主鍵。

如果你沒有指定任何一個字段的primary_key=True，Django 就會自動添加一個IntegerField 字段做為主鍵，所以除非你想覆蓋默認的主鍵行為，否則沒必要設(shè)置任何一個字段的primary_key=True。詳見自增主鍵字段。

主鍵字段是只讀的。如果你在一個已存在的對象上面更改主鍵的值并且保存，一個新的對象將會在原有對象之外創(chuàng)建出來。例如：

from django.db import models class Fruit(models.Model):name = models.CharField(max_length=100, primary_key=True) >>> fruit = Fruit.objects.create(name='Apple') >>> fruit.name = 'Pear' >>> fruit.save() >>> Fruit.objects.values_list('name', flat=True) ['Apple', 'Pear']

unique

如果該值設(shè)置為 True, 這個數(shù)據(jù)字段的值在整張表中必須是唯一的

再說一次，這些僅僅是常用字段的簡短介紹， 要了解詳細內(nèi)容，請查看 通用 model 字段選項參考(common model field option reference).

自增主鍵字段

默認情況下，Django 會給每個模型添加下面這個字段：

id = models.AutoField(primary_key=True)

這是一個自增主鍵字段。

如果你想指定一個自定義主鍵字段，只要在某個字段上指定 primary_key=True 即可。如果 Django 看到你顯式地設(shè)置了 Field.primary_key，就不會自動添加 id 列。

每個模型只能有一個字段指定primary_key=True（無論是顯式聲明還是自動添加）。

字段的自述名

除ForeignKey、ManyToManyField 和 OneToOneField 之外，每個字段類型都接受一個可選的位置參數(shù) —— 字段的自述名。如果沒有給定自述名，Django 將根據(jù)字段的屬性名稱自動創(chuàng)建自述名 —— 將屬性名稱的下劃線替換成空格。

在這個例子中，自述名是 "person's first name"：

first_name = models.CharField("person's first name", max_length=30)

在這個例子中，自述名是 ?"first name"：

first_name = models.CharField(max_length=30)

ForeignKey、ManyToManyField 和 OneToOneField 都要求第一個參數(shù)是一個模型類，所以要使用 verbose_name 關(guān)鍵字參數(shù)才能指定自述名：

poll = models.ForeignKey(Poll, verbose_name="the related poll") sites = models.ManyToManyField(Site, verbose_name="list of sites") place = models.OneToOneField(Place, verbose_name="related place")

習慣上，verbose_name 的首字母不用大寫。Django 在必要的時候會自動大寫首字母。

關(guān)系

顯然，關(guān)系數(shù)據(jù)庫的威力體現(xiàn)在表之間的相互關(guān)聯(lián)。 Django 提供了三種最常見的數(shù)據(jù)庫關(guān)系：多對一(many-to-one)，多對多(many-to-many)，一對一(one-to-one)。

多對一關(guān)系?

Django 使用 django.db.models.ForeignKey 定義多對一關(guān)系。和使用其它字段類型一樣：在模型當中把它做為一個類屬性包含進來。

ForeignKey 需要一個位置參數(shù)：與該模型關(guān)聯(lián)的類。

比如，一輛Car有一個Manufacturer —— 但是一個Manufacturer 生產(chǎn)很多Car，每一輛Car 只能有一個Manufacturer —— 使用下面的定義：

from django.db import modelsclass Manufacturer(models.Model):# ...passclass Car(models.Model):manufacturer = models.ForeignKey(Manufacturer)# ...

你還可以創(chuàng)建遞歸的關(guān)聯(lián)關(guān)系（對象和自己進行多對一關(guān)聯(lián)）和 與尚未定義的模型的關(guān)聯(lián)關(guān)系；詳見模型字段參考。

建議你用被關(guān)聯(lián)的模型的小寫名稱做為ForeignKey 字段的名字（例如，上面manufacturer）。當然，你也可以起別的名字。例如：

class Car(models.Model):company_that_makes_it = models.ForeignKey(Manufacturer)# ...

另見

ForeignKey 字段還接受許多別的參數(shù)，在模型字段參考有詳細介紹。這些選項幫助定義關(guān)聯(lián)關(guān)系應(yīng)該如何工作；它們都是可選的參數(shù)。

訪問反向關(guān)聯(lián)對象的細節(jié)，請見Following relationships backward example。

示例代碼，請見多對一關(guān)系模型示例)。

多對多關(guān)系

ManyToManyField 用來定義多對多關(guān)系，用法和其他Field 字段類型一樣：在模型中做為一個類屬性包含進來。

ManyToManyField 需要一個位置參數(shù)：和該模型關(guān)聯(lián)的類。

例如，一個Pizza可以有多種Topping —— 一種Topping 可以位于多個Pizza 上，而且每個Pizza 可以有多種Topping —— 如下：

from django.db import modelsclass Topping(models.Model):# ...passclass Pizza(models.Model):# ...toppings = models.ManyToManyField(Topping)

和使用ForeignKey 一樣，你也可以創(chuàng)建遞歸的關(guān)聯(lián)關(guān)系（對象與自己的多對多關(guān)聯(lián)）和與尚未定義關(guān)系的模型的關(guān)聯(lián)關(guān)系；詳見模型字段參考。

建議你以被關(guān)聯(lián)模型名稱的復(fù)數(shù)形式做為ManyToManyField 的名字（例如上例中的toppings）。

在哪個模型中設(shè)置 ManyToManyField 并不重要，在兩個模型中任選一個即可 —— 不要兩個模型都設(shè)置。

通常，ManyToManyField 實例應(yīng)該位于可以編輯的表單中。在上面的例子中，toppings 位于Pizza 中（而不是在 Topping 里面設(shè)置pizzas 的 ManyToManyField 字段），因為設(shè)想一個Pizza 有多種Topping 比一個Topping 位于多個Pizza 上要更加自然。按照上面的方式，在Pizza 的表單中將允許用戶選擇不同的Toppings。

另見

完整的示例參見多對多關(guān)系模型示例。

ManyToManyField 字段還接受別的參數(shù)，在模型字段參考中有詳細介紹。這些選項幫助定義關(guān)系應(yīng)該如何工作；它們都是可選的。

多對多關(guān)系中的其他字段

處理類似搭配 pizza 和 topping 這樣簡單的多對多關(guān)系時，使用標準的ManyToManyField? 就可以了。但是，有時你可能需要關(guān)聯(lián)數(shù)據(jù)到兩個模型之間的關(guān)系上。

例如，有這樣一個應(yīng)用，它記錄音樂家所屬的音樂小組。我們可以用一個ManyToManyField 表示小組和成員之間的多對多關(guān)系。但是，有時你可能想知道更多成員關(guān)系的細節(jié)，比如成員是何時加入小組的。

對于這些情況，Django 允許你指定一個模型來定義多對多關(guān)系。 你可以將其他字段放在中介模型里面。源模型的ManyToManyField 字段將使用through 參數(shù)指向中介模型。對于上面的音樂小組的例子，代碼如下：

from django.db import modelsclass Person(models.Model):name = models.CharField(max_length=128)def __str__(self): # __unicode__ on Python 2return self.nameclass Group(models.Model):name = models.CharField(max_length=128)members = models.ManyToManyField(Person, through='Membership')def __str__(self): # __unicode__ on Python 2return self.nameclass Membership(models.Model):person = models.ForeignKey(Person)group = models.ForeignKey(Group)date_joined = models.DateField()invite_reason = models.CharField(max_length=64)

在設(shè)置中介模型時，要顯式指定外鍵并關(guān)聯(lián)到多對多關(guān)系涉及的模型。這個顯式聲明定義兩個模型之間是如何關(guān)聯(lián)的。

中介模型有一些限制：

• 中介模型必須有且只有一個外鍵到源模型（上面例子中的Group），或者你必須使用ManyToManyField.through_fields 顯式指定Django 應(yīng)該使用的外鍵。如果你的模型中存在超個一個的外鍵，并且through_fields沒有指定，將會觸發(fā)一個無效的錯誤。 對目標模型的外鍵有相同的限制（上面例子中的 Person）。
• 對于通過中介模型與自己進行多對多關(guān)聯(lián)的模型，允許存在到同一個模型的兩個外鍵，但它們將被作為多對多關(guān)聯(lián)關(guān)系的兩個（不同的）方面。如果有超過 兩個外鍵，同樣你必須像上面一樣指定through_fields，否則將引發(fā)一個驗證錯誤。
• 使用中介模型定義與自身的多對多關(guān)系時，你必須設(shè)置 symmetrical=False（詳見模型字段參考）。

Changed in Django 1.7:

在Django 1.6 及之前的版本中，中介模型禁止包含多于一個的外鍵。

既然你已經(jīng)設(shè)置好ManyToManyField 來使用中介模型（在這個例子中就是Membership），接下來你要開始創(chuàng)建多對多關(guān)系。你要做的就是創(chuàng)建中介模型的實例：

>>> ringo = Person.objects.create(name="Ringo Starr") >>> paul = Person.objects.create(name="Paul McCartney") >>> beatles = Group.objects.create(name="The Beatles") >>> m1 = Membership(person=ringo, group=beatles, ... date_joined=date(1962, 8, 16), ... invite_reason="Needed a new drummer.") >>> m1.save() >>> beatles.members.all() [<Person: Ringo Starr>] >>> ringo.group_set.all() [<Group: The Beatles>] >>> m2 = Membership.objects.create(person=paul, group=beatles, ... date_joined=date(1960, 8, 1), ... invite_reason="Wanted to form a band.") >>> beatles.members.all() [<Person: Ringo Starr>, <Person: Paul McCartney>]

與普通的多對多字段不同，你不能使用add、 create和賦值語句（比如，beatles.members = [...]）來創(chuàng)建關(guān)系：

# THIS WILL NOT WORK >>> beatles.members.add(john) # NEITHER WILL THIS >>> beatles.members.create(name="George Harrison") # AND NEITHER WILL THIS >>> beatles.members = [john, paul, ringo, george]

為什么不能這樣做？ 這是因為你不能只創(chuàng)建 Person和 Group之間的關(guān)聯(lián)關(guān)系，你還要指定 Membership模型中所需要的所有信息；而簡單的add、create 和賦值語句是做不到這一點的。所以它們不能在使用中介模型的多對多關(guān)系中使用。此時，唯一的辦法就是創(chuàng)建中介模型的實例。

remove()方法被禁用也是出于同樣的原因。但是clear()?方法卻是可用的。它可以清空某個實例所有的多對多關(guān)系：

>>> # Beatles have broken up >>> beatles.members.clear() >>> # Note that this deletes the intermediate model instances >>> Membership.objects.all() []

通過創(chuàng)建中介模型的實例來建立對多對多關(guān)系后，你就可以執(zhí)行查詢了。 和普通的多對多字段一樣，你可以直接使用被關(guān)聯(lián)模型的屬性進行查詢：

# Find all the groups with a member whose name starts with 'Paul' >>> Group.objects.filter(members__name__startswith='Paul') [<Group: The Beatles>]

如果你使用了中介模型，你也可以利用中介模型的屬性進行查詢：

# Find all the members of the Beatles that joined after 1 Jan 1961 >>> Person.objects.filter( ... group__name='The Beatles', ... membership__date_joined__gt=date(1961,1,1)) [<Person: Ringo Starr]

如果你需要訪問一個成員的信息，你可以直接獲取Membership模型：

>>> ringos_membership = Membership.objects.get(group=beatles, person=ringo) >>> ringos_membership.date_joined datetime.date(1962, 8, 16) >>> ringos_membership.invite_reason 'Needed a new drummer.'

另一種獲取相同信息的方法是，在Person對象上查詢多對多反轉(zhuǎn)關(guān)系：

>>> ringos_membership = ringo.membership_set.get(group=beatles) >>> ringos_membership.date_joined datetime.date(1962, 8, 16) >>> ringos_membership.invite_reason 'Needed a new drummer.'

一對一關(guān)系

OneToOneField用來定義一對一關(guān)系。 用法和其他字段類型一樣：在模型里面做為類屬性包含進來。

當某個對象想擴展自另一個對象時，最常用的方式就是在這個對象的主鍵上添加一對一關(guān)系。

OneToOneField要一個位置參數(shù)：與模型關(guān)聯(lián)的類。

例如，你想建一個“places” 數(shù)據(jù)庫，里面有一些常用的字段，比如address、 phone number 等等。 接下來，如果你想在Place 數(shù)據(jù)庫的基礎(chǔ)上建立一個Restaurant 數(shù)據(jù)庫，而不想將已有的字段復(fù)制到Restaurant模型，那你可以在 Restaurant 添加一個OneToOneField 字段，這個字段指向Place（因為Restaurant 本身就是一個Place；事實上，在處理這個問題的時候，你應(yīng)該使用一個典型的 繼承，它隱含一個一對一關(guān)系)。

和使用 ForeignKey一樣，你可以定義_ 遞歸的關(guān)聯(lián)關(guān)系和引用尚未定義關(guān)系的模型。詳見模型字段參考_。

另見

在一對一關(guān)系的模型例子 中有一套完整的例子。

OneToOneField字段也接受一個特定的可選的parent_link參數(shù)，在模型字段參考 中有詳細介紹。

在以前的版本中，OneToOneField 字段會自動變成模型 的主鍵。不過現(xiàn)在已經(jīng)不這么做了(不過要是你愿意的話，你仍可以傳遞 primary_key參數(shù)來創(chuàng)建主鍵字段)。所以一個 模型 中可以有多個OneToOneField 字段。

跨文件的模型

訪問其他應(yīng)用的模型是非常容易的。 在文件頂部你定義模型的地方，導入相關(guān)的模型來實現(xiàn)它。然后，無論在哪里需要的話，都可以引用它。例如：

from django.db import models from geography.models import ZipCodeclass Restaurant(models.Model):# ...zip_code = models.ForeignKey(ZipCode)

字段命名的限制

Django 對字段的命名只有兩個限制：

字段的名稱不能是Python 保留的關(guān)鍵字，因為這將導致一個Python 語法錯誤。例如：

class Example(models.Model):pass = models.IntegerField() # 'pass' is a reserved word!

由于Django 查詢語法的工作方式，字段名稱中連續(xù)的下劃線不能超過一個。例如：

class Example(models.Model):foo__bar = models.IntegerField() # 'foo__bar' has two underscores!

這些限制有變通的方法，因為沒有要求字段名稱必須與數(shù)據(jù)庫的列名匹配。參 db_column 選項。

SQL 的保留字例如join、where 和select，可以用作模型的字段名，因為Django 會對底層的SQL 查詢語句中的數(shù)據(jù)庫表名和列名進行轉(zhuǎn)義。 它根據(jù)你的數(shù)據(jù)庫引擎使用不同的引用語法。

自定義字段類型

如果已有的模型字段都不合適，或者你想用到一些很少見的數(shù)據(jù)庫列類型的優(yōu)點，你可以創(chuàng)建你自己的字段類型。創(chuàng)建你自己的字段在編寫自定義的模型字段中有完整講述。

元選項

使用內(nèi)部的class Meta 定義模型的元數(shù)據(jù)，例如：

from django.db import modelsclass Ox(models.Model):horn_length = models.IntegerField()class Meta:ordering = ["horn_length"]verbose_name_plural = "oxen"

模型元數(shù)據(jù)是“任何不是字段的數(shù)據(jù)”，比如排序選項（ordering），數(shù)據(jù)表名（db_table）或者人類可讀的單復(fù)數(shù)名稱（verbose_name 和verbose_name_plural）。在模型中添加class Meta是完全可選的，所有選項都不是必須的。

所有元選項的完整列表可以在模型選項參考找到。

模型的屬性

objects

The most important attribute of a model is the
Manager. It’s the interface through which
database query operations are provided to Django models and is used to
retrieve the instances from the database. If no
custom Manager is defined, the default name is
objects. Managers are only accessible via
model classes, not the model instances.

模型的方法

可以在模型上定義自定義的方法來給你的對象添加自定義的“底層”功能。Manager 方法用于“表范圍”的事務(wù)，模型的方法應(yīng)該著眼于特定的模型實例。

這是一個非常有價值的技術(shù)，讓業(yè)務(wù)邏輯位于同一個地方 —— 模型中。

例如，下面的模型具有一些自定義的方法：

from django.db import modelsclass Person(models.Model):first_name = models.CharField(max_length=50)last_name = models.CharField(max_length=50)birth_date = models.DateField()def baby_boomer_status(self):"Returns the person's baby-boomer status."import datetimeif self.birth_date < datetime.date(1945, 8, 1):return "Pre-boomer"elif self.birth_date < datetime.date(1965, 1, 1):return "Baby boomer"else:return "Post-boomer"def _get_full_name(self):"Returns the person's full name."return '%s %s' % (self.first_name, self.last_name)full_name = property(_get_full_name)

這個例子中的最后一個方法是一個property。

模型實例參考 具有一個完整的為模型自動生成的方法 列表。你可以覆蓋它們 —— 參見下文覆蓋模型預(yù)定義的方法 —— 但是有些方法你會始終想要重新定義：

__str__() (Python 3)

Python 3 equivalent of __unicode__().

__unicode__() (Python 2)

一個Python “魔法方法”，返回對象的Unicode “表示形式”。當模型實例需要強制轉(zhuǎn)換并顯示為普通的字符串時，Python 和Django 將使用這個方法。最明顯是在交互式控制臺或者管理站點顯示一個對象的時候。

將將永遠想要定義這個方法；默認的方法幾乎沒有意義。

get_absolute_url()

它告訴Django 如何計算一個對象的URL。Django 在它的管理站點中使用到這個方法，在其它任何需要計算一個對象的URL 時也將用到。

任何具有唯一標識自己的URL 的對象都應(yīng)該定義這個方法。

覆蓋預(yù)定義的模型方法

還有另外一部分封裝數(shù)據(jù)庫行為的模型方法，你可能想要自定義它們。特別是，你將要經(jīng)常改變save() 和delete() 的工作方式。

你可以自由覆蓋這些方法（和其它任何模型方法）來改變它們的行為。

覆蓋內(nèi)建模型方法的一個典型的使用場景是，你想在保存一個對象時做一些其它事情。例如（參見save() 中關(guān)于它接受的參數(shù)的文檔）：

from django.db import modelsclass Blog(models.Model):name = models.CharField(max_length=100)tagline = models.TextField()def save(self, *args, **kwargs):do_something()super(Blog, self).save(*args, **kwargs) # Call the "real" save() method.do_something_else()

你還可以阻止保存：

from django.db import modelsclass Blog(models.Model):name = models.CharField(max_length=100)tagline = models.TextField()def save(self, *args, **kwargs):if self.name == "Yoko Ono's blog":return # Yoko shall never have her own blog!else:super(Blog, self).save(*args, **kwargs) # Call the "real" save() method.

必須要記住調(diào)用超類的方法—— super(Blog, self).save(*args, **kwargs) —— 來確保對象被保存到數(shù)據(jù)庫中。如果你忘記調(diào)用超類的這個方法，默認的行為將不會發(fā)生且數(shù)據(jù)庫不會有任何改變。

還要記住傳遞參數(shù)給這個模型方法 —— 即*args, **kwargs。 Django 未來將一直會擴展內(nèi)建模型方法的功能并添加新的參數(shù)。如果在你的方法定義中使用*args, **kwargs，將保證你的代碼自動支持這些新的參數(shù)。

Overridden model methods are not called on bulk operations

注意，當使用查詢集批量刪除對象時，將不會為每個對象調(diào)用delete() 方法。為確保自定義的刪除邏輯得到執(zhí)行，你可以使用pre_delete 和/或post_delete 信號。

不幸的是，當批量creating 或updating 對象時沒有變通方法，因為不會調(diào)用save()、pre_save和 post_save。

執(zhí)行自定義的SQL

另外一個常見的需求是在模型方法和模塊級別的方法中編寫自定義的SQL 語句。關(guān)于使用原始SQL 語句的更多細節(jié)，參見使用原始 SQL 的文檔。

模型繼承

Django 中的模型繼承與 Python 中普通類繼承方式幾乎完全相同，但是本頁頭部列出的模型基本的要求還是要遵守。這表示自定義的模型類應(yīng)該繼承django.db.models.Model。

你唯一需要作出的決定就是你是想讓父模型具有它們自己的數(shù)據(jù)庫表，還是讓父模型只持有一些共同的信息而這些信息只有在子模型中才能看到。

在Django 中有3中風格的繼承。

通常，你只想使用父類來持有一些信息，你不想在每個子模型中都敲一遍。這個類永遠不會單獨使用，所以你使用抽象基類。

如果你繼承一個已經(jīng)存在的模型且想讓每個模型具有它自己的數(shù)據(jù)庫表，那么應(yīng)該使用多表繼承。

最后，如果你只是想改變模塊Python 級別的行為，而不用修改模型的字段，你可以使用代理模型。

抽象基類

當你想將一些常見信息存儲到很多model的時候，抽象化類是十分有用的。你編寫完基類之后，在 Meta類中設(shè)置 abstract=True ，該類就不能創(chuàng)建任何數(shù)據(jù)表。取而代之的是，當它被用來作為一個其他model的基礎(chǔ)類時，它將被加入那一子類中。如果抽象化基礎(chǔ)類和它的子類有相同的項，那么將會出現(xiàn)error（并且Django將返回一個exception）。

一個例子

from django.db import models class CommonInfo(models.Model):name = models.CharField(max_length=100)age = models.PositiveIntegerField()class Meta:abstract = Trueclass Student(CommonInfo):home_group = models.CharField(max_length=5)

Student 模型將有三個項：name, age 和 home_group。CommonInfo 模型無法像一般的Django模型一樣使用，因為它是一個抽象化基礎(chǔ)類。它無法生成數(shù)據(jù)表單或者管理器，并且不能實例化或者儲存。

對很多用戶來說, 這種類型的模型繼承就是你想要的。它提供一種在 Python 語言層級上提取公共信息的方式，但在數(shù)據(jù)庫層級上，各個子類仍然只創(chuàng)建一個數(shù)據(jù)庫。

元 繼承

當一個抽象類被創(chuàng)建的時候, Django會自動把你在基類中定義的 Meta 作為子類的一個屬性。如果子類沒有聲明自己的Meta 類, 他將會繼承父類的Meta. 如果子類想要擴展父類??的，可以繼承父類的?Meta?即可，例如

from django.db import modelsclass CommonInfo(models.Model):# ...class Meta:abstract = Trueordering = ['name']class Student(CommonInfo):# ...class Meta(CommonInfo.Meta):db_table = 'student_info'

繼承時，Django 會對基類的 Meta類做一個調(diào)整：在安裝 Meta屬性之前，Django 會設(shè)置 abstract=False。這意味著抽象基類的子類不會自動變成抽象類。 當然，你可以讓一個抽象類繼承另一個抽象基類，不過每次都要顯式地設(shè)置 abstract=True。

對于抽象基類而言，有些屬性放在 ?Meta?內(nèi)嵌類里面是沒有意義的。例如，包含 db_table將意味著所有的子類(是指那些沒有指定自己的 Meta 類的子類)都使用同一張數(shù)據(jù)表，一般來說，這并不是我們想要的。

小心使用 related_name

如果你在 ForeignKey或 ?ManyToManyField字段上使用 ?related_name屬性，你必須總是為該字段指定一個唯一的反向名稱。但在抽象基類上這樣做就會引發(fā)一個很嚴重的問題。因為 Django 會將基類字段添加到每個子類當中，而每個子類的字段屬性值都完全相同 (這里面就包括related_name)。

當你在(且僅在)抽象基類中使用 related_name 時，如果想繞過這個問題，名稱中就要包含'%(app_label)s'和?'%(class)s'。

• '%(class)s' 會替換為子類的小寫加下劃線格式的名稱，字段在子類中使用。
• '%(app_label)s' 會替換為應(yīng)用的小寫加下劃線格式的名稱，應(yīng)用包含子類。每個安裝的應(yīng)用名稱都應(yīng)該是唯一的，而且應(yīng)用里每個模型類的名稱也應(yīng)該是唯一的，所以產(chǎn)生的名稱應(yīng)該彼此不同。

例如，假設(shè)有一個app叫做common/models.py：

from django.db import modelsclass Base(models.Model):m2m = models.ManyToManyField(OtherModel, related_name="%(app_label)s_%(class)s_related")class Meta:abstract = Trueclass ChildA(Base):passclass ChildB(Base):pass

以及另一個應(yīng)用 rare/models.py：

from common.models import Baseclass ChildB(Base):pass

ChildA.m2m 字段的反向名稱是 childa_related，而 ChildB.m2m 字段的反向名稱是 childb_related。這取決于你如何使用 ?'%(class)s' 和'%(app_label)s來構(gòu)造你的反向名稱。如果你沒有這樣做，Django 就會在驗證 model (或運行 migrate) 時拋出錯誤。

果你沒有在抽象基類中為某個關(guān)聯(lián)字段定義 related_name?屬性，那么默認的反向名稱就是子類名稱加上'_set'，它能否正常工作取決于你是否在子類中定義了同名字段。例如，在上面的代碼中，如果去掉 related_name屬性，在 ChildA中，m2m 字段的反向名稱就是 childa_set；而 ChildB的 m2m 字段的反向名稱就是 childb_set。

多表繼承

這是 Django 支持的第二種繼承方式。使用這種繼承方式時，同一層級下的每個子 model 都是一個真正意義上完整的 model 。 每個子 model 都有專屬的數(shù)據(jù)表，都可以查詢和創(chuàng)建數(shù)據(jù)表。 繼承關(guān)系在子 model 和它的每個父類之間都添加一個鏈接 (通過一個自動創(chuàng)建的 OneToOneField來實現(xiàn))。?例如：

from django.db import models class Place(models.Model):name = models.CharField(max_length=50)address = models.CharField(max_length=80)class Restaurant(Place):serves_hot_dogs = models.BooleanField(default=False)serves_pizza = models.BooleanField(default=False)

Place里面的所有字段在 Restaurant中也是有效的，只不過數(shù)據(jù)保存在另外一張數(shù)據(jù)表當中。所以下面兩個語句都是可以運行的：

>>> Place.objects.filter(name="Bob's Cafe") >>> Restaurant.objects.filter(name="Bob's Cafe")

如果你有一個 Place?，那么它同時也是一個 Restaurant， 那么你可以使用子 model 的小寫形式從 PlPlace 對象中獲得與其對應(yīng)的 Restaurant對象：

>>> p = Place.objects.get(id=12) # If p is a Restaurant object, this will give the child class: >>> p.restaurant <Restaurant: ...>

但是，如果上例中的 p 并不是Restaurant?(比如它僅僅只是 Place對象，或者它是其他類的父類)，那么在引用 p.restaurant就會拋出Restaurant.DoesNotExist 異常。

多表繼承中的Meta

在多表繼承中，子類繼承父類的 Meta類是沒什么意義的。所有的 Meta?選項已經(jīng)對父類起了作用，再次使用只會起反作用。(這與使用抽象基類的情況正好相反，因為抽象基類并沒有屬于它自己的內(nèi)容)

所以子 model 并不能訪問它父類的 Meta?類。但是在某些受限的情況下，子類可以從父類繼承某些 Meta ：如果子類沒有指定 ordering屬性或 get_latest_by 屬性，它就會從父類中繼承這些屬性。

如果父類有了排序設(shè)置，而你并不想讓子類有任何排序設(shè)置，你就可以顯式地禁用排序：

class ChildModel(ParentModel):# ...class Meta:# Remove parent's ordering effectordering = []

繼承與反向關(guān)聯(lián)

因為多表繼承使用了一個隱含的 OneToOneField來鏈接子類與父類，所以象上例那樣，你可以用父類來指代子類。但是這個 OnetoOneField 字段默認的 related_name 值與 ForeignKey 和 ManyToManyField?默認的反向名稱相同。如果你與其他 model 的子類做多對一或是多對多關(guān)系，你就必須在每個多對一和多對多字段上強制指定 related_name。如果你沒這么做，Django 就會在你運行 驗證(validation) ?時拋出異常。

例如，仍以上面 Place類為例，我們創(chuàng)建一個帶有 ManyToManyField字段的子類：

class Supplier(Place):customers = models.ManyToManyField(Place)

這會產(chǎn)生一個錯誤：

Reverse query name for 'Supplier.customers' clashes with reverse query name for 'Supplier.place_ptr'.HINT: Add or change a related_name argument to the definition for 'Supplier.customers' or 'Supplier.place_ptr'.

像下面那樣，向customers字段中添加related_name可以解決這個錯誤：models.ManyToManyField(Place, related_name='provider')。

指定鏈接父類的字段

之前我們提到，Django 會自動創(chuàng)建一個 OneToOneField字段將子類鏈接至非抽象的父 model 。如果你想指定鏈接父類的屬性名稱，你可以創(chuàng)建你自己的 OneToOneField字段并設(shè)置 parent_link=True ，從而使用該字段鏈接父類。

代理模型

使用 ?多表繼承時，model 的每個子類都會創(chuàng)建一張新數(shù)據(jù)表，通常情況下，這正是我們想要的操作。這是因為子類需要一個空間來存儲不包含在基類中的字段數(shù)據(jù)。 但有時，你可能只想更改 model 在 Python 層的行為實現(xiàn)。比如：更改默認的 manager ，或是添加一個新方法。

而這，正是代理 model 繼承方式要做的：為原始 model 創(chuàng)建一個代理?。你可以創(chuàng)建，刪除，更新代理 model 的實例，而且所有的數(shù)據(jù)都可以象使用原始 model 一樣被保存。 不同之處在于：你可以在代理 model 中改變默認的排序設(shè)置和默認的 manager ，更不會對原始 model 產(chǎn)生影響。

聲明代理 model 和聲明普通 model 沒有什么不同。 設(shè)置Meta類中 proxy?的值為 True，就完成了對代理 model 的聲明。

舉個例子，假設(shè)你想給 Django 自帶的標準 Person model添加一個方法。你可以這樣做：

from django.db import modelsclass Person(models.Model):first_name = models.CharField(max_length=30)last_name = models.CharField(max_length=30)class MyPerson(Person):class Meta:proxy = Truedef do_something(self):# ...pass

MyPerson類和它的父類 Person?操作同一個數(shù)據(jù)表。特別的是，Person?的任何實例也可以通過 MyPerson訪問，反之亦然：

>>> p = Person.objects.create(first_name="foobar") >>> MyPerson.objects.get(first_name="foobar") <MyPerson: foobar>

你也可以使用代理 model 給 model 定義不同的默認排序設(shè)置。 你可能并不想每次都給Person模型排序，但是使用代理的時候總是按照last_name屬性排序。這非常容易：

class OrderedPerson(Person):class Meta:ordering = ["last_name"]proxy = True

現(xiàn)在，普通的Person查詢時無序的，而?OrderedPerson查詢會按照last_name排序。

查詢集始終返回請求的模型

也就是說，沒有辦法讓DJango在查詢Person對象時返回MyPerson對象。Person 對象的查詢集會返回相同類型的對象。代理對象的要點是，依賴于原生Person對象的代碼仍然使用它，而你可以使用你添加進來的擴展對象（它不會依賴其它任何代碼）。而并不是將Person模型（或者其它）在所有地方替換為其它你自己創(chuàng)建的模型。

基類的限制

代理 模型必須繼承自一個非抽象基類。 你不能繼承自多個非抽象基類，這是因為一個代理 model 不能連接不同的數(shù)據(jù)表。 代理 model 也可以繼承任意多個抽象基類，但前提是它們沒有?定義任何 model 字段。

代理模型的管理器

如果你沒有在代理 模型中定義任何 管理器 ，代理模型就會從父類中繼承 管理器?。 如果你在代理 模型中定義了一個 管理器 ，它就會變成默認的管理器?，不過定義在父類中的管理器仍然有效。

繼續(xù)上面的例子，當你查詢Person模型的時候，你可以改變默認 管理器，例如：

from django.db import modelsclass NewManager(models.Manager):# ...passclass MyPerson(Person):objects = NewManager()class Meta:proxy = True

如果你想要向代理中添加新的管理器，而不是替換現(xiàn)有的默認管理器，你可以使用自定義管理器管理器文檔中描述的技巧：創(chuàng)建一個含有新的管理器的基類，并且在主基類之后繼承它：

# Create an abstract class for the new manager. class ExtraManagers(models.Model):secondary = NewManager()class Meta:abstract = Trueclass MyPerson(Person, ExtraManagers):class Meta:proxy = True

你可能不需要經(jīng)常這樣做，但這樣做是可行的。

代理 模型與非托管 模型之間的差異

代理 model 繼承看上去和使用Meta類中的 managed?屬性的非托管 model 非常相似。但兩者并不相同，你應(yīng)當考慮選用哪種方案。

一個不同之處是你可以在Meta.managed=False的 model 中定義字段(事實上，是必須指定，除非你真的想得到一個空 model )。在創(chuàng)建非托管 model 時要謹慎設(shè)置Meta.db_table ，這是因為創(chuàng)建的非托管 model 映射某個已存在的 model ，并且有自己的方法。因此，如果你要保證這兩個 model 同步并對程序進行改動，那么就會變得繁冗而脆弱。

另一個不同之處是兩者對 管理器的處理方式不同。 代理 model 要與它所代理的 model 行為相似，所以代理 model 要繼承父 model 的 managers ，包括它的默認 manager 。 但在普通的多表繼承中，子類不能繼承父類的 manager ，這是因為在處理非基類字段時，父類的 manager 未必適用。 后一種情況在 管理器文檔有詳細介紹。

我們實現(xiàn)了這兩種特性之后，曾嘗試把兩者結(jié)合到一起。 結(jié)果證明，宏觀的繼承關(guān)系和微觀的 管理器揉在一起，不僅導致 API 復(fù)雜難用，而且還難以理解。 由于任何場合下都可能需要這兩個選項，所以目前二者仍是各自獨立使用的。

所以，一般規(guī)則是：

如果你要借鑒一個已有的 模型或數(shù)據(jù)表，且不想涉及所有的原始數(shù)據(jù)表的列，那就令 Meta.managed=False。通常情況下，對數(shù)據(jù)庫視圖創(chuàng)建 模型或是數(shù)據(jù)表不需要由 Django 控制時，就使用這個選項。

如果你想對 model 做 Python 層級的改動，又想保留字段不變，那就令 Meta.proxy=True。因此在數(shù)據(jù)保存時，代理 model 相當于完全復(fù)制了原始 模型的存儲結(jié)構(gòu)。

多重繼承

就像Python的子類那樣，DJango的模型可以繼承自多個父類模型。切記一般的Python名稱解析規(guī)則也會適用。出現(xiàn)特定名稱的第一個基類(比如Meta)是所使用的那個。例如，這意味著如果多個父類含有?Meta類，只有第一個會被使用，剩下的會忽略掉。

一般來說，你并不需要繼承多個父類。多重繼承主要對“mix-in”類有用：向每個繼承mix-in的類添加一個特定的、額外的字段或者方法。你應(yīng)該嘗試將你的繼承關(guān)系保持得盡可能簡潔和直接，這樣你就不必費很大力氣來弄清楚某段特定的信息來自哪里。

Changed in Django 1.7.

Django 1.7之前，繼承多個含有id主鍵字段的模型不會拋出異常，但是會導致數(shù)據(jù)丟失。例如，考慮這些模型（由于id字段的沖突，它們不再有效）：

class Article(models.Model):headline = models.CharField(max_length=50)body = models.TextField()class Book(models.Model):title = models.CharField(max_length=50)class BookReview(Book, Article):pass

這段代碼展示了如何創(chuàng)建子類的對象，并覆寫之前創(chuàng)建的父類對象中的值。

>>> article = Article.objects.create(headline='Some piece of news.') >>> review = BookReview.objects.create( ... headline='Review of Little Red Riding Hood.', ... title='Little Red Riding Hood') >>> >>> assert Article.objects.get(pk=article.pk).headline == article.headline Traceback (most recent call last):File "<console>", line 1, in <module> AssertionError >>> # the "Some piece of news." headline has been overwritten. >>> Article.objects.get(pk=article.pk).headline 'Review of Little Red Riding Hood.'

你可以在模型基類中使用顯式的AutoField來合理使用多重繼承：

class Article(models.Model):article_id = models.AutoField(primary_key=True)...class Book(models.Model):book_id = models.AutoField(primary_key=True)...class BookReview(Book, Article):pass

或者是使用一個公共的祖先來持有AutoField：

class Piece(models.Model):passclass Article(Piece):...class Book(Piece):...class BookReview(Book, Article):pass

Field name “hiding” is not permitted

普通的 Python 類繼承允許子類覆蓋父類的任何屬性。 但在 Django 中，重寫 Field實例是不允許的(至少現(xiàn)在還不行)。如果基類中有一個 author字段，你就不能在子類中創(chuàng)建任何名為 author的字段。

重寫父類的字段會導致很多麻煩，比如：初始化實例(指定在 Model.__init__ 中被實例化的字段) 和序列化。而普通的 Python 類繼承機制并不能處理好這些特性。所以 Django 的繼承機制被設(shè)計成與 Python 有所不同，這樣做并不是隨意而為的。

這些限制僅僅針對做為屬性使用的 Field實例，并不是針對 Python 屬性，Python 屬性仍是可以被重寫的。 在 Python 看來，上面的限制僅僅針對字段實例的名稱：如果你手動指定了數(shù)據(jù)庫的列名稱，那么在多重繼承中，你就可以在子類和某個祖先類當中使用同一個列名稱。(因為它們使用的是兩個不同數(shù)據(jù)表的字段)。

如果你在任何一個祖先類中重寫了某個 model 字段，Django 都會拋出 FieldError異常。

另見

The Models Reference

Covers all the model related APIs including model fields, related
objects, and QuerySet.

譯者：Django 文檔協(xié)作翻譯小組，原文：Model syntax。

本文以 CC BY-NC-SA 3.0 協(xié)議發(fā)布，轉(zhuǎn)載請保留作者署名和文章出處。

Django 文檔協(xié)作翻譯小組人手緊缺，有興趣的朋友可以加入我們，完全公益性質(zhì)。交流群：467338606。

總結(jié)

以上是生活随笔為你收集整理的django 1.8 官方文档翻译：2-1-1 模型语法的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。