Yet Another Document Mapper¶

Base fields¶

Base classes for build database fields.

class yadm.fields.base.NotLoadedError¶

Raise if value marked as not loaded

doc = db(Doc).fields('a').find_one()
try:
    doc.b
except NotLoadedError:
    print("raised!")

class yadm.fields.base.FieldDescriptor(name, field)¶

Base desctiptor for fields

name¶

Name of field

field¶

Field instance for this desctiptor

__delete__(instance)¶

Mark document’s key as not set

__get__(instance, owner)¶

Get python value from document

1. Lookup in __changed__;

2. Lookup in __cache__;

3. Lookup in __raw__:

   • if AttributeNotSet – call Field.get_if_attribute_not_set;
   • if NotLoaded – call Field.get_if_not_loaded;
   • call Field.from_mongo;
   • set __name__ and __parent__
   • save to __cache__

4. Call Field.get_default;

5. If AttributeNotSet – call Field.get_if_attribute_not_set;

6. Return value.

__set__(instance, value)¶

Set value to document

1. Call Field.prepare_value for cast value;
2. Save in Document.__changed__;
3. Call Field.set_parent_changed.

class yadm.fields.base.Field(smart_null=False)¶

Base field for all database fields

Parameters:	smart_null (bool) – If it True, access to not exists fields return None instead AttributeError exception. You will not be able to distinguish null value from not exist. Use with care.

descriptor_class¶

Class of desctiptor for work with field

document_class¶

Class of document. Set in contribute_to_class().

name¶

Name of field in document. Set in contribute_to_class().

contribute_to_class(document_class, name)¶

Add field for document_class

Parameters:	document_class (MetaDocument) – document class for add

copy()¶

Return copy of field

descriptor_class

alias of FieldDescriptor

from_mongo(document, value)¶

Convert mongo value to python value

Parameters:	document (BaseDocument) – document value – mongo value
Returns:	python value

get_default(document)¶

Return default value

get_fake(document, faker, deep)¶

Return fake data for testing

get_if_attribute_not_set(document)¶

Call if key not exist in document

get_if_not_loaded(document)¶

Call if field data marked as not loaded

prepare_value(document, value)¶

The method is called when value is assigned

for the attribute

Parameters:	document (BaseDocument) – document value – raw value
Returns:	prepared value

It must be accept value argument and return processed (e.g. casted) analog. Also it is called once for the default value.

to_mongo(document, value)¶

Convert python value to mongo value

Parameters:	document (BaseDocument) – document value – python value
Returns:	mongo value

Simple fields¶

Fields for basic data types.

class yadm.fields.simple.BooleanField(default=<class 'yadm.markers.AttributeNotSet'>, *, choices=None, **kwargs)¶

Field for boolean values

type¶

alias of bool

class yadm.fields.simple.FloatField(default=<class 'yadm.markers.AttributeNotSet'>, *, choices=None, **kwargs)¶

Field for float

type¶

alias of float

class yadm.fields.simple.IntegerField(default=<class 'yadm.markers.AttributeNotSet'>, *, choices=None, **kwargs)¶

Field for integer

type¶

alias of int

class yadm.fields.simple.ObjectIdField(default_gen=False)¶

Field for ObjectId

Parameters:	default_gen (bool) – generate default value if not set

type¶

alias of ObjectId

class yadm.fields.simple.SimpleField(default=<class 'yadm.markers.AttributeNotSet'>, *, choices=None, **kwargs)¶

Base field for simple types

Parameters:	default – default value choices (set) – set of possible values

class yadm.fields.simple.StringField(default=<class 'yadm.markers.AttributeNotSet'>, *, choices=None, **kwargs)¶

Field for string

type¶

alias of str

Datetime field¶

class yadm.fields.datetime.DatetimeField(*, auto_now=False, **kwargs)¶

Field for time stamp

Parameters:	auto_now (bool) – datetime.now as default (default: False)

Decimal field¶

Field for decimal numbers

This code save to MongoDB document:

class yadm.fields.decimal.DecimalField(*, context=None, **kwargs)¶

Field for work with decimal.Decimal

Parameters:	context (decimal.Context) – context for decimal operations (default: run decimal.getcontext() when need) default (decimal.Decimal) –

TODO: context in copy()

context¶

Context

Returns:	decimal.Context for values

prepare_value(document, value)¶

Cast value to decimal.Decimal

Embedded documents fields¶

