From 604b9fc756bc0c535c38733768bac7fe79a2d562 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20tom=20W=C3=B6rden?= <h.tomwoerden@indiscale.com>
Date: Mon, 20 Feb 2023 12:36:36 +0100
Subject: [PATCH] DOC: document _wrap a bit
---
src/caosdb/common/models.py | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/src/caosdb/common/models.py b/src/caosdb/common/models.py
index 70b4bfa2..f89c57a5 100644
--- a/src/caosdb/common/models.py
+++ b/src/caosdb/common/models.py
@@ -102,6 +102,8 @@ class Entity:
self._checksum = None
self._size = None
self._upload = None
+ # If an entity is used (e.g. as parent), it is wrapped instead of being used directly.
+ # see Entity._wrap()
self._wrapped_entity = None
self._version = None
self._cuid = None
@@ -1331,6 +1333,12 @@ out: List[Entity]
flags=flags)[0]
def _wrap(self, entity):
+ """
+ When entity shall be used as parent or property it is not added to the corresponding list
+ (such as the parent list) directly, but another Entity object is created and the original
+ Entity is wrapped using this function
+ TODO: document here and in dev docs why this is done.
+ """
self._wrapped_entity = entity
return self
--
GitLab