Simple DRM for motor client
Project description
MDocument
Simple DRM for async mongo motor client
Usage
import asyncio
from mdocument import Document
class Comment(Document):
__collection__ = "comments"
class Video(Document):
__collection__ = "videos"
@Document.related(self_field="_id", other_field="video")
def comments(self):
return Comment
loop = asyncio.get_event_loop()
Document.setup(loop, "localhost", "test_database")
async def main():
video = await Video.create(
title="Test",
)
comment1 = await Comment.create(
video=video._id,
message="First!",
)
comment2 = await Comment.create(
video=video._id,
message="Second!"
)
loop.run_until_complete(main())
Now we can easily access our comments using our related documents
print(await video.comments)
[
Comment(_id=5e7533d55eb6a8c6d24d3cc7, video=5e7533d55eb6a8c6d24d3cc6, message=First!),
Comment(_id=5e7533d55eb6a8c6d24d3cc8, video=5e7533d55eb6a8c6d24d3cc6, message=Second!)
]
Play from console
If you want changes made from console immediately you can use update_immediately argument
run = loop.run_until_complete
video = run(Video.create(update_immediately=True,
title="Test"))
video.length = "1:10"
Now we can find that original document was changed
print(run(Video.collection.find_one({"length": "1:10"})))
{'_id': ObjectId('5e75373e5eb6a8c6d24d3cce'), 'title': 'Test', 'length': '1:10'}
Document methods
Here is a list of Document basic methods
.create
async def create(cls, loop=None, update_immediately=False, **kwargs):
If you want to create a new document you can do it easily with .create method. Example:
import asyncio
from mdocument import Document
class Message(Document):
__collection__ = "messages"
Document.setup(loop, "localhost", "test_database")
loop.run_until_complete(
Message.create(from_user="admin", text="Test message!")
)
This will create document in database:
{
'_id': ObjectId('5e75373e5eb6a8c6d14d3ccd'),
'from_user': 'admin',
'text': "Test message!"
}
.delete
Deletion of document from database. Based on your set @related rules all related documents will be modified too.
message = await Message.one(from_user="admin")
await message.delete()
Project details
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
Close
Hashes for mdocument-1.0.1584890051-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7f50aaef9b103e7a965c2cf5f6272dfe8e627484bb2b52dd3f9c8218cb91d799 |
|
MD5 | c1ba589ec7becae45a6dd99dadf2301c |
|
BLAKE2b-256 | 93aebec39ff92be3856830f80ece1c388e22f9231504d4a1bbb33bb662b03453 |