Yet Another Document Mapper (ODM) for MongoDB
Project description
It’s small and simple ODM for use with MongoDB.
Full documentation: http://yadm.readthedocs.org
Quick start
import pymongo
from yadm import Database, Document, fields
# Create model
class BlogPost(Document):
__collection__ = 'blog_posts'
title = fields.StringField
body = fields.StringField
# Create post
post = BlogPost()
post.title = 'Small post'
post.body = 'Bla-bla-bla...'
# Connect to database
client = pymongo.MongoClient('localhost', 27017)
db = Database(client, 'test')
# Insert post to database
db.insert(post)
# Query posts
qs = db.get_queryset(BlogPost).find({'title': {'$regex': '^S'}})
assert qs.count() > 0
for post in qs:
assert post.title.startswith('S')
# Query one post
post = db.get_queryset(BlogPost).find_one({'title': 'Small post'})
# Change post
post.title = 'Bla-bla-bla title'
# Save changed post
db.save(post)CHANGES
1.0 (XXXX-XX-XX)
- Change document structure. No more bad BaseDocument.__data__ attribute:
BaseDocument.__raw__: raw data from mongo;
BaseDocument.__cache__: cached objects, casted with fields;
BaseDocument.__changed__: changed objects.
- Changes api for custom fields:
Not more need create field descriptors for every field;
prepare_values called only for setattr;
to_mongo called only for save objects to mongo;
from_mongo called only for load values from BaseDocument.__raw__;
Remove Field.default attribute. Use Field.get_default method;
Raise NotLoadedError if field not loaded from projection;
- Changes in ReferenceField:
Raise BrokenReference if link is bloken;
Raise NotBindingToDatabase if document not saved to database;
Remove ArrayContainer and ArrayContainerField;
Remove old MapIntKeysField and MapObjectIdKeysField. Use new MapCustomKeysField;
Add Database.update_one method for run simple update query with specified document;
serialize.from_mongo now accept not_loaded sequence with filed names who must mark as not loaded, parent and name;
serialize.to_mongo do not call FieldDescriptor.__set__;
ReferenceField now have boolean argument null insted default=None;
Fakers! Subsystem for generate test objects;
Tests now use pytest;
And more, and more…
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
