mdocument

MDocument

Simple DRM for async mongo motor client

Usage

import asyncio

from mdocument import Document, DatabaseClient

client1 = DatabaseClient(uri="localhost")

class Comment(Document):
    _collection_ = "comments"
    _database_ = "mdocument"
    _client_ = client1


class Video(Document):
    _collection_ = "videos"
    _database_ = "mdocument"
    _client_ = client1

    @Document.related(self_field="_id", other_field="video")
    def comments(self):
        return Comment


loop = asyncio.get_event_loop()
Document.setup(loop, "localhost", "test_database")

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.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_field, other_field, multiple=True, on_delete=None):

Example:

from mdocument import Document, DeleteDocument


class Artist(Document):
    __collection__ = "artists"

    @Document.related("_id", "album._id", on_delete=DeleteDocument)
    def albums(self):
        return Album

class Album(Document):
    __collection__ = "messages"

    @Document.related("_id", "album._id", on_delete=DeleteDocument)
    def songs(self):
        return Song


class Song(Document):
    __collection__ = "songs"

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

async def create(cls, loop=None, update_immediately=False, **kwargs):

If you want to create a new document you can do it easily with .create method. Example:

import asyncio

from mdocument import Document, DatabaseClient


class Message(Document):
    _collection_ = "messages"
    _database_ = "mdocument"
    _client_ = DatabaseClient(host="localhost")

Document.setup(loop, "localhost", "test_database")

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 2.1.1585431917

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 2.1.1585431917
File	Size	Uploaded
mdocument-2.1.1585431917.tar.gz	7.1 kB	Mar 28, 2020	Details

Built distribution (wheel)

Table of built distributions (wheels) for mdocument 2.1.1585431917
File	Interpreter	ABI	Platform	Reset
mdocument-2.1.1585431917-py3-none-any.whl 7.8 kB Mar 28, 2020	Python 3	none	any	Details

Total release size: 14.8 kB

Release files / mdocument-2.1.1585431917.tar.gz

Download URL	mdocument-2.1.1585431917.tar.gz
Size	7.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`3d2bfdcbfc17abfc00867b5d3086b41ef6352f2142dda7b647719e8599001d24`
BLAKE2b-256 checksum How to use checksums	`680e99a717bfa2e8d530b827e06d2a44d3eb4517c30090ff638b0c5fae3a412c`
Upload date	Mar 28, 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.1.3 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.2`

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

Download URL	mdocument-2.1.1585431917-py3-none-any.whl
Size	7.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`1cf3fe2ede57988b026ef79434a28d9321d85f2d2c74195665ae9f19d7bf4b42`
BLAKE2b-256 checksum How to use checksums	`07f9ad2e3839283edc63cfd507fc545fecf8a5d61f562fcdb61eb868b647fc15`
Upload date	Mar 28, 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.1.3 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.2`