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

Ensure all field params are documented (#97)

Browse Source
This commit is contained in:
Ross Lawley 2013-04-23 15:59:23 +00:00
parent 1e1e48732a
commit 88f96b0838
7 changed files with 50 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
docs/apireference.rst
View File

@ -54,28 +54,33 @@ Querying
Fields Fields
====== ======
.. autoclass:: mongoengine.BinaryField
.. autoclass:: mongoengine.BooleanField
.. autoclass:: mongoengine.ComplexDateTimeField
.. autoclass:: mongoengine.DateTimeField
.. autoclass:: mongoengine.DecimalField
.. autoclass:: mongoengine.DictField
.. autoclass:: mongoengine.DynamicField
.. autoclass:: mongoengine.EmailField
.. autoclass:: mongoengine.EmbeddedDocumentField
.. autoclass:: mongoengine.FileField
.. autoclass:: mongoengine.FloatField
.. autoclass:: mongoengine.GenericEmbeddedDocumentField
.. autoclass:: mongoengine.GenericReferenceField
.. autoclass:: mongoengine.GeoPointField
.. autoclass:: mongoengine.ImageField
.. autoclass:: mongoengine.IntField
.. autoclass:: mongoengine.ListField
.. autoclass:: mongoengine.MapField
.. autoclass:: mongoengine.ObjectIdField
.. autoclass:: mongoengine.ReferenceField
.. autoclass:: mongoengine.SequenceField
.. autoclass:: mongoengine.SortedListField
.. autoclass:: mongoengine.StringField .. autoclass:: mongoengine.StringField
.. autoclass:: mongoengine.URLField .. autoclass:: mongoengine.URLField
.. autoclass:: mongoengine.EmailField
.. autoclass:: mongoengine.IntField
.. autoclass:: mongoengine.LongField
.. autoclass:: mongoengine.FloatField
.. autoclass:: mongoengine.DecimalField
.. autoclass:: mongoengine.BooleanField
.. autoclass:: mongoengine.DateTimeField
.. autoclass:: mongoengine.ComplexDateTimeField
.. autoclass:: mongoengine.EmbeddedDocumentField
.. autoclass:: mongoengine.GenericEmbeddedDocumentField
.. autoclass:: mongoengine.DynamicField
.. autoclass:: mongoengine.ListField
.. autoclass:: mongoengine.SortedListField
.. autoclass:: mongoengine.DictField
.. autoclass:: mongoengine.MapField
.. autoclass:: mongoengine.ReferenceField
.. autoclass:: mongoengine.GenericReferenceField
.. autoclass:: mongoengine.BinaryField
.. autoclass:: mongoengine.FileField
.. autoclass:: mongoengine.ImageField
.. autoclass:: mongoengine.GeoPointField
.. autoclass:: mongoengine.SequenceField
.. autoclass:: mongoengine.ObjectIdField
.. autoclass:: mongoengine.UUIDField .. autoclass:: mongoengine.UUIDField
.. autoclass:: mongoengine.GridFSError
.. autoclass:: mongoengine.GridFSProxy
.. autoclass:: mongoengine.ImageGridFsProxy
.. autoclass:: mongoengine.ImproperlyConfigured

2
docs/django.rst
View File

@ -10,7 +10,7 @@ In your **settings.py** file, ignore the standard database settings (unless you
also plan to use the ORM in your project), and instead call also plan to use the ORM in your project), and instead call
:func:`~mongoengine.connect` somewhere in the settings module. :func:`~mongoengine.connect` somewhere in the settings module.
.. note :: .. note::
If you are not using another Database backend you may need to add a dummy If you are not using another Database backend you may need to add a dummy
database backend to ``settings.py`` eg:: database backend to ``settings.py`` eg::

4
docs/guide/querying.rst
View File

@ -450,7 +450,7 @@ modifier comes before the field, not after it::
>>> post.tags >>> post.tags
['database', 'nosql'] ['database', 'nosql']
.. note :: .. note::
In version 0.5 the :meth:`~mongoengine.Document.save` runs atomic updates In version 0.5 the :meth:`~mongoengine.Document.save` runs atomic updates
on changed documents by tracking changes to that document. on changed documents by tracking changes to that document.
@ -466,7 +466,7 @@ cannot use the `$` syntax in keyword arguments it has been mapped to `S`::
>>> post.tags >>> post.tags
['database', 'mongodb'] ['database', 'mongodb']
.. note :: .. note::
Currently only top level lists are handled, future versions of mongodb / Currently only top level lists are handled, future versions of mongodb /
pymongo plan to support nested positional operators. See `The $ positional pymongo plan to support nested positional operators. See `The $ positional
operator <http://www.mongodb.org/display/DOCS/Updating#Updating-The%24positionaloperator>`_. operator <http://www.mongodb.org/display/DOCS/Updating#Updating-The%24positionaloperator>`_.

