mdocument

MDocument

Simple DRM for async mongo motor client

Usage

import asyncio

from mdocument import Document

import motor.motor_asyncio

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(self_field="_id", other_field="video")
    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("Artist._id", "Album._id")
    def albums(self):
        pass

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

    @Document.related("Album._id", "Song._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.1590238503

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.1590238503
File	Size	Uploaded
mdocument-3.0.1590238503.tar.gz	7.7 kB	May 23, 2020	Details

Built distribution (wheel)

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

Total release size: 15.8 kB

Release files / mdocument-3.0.1590238503.tar.gz

Download URL	mdocument-3.0.1590238503.tar.gz
Size	7.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`d0a9b1dfeaba2e27b8020dac189b991bb9712718b658a33c896b3b2e3eeaba2b`
BLAKE2b-256 checksum How to use checksums	`063fe9fc2c75472bcd9d9fd89aabed04bd4a29fda28167b7ad8a0eca69d72015`
Upload date	May 23, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2`

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

Download URL	mdocument-3.0.1590238503-py3-none-any.whl
Size	8.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`8664d7b245ec81b6de137c34a2865d71f6716910ad5b172bd1511a9c0c275f51`
BLAKE2b-256 checksum How to use checksums	`c4305cee905908ad4733ff4f051c4e03fe406c61d9bfa97088ee37cf99c7538a`
Upload date	May 23, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2`