mango-odm

Mango

🥭 带有类型提示的 Python 异步 MongoDB 对象文档映射器

查看演示 · 错误报告 · 功能请求

简体中文 · English · 日本語

🔖 目录

目录

• 简介
  • 核心特性
• 安装
  • PIP
  • Poetry
• 示例
• 贡献
  • 鸣谢
• 支持
• 许可证

📖 简介

Mango 是一个带有类型提示的 Python 异步 MongoDB 对象文档映射器(ODM)，它构建在 Motor 和 Pydantic 之上。

Mango 使得数据建模和查询变得非常容易，帮助您关注应用程序中真正重要的部分。

✨ 核心特性：

• 完善的类型标注：利用静态分析来减少运行时问题
• 简洁流畅的 API：更易于学习和使用，提高开发效率
• 优雅的编辑器支持：自动完成无处不在，从对象创建到查询结果

[⬆回到顶部]

🚀 安装

PIP

pip install mango-odm

Poetry

poetry add mango-odm

[⬆回到顶部]

🌟 示例

import asyncio

from mango import Document, EmbeddedDocument, Field, Mango


# 嵌入式文档
class Author(EmbeddedDocument):
    name: str
    profile: str | None = None


# Mango 文档模型
class Book(Document):
    name: str = Field(primary_key=True)  # 将字段设置为主键，如果不显式指定主键，则会自动创建 id 字段作为主键
    summary: str | None = None
    author: Author  # 嵌入文档
    price: int = Field(index=True)  # 为字段添加索引


async def main():
    # 初始化 Mango，它会创建连接并初始化文档模型，你可以传入 db 或者 uri 参数来指定连接
    await Mango.init()

    # 像 pydantic 的模型一样使用
    book = Book(name="book", author=Author(name="author"), price=10)
    # 将它插入到数据库中
    await book.save()

    # Mango 提供了丰富的查询语言，允许您使用 Python 表达式来查询
    if book := await Book.find(Book.price <= 20, Book.author.name == "author").get():
        # 更新文档的 summary 字段
        book.summary = "summary"
        await book.update()


if __name__ == "__main__":
    asyncio.run(main())

[⬆回到顶部]

🤝 贡献

想为这个项目做出一份贡献吗？点击这里阅读并了解如何贡献。

🎉 鸣谢

感谢以下开发者对该项目做出的贡献：

[⬆回到顶部]

💖 支持

喜欢这个项目？请点亮 star 并分享它！

[⬆回到顶部]

📝 许可证

在 MIT 许可证下分发。请参阅 LICENSE 以获取更多信息。

[⬆回到顶部]