pub/mongoengine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clearer docstring of Document._get_collection [ci skip]

Browse Source
This commit is contained in:
Stefan Wojcik 2019-06-14 14:57:12 +02:00
parent 008bb19b0b
commit 1fcd706e11
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
mongoengine/document.py
View File

@ -182,8 +182,13 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
@classmethod @classmethod
def _get_collection(cls): def _get_collection(cls):
"""Return the corresponding PyMongo collection of this document. """Return the PyMongo collection corresponding to this document.
Upon the first call, it will ensure that indexes gets created. The returned collection then gets cached
Upon first call, this method:
1. Initializes a :class:`~pymongo.collection.Collection` corresponding
to this document.
2. Creates indexes defined in this document's :attr:`meta` dictionary.
This happens only if `auto_create_index` is True.
""" """
if not hasattr(cls, '_collection') or cls._collection is None: if not hasattr(cls, '_collection') or cls._collection is None:
# Get the collection, either capped or regular. # Get the collection, either capped or regular.