欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

Django Model中的字段类型、参数、Meta选项详解

程序员文章站 2022-05-11 17:26:07
...

model 字段类型

AutoField

 一个自增的IntegerField

一般不直接使用,Django会自动给每张表添加一个自增的primary key。

BigIntegerField

64位整数,

-9223372036854775808 到 9223372036854775807。默认的显示widget 是 TextInput.

BinaryField ( Django 1.6 版本新增 )

存储二进制数据。不能使用 filter 函数获得 QuerySet

BooleanField

True/False,默认的widget 是 CheckboxInput。

如果需要置空,则必须用 NullBooleanField 代替。
Django 1.6 修改:BooleanField 的默认值 由 False 改为 None,在 default 属性未设置的情况下。

CharField

存储字符串。必须有 max_length 参数指定长度。默认的form widget 是 TextInput

如果字符串巨长,推荐使用 TextField。

CommaSeparatedIntegerField

一串由逗号分开的整数。必须有 max_length 参数。

DateField

日期,与python里的datetime.date 实例同。有以下几个可选的选项,均为bool类型:

DateField.auto_now: 每次执行 save 操作的时候自动记录当前时间,常作为最近一次修改的时间 使用。注意:总是在执行save 操作的时候执行,无法覆盖。
DateField.auto_now_add: 第一次创建的时候添加当前时间。常作为 创建时间 使用。注意:每次create 都会调用。
默认的form widget 是 TextInput。
注意:设置auto_now 或者 auto_now_add 为 True 会导致当前自动拥有 editable=False 和 blank = True 设置。

DateTimeField
日期+时间。

与python里的 datetime.datetime 实例同。常用附加选项和DateField一样。
默认 form widget 是一个 TextInput

DecimalField

设置了精度的十进制数字。

A fixed-precision decimal number, represented in Python by a Decimal instance. Has two required arguments:
DecimalField.max_digits
The maximum number of digits allowed in the number. Note that this number must be greater than or equal to decimal_places.
DecimalField.decimal_places?
The number of decimal places to store with the number.
For example, to store numbers up to 999 with a resolution of 2 decimal places, you’d use:
models.DecimalField(…, max_digits=5, decimal_places=2)
And to store numbers up to approximately one billion with a resolution of 10 decimal places:
models.DecimalField(…, max_digits=19, decimal_places=10)
The default form widget for this field is a TextInput.

EmailField

在 CharField 基础上附加了 邮件地址合法性验证。不需要强制设定 max_length

注意:当前默认设置 max_length 是 75,虽然已经不符合标准,但未了向前兼容,未修改。

FileField

文件上传。不支持 primary_key 和 unique 选项。否则会报 TypeError 异常。

必须设置 FileField.upload_to 选项,这个是 本地文件系统路径,附加在 MEDIA_ROOT 设置的后边,也就是 MEDIA_ROOT 下的子目录相对路径。
默认的form widget 是 FileInput。
使用 FileField 和 ImageField 需要以下步骤:
(1)修改 settting.py,设置 MEDIA_ROOT(使用绝对路径),指定用户上传的文件保存在哪里。 设置 MEDIA_URL,作为 web地址 前缀,要保证 MEDIA_ROOT 目录对运行 Django 的用户是可写的;
(2)在 model 中增加 FileField 或 ImageField,并指定 upload_to 选项指定存在 MEDIA_ROOT 的哪个子目录里;
(3)存在数据库里的是什么东西呢?是 File 或 Image相对于 MEDIA_ROOT 的相对路径,你可以在 Django 里方便的使用这个地址, 比如你的 ImageField 叫 tupian,你可以在 template 中用{{object.tupian.url}}。
举个例子:假设你的 MEDIA_ROOT=’/home/media’,upload_to 设置为 ‘photos/%Y/%m/%d’,’%Y/%m/%d’ 部分使用strftime() 提供。如果你在 2013年10月10日上传了一个文件,那么它就存在 /home/media/photos/2013/10/10/ 下。
文件在 model实例 执行 save操作的同时保存,所以文件在model实例执行save之前,硬盘的上的文件名的是不可靠的。
注意:要验证用户上传的文件确实是自己需要的,以防止安全漏洞出现。
默认情况下,FileField 在数据库中表现为 varchar(100) 的一个列。你可以使用 max_length 来改变这个大小。

FileField 和 FieldFile

当你访问 一个 model 内的 FileField 时,将得到一个 FieldFile 实例来访问实际的文件。这个类提供了几个属性和方法用来和实际的文件数据交互:

FieldFile.url:只读属性,获取文件的相对URL地址;
FieldFile.open( mode = ‘rb’ ):打开文件,和python 的 open 一样;
FieldFile.close():和 python 的 file.close() 一样;
FieldFile.save( name, content, save=True ):name 是文件名,content 是包含了文件内容的 django.core.files.File 实例,与 python 的 file 不一样。The optional save argument controls whether or not the instance is saved after the file has been altered. Defaults to True。
两种方式 进行 content 设置:
from django.core.files import File
f = open( ‘helo.txt’ )
content = File(f)
另一种是:
from django.core.files.base import ContentFile
content = ContentFile( ‘helloworld’ )
更多内容可见:https://docs.djangoproject.com/en/dev/topics/files/
FieldFile.delete( save = True ):删除当前的文件。如果文件已经打开,则自动关闭。The optional save argument controls whether or not the instance is saved after the file has been deleted. Defaults to True.
值得注意的是:当一个 model实例 被删除之后,相关联的文件并没有被删除,需要自己清除!

FloatField

与 python 里的 float 实例相同,默认的 form widget 是 TextInput。

虽然 FloatField 与 DecimalField 都是表示实数,但却是不同的表现形式,FloatField 用的是 python d float 类型,但是 DecimalField 用的却是 Decimal 类型。区别可见:http://docs.python.org/2.7/library/decimal.html#decimal

ImageField
在 FileField 基础上加上是否是合法图片验证功能的一个类型。

除了 FileField 有的属性外,ImageField 另有 height 和 width 属性。
To facilitate querying on those attributes, ImageField has two extra optional arguments:
ImageField.height_field
Name of a model field which will be auto-populated with the height of the image each time the model instance is saved.
ImageField.width_field
Name of a model field which will be auto-populated with the width of the image each time the model instance is saved.
注意:需要安装 PIL 或者 Pillow 模块。在数据库中同样表现为 varchar(100),可通过 max_length 改大小。

IntegerField

整数,默认的form widget 是 TextInput。

IPAddressField

IP地址,字符串类型,如 127.0.0.1。默认 form widget 是 TextInput。

TextField

大文本,巨长的文本。默认的 form widget 是 Textarea。

注意,如果使用 MySQLdb 1.2.1p2 和 utf-8_bin 编码,会有一些问题https://docs.djangoproject.com/en/dev/ref/databases/#mysql-collation。具体问题未分析,可自行避开。

URLField

加了 URL 合法性验证的 CharField。

默认的 form widget 是 TextInput。
默认max_length=200,可修改。
18、ForeignKey / ManyToManyField / OneToOneField / SmallIntegerField / SlugField / PositiveSmallIntegerField / PositiveIntegerField

model 参数

null

boolean 值,缺省设置为false。通常不将其用于字符型字段上,比如CharField,TextField上。字符型字段如果没有值会返回空字符串。

blank

boolean 值,该字段是否可以为空。如果为假,则必须有值。

choices

元组值,一个用来选择值的2维元组。第一个值是实际存储的值,第二个用来方便进行选择。如SEX_CHOICES=((‘F’,’Female’),(‘M’,’Male’),)

db_column

string 值,指定当前列在数据库中的名字,不设置,将自动采用model字段名;

db_index

boolean 值,如果为True将为此字段创建索引;

default

给当前字段设定的缺省值,可以是一个具体值,也可以是一个可调用的对象,如果是可调用的对象将每次产生一个新的对象;

editable

boolean 值,如果为假,admin模式下将不能改写。缺省为真;

error_messages

字典,设置默认的出错信息,可覆盖的key 有 null, blank, invalid, invalid_choice, 和 unique。

help_text

admin模式下帮助文档
form widget 内显示帮助文本。

primary_key

设置主键,如果没有设置django创建表时会自动加上:id = meta.AutoField(‘ID’, primary_key=True)
primary_key=True implies blank=False, null=False and unique=True. Only one primary key is allowed on an object.

radio_admin

用于 admin 模式下将 select 转换为 radio 显示。只用于 ForeignKey 或者设置了choices

unique

boolean值,数据是否进行唯一性验证;

unique_for_date

字符串类型,值指向一个DateTimeField 或者 一个 DateField的列名称。日期唯一,如下例中系统将不允许title和pub_date两个都相同的数据重复出现
title = meta.CharField( maxlength=30, unique_for_date=’pub_date’ )

unique_for_month / unique_for_year

用法同上

