pub/mongoengine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clean up how _changed_fields are set in BaseDocument._from_son (#2090)

Browse Source
This commit is contained in:
Stefan Wójcik 2019-06-17 13:41:02 +02:00 committed by GitHub
parent 22f3c70234
commit 09c77973a0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
mongoengine/base/document.py
View File

@ -25,6 +25,16 @@ NON_FIELD_ERRORS = '__all__'
class BaseDocument(object): class BaseDocument(object):
# TODO simplify how `_changed_fields` is used.
# Currently, handling of `_changed_fields` seems unnecessarily convoluted:
# 1. `BaseDocument` defines `_changed_fields` in its `__slots__`, yet it's
# not setting it to `[]` (or any other value) in `__init__`.
# 2. `EmbeddedDocument` sets `_changed_fields` to `[]` it its overloaded
# `__init__`.
# 3. `Document` does NOT set `_changed_fields` upon initialization. The
# field is primarily set via `_from_son` or `_clear_changed_fields`,
# though there are also other methods that manipulate it.
# 4. The codebase is littered with `hasattr` calls for `_changed_fields`.
__slots__ = ('_changed_fields', '_initialised', '_created', '_data', __slots__ = ('_changed_fields', '_initialised', '_created', '_data',
'_dynamic_fields', '_auto_id_field', '_db_field_map', '_dynamic_fields', '_auto_id_field', '_db_field_map',
'__weakref__') '__weakref__')
@ -665,9 +675,7 @@ class BaseDocument(object):
@classmethod @classmethod
def _from_son(cls, son, _auto_dereference=True, only_fields=None, created=False): def _from_son(cls, son, _auto_dereference=True, only_fields=None, created=False):
"""Create an instance of a Document (subclass) from a PyMongo """Create an instance of a Document (subclass) from a PyMongo SON."""
SON.
"""
if not only_fields: if not only_fields:
only_fields = [] only_fields = []
@ -690,7 +698,6 @@ class BaseDocument(object):
if class_name != cls._class_name: if class_name != cls._class_name:
cls = get_document(class_name) cls = get_document(class_name)
changed_fields = []
errors_dict = {} errors_dict = {}
fields = cls._fields fields = cls._fields
@ -720,8 +727,13 @@ class BaseDocument(object):
if cls.STRICT: if cls.STRICT:
data = {k: v for k, v in iteritems(data) if k in cls._fields} data = {k: v for k, v in iteritems(data) if k in cls._fields}
obj = cls(__auto_convert=False, _created=created, __only_fields=only_fields, **data) obj = cls(
obj._changed_fields = changed_fields __auto_convert=False,
_created=created,
__only_fields=only_fields,
**data
)
obj._changed_fields = []
if not _auto_dereference: if not _auto_dereference:
obj._fields = fields obj._fields = fields