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.1 (2016-04-26)
Add cacheing on queryset level and use it for ReferenceField;
Add mongo aggregation framework support;
Add read_preference setting;
Add exc argument to QuerySet.find_one for raise exception if not found;
Add multi argument to QuerySet.remove;
Deprecate QuerySet.with_id;
Refactoring.
1.0 (2015-11-14)
- 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_value 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;
Add Field.get_if_not_loaded and Field.get_if_attribute_not_set method;
By default 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;
smart_null keyword for Field;
Fields in document must be instances (not classes!);
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;
Add QuerySet.distinct;
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__;
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.
Source Distribution
Built Distribution
File details
Details for the file yadm-1.1.0.tar.gz.
File metadata
- Download URL: yadm-1.1.0.tar.gz
- Upload date:
- Size: 38.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7f7af837fee7ac359b9f3c6b8c067fa0da45d0f56483d5687b6c95f7a7001971 |
|
| MD5 | e7b5d58dd43c0128fe4c9c99644a9e5b |
|
| BLAKE2b-256 | 11f493070690da9daba9156e870e9eafc2a868c74a156ddc342c09c0350f534d |
File details
Details for the file yadm-1.1.0-py3-none-any.whl.
File metadata
- Download URL: yadm-1.1.0-py3-none-any.whl
- Upload date:
- Size: 35.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2c2a8dee85eb7e5f8a00ea5b695b7fe1bf8baa710e9ceee548c9603f2a61e39a |
|
| MD5 | e116c685e0d9333a9b26d7f036ae6a30 |
|
| BLAKE2b-256 | 7cac63e8b8597d951fef35a4cf972daebcea980c30eca9e6e3f425cee2344cbd |