Work with embedded documents.

class EDoc(EmbeddedDocument):
    i = fields.IntegerField()

class Doc(Document):
    __collection__ = 'docs'
    edoc = EmbeddedDocumentField(EDoc)

doc = Doc()
doc.edoc = EDoc()
doc.edoc.i = 13
db.insert(doc)

class yadm.fields.embedded.EmbeddedDocumentField(embedded_document_class, *, auto_create=True, **kwargs)¶

Field for embedded objects

Parameters:	embedded_document_class (EmbeddedDocument) – class for embedded document auto_create (bool) – automatic creation embedded document from access

copy()¶

Return copy of field

get_if_attribute_not_set(document)¶

Call if key not exist in document

If auto_create is True, create and return new embedded document. Else AttributeError is raised.

Reference field¶

Work with references.

class RDoc(Document):
    i = fields.IntegerField

class Doc(Document):
    rdoc = fields.ReferenceField(RDoc)

rdoc = RDoc()
rdoc.i = 13
db.insert(rdoc)

doc = Doc()
doc.rdoc = rdoc
db.insert(doc)

doc = db.get_queryset(Doc).with_id(doc.id)  # reload doc
assert doc.rdoc.id == rdoc.id
assert doc.rdoc.i == 13

exception yadm.fields.reference.BrokenReference¶

Raise if referrenced document is not found

exception yadm.fields.reference.NotBindingToDatabase¶

Raise if set ObjectId insted referenced document to new document, who not binded to database.

class yadm.fields.reference.ReferenceField(reference_document_class, **kwargs)¶

Field for work with references

Parameters:	reference_document_class – class for refered documents

get_fake(document, faker, depth)¶

Try create referenced document

Containers fields¶

Base classes for containers.

class yadm.fields.containers.Container(field, parent, value)¶

Base class for containers

reload()¶

Reload all object from database

class yadm.fields.containers.ContainerField(item_field=None, *, auto_create=True, **kwargs)¶

Base class for container fields

container¶

alias of Container

from_mongo(document, value)¶

get_default(document)¶

get_default_value()¶

prepare_item(container, item, value)¶

prepare_value(document, value)¶

to_mongo(document, value)¶

List fields¶

List of objects

class Doc(Document):
    __collection__ = 'docs'
    integers = fields.ListField(fields.IntegerField)

doc = Doc()
doc.integers.append(1)
doc.integers.append(2)
assert doc.integers == [1, 2]

db.insert(doc)
doc = db.get_queryset(Doc).with_id(doc.id)  # reload

doc.integers.append(3)  # do not save
assert doc.integers == [1, 2, 3]
doc = db.get_queryset(Doc).with_id(doc.id)  # reload
assert doc.integers == [1, 2]

doc.integers.remove(2)  # do not save too
assert doc.integers == [1]
doc = db.get_queryset(Doc).with_id(doc.id)  # reload
assert doc.integers == [1, 2]

doc.integers.push(3)  # $push query
assert doc.integers == [1, 2, 3]
doc = db.get_queryset(Doc).with_id(doc.id)  # reload
assert doc.integers == [1, 2, 3]

doc.integers.pull(2)  # $pull query
assert doc.integers == [1, 3]
doc = db.get_queryset(Doc).with_id(doc.id)  # reload
assert doc.integers == [1, 3]

class yadm.fields.list.List(field, parent, value)¶

Container for list

append(item)¶

Append item to list

Parameters:	item – item for append

This method does not save object!

insert(index, item)¶

Append item to list

Parameters:	index (int) – item – item for insert

This method does not save object!

pull(query, reload=True)¶

Pull item from database

Parameters:	query – query for $pull on this field reload (bool) – automatically reload all values from database

See $pull in MongoDB’s update.

push(item, reload=True)¶

Push item directly to database

Parameters:	item – item for $push reload (bool) – automatically reload all values from database

See $push in MongoDB’s update.

remove(item)¶

Remove item from list

Parameters:	item – item for remove

This method does not save object!

replace(query, item, reload=True)¶

Replace list elements

Parameters:	query – query for update. Keys of this query is relative. item – embedded document or dict reload (bool) – automatically reload all values from database

update(query, values, reload=True)¶

Update fields in embedded documents

Parameters:	query – query for update. Keys of this query is relative. values – dict of new values reload (bool) – automatically reload all values from database

class yadm.fields.list.ListField(item_field=None, *, auto_create=True, **kwargs)¶

