edit comments / inline as_mql()

Author: timgraham

django_mongodb/fields/__init__.py

@@ -1,6 +1,6 @@
 from .auto import ObjectIdAutoField
 from .duration import register_duration_field
-from .embedded_model import EmbeddedModelField, register_embedded_model_field
+from .embedded_model import EmbeddedModelField
 from .json import register_json_field
 from .objectid import ObjectIdField
 
@@ -9,5 +9,4 @@
 
 def register_fields():
     register_duration_field()
-    register_embedded_model_field()
     register_json_field()

django_mongodb/fields/embedded_model.py

@@ -46,13 +46,8 @@ def _set_model(self, model):
         Resolve embedded model class once the field knows the model it belongs
         to.
 
-        If the model argument passed to __init__() was a string, resolve that
-        string to the corresponding model class, similar to relation fields.
-        However, we need to know our own model to generate a valid key
-        for the embedded model class lookup and EmbeddedModelFields are
-        not contributed_to_class if used in iterable fields. Thus the
-        collection field sets this field's "model" attribute in its
-        contribute_to_class().
+        If __init__()'s embedded_model argument is a string, resolve it to the
+        corresponding model class, similar to relation fields.
         """
         self._model = model
         if model is not None and isinstance(self.embedded_model, str):
@@ -69,8 +64,8 @@ def from_db_value(self, value, expression, connection):
 
     def to_python(self, value):
         """
-        Passes embedded model fields' values through embedded fields
-        to_python() and reinstiatates the embedded instance.
+        Pass embedded model fields' values through each field's to_python() and
+        reinstiatate the embedded instance.
         """
         if value is None:
             return None
@@ -91,14 +86,8 @@ def to_python(self, value):
 
     def get_db_prep_save(self, embedded_instance, connection):
         """
-        Apply pre_save() and get_db_prep_save() of embedded instance
-        fields and passes a field => value mapping down to database
-        type conversions.
-
-        The embedded instance will be saved as a column => value dict, but
-        because we need to apply database type conversions on embedded instance
-        fields' values and for these we need to know fields those values come
-        from, we need to entrust the database layer with creating the dict.
+        Apply pre_save() and get_db_prep_save() of embedded instance fields and
+        create the {field: value} dict to be saved.
         """
         if embedded_instance is None:
             return None
@@ -121,7 +110,7 @@ def get_db_prep_save(self, embedded_instance, connection):
                 continue
             field_values[field.attname] = value
         # This instance will exist in the database soon.
-        # TODO.XXX: Ensure that this doesn't cause race conditions.
+        # TODO: Ensure that this doesn't cause race conditions.
         embedded_instance._state.adding = False
         return field_values
 
@@ -164,11 +153,10 @@ def preprocess_lhs(self, compiler, connection):
         mql = previous.as_mql(compiler, connection)
         return mql, key_transforms
 
-
-def key_transform(self, compiler, connection):
-    mql, key_transforms = self.preprocess_lhs(compiler, connection)
-    transforms = ".".join(key_transforms)
-    return f"{mql}.{transforms}"
+    def as_mql(self, compiler, connection):
+        mql, key_transforms = self.preprocess_lhs(compiler, connection)
+        transforms = ".".join(key_transforms)
+        return f"{mql}.{transforms}"
 
 
 class KeyTransformFactory:
@@ -177,7 +165,3 @@ def __init__(self, key_name):
 
     def __call__(self, *args, **kwargs):
         return KeyTransform(self.key_name, *args, **kwargs)
-
-
-def register_embedded_model_field():
-    KeyTransform.as_mql = key_transform