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.1592410567

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.1592410567
File	Size	Uploaded
mdocument-3.0.1592410567.tar.gz	8.0 kB	Jun 17, 2020	Details

Built distribution (wheel)

Table of built distributions (wheels) for mdocument 3.0.1592410567
File	Interpreter	ABI	Platform	Reset
mdocument-3.0.1592410567-py3-none-any.whl 8.0 kB Jun 17, 2020	Python 3	none	any	Details

Total release size: 16.0 kB

Release files / mdocument-3.0.1592410567.tar.gz

Download URL	mdocument-3.0.1592410567.tar.gz
Size	8.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`441f09c4cc545300b64a51762224b1687d5dbdae769cc9380715921cfb3e3ba9`
BLAKE2b-256 checksum How to use checksums	`743383c18144e2f0340edaa0f946858df89b8756c41cbf194da4d61d2b9e4049`
Upload date	Jun 17, 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/47.3.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3`

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

Download URL	mdocument-3.0.1592410567-py3-none-any.whl
Size	8.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`44a4ee8097f731bca2ee615c166bd51731a43786b76a54a7ea519a2205c7d7fa`
BLAKE2b-256 checksum How to use checksums	`07411a6f0647ba5f36178fb0c579a722bad8a62f066e7e49e9fb9e7911a467a7`
Upload date	Jun 17, 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/47.3.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.3`