API Reference

Document

class umongo.Document(**kwargs)

classmethod build_from_mongo(data, partial=False, use_cls=False)

Create a document instance from MongoDB data

Parameters:

• data – data as retrieved from MongoDB
• use_cls – if the data contains a _cls field, use it determine the Document class to instanciate

clear_modified()

Reset the list of document’s modified items

dbref

Return a pymongo DBRef instance related to the document

dump(schema=None)

Dump the document: return a dict

Parameters:schema – use this schema for the dump instead of the default one

from_mongo(data, partial=False)

Update the document with the MongoDB data

Parameters:data – data as retrieved from MongoDB

pk

Return the document’s primary key (i.e. _id in mongo notation) or None if not available yet

to_mongo(update=False)

update(data, schema=None)

Update the document with the given data

Parameters:schema – use this schema for the load instead of the default one

class umongo.meta.DocumentOpts(name, nmspc, bases)

Fields

class umongo.fields.DictField(*args, **kwargs)

class umongo.fields.ListField(*args, **kwargs)

map_to_field(mongo_path, path, func)

Apply a function to every field in the schema

class umongo.fields.StringField(*args, io_validate=None, unique=False, **kwargs)

class umongo.fields.UUIDField(*args, io_validate=None, unique=False, **kwargs)

class umongo.fields.NumberField(*args, io_validate=None, unique=False, **kwargs)

class umongo.fields.IntegerField(*args, io_validate=None, unique=False, **kwargs)

class umongo.fields.DecimalField(*args, io_validate=None, unique=False, **kwargs)

class umongo.fields.BooleanField(*args, io_validate=None, unique=False, **kwargs)

class umongo.fields.FormattedStringField(*args, io_validate=None, unique=False, **kwargs)

class umongo.fields.FloatField(*args, io_validate=None, unique=False, **kwargs)

class umongo.fields.DateTimeField(*args, io_validate=None, unique=False, **kwargs)

class umongo.fields.UrlField(*args, io_validate=None, unique=False, **kwargs)

umongo.fields.URLField

alias of UrlField

class umongo.fields.EmailField(*args, io_validate=None, unique=False, **kwargs)

umongo.fields.StrField

alias of StringField

umongo.fields.BoolField

alias of BooleanField

umongo.fields.IntField

alias of IntegerField

class umongo.fields.ConstantField(*args, io_validate=None, unique=False, **kwargs)

class umongo.fields.ObjectIdField(*args, io_validate=None, unique=False, **kwargs)

Marshmallow field for bson.ObjectId

class umongo.fields.ReferenceField(document_cls, *args, reference_cls=<class 'umongo.data_objects.Reference'>, **kwargs)

document_cls

class umongo.fields.GenericReferenceField(*args, reference_cls=<class 'umongo.data_objects.Reference'>, **kwargs)

class umongo.fields.EmbeddedField(embedded_document_cls, *args, **kwargs)

map_to_field(mongo_path, path, func)

Apply a function to every field in the schema

Data objects

class umongo.data_objects.EmbeddedDocument(**kwargs)

Schema

alias of EmbeddedDocumentSchema

clear_modified()

dump()

from_mongo(data)

is_modified()

schema = <EmbeddedDocumentSchema(many=False, strict=False)>

set_modified()

to_mongo(update=False)

class umongo.data_objects.List(container_field, *args, **kwargs)

append(obj)

clear(*args, **kwargs)

extend(iterable)

pop(*args, **kwargs)

remove(*args, **kwargs)

reverse(*args, **kwargs)

sort(*args, **kwargs)

class umongo.data_objects.Reference(document_cls, pk)

io_fetch(no_data=False)

Exceptions

exception umongo.exceptions.AbstractDocumentError

exception umongo.exceptions.AlreadyRegisteredDocumentError

exception umongo.exceptions.DeleteError

exception umongo.exceptions.DocumentDefinitionError

exception umongo.exceptions.FieldNotLoadedError

exception umongo.exceptions.MissingSchemaError

exception umongo.exceptions.NoCollectionDefinedError

exception umongo.exceptions.NoCompatibleDalError

exception umongo.exceptions.NoDBDefinedError

exception umongo.exceptions.NotCreatedError

exception umongo.exceptions.NotRegisteredDocumentError

exception umongo.exceptions.UMongoError

exception umongo.exceptions.UpdateError