Field for list values

For example, document with list of integers:

class TestDoc(Document):
    __collection__ = 'testdoc'
    li = fields.ListField(fields.IntegerField())

container¶

alias of List

Set field¶

Field with sets.

Similar as yadm.fields.list.

class yadm.fields.set.Set(field, parent, value)¶

Container for set

add(item)¶

Append item to set

Parameters:	item – item for add

This method does not save object!

add_to_set(item, reload=True)¶

Add item directly to database

Parameters:	item – item for $addToSet reload (bool) – automatically reload all values from database

See $addToSet in MongoDB’s update.

discard(item)¶

Remove item from the set if it is present

Parameters:	item – item for discard

This method does not save object!

pull(query, reload=True)¶

Pull item from database

Parameters:	query – query for $pull on this field reload (bool) – automatically reload all values from database

See $pull in MongoDB’s update.

remove(item)¶

Remove item from set

Parameters:	item – item for remove

This method does not save object!

class yadm.fields.set.SetField(item_field=None, *, auto_create=True, **kwargs)¶

Field for set values

container¶

alias of Set

Map field¶

Map

class Doc(Document):
    __collection__ = 'docs'
    map = fields.MapField(fields.IntegerField)

doc = Doc()
doc.map['a'] = 1
doc.map['b'] = 2
assert doc.map == {'a': 1, 'b': 2}

db.insert(doc)
doc = db.get_queryset(Doc).with_id(doc.id)  # reload

doc.map['c'] = 3  # do not save
assert doc.map == {'a': 1, 'b': 2, 'c': 3}
doc = db.get_queryset(Doc).with_id(doc.id)  # reload
assert doc.map == {'a': 1, 'b': 2}

del doc.map['b']  # do not save too
assert doc.map == {'a': 1}
doc = db.get_queryset(Doc).with_id(doc.id)  # reload
assert doc.map == {'a': 1, 'b': 2}

doc.map.set('d', 3)  # $set query
assert doc.map == {'a': 1, 'b': 2, 'c': 3}
doc = db.get_queryset(Doc).with_id(doc.id)  # reload
assert doc.map == {'a': 1, 'b': 2, 'c': 3}

doc.map.unset('d', 3)  # $unset query
assert doc.map == {'a': 1, 'b': 2}
doc = db.get_queryset(Doc).with_id(doc.id)  # reload
assert doc.map == {'a': 1, 'b': 2}

class yadm.fields.map.Map(field, parent, value)¶

set(key, value, reload=True)¶

Set key directly in database

Parameters:	key – key value – value for $set

See $set in MongoDB’s set.

unset(key, reload=True)¶

Unset key directly in database

Parameters:	key – key

See $unset in MongoDB’s unset.

class yadm.fields.map.MapCustomKeysField(item_field, key_factory, *, key_to_str=<class 'str'>, auto_create=True, **kwargs)¶

Field for maps with custom key type

Parameters:	item_field (field) – key_factory (func) – function, who return thue key from raw string key key_to_str (func) – auto_create (bool) –

class yadm.fields.map.MapField(item_field=None, *, auto_create=True, **kwargs)¶

Field for maps

container¶

alias of Map

Geo fields¶

Fields for geo data

See: http://docs.mongodb.org/manual/applications/geospatial-indexes/

GeoJSON: http://geojson.org/geojson-spec.html

class yadm.fields.geo.Geo¶

Base class for GeoJSON data

class yadm.fields.geo.GeoCoordinates¶

Base class for GeoJSON data with coordinates

class yadm.fields.geo.GeoField(types=[<class 'yadm.fields.geo.Point'>, <class 'yadm.fields.geo.MultiPoint'>], **kwargs)¶

Base field for GeoJSON objects

class yadm.fields.geo.GeoOneTypeField(**kwargs)¶

Base field for GeoJSON objects with one acceptable type

class yadm.fields.geo.MultiPoint(points)¶

Class for GeoJSON MultiPoint objects

See: http://geojson.org/geojson-spec.html#id5

class yadm.fields.geo.MultiPointField(**kwargs)¶

Field for MultiPoint

type¶

alias of MultiPoint

class yadm.fields.geo.Point(longitude, latitude)¶

Class for GeoJSON Point objects

See: http://geojson.org/geojson-spec.html#id2

class yadm.fields.geo.PointField(**kwargs)¶

Field for Point

type¶

alias of Point