sync/async MongoDB ODM, yes.
Project description
μMongo: sync/async ODM
μMongo is a Python MongoDB ODM. It inception comes from two needs: the lack of async ODM and the difficulty to do document (un)serialization with existing ODMs.
From this point, μMongo made a few design choices:
Stay close to the standards MongoDB driver to keep the same API when possible: use find({"field": "value"}) like usual but retrieve your data nicely OO wrapped !
Work with multiple drivers (PyMongo, TxMongo, motor_asyncio and mongomock for the moment)
Tight integration with Marshmallow serialization library to easily dump and load your data with the outside world
i18n integration to localize validation error messages
Free software: MIT license
Test with 90%+ coverage ;-)
Quick example
from datetime import datetime
from pymongo import MongoClient
from umongo import Instance, Document, fields, validate
db = MongoClient().test
instance = Instance(db)
@instance.register
class User(Document):
email = fields.EmailField(required=True, unique=True)
birthday = fields.DateTimeField(validate=validate.Range(min=datetime(1900, 1, 1)))
friends = fields.ListField(fields.ReferenceField("User"))
class Meta:
collection = db.user
# Make sure that unique indexes are created
User.ensure_indexes()
goku = User(email='goku@sayen.com', birthday=datetime(1984, 11, 20))
goku.commit()
vegeta = User(email='vegeta@over9000.com', friends=[goku])
vegeta.commit()
vegeta.friends
# <object umongo.data_objects.List([<object umongo.dal.pymongo.PyMongoReference(document=User, pk=ObjectId('5717568613adf27be6363f78'))>])>
vegeta.dump()
# {id': '570ddb311d41c89cabceeddc', 'email': 'vegeta@over9000.com', friends': ['570ddb2a1d41c89cabceeddb']}
User.find_one({"email": 'goku@sayen.com'})
# <object Document __main__.User({'id': ObjectId('570ddb2a1d41c89cabceeddb'), 'friends': <object umongo.data_objects.List([])>,
# 'email': 'goku@sayen.com', 'birthday': datetime.datetime(1984, 11, 20, 0, 0)})>Get it now:
$ pip install umongo # This installs umongo with pymongo $ pip install my-mongo-driver # Other MongoDB drivers must be installed manually
Or to get it along with the MongoDB driver you’re planing to use:
$ pip install umongo[motor] $ pip install umongo[txmongo] $ pip install umongo[mongomock]
History
1.2.0 (2019-02-08)
Add Schema cache to as_marshmallow_schema (see #165).
Add DecimalField. This field only works on MongoDB 3.4+. (see #162)
1.1.0 (2019-01-14)
Fix bug when filtering by id in a Document subclass find query (see #145).
Fix __getattr__ to allow copying and deepcopying Document and EmbeddedDocument (see #157).
Add Document.clone() method (see #158).
1.0.0 (2018-11-29)
Raise UnknownFieldInDBError when an unknown field is found in database and not using BaseNonStrictDataProxy (see #121)
Fix (non fatal) crash in garbage collector when using WrappedCursor with mongomock
Depend on pymongo 3.7+ (see #149)
Pass as_marshmallow_schema params to nested schemas. Since this change, every field’s as_marshmallow_schema method should expect unknown **kwargs (see #101).
Pass params to container field in ListField.as_marshmallow_schema (see #150)
Add meta kwarg to as_marshmallow_schema to pass a dict of attributes for the schema’s Meta class (see #151)
0.15.0 (2017-08-15)
Add strict option to (Embedded)DocumentOpts to allow loading of document with unknown fields from mongo (see #115)
Fix fields serialization/deserialization when allow_none is True (see #69)
Fix ReferenceFild assignment from another ReferenceField (see #110)
Fix deletion of field proxied by a property (see #109)
Fix StrictDateTime bonus field: _deserialize does not accept datetime.datetime instances (see #106)
Add force_reload param to Reference.fetch (see #96)
0.14.0 (2017-03-03)
Fix bug in mashmallow tag handling (see #90)
Fix allow none in DataProxy.set (see #89)
Support motor 1.1 (see #87)
0.13.0 (2017-01-02)
Fix deserialization error with nested EmbeddedDocuments (see #84, #67)
Add abstract and allow_inheritance options to EmbeddedDocument
Remove buggy as_marshmallow_schema’s parameter missing_accessor (see #73, #74)
0.12.0 (2016-11-11)
Replace Document.opts.children by offspring and fix grand child inheritance issue (see #66)
Fix dependency since release of motor 1.0 with breaking API
0.11.0 (2016-11-02)
data_objects Dict and List inherit builtins dict and list
Document&EmbeddedDocument store fields passed during initialization as modified (see #50)
Required field inside embedded document are handled correctly (see #61)
Document support marshmallow’s pre/post processors
0.10.0 (2016-09-29)
Add pre/post update/insert/delete hooks (see #22)
Provide Umongo to Marshmallow schema/field conversion with schema.as_marshmallow_schema() and field.as_marshmallow_field() (see #34)
List and Dict inherit from collections’s UserList and UserDict instead of builtins types (needed due to metaprogramming conflict otherwise)
DeleteError and UpdateError returns the driver result object instead of the raw error dict (except for motor which only has raw error dict)
0.9.0 (2016-06-11)
Queries can now be expressed with the document’s fields name instead of the name in database
EmbeddedDocument also need to be registered by and instance before use
0.8.1 (2016-05-19)
Replace Document.created by is_created (see #14)
0.8.0 (2016-05-18)
Heavy rewrite of the project, lost of API breakage
Documents are now first defined as templates then implemented inside an Instance
DALs has been replaced by frameworks implementations of Builder
Fix __getitem__ for Pymongo.Cursor wrapper
Add conditions argument to Document.commit
Add count method to txmongo
0.7.8 (2016-4-28)
Fix setup.py style preventing release of version 0.7.7
0.7.7 (2016-4-28)
Fix await error with Reference.fetch
Pymongo is now only installed with extra flavours of umongo
0.7.6 (2016-4-28)
Use extras_require to install driver along with umongo
0.7.5 (2016-4-23)
Fixing await (Python >= 3.5) support for motor-asyncio
0.7.4 (2016-4-21)
Fix missing package in setup.py
0.7.3 (2016-4-21)
Fix setup.py style preventing from release
0.7.2 (2016-4-21)
Fix crash when generating indexes on EmbeddedDocument
0.7.1 (2016-4-21)
Fix setup.py not to install tests package
Pass status to Beta
0.7.0 (2016-4-21)
Add i18n support
Add MongoMock support
Documentation has been a lot extended
0.6.1 (2016-4-13)
Add <dal>_lazy_loader to configure Document’s lazy_collection
0.6.0 (2016-4-12)
Heavy improvements everywhere !
0.1.0 (2016-1-22)
First release on PyPI.
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 umongo-1.2.0.tar.gz.
File metadata
- Download URL: umongo-1.2.0.tar.gz
- Upload date:
- Size: 86.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.6.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 694024e136d834937df7e854f791cf1df2bfb04f42310b965533b61a456f1ceb |
|
| MD5 | 9a56aee8a143713f77df84ae9e0e8a6d |
|
| BLAKE2b-256 | 64d65e63588d0d290102429f313c1e75c92e9827a0805cd8d3a2879ecb5cff09 |
File details
Details for the file umongo-1.2.0-py2.py3-none-any.whl.
File metadata
- Download URL: umongo-1.2.0-py2.py3-none-any.whl
- Upload date:
- Size: 45.7 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.6.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6584972dd60d4356de977a3f81e5bec4b28bb30215876e57accc773bbc8b5210 |
|
| MD5 | f8e461d4afe88f12f1d2195956136821 |
|
| BLAKE2b-256 | 2abe77c68cb114647a9406c04c6eeb1bbf0a3743c0a06c35aeb549dc3fefd22e |