verbose_name

string类型。更人性化的列名。

validators

有效性检查。无效则抛出 django.core.validators.ValidationError 异常。
如何实现检查器 见:https://docs.djangoproject.com/en/dev/ref/validators/

on_delete:

Django2.0以上版本ForeignKey需添加新参数on_delete,

on_delete指的是通过ForeignKey连接起来的对象被删除后,当前字段怎么变化。

常见的选项有:

  • models.CASCADE,对就对象删除后,包含ForeignKey的字段也会被删除

  • models.PROTECT,删除时会引起ProtectedError

  • models.SET_NULL,注意只有当当前字段设置null设置为True才有效,此情况会将ForeignKey字段设置为null

  • models.SET_DEFAULT ,同样,当前字段设置了default才有效,此情况会将ForeignKey 字段设置为default 值

  • moels.SET,此时需要指定set的值

  • models.DO_NOTHING ,什么也不做

Meta选项

Django模型类的Meta是一个内部类,它用于定义一些Django模型类的行为特性。而可用的选项大致包含以下几类

abstract

这个属性是定义当前的模型是不是一个抽象类。所谓抽象类是不会对应数据库表的。一般我们用它来归纳一些公共属性字段,然后继承它的子类可以继承这些字段。

Options.abstract

如果abstract = True 这个model就是一个抽象类

app_label

这个选型只在一种情况下使用,就是你的模型不在默认的应用程序包下的models.py文件中,这时候需要指定你这个模型是哪个应用程序的。

Options.app_label

如果一个model定义在默认的models.py,例如如果你的app的models在myapp.models子模块下,你必须定义app_label让Django知道它属于哪一个app
app_label = ‘myapp’

db_table

db_table是指定自定义数据库表明的。Django有一套默认的按照一定规则生成数据模型对应的数据库表明。
Options.db_table
定义该model在数据库中的表名称
  db_table = ‘Students’
如果你想使用自定义的表名,可以通过以下该属性
  table_name = ‘my_owner_table’

db_teblespace

Options.db_teblespace
定义这个model所使用的数据库表空间。如果在项目的settin中定义那么它会使用这个值

get_latest_by

Options.get_latest_by
在model中指定一个DateField或者DateTimeField。这个设置让你在使用model的Manager上的lastest方法时,默认使用指定字段来排序

managed

Options.managed
默认值为True,这意味着Django可以使用syncdb和reset命令来创建或移除对应的数据库。默认值为True,如果你不希望这么做,可以把manage的值设置为False

order_with_respect_to

这个选项一般用于多对多的关系中,它指向一个关联对象,就是说关联对象找到这个对象后它是经过排序的。指定这个属性后你会得到一个get_xxx_order()和set_xxx_order()的方法,通过它们你可以设置或者回去排序的对象

ordering

这个字段是告诉Django模型对象返回的记录结果集是按照哪个字段排序的。这是一个字符串的元组或列表,没有一个字符串都是一个字段和用一个可选的表明降序的’-‘构成。当字段名前面没有’-‘时,将默认使用升序排列。使用’?'将会随机排列

ordering=[‘order_date’] # 按订单升序排列
ordering=[’-order_date’] # 按订单降序排列,-表示降序
ordering=[’?order_date’] # 随机排序,?表示随机
ordering=[’-pub_date’,‘author’] # 以pub_date为降序,在以author升序排列

permissions

permissions主要是为了在Django Admin管理模块下使用的,如果你设置了这个属性可以让指定的方法权限描述更清晰可读。Django自动为每个设置了admin的对象创建添加,删除和修改的权限。
permissions = ((‘can_deliver_pizzas’,‘Can deliver pizzas’))

proxy

这是为了实现代理模型使用的,如果proxy = True,表示model是其父的代理 model

unique_together

unique_together这个选项用于:当你需要通过两个字段保持唯一性时使用。比如假设你希望,一个Person的FirstName和LastName两者的组合必须是唯一的,那么需要这样设置:
unique_together = ((“first_name”, “last_name”),)
一个ManyToManyField不能包含在unique_together中。如果你需要验证关联到ManyToManyField字段的唯一验证,尝试使用signal(信号)或者明确指定through属性。

verbose_name

verbose_name的意思很简单,就是给你的模型类起一个更可读的名字一般定义为中文,我们:
verbose_name = “学校”

verbose_name_plural

这个选项是指定,模型的复数形式是什么,比如:
verbose_name_plural = “学校”
如果不指定Django会自动在模型名称后加一个’s’