Field options
(字段選項(xiàng)。以下參數(shù)可用于所有字段類型。所有都是可選的。)
Field.null
如果True
,Django將存儲(chǔ)NULL
數(shù)據(jù)庫(kù)中的空值。默認(rèn)是False
。
基于字符串的字段,避免使用null
,如 CharField
和TextField
。如果一個(gè)基于字符串的字段有 null=True
,這意味著它有兩個(gè)可能的值為“無(wú)數(shù)據(jù)”:NULL
和空字符串。在大多數(shù)情況下,“無(wú)數(shù)據(jù)”有兩個(gè)可能的值是多余的,Django約定是使用空字符串,而不是 NULL
。有一個(gè)例外是當(dāng)一個(gè)CharField
有,unique=True
并blank=True
設(shè)置。在這種情況下,null=True
當(dāng)保存具有空值的多個(gè)對(duì)象時(shí),需要避免唯一的約束違規(guī)。
對(duì)于基于字符串和非字符串的字段,您還需要設(shè)置blank=True
是否允許表單中的空值,因?yàn)樵?null
參數(shù)只影響數(shù)據(jù)庫(kù)存儲(chǔ)(請(qǐng)參閱參考資料blank
)。
Field.blank
如果True
,該字段被允許為空白。默認(rèn)是False
。
請(qǐng)注意,這是不同于null
。null
純粹與數(shù)據(jù)庫(kù)相關(guān),而blank
與驗(yàn)證相關(guān)。如果一個(gè)字段有blank=True
,表單驗(yàn)證將允許輸入一個(gè)空值。如果一個(gè)字段有blank=False
,字段將是必需的。
Field.choices
一個(gè)可迭代的(例如,一個(gè)列表或元組),它自己包含兩個(gè)項(xiàng)目(例如)的迭代項(xiàng),用作該項(xiàng)目的選項(xiàng)。如果這是給定的,默認(rèn)的表單小部件將是一個(gè)選擇框與這些選擇,而不是標(biāo)準(zhǔn)的文本字段。[(A, B), (A, B) ...]
每個(gè)元組中的第一個(gè)元素是要在模型上設(shè)置的實(shí)際值,第二個(gè)元素是人類可讀的名稱。例如:
YEAR_IN_SCHOOL_CHOICES = (
('FR' , '大一' ),
('SO' , '大二' ),
('JR' , '少年' ),
('SR' , '高級(jí)' ),
)
通常,最好在模型類中定義選擇,并為每個(gè)值定義一個(gè)適當(dāng)命名的常量:
from django.db import models
class Student(models.Model):
FRESHMAN = 'FR'
SOPHOMORE = 'SO'
JUNIOR = 'JR'
SENIOR = 'SR'
YEAR_IN_SCHOOL_CHOICES = (
(FRESHMAN, 'Freshman'),
(SOPHOMORE, 'Sophomore'),
(JUNIOR, 'Junior'),
(SENIOR, 'Senior'),
)
year_in_school = models.CharField(
max_length=2,
choices=YEAR_IN_SCHOOL_CHOICES,
default=FRESHMAN,
)
def is_upperclass(self):
return self.year_in_school in (self.JUNIOR, self.SENIOR)
Field.db_column
用于此字段的數(shù)據(jù)庫(kù)列的名稱。如果沒(méi)有給出,Django將使用該字段的名稱。
如果您的數(shù)據(jù)庫(kù)列名是SQL保留字,或者包含Python變量名中不允許使用的字符(尤其是連字符),那就OK了。Django在幕后引用列名和表名。
Field.db_index
如果True,將為此字段創(chuàng)建一個(gè)數(shù)據(jù)庫(kù)索引。
Field.db_tablespace
如果此字段已編入索引,則用于此字段索引的數(shù)據(jù)庫(kù)表空間的名稱。默認(rèn)值是項(xiàng)目的 DEFAULT_INDEX_TABLESPACE
設(shè)置(如果已設(shè)置)或 db_tablespace
模型(如果有)。如果后端不支持索引的表空間,則忽略此選項(xiàng)。
Field.default
字段的默認(rèn)值。這可以是一個(gè)值或一個(gè)可調(diào)用的對(duì)象。如果可調(diào)用,則每次創(chuàng)建新對(duì)象時(shí)都會(huì)調(diào)用它。
默認(rèn)不能是可變對(duì)象(模型實(shí)例,list,set等),作為該對(duì)象的相同實(shí)例的引用將被用作在所有新的模型實(shí)例的默認(rèn)值。相反,將所需的默認(rèn)值包裝為可調(diào)用的。例如,如果要指定一個(gè)默認(rèn)dict的 JSONField,使用函數(shù):
def contact_default ():
return { “email” : “to1@example.com” }
contact_info = JSONField (“ContactInfo” , 默認(rèn)= contact_default )
lambdas
不能用于字段選項(xiàng),default
因?yàn)樗鼈儾荒鼙贿w移序列化。請(qǐng)參閱該文檔以了解其他注意事項(xiàng)。
對(duì)于像ForeignKey
映射到模型實(shí)例的字段,默認(rèn)值應(yīng)該是它們引用的字段的值(pk
除非 to_field
設(shè)置),而不是模型實(shí)例。
創(chuàng)建新模型實(shí)例時(shí)使用默認(rèn)值,并且未為該字段提供值。當(dāng)該字段是主鍵時(shí),當(dāng)字段設(shè)置為時(shí)也使用默認(rèn)值None
。
Field.editable
如果False
,該字段將不會(huì)顯示在管理員或任何其他 ModelForm
。在模型驗(yàn)證期間,它們也被跳過(guò)。默認(rèn)是True
。
Field.error_messages
該error_messages
參數(shù)讓您覆蓋該字段將引發(fā)的默認(rèn)消息。傳入一個(gè)與您要覆蓋的錯(cuò)誤消息匹配的密鑰的字典。
錯(cuò)誤消息鍵包括null
,blank
,invalid
,invalid_choice
, unique
,和unique_for_date
。下面的字段類型部分中的每個(gè)字段都指定了其他錯(cuò)誤消息鍵。
這些錯(cuò)誤信息通常不會(huì)傳播到表單。請(qǐng)參閱 關(guān)于模型的error_messages的注意事項(xiàng)。
Field.help_text
額外的“幫助”文本與窗體小部件一起顯示。即使您的字段沒(méi)有在表單上使用,對(duì)于文檔也是有用的。
請(qǐng)注意,此值在自動(dòng)生成的表單中不是 HTML轉(zhuǎn)義的。如果你愿意,help_text
可以讓你包含HTML 。例如:
help_text = “請(qǐng)使用以下格式:<em> YYYY-MM-DD </ em>?!?
或者,您可以使用純文本和 django.utils.html.escape()
轉(zhuǎn)義任何HTML特殊字符。確保您轉(zhuǎn)義任何來(lái)自不受信任的用戶的幫助文本,以避免跨站點(diǎn)腳本攻擊。
Field.primary_key
如果True
這個(gè)字段是模型的主鍵。
如果你沒(méi)有primary_key=True
在你的模型中指定任何字段,Django會(huì)自動(dòng)添加一個(gè)AutoField
來(lái)保存主鍵,所以你不需要primary_key=True
在任何字段上設(shè)置,除非你想覆蓋默認(rèn)的主鍵行為。有關(guān)更多信息,請(qǐng)參閱 自動(dòng)主鍵字段。
primary_key=True
暗示null=False
和 unique=True
。一個(gè)對(duì)象只允許有一個(gè)主鍵。
主鍵字段是只讀的。如果您更改現(xiàn)有對(duì)象上主鍵的值并保存,則會(huì)在舊對(duì)象旁邊創(chuàng)建一個(gè)新對(duì)象。
Field.unique
如果True
,這個(gè)字段在整個(gè)表中必須是唯一的。
這是在數(shù)據(jù)庫(kù)級(jí)和模型驗(yàn)證實(shí)施的。如果您嘗試在unique
字段中保存具有重復(fù)值django.db.IntegrityError
的模型,則模型的save()
方法將引發(fā)一個(gè)模型 。
此選項(xiàng)在除ManyToManyFieldand
外的所有字段類型都有效OneToOneField
。
請(qǐng)注意,何時(shí)unique
是True
,您不需要指定db_index
,因?yàn)?code>unique意味著創(chuàng)建一個(gè)索引。
在Django 1.11中更改:
在舊版本中,unique=True不能使用FileField。
Field.unique_for_date
將其設(shè)置一個(gè)名稱為DateField
或DateTimeField
時(shí),要求此字段對(duì)于日期字段的值是唯一的。
舉例來(lái)說(shuō),如果你有一個(gè)字段title
有unique_for_date="pub_date"
,那么Django的不允許的兩個(gè)記錄具有相同的入口title
和pub_date
。
請(qǐng)注意,如果您將其設(shè)置為指向一個(gè)DateTimeField
,則只會(huì)考慮該字段的日期部分。此外,當(dāng)USE_TZ
是 True
時(shí),支票將在執(zhí)行當(dāng)前時(shí)區(qū)的對(duì)象被保存的時(shí)間。
這是Model.validate_unique()
在模型驗(yàn)證期間強(qiáng)制執(zhí)行的,而不是在數(shù)據(jù)庫(kù)級(jí)。如果任何unique_for_date
約束涉及不屬于某個(gè)字段的字段ModelForm
(例如,如果其中一個(gè)字段列在exclude
或有 editable=False
),Model.validate_unique()
則會(huì)跳過(guò)對(duì)該特定約束的驗(yàn)證。
Field.unique_for_month
類似unique_for_date
,但要求該領(lǐng)域是相對(duì)于本月獨(dú)一無(wú)二的。
Field.unique_for_year
類似unique_for_date
和unique_for_month
。
Field.verbose_name
該字段的人類可讀名稱。如果沒(méi)有給出詳細(xì)名稱,Django將使用字段的屬性名稱自動(dòng)創(chuàng)建它,將下劃線轉(zhuǎn)換為空格。請(qǐng)參閱詳細(xì)字段名稱。
Field.validators
要為此字段運(yùn)行的驗(yàn)證程序列表。有關(guān)更多信息,請(qǐng)參閱驗(yàn)證器文檔。
注冊(cè)和提取查找
Field
實(shí)現(xiàn)查找注冊(cè)API。該API可用于定制哪些查找可用于字段類,以及如何從字段中提取查找。