django模型高级操作
本文介绍一些django模型中的高级用法。
Meta类
在数据模型类中往往有一个Meta类作为内部类。它用于定义一些Django模型类的行为特性。以下对此作一总结:
abstract
这个属性是定义当前的模型类是不是一个抽象类。所谓抽象类是不会对应数据库表的。一般我们用它来归纳一些公共属性字段,然后继承它的子类可以继承这些字段。比如下面的代码中Human是一个抽象类,Employee是一个继承了Human的子类,那么在运行数据库同步命令时,不会生成Human表,但是会生成一个Employee表,它包含了Human中继承来的字段,以后如果再添加一个Customer模型类,它可以同样继承Human的公共属性:
classHuman(models.Model):
name=models.CharField(max_length=100)
GENDER_CHOICE=((u'M',u'Male'),(u'F',u'Female'),)
gender=models.CharField(max_length=2,choices=GENDER_CHOICE,null=True)
class Meta:
abstract=True
classEmployee(Human):
joint_date=models.DateField()
class Customer(Human):
first_name=models.CharField(max_length=100)
birth_day=models.DateField()
上面的代码,执行同步命令后的输出结果入下,可以看出Human表并没有被创建:
$ pythonmanage.py syncdb
Creatingtables ...
Creatingtable myapp_employee
Creatingtable myapp_customer
Installingcustom SQL ...
Installingindexes ...
Nofixtures found.
app_label
这个选项只在一种情况下使用,就是你的模型类不在默认的应用程序包下的models.py文件中,这时候你需要指定你这个模型类是那个应用程序的。比如你在其他地方写了一个模型类,而这个模型类是属于myapp的,那么你这是需要指定为:
app_label='myapp'
db_table
db_table是用于指定自定义数据库表名的。Django有一套默认的按照一定规则生成数据模型对应的数据库表名,如果你想使用自定义的表名,就通过这个属性指定,比如:
table_name='my_owner_table'
db_tablespace
有些数据库有数据库表空间,比如Oracle。你可以通过db_tablespace来指定这个模型对应的数据库表放在哪个数据库表空间。
get_latest_by
由于Django的管理方法中有个lastest()方法,就是得到最近一行记录。如果你的数据模型中有 DateField 或 DateTimeField 类型的字段,你可以通过这个选项来指定lastest()是按照哪个字段进行选取的。
managed
由于Django会自动根据模型类生成映射的数据库表,如果你不希望Django这么做,可以把managed的值设置为False。
order_with_respect_to
这个选项一般用于多对多的关系中,它指向一个关联对象。就是说关联对象找到这个对象后它是经过排序的。指定这个属性后你会得到一个get_XXX_order()和set_XXX_order()的方法,通过它们你可以设置或者回去排序的对象。
ordering
这个字段是告诉Django模型对象返回的记录结果集是按照哪个字段排序的。比如下面的代码:
ordering=['order_date']# 按订单升序排列
ordering=['-order_date']# 按订单降序排列,-表示降序
ordering=['?order_date']# 随机排序,?表示随机
permissions
permissions主要是为了在Django Admin管理模块下使用的,如果你设置了这个属性可以让指定的方法权限描述更清晰可读。
proxy
这是为了实现代理模型使用的,这里先不讲随后的文章介绍。
unique_together
unique_together这个选项用于:当你需要通过两个字段保持唯一性时使用。比如假设你希望,一个Person的FirstName和LastName两者的组合必须是唯一的,那么需要这样设置:
unique_together= (("first_name", "last_name"),)
verbose_name
verbose_name的意思很简单,就是给你的模型类起一个更可读的名字:
verbose_name= "pizza"
verbose_name_plural
这个选项是指定,模型的复数形式是什么,比如:
verbose_name_plural= "stories"
如果不指定Django会自动在模型名称后加一个’s’
__unicode__函数
__unicode__()方法与admin相关,告诉Python如何将对象以unicode的方式显示出来。__unicode__() 方法可以进行任何处理来返回对一个对象的字符串表示。对__unicode__()的唯一要求就是它要返回一个unicode对象 如果`` __unicode__()`` 方法未返回一个Unicode对象,而返回比如说一个整型数字,那么Python将抛出一个`` TypeError`` 错误,并提示:”coercing to Unicode: need stringor buffer, int found”。
数据导入导出
django 项目提供了一个导出的方法 python manage.py dumpdata, 不指定 appname 时默认为导出所有的app
导出:
pythonmanage.py dumpdata [appname] > appname_data.json
比如我们有一个项目叫 mysite, 里面有一个 app 叫 blog ,我们想导出 blog 的所有数据
pythonmanage.py dumpdata blog > blog_dump.json
导入:
数据导入,不需要指定 appname
pythonmanage.py loaddata blog_dump.json
一些常用的命令
pythonmanage.py dumpdata auth > auth.json # 导出用户数据
优点:可以兼容各种支持的数据库,也就是说,以前用的是 SQLite3,可以导出后,用这种方法导入到 MySQL, PostgreSQL等数据库,反过来也可以。
缺点:数据量大的时候,速度相对较慢,表的关系比较复杂的时候可以导入不成功。
数据库的迁移
用 Django 自带的命令
比如早期我们为了开发方便,用的sqlite3数据库,后来发现网站数据太多,sqlite3性能有点跟不上了,想换成postgreSQL,或者 MySQL的时候。如果还我还使用上面的命令,如果你运气好的话,也许会导入成功,流程如下:
1.从原来的整个数据库导出所有数据
pythonmanage.py dumpdata > mysite_all_data.json
2. 将mysite_all_data.json传送到另一个服务器或电脑上导入
pythonmanage.py loaddata mysite_all_data.json
如果你运气好的话可能会导入完成,但是往往不那么顺利,原因如下:
a) 我们在写models的时候如果用到CharField,就一定要写max_length,在sqlite3中是不检查这个最大长度的,你写最大允许长度为100,你往数据库放10000个,sqlite3都不报错,而且不截断数据的长度,这似乎是slite3的优点,但是也给从sqlite3导入其它数据库带来了困难,因为MySQL和PostgreSQL数据库都会检查最大长度,超出时就报错!
b) Django自带的contentType会导致出现一些问题
用上面的方法只迁移一个app应该问题不大,但是如果有用户,用户组挂钩,事情往往变得糟糕!如果导入后没有对数据进行修改,你可以考虑重新导入,可能还要快一些,如果是手动在后台输入或者修改过,这种方法就不适用了。
以MySQL 为例:
使用网页工具,比如phpMyAdmin 导入导出很简单,这里就不说了,主要说一下命令行如何操作:
# 导出数据库 zqxt 到 zqxt.sql 文件中
mysqldump-u username -p --database zqxt > zqxt.sql
# 导入数据库到 新的服务器
mysql -uusername -p
输入密码进入 MySQL 命令行
>source /path/to/zqxt.sql
总结:其它的数据库,请自行搜索如何导入导出,整个数据库导出的好处就是对数据之间的关系处理比较省事,比如自强学堂里面的很多教程,上一篇和下一篇是一个一对一的关系,这样的话用 python manage.py dumpdata 无法导出教程与教程的关系,但是数据库整个导出就没有任何问题,当然也可以写一个脚本去导出关系再导入。Django 自带的 python manage.py dumpdata 和 python manage.py loaddata 最大的好处就是可以跨数据库进行导入导出。
自定义Field
当现有字段不能够满足需求的时候使用如下方法可以自定义字段:
#coding:utf-8
fromdjango.db import models
classCompressedTextField(models.TextField):
"""
model Fields for storing text in acompressed format (bz2 by default)
"""
def from_db_value(self, value, expression,connection, context):
if not value:
return value
try:
returnvalue.decode('base64').decode('bz2').decode('utf-8')
except Exception:
return value
def to_python(self, value):
if not value:
return value
try:
returnvalue.decode('base64').decode('bz2').decode('utf-8')
except Exception:
return value
def get_prep_value(self, value):
if not value:
return value
try:
value.decode('base64')
return value
except Exception:
try:
returnvalue.encode('utf-8').encode('bz2').encode('base64')
except Exception:
return value
Django1.8及以上版本中,from_db_value 函数用于转化数据库中的字符到 Python的变量。
比如我们想保存一个 列表到数据库中,在读取用的时候要是 Python的列表的形式,我们来自己写一个 ListField:
这个ListField继承自 TextField,代码如下:
fromdjango.db import models
importast
classListField(models.TextField):
__metaclass__ = models.SubfieldBase
description = "Stores a pythonlist"
def __init__(self, *args, **kwargs):
super(ListField, self).__init__(*args,**kwargs)
def to_python(self, value):
if not value:
value = []
if isinstance(value, list):
return value
return ast.literal_eval(value)
def get_prep_value(self, value):
if value is None:
return value
return unicode(value) # use str(value)in Python 3
def value_to_string(self, obj):
value = self._get_val_from_obj(obj)
return self.get_db_prep_value(value)
使用它很简单,首先导入 ListField,像自带的 Field 一样使用:
classArticle(models.Model):
labels = ListField()
在终端上尝试(运行 python manage.py shell 进入):
>>>from app.models import Article
>>>d = Article()
>>>d.labels
[]
>>>d.labels = ["Python", "Django"]
>>>d.labels
["Python","Django"]
models.Manager使用
在语句Book.objects.all()中,objects是一个特殊的属性,需要通过它查询数据库。我们只是简要地说这是模块的manager 。现在是时候深入了解managers是什么和如何使用了。总之,模块manager是一个对象,Django模块通过它进行数据库查询。 每个Django模块至少有一个manager,你可以创建自定义manager以定制数据库访问。
下面是你创建自定义manager的两个原因: 增加额外的manager方法,或修manager返回的初始QuerySet。
增加额外的Manager方法
增加额外的manager方法是为模块添加表级功能的首选办法。例如,我们为Book模型定义了一个title_count()方法,它需要一个关键字,返回包含这个关键字的书的数量。
#models.py
fromdjango.db import models
classBookManager(models.Manager):
def title_count(self, keyword):
return self.filter(title__icontains=keyword).count()
classBook(models.Model):
title = models.CharField(max_length=100)
authors = models.ManyToManyField(Author)
publisher = models.ForeignKey(Publisher)
publication_date = models.DateField()
num_pages = models.IntegerField(blank=True,null=True)
objects = BookManager()
def __unicode__(self):
return self.title
有了这个manager,我们现在可以这样做:
Book.objects.title_count('django')
Book.objects.title_count('python')
下面是编码该注意的一些地方:
我们建立了一个BookManager类,它继承了django.db.models.Manager。这个类只有一个title_count()方法,用来做统计。 注意,这个方法使用了self.filter(),此处self指manager本身。我们把BookManager()赋值给模型的objects属性。 它将取代模型的默认manager(objects)如果我们没有特别定义,它将会被自动创建。 我们把它命名为objects,这是为了与自动创建的manager保持一致。为什么我们要添加一个title_count()方法呢?是为了将经常使用的查询进行封装,这样我们就不必重复编码了。
修改初始Manager QuerySets
manager的基本QuerySet返回系统中的所有对象。 例如,`` Book.objects.all()`` 返回数据库book中的所有书本。我们可以通过覆盖Manager.get_query_set()方法来重写manager的基本QuerySet。 get_query_set()按照你的要求返回一个QuerySet。
例如,下面的模型有两个manager。一个返回所有对像,另一个只返回作者是Roald Dahl的书。
fromdjango.db import models
class DahlBookManager(models.Manager):
defget_query_set(self):
return super(DahlBookManager,self).get_query_set().filter(author='Roald Dahl')**
classBook(models.Model):
title = models.CharField(max_length=100)
author = models.CharField(max_length=50)
# ...
objects = models.Manager() # The defaultmanager.
dahl_objects = DahlBookManager() # TheDahl-specific manager.
在这个示例模型中,Book.objects.all()返回了数据库中的所有书本,而Book.dahl_objects.all()只返回了一本. 注意我们明确地将objects设置成manager的实例,因为如果我们不这么做,那么唯一可用的manager就将是dah1_objects。当然,由于get_query_set()返回的是一个QuerySet对象,所以我们可以使用filter(),exclude()和其他一切QuerySet的方法。 像这些语法都是正确的:
Book.dahl_objects.all()
Book.dahl_objects.filter(title='Matilda')
Book.dahl_objects.count()
这个例子也指出了其他有趣的技术: 在同一个模型中使用多个manager。 只要你愿意,你可以为你的模型添加多个manager()实例。 这是一个为模型添加通用滤器的简单方法。
例如:
classMaleManager(models.Manager):
def get_query_set(self):
return super(MaleManager,self).get_query_set().filter(sex='M')
classFemaleManager(models.Manager):
def get_query_set(self):
return super(FemaleManager,self).get_query_set().filter(sex='F')
classPerson(models.Model):
first_name =models.CharField(max_length=50)
last_name = models.CharField(max_length=50)
sex = models.CharField(max_length=1,choices=(('M', 'Male'), ('F', 'Female')))
people = models.Manager()
men = MaleManager()
women = FemaleManager()
这个例子允许你执行`` Person.men.all()`` ,`` Person.women.all()`` ,`` Person.people.all()`` 查询,生成你想要的结果。
如果你使用自定义的Manager对象,请注意,Django遇到的第一个Manager(以它在模型中被定义的位置为准)会有一个特殊状态。 Django将会把第一个Manager 定义为默认Manager ,Django的许多部分(但是不包括admin应用)将会明确地为模型使用这个manager。 结论是,你应该小心地选择你的默认manager。因为覆盖get_query_set() 了,你可能接受到一个无用的返回对像,你必须避免这种情况。
模型方法
为了给你的对像添加一个行级功能,那就定义一个自定义方法。 有鉴于manager经常被用来用一些整表操作(table-wide),模型方法应该只对特殊模型实例起作用。这是一项在模型的一个地方集中业务逻辑的技术。最好用例子来解释一下。 这个模型有一些自定义方法:
fromdjango.contrib.localflavor.us.models import USStateField
fromdjango.db import models
classPerson(models.Model):
first_name =models.CharField(max_length=50)
last_name = models.CharField(max_length=50)
birth_date = models.DateField()
address = models.CharField(max_length=100)
city = models.CharField(max_length=50)
state = USStateField() # Yes, this isU.S.-centric...
def baby_boomer_status(self):
"Returns the person's baby-boomerstatus."
import datetime
if datetime.date(1945, 8, 1) <=self.birth_date <= datetime.date(1964, 12, 31):
return "Baby boomer"
if self.birth_date <datetime.date(1945, 8, 1):
return "Pre-boomer"
return "Post-boomer"
defis_midwestern(self):
"Returns True if this person isfrom the Midwest."
return self.state in ('IL', 'WI', 'MI','IN', 'OH', 'IA', 'MO')
def _get_full_name(self):
"Returns the person's fullname."
return u'%s %s' % (self.first_name,self.last_name)
full_name = property(_get_full_name)
例子中的最后一个方法是一个property。
这是用法的实例:
>>>p = Person.objects.get(first_name='Barack', last_name='Obama')
>>>p.birth_date
datetime.date(1961,8, 4)
>>>p.baby_boomer_status()
'Babyboomer'
>>>p.is_midwestern()
True
>>>p.full_name # Note this isn't a method-- it's treated as an attribute
u'BarackObama'
执行原始SQL查询
有时候你会发现Django数据库API带给你的也只有这么多,那你可以为你的数据库写一些自定义SQL查询。 你可以通过导入django.db.connection对像来轻松实现,它代表当前数据库连接。 要使用它,需要通过connection.cursor()得到一个游标对像。 然后,使用cursor.execute(sql, [params])来执行SQL语句,使用cursor.fetchone()或者cursor.fetchall()来返回记录集。 例如:
>>>from django.db import connection
>>>cursor = connection.cursor()
>>>cursor.execute("""
... SELECT DISTINCT first_name
... FROM people_person
... WHERE last_name = %s""",['Lennon'])
>>>row = cursor.fetchone()
>>>print row
['John']
connection和cursor几乎实现了标准Python DB-API,
你可以访问http://www.python.org/peps/pep-0249.html来获取更多信息。 如果你对Python DB-API不熟悉,请注意在cursor.execute() 的SQL语句中使用`` “%s”`` ,而不要在SQL内直接添加参数。 如果你使用这项技术,数据库基础库将会自动添加引号,同时在必要的情况下转意你的参数。
不要把你的视图代码和django.db.connection语句混杂在一起,把它们放在自定义模型或者自定义manager方法中是个不错的主意。 比如,上面的例子可以被整合成一个自定义manager方法,就像这样:
fromdjango.db import connection, models
classPersonManager(models.Manager):
def first_names(self, last_name):
cursor = connection.cursor()
cursor.execute("""
SELECT DISTINCT first_name
FROM people_person
WHERE last_name =%s""", [last_name])
return [row[0] for row in cursor.fetchone()]
classPerson(models.Model):
first_name =models.CharField(max_length=50)
last_name = models.CharField(max_length=50)
objects = PersonManager()
然后这样使用:
>>>Person.objects.first_names('Lennon')
['John','Cynthia']