mongoengine

蒙戈引擎

信息：	MongoEngine 是 PyMongo 之上的类似 ORM 的层。
存储库：	https://github.com/MongoEngine/mongoengine
作者：	哈利·马尔 (http://github.com/hmarr)
维护者：	巴斯蒂安·杰拉德 (http://github.com/bagerard)

关于

MongoEngine 是一个用于 MongoDB 的 Python 对象文档映射器。文档可在 https://mongoengine-odm.readthedocs.io 上获取 - 目前有教程、用户指南和 API 参考。

支持的 MongoDB 版本

MongoEngine 目前针对 MongoDB v3.6、v4.0、v4.4、v5.0、v6.0 和 v7.0 进行了测试。未来的版本也应该受到支持，但目前尚未进行积极测试。如果您在使用较新的 MongoDB 版本时遇到任何问题，请务必提出问题或提交拉取请求。

安装

我们建议使用 virtualenv 和 pip。然后您可以使用python -m pip install -U mongoengine 。您可能还拥有安装工具，因此您可以使用easy_install -U mongoengine 。另一个选择是 pipelinev。然后，您可以使用pipenv install mongoengine创建虚拟环境并安装软件包。否则，您可以从 GitHub 下载源代码并运行python setup.py install 。

MongoEngine 0.20.0 取消了对 Python2 的支持

依赖关系

所有依赖项都可以通过 python -m pip 轻松安装。至少，您需要这两个包才能使用 MongoEngine：

• pymongo>=3.4

如果您使用DateTimeField ，您还可以使用更灵活的日期解析器：

• dateutil>=2.1.0

如果您需要使用ImageField或ImageGridFsProxy ：

• 枕头>=7.0.0

如果需要使用信号：

• 方向灯>=1.3

示例

MongoEngine 代码的一些简单示例：

 from mongoengine import *
connect ( 'mydb' )

class BlogPost ( Document ):
    title = StringField ( required = True , max_length = 200 )
    posted = DateTimeField ( default = datetime . datetime . utcnow )
    tags = ListField ( StringField ( max_length = 50 ))
    meta = { 'allow_inheritance' : True }

class TextPost ( BlogPost ):
    content = StringField ( required = True )

class LinkPost ( BlogPost ):
    url = StringField ( required = True )

# Create a text-based post
> >> post1 = TextPost ( title = 'Using MongoEngine' , content = 'See the tutorial' )
> >> post1 . tags = [ 'mongodb' , 'mongoengine' ]
> >> post1 . save ()

# Create a link-based post
> >> post2 = LinkPost ( title = 'MongoEngine Docs' , url = 'hmarr.com/mongoengine' )
> >> post2 . tags = [ 'mongoengine' , 'documentation' ]
> >> post2 . save ()

# Iterate over all posts using the BlogPost superclass
> >> for post in BlogPost . objects :
...     print ( '===' , post . title , '===' )
...     if isinstance ( post , TextPost ):
...         print ( post . content )
...     elif isinstance ( post , LinkPost ):
...         print ( 'Link:' , post . url )
...

# Count all blog posts and its subtypes
>> > BlogPost . objects . count ()
2
>> > TextPost . objects . count ()
1
>> > LinkPost . objects . count ()
1

# Count tagged posts
>> > BlogPost . objects ( tags = 'mongoengine' ). count ()
2
>> > BlogPost . objects ( tags = 'mongodb' ). count ()
1 

测试

要运行测试套件，请确保您在标准端口上运行 MongoDB 的本地实例并安装了pytest 。然后，运行pytest tests/ 。

要在每个受支持的 Python 和 PyMongo 版本上运行测试套件，您可以使用tox 。您需要确保您的环境中安装了每个受支持的 Python 版本，然后：

 # Install tox
$ python -m pip install tox
# Run the test suites
$ tox

社区

• MongoEngine 用户邮件列表
• MongoEngine 开发者邮件列表

贡献

我们欢迎贡献！请参阅贡献指南