mdocument

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

@related

Decorator for defining related documents. Made for easily managing deletion of related documents.

def related(self_path, other_path, multiple=True, parent=True):

Example:

from mdocument import Document, DeleteDocument

import motor.motor_asyncio

client = motor.motor_asyncio.AsyncIOMotorClient()

class Artist(Document):
    collection = "artists"
    database = "mdocument"
    client = client

    @Document.related(Album.Field._id, self_field_name="_id")
    def albums(self):
        pass

class Album(Document):
    collection = "albums"
    database = "mdocument"
    client = client

    @Document.related(Song.Field._id, self_field_name="_id")
    def songs(self):
        pass


class Song(Document):
    collection = "songs"
    database = "abc"
    client = client

As we set our relations. Now we have next actions: Album deleted -> all songs related to this album are deleted Author deleted -> all albums related to author are deleted -> each song related to deleted albums deleted

.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()

Metadata

Release files for mdocument 3.0.1595701480

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mdocument 3.0.1595701480
File	Size	Uploaded
mdocument-3.0.1595701480.tar.gz	8.0 kB	Jul 25, 2020	Details

Built distribution (wheel)

Table of built distributions (wheels) for mdocument 3.0.1595701480
File	Interpreter	ABI	Platform	Reset
mdocument-3.0.1595701480-py3-none-any.whl 8.1 kB Jul 25, 2020	Python 3	none	any	Details

Total release size: 16.1 kB

Release files / mdocument-3.0.1595701480.tar.gz

Download URL	mdocument-3.0.1595701480.tar.gz
Size	8.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`48687fa6dc4990b796d777f94c01f4bc3867d849bc71338fe1d555206736be62`
BLAKE2b-256 checksum How to use checksums	`fac96eba0053111bdda5287c82ae7700eef4ac984a2ee42ba9a151daa20b1dc8`
Upload date	Jul 25, 2020
Uploaded using Trusted Publishing? What is 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`

Release files / mdocument-3.0.1595701480-py3-none-any.whl

Download URL	mdocument-3.0.1595701480-py3-none-any.whl
Size	8.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`72a0aa541c675b817aed7dbaa619f0c05970296094a7332e922d4d5d82b11fad`
BLAKE2b-256 checksum How to use checksums	`9bc46689ca367791d93b9b55d584ef9720b2c258808334645473b02f014b874f`
Upload date	Jul 25, 2020
Uploaded using Trusted Publishing? What is 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`