micromongo 0.1.4

入门指南

要开始使用micromongo，只需导入它即可

>>> from micromongo import connect, Model
>>> c = connect()

connect 函数接受与 pymongo 的 Connection 对象 相同的参数，并且行为几乎相同，唯一的区别在于它会尝试自动返回用适当的 Model 类包装的查询结果。通过这个调用创建的连接对象将被缓存，并由各种 ORM 风格的设施使用，如 Model.save()、Model.proxy 等。如果您想要一个干净的标准 Connection 对象，您可以轻松获取一个。

>>> from micromongo import clean_connection
>>> clean = clean_connection()

请注意，clean_connection 不接受任何参数，并且总是返回与当前 micromongo 连接相同设置的干净 Connection 类。

使用这些连接对象，您可以创建数据库或执行您会使用正常 pymongo 对象所做的任何操作。

>>> db = c.test_db
>>> collection = db.test_collection
>>> collection.save({"docid": 1, "fail": False})
>>> collection.find_one()
{u'_id': ObjectId('...'), u'fail': False, u'docid': 1}

您还可以以声明性风格为特定集合声明您自己的 Model。

>>> class TestModel(Model):
        collection = 'test_db.test_collection'

>>> collection.find_one()
<TestModel: {u'_id': ObjectId('...'), u'fail': False, u'docid': 1}>

这些类相较于字典具有许多额外功能，使得它们更加方便使用。文档键都可以作为属性访问。

>>> t = collection.find_one()
>>> t.fail
False
>>> t.docid
1

文档也可以轻松持久化到数据库。

>>> t.docid = 17
>>> t.save()
>>> clean.test_db.test_collection.find_one()
{u'_id': ObjectId('...'), u'fail': False, u'docid': 17}

定义模型

上面，将 collection 属性分配给了我们的 Foo 模型。这是一个快捷方式；如果单独分配了 database 和 collection，模型可以自己推断完整的集合名称。如果集合和数据库都不存在，micromongo 会尝试根据您的模型类和模块名称来推断。例如，blog.Post 将变为 blog.post，或 stream.StreamEntry 将变为 stream.stream_entry。显式比隐式更好，并且建议您手动设置集合。

除了打包和提取数据库结果外，模型还可以定义一个 spec 文档，该文档可以定义默认值并在保存模型之前执行验证。以下是一个简单的博客帖子模型示例：

>>> from micromongo.spec import *
>>> class Post(Model):
        collection = 'test_db.blog_posts'
        spec = dict(
            author=Field(required=True, default='jmoiron', type=basestring),
            title=Field(required=False, default='', type=basestring),
            published=Field(required=True, default=False, type=[True, False]),
            body=Field(type=unicode),
            timestamp=Field(),
        )

>>> p = Post.new()
>>> p
<Post: {'title': u'', 'author': u'jmoiron', 'published': False}>

这里有几个要点。具有默认值的字段将初始化为该默认值，无论它们是否是必需的。如果必需的字段没有默认值，它将初始化为 None。

字段可以接受一个 type 参数，该参数可以是接受一个值并返回 True 或 False 的可调用对象，一个或多个基类型，或一个或多个值。如果提供了一个或多个类型，则使用 isinstance 来测试值是否是正确的类型。如果提供了一个或多个值，字段充当枚举类型，检查值是否在其值集中。如果没有给出类型，除非它是必需的且不存在，否则验证总是通过字段。

如果 p 中的字段被赋予了一个无效的类型，则会引发 ValueError。

>>> p.title = 10
>>> p.save()
Traceback (most recent call last):
  ...
ValueError: Keys did not match spec: ['title']
>>> del p.author
>>> p.save()
Traceback (most recent call last):
  ...
ValueError: Missing fields: ['author'], Invalid fields: ['title']
>>> p.title = 'My first blogpost'
>>> p.author = 'jmoiron'
>>> p.published = True
>>> p.body = u"This is my first blog post..  I'm so excited!"
>>> p.save()