Fix Document._object_key (#2125)

Previous implementation of `Document._object_key` was *pretending* to work on
MongoEngine-level fields (e.g. using "pk" instead of "_id" and separating
nested field parts by "__" instead of "."), but then it was also attempting to
transform field names from the `shard_key` into DB-level fields.

This, expectedly, didn't really work well. Most of the test cases added in this
commit were failing prior to the code fixes.
This commit is contained in:
Stefan Wójcik
2019-07-09 12:08:26 +02:00
committed by GitHub
parent abe8070c36
commit aa76ccdd25
4 changed files with 82 additions and 14 deletions

View File

@@ -202,6 +202,7 @@ class BaseDocument(object):
self__initialised = self._initialised
except AttributeError:
self__initialised = False
# Check if the user has created a new instance of a class
if (
self._is_document

View File

@@ -575,22 +575,24 @@ class Document(six.with_metaclass(TopLevelDocumentMetaclass, BaseDocument)):
@property
def _object_key(self):
"""Get the query dict that can be used to fetch this object from
the database.
"""Return a query dict that can be used to fetch this document.
Most of the time the dict is a simple PK lookup, but in case of
a sharded collection with a compound shard key, it can contain a more
complex query.
Note that the dict returned by this method uses MongoEngine field
names instead of PyMongo field names (e.g. "pk" instead of "_id",
"some__nested__field" instead of "some.nested.field", etc.).
"""
select_dict = {"pk": self.pk}
shard_key = self.__class__._meta.get("shard_key", tuple())
for k in shard_key:
path = self._lookup_field(k.split("."))
actual_key = [p.db_field for p in path]
val = self
for ak in actual_key:
val = getattr(val, ak)
select_dict["__".join(actual_key)] = val
field_parts = k.split(".")
for part in field_parts:
val = getattr(val, part)
select_dict["__".join(field_parts)] = val
return select_dict
def update(self, **kwargs):