|
| 1 | +import contextlib |
| 2 | + |
| 3 | +from django.core import checks |
| 4 | +from django.core.exceptions import FieldDoesNotExist, ValidationError |
| 5 | +from django.db import models |
| 6 | +from django.db.models.fields.related import lazy_related_operation |
| 7 | + |
| 8 | +from .embedded_model import KeyTransformFactory |
| 9 | +from .utils import get_mongodb_connection |
| 10 | + |
| 11 | + |
| 12 | +class PolymorphicEmbeddedModelField(models.Field): |
| 13 | + """Field that stores a model instance of varying type.""" |
| 14 | + |
| 15 | + stores_model_instance = True |
| 16 | + |
| 17 | + def __init__(self, embedded_models, *args, **kwargs): |
| 18 | + """ |
| 19 | + `embedded_models` is a list of possible model classes to be stored. |
| 20 | + Like other relational fields, each model may also be passed as a |
| 21 | + string. |
| 22 | + """ |
| 23 | + self.embedded_models = embedded_models |
| 24 | + kwargs["editable"] = False |
| 25 | + super().__init__(*args, **kwargs) |
| 26 | + |
| 27 | + def db_type(self, connection): |
| 28 | + return "embeddedDocuments" |
| 29 | + |
| 30 | + def check(self, **kwargs): |
| 31 | + from ..models import EmbeddedModel |
| 32 | + |
| 33 | + errors = super().check(**kwargs) |
| 34 | + embedded_fields = {} |
| 35 | + for model in self.embedded_models: |
| 36 | + if not issubclass(model, EmbeddedModel): |
| 37 | + return [ |
| 38 | + checks.Error( |
| 39 | + "Embedded models must be a subclass of " |
| 40 | + "django_mongodb_backend.models.EmbeddedModel.", |
| 41 | + obj=self, |
| 42 | + hint="{model} doesn't subclass EmbeddedModel.", |
| 43 | + id="django_mongodb_backend.embedded_model.E002", |
| 44 | + ) |
| 45 | + ] |
| 46 | + for field in model._meta.fields: |
| 47 | + if field.remote_field: |
| 48 | + errors.append( |
| 49 | + checks.Error( |
| 50 | + "Embedded models cannot have relational fields " |
| 51 | + f"({model().__class__.__name__}.{field.name} " |
| 52 | + f"is a {field.__class__.__name__}).", |
| 53 | + obj=self, |
| 54 | + id="django_mongodb_backend.embedded_model.E001", |
| 55 | + ) |
| 56 | + ) |
| 57 | + field_name = field.name |
| 58 | + if existing_field := embedded_fields.get(field.name): |
| 59 | + connection = get_mongodb_connection() |
| 60 | + if existing_field.db_type(connection) != field.db_type(connection): |
| 61 | + errors.append( |
| 62 | + checks.Warning( |
| 63 | + f"Embedded models {existing_field.model._meta.label} " |
| 64 | + f"and {field.model._meta.label} both have field " |
| 65 | + f"'{field_name}' of different type.", |
| 66 | + obj=self, |
| 67 | + id="django_mongodb_backend.embedded_model.E003", |
| 68 | + hint="It may be impossible to query both fields.", |
| 69 | + ) |
| 70 | + ) |
| 71 | + |
| 72 | + else: |
| 73 | + embedded_fields[field_name] = field |
| 74 | + return errors |
| 75 | + |
| 76 | + def deconstruct(self): |
| 77 | + name, path, args, kwargs = super().deconstruct() |
| 78 | + if path.startswith("django_mongodb_backend.fields.polymorphic_embedded_model"): |
| 79 | + path = path.replace( |
| 80 | + "django_mongodb_backend.fields.polymorphic_embedded_model", |
| 81 | + "django_mongodb_backend.fields", |
| 82 | + ) |
| 83 | + kwargs["embedded_models"] = self.embedded_models |
| 84 | + del kwargs["editable"] |
| 85 | + return name, path, args, kwargs |
| 86 | + |
| 87 | + def get_internal_type(self): |
| 88 | + return "PolymorphicEmbeddedModelField" |
| 89 | + |
| 90 | + def _set_model(self, model): |
| 91 | + """ |
| 92 | + Resolve embedded model classes once the field knows the model it |
| 93 | + belongs to. If any of the items in __init__()'s embedded_models |
| 94 | + argument are strings, resolve each to the actual model class, similar |
| 95 | + to relational fields. |
| 96 | + """ |
| 97 | + self._model = model |
| 98 | + if model is not None: |
| 99 | + for embedded_model in self.embedded_models: |
| 100 | + if isinstance(embedded_model, str): |
| 101 | + |
| 102 | + def _resolve_lookup(_, *resolved_models): |
| 103 | + self.embedded_models = resolved_models |
| 104 | + |
| 105 | + lazy_related_operation(_resolve_lookup, model, *self.embedded_models) |
| 106 | + |
| 107 | + model = property(lambda self: self._model, _set_model) |
| 108 | + |
| 109 | + def from_db_value(self, value, expression, connection): |
| 110 | + return self.to_python(value) |
| 111 | + |
| 112 | + def to_python(self, value): |
| 113 | + """ |
| 114 | + Pass embedded model fields' values through each field's to_python() and |
| 115 | + reinstantiate the embedded instance. |
| 116 | + """ |
| 117 | + if value is None: |
| 118 | + return None |
| 119 | + if not isinstance(value, dict): |
| 120 | + return value |
| 121 | + model_class = self._get_model_from_label(value.pop("_label")) |
| 122 | + instance = model_class( |
| 123 | + **{ |
| 124 | + field.attname: field.to_python(value[field.attname]) |
| 125 | + for field in model_class._meta.fields |
| 126 | + if field.attname in value |
| 127 | + } |
| 128 | + ) |
| 129 | + instance._state.adding = False |
| 130 | + return instance |
| 131 | + |
| 132 | + def get_db_prep_save(self, embedded_instance, connection): |
| 133 | + """ |
| 134 | + Apply pre_save() and get_db_prep_save() of embedded instance fields and |
| 135 | + create the {field: value} dict to be saved. |
| 136 | + """ |
| 137 | + if embedded_instance is None: |
| 138 | + return None |
| 139 | + if not isinstance(embedded_instance, self.embedded_models): |
| 140 | + raise TypeError( |
| 141 | + f"Expected instance of type {self.embedded_models!r}, not " |
| 142 | + f"{type(embedded_instance)!r}." |
| 143 | + ) |
| 144 | + field_values = {} |
| 145 | + add = embedded_instance._state.adding |
| 146 | + for field in embedded_instance._meta.fields: |
| 147 | + value = field.get_db_prep_save( |
| 148 | + field.pre_save(embedded_instance, add), connection=connection |
| 149 | + ) |
| 150 | + # Exclude unset primary keys (e.g. {'id': None}). |
| 151 | + if field.primary_key and value is None: |
| 152 | + continue |
| 153 | + field_values[field.attname] = value |
| 154 | + # Store the model's label to know the class to use for initializing |
| 155 | + # upon retrieval. |
| 156 | + field_values["_label"] = embedded_instance._meta.label |
| 157 | + # This instance will exist in the database soon. |
| 158 | + embedded_instance._state.adding = False |
| 159 | + return field_values |
| 160 | + |
| 161 | + def get_transform(self, name): |
| 162 | + transform = super().get_transform(name) |
| 163 | + if transform: |
| 164 | + return transform |
| 165 | + for model in self.embedded_models: |
| 166 | + with contextlib.suppress(FieldDoesNotExist): |
| 167 | + field = model._meta.get_field(name) |
| 168 | + break |
| 169 | + else: |
| 170 | + raise FieldDoesNotExist( |
| 171 | + f"The models of field '{self.name}' have no field named '{name}'." |
| 172 | + ) |
| 173 | + return KeyTransformFactory(name, field) |
| 174 | + |
| 175 | + def validate(self, value, model_instance): |
| 176 | + super().validate(value, model_instance) |
| 177 | + if not isinstance(value, self.embedded_models): |
| 178 | + raise ValidationError( |
| 179 | + f"Expected instance of type {self.embedded_models!r}, not {type(value)!r}." |
| 180 | + ) |
| 181 | + for field in value._meta.fields: |
| 182 | + attname = field.attname |
| 183 | + field.validate(getattr(value, attname), model_instance) |
| 184 | + |
| 185 | + def formfield(self, **kwargs): |
| 186 | + raise NotImplementedError("PolymorphicEmbeddedModelField does not support forms.") |
| 187 | + |
| 188 | + def _get_model_from_label(self, label): |
| 189 | + return next(model for model in self.embedded_models if model._meta.label == label) |
0 commit comments