MongoDB Object DataBase (MODB) for Python objects
Project description
jaraco.modb is a small, pure-Python library for persisting Python objects to MongoDB.
Manual Usage
jaraco.modb facilitates using jsonpickle to produce MongoDB-friendly representations of pickleable Python objects for easy storage in a MongoDB database.
One may simply encode and decode Python objects to MongoDB BSON-friendly representations:
class MyObject(object):
def __init__(self, val):
self.val = val
import jaraco.modb
import pymongo
mongo_collection = pymongo.MongoClient().mydb.mycollection
val = MyObject(3)
# save the object to the DB
id = mongo_collection.save(jaraco.modb.encode(val))
# retrieve the object from the DB
new_val = jaraco.modb.decode(mongo_collection.find_one(id))
assert isinstance(new_val, MyObject)
assert new_val.val == 3
A more detailed tutorial is now published as a Jupyter Notebook.
Automatic Usage
jaraco.modb also provides an SON Manipulator suitable for automatically encoding arbitrary objects for a pymongo.Database:
jaraco.modb.SONManipulator.install(mongo_collection.database)
mongo_collection.save({'val': val})
Unfortunately, due to a limitation with the API of the SONManipulator, it’s not possible to save a custom object as the document itself (the document must always be a dict).
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
Hashes for jaraco.modb-6.0.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b5e815396dd0ef3e0db811c05819e806e8d0bb75f4fbdb666f40b1e34569eccc |
|
| MD5 | 56c72dd6c68cbca379a51ccb66331b19 |
|
| BLAKE2b-256 | 7781c05bb0886fae54c89d030fe8f33fb3aee8e9a17da28040671228508848a1 |
