Skip to main content

Simple DRM for motor client

Project description

MDocument

pipeline status coverage report pypi link

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

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mdocument-3.0.1585479864.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

mdocument-3.0.1585479864-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file mdocument-3.0.1585479864.tar.gz.

File metadata

  • Download URL: mdocument-3.0.1585479864.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using 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.44.0 CPython/3.8.2

File hashes

Hashes for mdocument-3.0.1585479864.tar.gz
Algorithm Hash digest
SHA256 975a637a456b4a26c4789f438b059acf1ea0671c9316dab666912e8b64db25d0
MD5 1ae5bfd2eec91e89df7d1e609b147b20
BLAKE2b-256 d0fcfad0b5a5d6bf8fe98e1b3e2aa277fe0e9020c82109f567ebb80332674c79

See more details on using hashes here.

Provenance

File details

Details for the file mdocument-3.0.1585479864-py3-none-any.whl.

File metadata

  • Download URL: mdocument-3.0.1585479864-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using 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.44.0 CPython/3.8.2

File hashes

Hashes for mdocument-3.0.1585479864-py3-none-any.whl
Algorithm Hash digest
SHA256 8475d8a95c4d8fe382571f4cf0f321524f87b51b8511f7c15af7a7ca5a9ee7ce
MD5 a05e4de6a73f07874714c70dd10c13cf
BLAKE2b-256 acbe6afb3d4c9e2eab2b46c8bcf974252da6b7beab915c2da4b7d3883662b62a

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page