Simple DRM for motor client
Project description
MDocument
Simple DRM for async mongo motor client
Usage
import asyncio
import motor.motor_asyncio
from mdocument import Document
client = motor.motor_asyncio.AsyncIOMotorClient()
class Comment(Document):
collection = "comments"
database = "mdocument"
client = client
class Video(Document):
collection = "videos"
database = "mdocument"
client = client
@Document.related(Comment.Field.video, self_field_name="_id")
def comments(self):
pass
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 = asyncio.get_event_loop()
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!)
]
Document methods
Here is a list of Document basic methods
.create
@classmethod
async def create(cls, **kwargs):
If you want to create a new document you can do it easily with .create method. Example:
import asyncio
from mdocument import Document
import motor.motor_asyncio
client = motor.motor_asyncio.AsyncIOMotorClient()
class Message(Document):
collection = "messages"
database = "mdocument"
client = client
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!"
}
.push_update
Updates document and all @related fields.
await Message.push_update()
.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
File details
Details for the file mdocument-3.0.1595701480.tar.gz
.
File metadata
- Download URL: mdocument-3.0.1595701480.tar.gz
- Upload date:
- Size: 8.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 48687fa6dc4990b796d777f94c01f4bc3867d849bc71338fe1d555206736be62 |
|
MD5 | c330668ec5bafbc81e61bf93e7ce763a |
|
BLAKE2b-256 | fac96eba0053111bdda5287c82ae7700eef4ac984a2ee42ba9a151daa20b1dc8 |
File details
Details for the file mdocument-3.0.1595701480-py3-none-any.whl
.
File metadata
- Download URL: mdocument-3.0.1595701480-py3-none-any.whl
- Upload date:
- Size: 8.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 72a0aa541c675b817aed7dbaa619f0c05970296094a7332e922d4d5d82b11fad |
|
MD5 | 1363f9d435784ed7f280cc0275eeaae7 |
|
BLAKE2b-256 | 9bc46689ca367791d93b9b55d584ef9720b2c258808334645473b02f014b874f |