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 4.0.1610663369

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 4.0.1610663369
File	Size	Uploaded
mdocument-4.0.1610663369.tar.gz	9.0 kB	Jan 14, 2021	Details

Built distribution (wheel)

Table of built distributions (wheels) for mdocument 4.0.1610663369
File	Interpreter	ABI	Platform	Reset
mdocument-4.0.1610663369-py3-none-any.whl 9.7 kB Jan 14, 2021	Python 3	none	any	Details

Total release size: 18.8 kB

Release files / mdocument-4.0.1610663369.tar.gz

Download URL	mdocument-4.0.1610663369.tar.gz
Size	9.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`1feb708ae830af810bceb51fe4ccf1d7fb6271f8164e5108965adba643b2c82d`
BLAKE2b-256 checksum How to use checksums	`8f81d64db103773739f734bd7454b8de3e802ccf81859c7675af014e4fe5e4d0`
Upload date	Jan 14, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.2 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1`

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

Download URL	mdocument-4.0.1610663369-py3-none-any.whl
Size	9.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`155c7877367b4a56a37148728e0df3212182a0492c1bdd9274ab1d774b0975ac`
BLAKE2b-256 checksum How to use checksums	`bde2bcb4e8f422363e344fa4353eda488c9fdb6ed2bed105b0e1972803af2e67`
Upload date	Jan 14, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.2 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1`