Model field reference - Field options(Django模塊字段參考 - 字段選項(xiàng))

Field options

(字段選項(xiàng)。以下參數(shù)可用于所有字段類型。所有都是可選的。)

Field.null

如果True,Django將存儲(chǔ)NULL數(shù)據(jù)庫(kù)中的空值。默認(rèn)是False。
基于字符串的字段,避免使用null,如 CharFieldTextField。如果一個(gè)基于字符串的字段有 null=True,這意味著它有兩個(gè)可能的值為“無(wú)數(shù)據(jù)”:NULL和空字符串。在大多數(shù)情況下,“無(wú)數(shù)據(jù)”有兩個(gè)可能的值是多余的,Django約定是使用空字符串,而不是 NULL。有一個(gè)例外是當(dāng)一個(gè)CharField有,unique=Trueblank=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_choiceunique,和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=Falseunique=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í)uniqueTrue,您不需要指定db_index,因?yàn)?code>unique意味著創(chuàng)建一個(gè)索引。

在Django 1.11中更改:
在舊版本中,unique=True不能使用FileField。

Field.unique_for_date

將其設(shè)置一個(gè)名稱為DateFieldDateTimeField時(shí),要求此字段對(duì)于日期字段的值是唯一的。

舉例來(lái)說(shuō),如果你有一個(gè)字段titleunique_for_date="pub_date",那么Django的不允許的兩個(gè)記錄具有相同的入口titlepub_date。

請(qǐng)注意,如果您將其設(shè)置為指向一個(gè)DateTimeField,則只會(huì)考慮該字段的日期部分。此外,當(dāng)USE_TZTrue時(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_dateunique_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可用于定制哪些查找可用于字段類,以及如何從字段中提取查找。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,488評(píng)論 6 531
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,034評(píng)論 3 414
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人,你說(shuō)我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,327評(píng)論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我,道長(zhǎng),這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,554評(píng)論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 71,337評(píng)論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 54,883評(píng)論 1 321
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,975評(píng)論 3 439
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,114評(píng)論 0 286
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,625評(píng)論 1 332
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 40,555評(píng)論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 42,737評(píng)論 1 369
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,244評(píng)論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 43,973評(píng)論 3 345
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,362評(píng)論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,615評(píng)論 1 280
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 51,343評(píng)論 3 390
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 47,699評(píng)論 2 370