Python sqlite3模块的text_factory属性的使用方法研究

写这篇文章，起源于要写一个脚本批量把CSV文件（文件采用GBK或utf-8编码）写入到sqlite数据库里。

Python版本：2.7.9

sqlite3模块提供了con = sqlite3.connect("D:\\text_factory.db3") 这样的方法来创建数据库（当文件不存在时，新建库），数据库默认编码为UTF-8，支持使用特殊sql语句设置编码

PRAGMA encoding = "UTF-8"; 
PRAGMA encoding = "UTF-16"; 
PRAGMA encoding = "UTF-16le"; 
PRAGMA encoding = "UTF-16be";　　　　

但设置编码必须在main库之前，否则无法更改。 https://www.sqlite.org/pragma.html#pragma_encoding

认识text_factory属性，大家应该都是通过以下错误知晓的：

sqlite3.ProgrammingError: You must not use 8-bit bytestrings unless you use a text_factory that can interpret 8-bit bytestrings (like text_factory = str). It is highly recommended that you instead just switch your application to Unicode strings.

大意是推荐你把字符串入库之前转成unicode string，你要用bytestring字节型字符串（如ascii ，gbk，utf-8），需要加一条语句text_factory = str。

Python拥有两种字符串类型。标准字符串是单字节字符序列，允许包含二进制数据和嵌入的null字符。 Unicode 字符串是双字节字符序列，一个字符使用两个字节来保存，因此可以有最多65536种不同的unicode字符。尽管最新的Unicode标准支持最多100万个不同的字符，Python现在尚未支持这个最新的标准。 

默认text_factory = unicode，原以为这unicode、str是函数指针，但貌似不是，是<type 'unicode'>和<type 'str'>

下面写了一段测试验证代码：

# -*- coding: utf-8 -*-
import sqlite3
'''
GBK   UNIC  UTF-8
B8A3  798F  E7 A6 8F  福
D6DD  5DDE  E5 B7 9E  州
'''

con = sqlite3.connect(":memory:")
# con = sqlite3.connect("D:\\text_factory1.db3")
# con.executescript('PRAGMA encoding = "UTF-16";')
cur = con.cursor()

a_text      = "Fu Zhou"
gb_text     = "\xB8\xA3\xD6\xDD"
utf8_text   = "\xE7\xA6\x8F\xE5\xB7\x9E"
unicode_text= u"\u798F\u5DDE"

print 'Part 1: con.text_factory=str'
con.text_factory = str
print type(con.text_factory)
cur.execute("CREATE TABLE table1 (city);")
cur.execute("INSERT INTO table1 (city) VALUES (?);",(a_text,))
cur.execute("INSERT INTO table1 (city) VALUES (?);",(gb_text,))
cur.execute("INSERT INTO table1 (city) VALUES (?);",(utf8_text,))
cur.execute("INSERT INTO table1 (city) VALUES (?);",(unicode_text,))
cur.execute("select city from table1")
res = cur.fetchall()
print "--  result: %s"%(res)

print 'Part 2: con.text_factory=unicode'
con.text_factory = unicode
print type(con.text_factory)
cur.execute("CREATE TABLE table2 (city);")
cur.execute("INSERT INTO table2 (city) VALUES (?);",(a_text,))
# cur.execute("INSERT INTO table2 (city) VALUES (?);",(gb_text,))
# cur.execute("INSERT INTO table2 (city) VALUES (?);",(utf8_text,))
cur.execute("INSERT INTO table2 (city) VALUES (?);",(unicode_text,))
cur.execute("select city from table2")
res = cur.fetchall()
print "--  result: %s"%(res)

print 'Part 3: OptimizedUnicode'
con.text_factory = str
cur.execute("CREATE TABLE table3 (city);")
cur.execute("INSERT INTO table3 (city) VALUES (?);",(a_text,))
#cur.execute("INSERT INTO table3 (city) VALUES (?);",(gb_text,))
cur.execute("INSERT INTO table3 (city) VALUES (?);",(utf8_text,))
cur.execute("INSERT INTO table3 (city) VALUES (?);",(unicode_text,))
con.text_factory = sqlite3.OptimizedUnicode
print type(con.text_factory)
cur.execute("select city from table3")
res = cur.fetchall()
print "--  result: %s"%(res)

print 'Part 4: custom fuction'
con.text_factory = lambda x: unicode(x, "gbk", "ignore")
print type(con.text_factory)
cur.execute("CREATE TABLE table4 (city);")
cur.execute("INSERT INTO table4 (city) VALUES (?);",(a_text,))
cur.execute("INSERT INTO table4 (city) VALUES (?);",(gb_text,))
cur.execute("INSERT INTO table4 (city) VALUES (?);",(utf8_text,))
cur.execute("INSERT INTO table4 (city) VALUES (?);",(unicode_text,))
cur.execute("select city from table4")
res = cur.fetchall()
print "--  result: %s"%(res)

 