2
docs/upgrade.rst
View File

@ -205,7 +205,7 @@ via `save` eg ::
# Or in code: # Or in code:
my_document.save(cascade=True) my_document.save(cascade=True)
.. note :: .. note::
Remember: cascading saves **do not** cascade through lists. Remember: cascading saves **do not** cascade through lists.
ReferenceFields ReferenceFields

4
mongoengine/__init__.py
View File

@ -8,10 +8,12 @@ import queryset
from queryset import * from queryset import *
import signals import signals
from signals import * from signals import *
from errors import *
import errors
import django import django
__all__ = (list(document.__all__) + fields.__all__ + connection.__all__ + __all__ = (list(document.__all__) + fields.__all__ + connection.__all__ +
list(queryset.__all__) + signals.__all__) list(queryset.__all__) + signals.__all__ + list(errors.__all__))
VERSION = (0, 8, 0, '+') VERSION = (0, 8, 0, '+')

4
mongoengine/errors.py
View File

@ -3,7 +3,9 @@ from collections import defaultdict
from mongoengine.python_support import txt_type from mongoengine.python_support import txt_type
__all__ = ('NotRegistered', 'InvalidDocumentError', 'ValidationError') __all__ = ('NotRegistered', 'InvalidDocumentError', 'LookUpError',
'DoesNotExist', 'MultipleObjectsReturned', 'InvalidQueryError',
'OperationError', 'NotUniqueError', 'ValidationError')
class NotRegistered(Exception): class NotRegistered(Exception):

21
mongoengine/fields.py
View File

@ -4,7 +4,6 @@ import itertools
import re import re
import time import time
import urllib2 import urllib2
import urlparse
import uuid import uuid
import warnings import warnings
from operator import itemgetter from operator import itemgetter
@ -16,7 +15,7 @@ from mongoengine.errors import ValidationError
from mongoengine.python_support import (PY3, bin_type, txt_type, from mongoengine.python_support import (PY3, bin_type, txt_type,
str_types, StringIO) str_types, StringIO)
from base import (BaseField, ComplexBaseField, ObjectIdField, from base import (BaseField, ComplexBaseField, ObjectIdField,
get_document, BaseDocument, ALLOW_INHERITANCE) get_document, BaseDocument)
from queryset import DO_NOTHING, QuerySet from queryset import DO_NOTHING, QuerySet
from document import Document, EmbeddedDocument from document import Document, EmbeddedDocument
from connection import get_db, DEFAULT_CONNECTION_NAME from connection import get_db, DEFAULT_CONNECTION_NAME
@ -27,13 +26,17 @@ except ImportError:
Image = None Image = None
ImageOps = None ImageOps = None
__all__ = ['StringField', 'IntField', 'LongField', 'FloatField', 'BooleanField', __all__ = ['StringField', 'URLField', 'EmailField', 'IntField', 'LongField',
'DateTimeField', 'EmbeddedDocumentField', 'ListField', 'DictField', 'FloatField', 'DecimalField', 'BooleanField', 'DateTimeField',
'ObjectIdField', 'ReferenceField', 'ValidationError', 'MapField', 'ComplexDateTimeField', 'EmbeddedDocumentField', 'ObjectIdField',
'DecimalField', 'ComplexDateTimeField', 'URLField', 'DynamicField', 'GenericEmbeddedDocumentField', 'DynamicField', 'ListField',
'GenericReferenceField', 'FileField', 'BinaryField', 'SortedListField', 'DictField', 'MapField', 'ReferenceField',
'SortedListField', 'EmailField', 'GeoPointField', 'ImageField', 'GenericReferenceField', 'BinaryField', 'GridFSError',
'SequenceField', 'UUIDField', 'GenericEmbeddedDocumentField'] 'GridFSProxy', 'FileField', 'ImageGridFsProxy',
'ImproperlyConfigured', 'ImageField', 'GeoPointField',
'SequenceField', 'UUIDField']
RECURSIVE_REFERENCE_CONSTANT = 'self' RECURSIVE_REFERENCE_CONSTANT = 'self'