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

Arbitrary metadata documentation.

Browse Source
This commit is contained in:
Alice Bevan–McGregor 2015-10-13 22:51:03 -04:00
parent a57f28ac83
commit 50b271c868
2 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/guide/defining-documents.rst
View File

@ -172,11 +172,11 @@ arguments can be set on all fields:
class Shirt(Document): class Shirt(Document):
size = StringField(max_length=3, choices=SIZE) size = StringField(max_length=3, choices=SIZE)
:attr:`help_text` (Default: None) :attr:`**kwargs` (Optional)
Optional help text to output with the field -- used by form libraries You can supply additional metadata as arbitrary additional keyword
arguments. You can not override existing attributes, however. Common
:attr:`verbose_name` (Default: None) choices include `help_text` and `verbose_name`, commonly used by form and
Optional human-readable name for the field -- used by form libraries widget libraries.
List fields List fields

6
mongoengine/base/fields.py
View File

@ -64,7 +64,11 @@ class BaseField(object):
then the default value is set then the default value is set
:param sparse: (optional) `sparse=True` combined with `unique=True` and `required=False` :param sparse: (optional) `sparse=True` combined with `unique=True` and `required=False`
means that uniqueness won't be enforced for `None` values means that uniqueness won't be enforced for `None` values
:param **kwargs: (optional) Arbitrary indirection-free metadata for this field. :param **kwargs: (optional) Arbitrary indirection-free metadata for
this field can be supplied as additional keyword arguments and
accessed as attributes of the field. Must not conflict with any
existing attributes. Common metadata includes `verbose_name` and
`help_text`.
""" """
self.db_field = (db_field or name) if not primary_key else '_id' self.db_field = (db_field or name) if not primary_key else '_id'