打印结果：

Part 1: con.text_factory=str
<type 'type'>
--  result: [('Fu Zhou',), ('\xb8\xa3\xd6\xdd',), ('\xe7\xa6\x8f\xe5\xb7\x9e',), ('\xe7\xa6\x8f\xe5\xb7\x9e',)]
Part 2: con.text_factory=unicode
<type 'type'>
--  result: [(u'Fu Zhou',), (u'\u798f\u5dde',)]
Part 3: OptimizedUnicode
<type 'type'>
--  result: [('Fu Zhou',), (u'\u798f\u5dde',), (u'\u798f\u5dde',)]
Part 4: custom fuction
<type 'function'>
--  result: [(u'Fu Zhou',), (u'\u798f\u5dde',), (u'\u7ec2\u5fd3\u7a9e',), (u'\u7ec2\u5fd3\u7a9e',)]

 

Part 1：unicode被转换成了utf-8，utf-8和GBK被透传，写入数据库，GBK字符串被取出显示时，需要用类似'gbk chars'.decode("cp936").encode("utf_8")的语句进行解析print

Part 2：默认设置，注释的掉都会产生以上的经典错误，输入范围被限定在unicode对象或纯ascii码　　

Part 3：自动优化，ascii为str对象，非ascii转为unicode对象

Part 4：GBK被正确转换，utf-8和unicode在存入数据库时，都被转为了默认编码utf-8存储，既'\xe7\xa6\x8f\xe5\xb7\x9e'，

In[16]: unicode('\xe7\xa6\x8f\xe5\xb7\x9e','gbk')
Out[16]: u'\u7ec2\u5fd3\u7a9e'

就得到了以上结果。

接着，用软件查看数据库里是如何存放的。

分别用官方的sqlite3.exe和SqliteSpy查看，sqlite3.exe因为用命令行界面，命令行用的是GBK显示；SqliteSpy则是用UTF显示，所以GBK显示乱码。这就再次印证了GBK被允许存放入数据库的时候，存放的是raw数据，并不会强制转为数据库的默认编码utf-8保存。

Connection.text_factory使用此属性来控制我们可以从TEXT类型得到什么对象(我：这也印证写入数据库的时候，需要自己编码，不能依靠这个)。默认情况下，这个属性被设置为Unicode，sqlite3模块将会为TEXT返回Unicode对象。若你想返回bytestring对象，可以将它设置为str。

因为效率的原因，还有一个只针对非ASCII数据，返回Unicode对象，其它数据则全部返回bytestring对象的方法。要激活它，将此属性设置为sqlite3.OptimizedUnicode。

你也可以将它设置为任意的其它callabel，接收一个bytestirng类型的参数，并返回结果对象。《摘自http://www.360doc.com/content/11/1102/10/4910_161017252.shtml》

以上一段话是官方文档的中文版关于text_factory描述的节选。

 

综上，我谈谈我的看法*和使用建议：

1）sqlite3模块执行insert时，写入的是raw数据，写入前会根据text_factory属性进行类型判断，默认判断写入的是否为unicode对象；

2）使用fetchall()从数据库读出时，会根据text_factory属性进行转化。

3）输入字符串是GBK编码的bytestring，decode转为unicode写入；或加text_factory=str直接写入，读出时仍为GBK，前提需要数据库编码为utf-8，注意用sqlitespy查看是乱码。

4）输入字符串是Utf-8编码的bytestring，可以设置text_factory=str直接写入直接读出，sqlitespy查看正常显示。

5）如果不是什么高性能场景，入库前转成unicode，性能开销也很小，测试数据找不到了，像我这样话一整天研究这一行代码，不如让机器每次多跑零点几秒。。

*（因为没有查看sqlite3模块的源代码，所以只是猜测）

 

另外，附上数据库设置为UTF-16编码时，产生的结果，更乱，不推荐。

Part 1: con.text_factory=str
<type 'type'>
--  result: [('Fu Zhou',), ('\xc2\xb8\xc2\xa3\xef\xbf\xbd\xef\xbf\xbd',), ('\xe7\xa6\x8f\xe5\xb7\x9e',), ('\xe7\xa6\x8f\xe5\xb7\x9e',)]
Part 2: con.text_factory=unicode
<type 'type'>
--  result: [(u'Fu Zhou',), (u'\u798f\u5dde',)]
Part 3: OptimizedUnicode
<type 'type'>
--  result: [('Fu Zhou',), (u'\u798f\u5dde',), (u'\u798f\u5dde',)]
Part 4: custom fuction
<type 'function'>
--  result: [(u'Fu Zhou',), (u'\u8d42\u62e2\u951f\u65a4\u62f7',), (u'\u7ec2\u5fd3\u7a9e',), (u'\u7ec2\u5fd3\u7a9e',)]