Coverage for /home/runner/work/viur-core/viur-core/viur/src/viur/core/bones/relational.py: 9%
568 statements
« prev ^ index » next coverage.py v7.16.1, created at 2026-09-25 15:02 +0000
1"""
2This module contains the RelationalBone to create and manage relationships between skeletons
3and enums to parameterize it.
4"""
5import enum
6import json
7import logging
8import time
9import typing as t
10import warnings
11from itertools import chain
13from viur.core import db, i18n, utils
14from viur.core.bones.base import BaseBone, ReadFromClientError, ReadFromClientErrorSeverity, getSystemInitialized
16if t.TYPE_CHECKING: 16 ↛ 17line 16 didn't jump to line 17 because the condition on line 16 was never true
17 from viur.core.skeleton import SkeletonInstance, RelSkel
20class RelationalConsistency(enum.IntEnum):
21 """
22 An enumeration representing the different consistency strategies for handling stale relations in
23 the RelationalBone class.
24 """
25 Ignore = 1
26 """Ignore stale relations, which represents the old behavior."""
27 PreventDeletion = 2
28 """Lock the target object so that it cannot be deleted."""
29 SetNull = 3
30 """Drop the relation if the target object is deleted."""
31 CascadeDeletion = 4
32 """
33 .. warning:: Delete this object also if the referenced entry is deleted (Dangerous!)
34 """
37class RelationalUpdateLevel(enum.Enum):
38 """
39 An enumeration representing the different update levels for the RelationalBone class.
40 """
41 Always = 0
42 """Always update the relational information, regardless of the context."""
43 OnRebuildSearchIndex = 1
44 """Update the relational information only when rebuilding the search index."""
45 OnValueAssignment = 2
46 """Update the relational information only when a new value is assigned to the bone."""
49class RelDict(t.TypedDict):
50 dest: "SkeletonInstance"
51 rel: t.Optional["RelSkel"]
54class RelationalBone(BaseBone):
55 """
56 The base class for all relational bones in the ViUR framework.
57 RelationalBone is used to create and manage relationships between database entities. This class provides
58 basic functionality and attributes that can be extended by other specialized relational bone classes,
59 such as N1Relation, N2NRelation, and Hierarchy.
60 This implementation prioritizes read efficiency and is suitable for situations where data is read more
61 frequently than written. However, it comes with increased write operations when writing an entity to the
62 database. The additional write operations depend on the type of relationship: multiple=True RelationalBones
63 or 1:N relations.
65 The implementation does not instantly update relational information when a skeleton is updated; instead,
66 it triggers a deferred task to update references. This may result in outdated data until the task is completed.
68 Note: Filtering a list by relational properties uses the outdated data.
70 Example:
71 - Entity A references Entity B.
72 - Both have a property "name."
73 - Entity B is updated (its name changes).
74 - Entity A's RelationalBone values still show Entity B's old name.
76 It is not recommended for cases where data is read less frequently than written, as there is no
77 write-efficient method available yet.
79 :param kind: KindName of the referenced property.
80 :param module: Name of the module which should be used to select entities of kind "kind". If not set,
81 the value of "kind" will be used (the kindName must match the moduleName)
82 :param refKeys: A list of properties to include from the referenced property. These properties will be
83 available in the template without having to fetch the referenced property. Filtering is also only possible
84 by properties named here!
85 :param parentKeys: A list of properties from the current skeleton to include. If mixing filtering by
86 relational properties and properties of the class itself, these must be named here.
87 :param multiple: If True, allow referencing multiple Elements of the given class. (Eg. n:n-relation).
88 Otherwise its n:1, (you can only select exactly one). It's possible to use a unique constraint on this
89 bone, allowing for at-most-1:1 or at-most-1:n relations. Instead of true, it's also possible to use
90 a ```class MultipleConstraints``` instead.
92 :param format:
93 Hint for the frontend how to display such an relation. This is now a python expression
94 evaluated by safeeval on the client side. The following values will be passed to the expression:
96 - value
97 The value to display. This will be always a dict (= a single value) - even if the relation is
98 multiple (in which case the expression is evaluated once per referenced entity)
100 - structure
101 The structure of the skeleton this bone is part of as a dictionary as it's transferred to the
102 fronted by the admin/vi-render.
104 - language
105 The current language used by the frontend in ISO2 code (eg. "de"). This will be always set, even if
106 the project did not enable the multi-language feature.
108 :param updateLevel:
109 Indicates how ViUR should keep the values copied from the referenced entity into our
110 entity up to date. If this bone is indexed, it's recommended to leave this set to
111 RelationalUpdateLevel.Always, as filtering/sorting by this bone will produce stale results.
113 :param RelationalUpdateLevel.Always:
115 always update refkeys (old behavior). If the referenced entity is edited, ViUR will update this
116 entity also (after a small delay, as these updates happen deferred)
118 :param RelationalUpdateLevel.OnRebuildSearchIndex:
120 update refKeys only on rebuildSearchIndex. If the referenced entity changes, this entity will
121 remain unchanged (this RelationalBone will still have the old values), but it can be updated
122 by either by editing this entity or running a rebuildSearchIndex over our kind.
124 :param RelationalUpdateLevel.OnValueAssignment:
126 update only if explicitly set. A rebuildSearchIndex will not trigger an update, this bone has to be
127 explicitly modified (in an edit) to have it's values updated
129 :param consistency:
130 Can be used to implement SQL-like constrains on this relation. Possible values are:
131 - RelationalConsistency.Ignore
132 If the referenced entity gets deleted, this bone will not change. It will still reflect the old
133 values. This will be even be preserved over edits, however if that referenced value is once
134 deleted by the user (assigning a different value to this bone or removing that value of the list
135 of relations if we are multiple) there's no way of restoring it
137 - RelationalConsistency.PreventDeletion
138 Will prevent deleting the referenced entity as long as it's selected in this bone (calling
139 skel.delete() on the referenced entity will raise errors.Locked). It's still (technically)
140 possible to remove the underlying datastore entity using db.delete manually, but this *must not*
141 be used on a skeleton object as it will leave a whole bunch of references in a stale state.
143 - RelationalConsistency.SetNull
144 Will set this bone to None (or remove the relation from the list in
145 case we are multiple) when the referenced entity is deleted.
147 - RelationalConsistency.CascadeDeletion:
148 (Dangerous!) Will delete this entity when the referenced entity is deleted. Warning: Unlike
149 relational updates this will cascade. If Entity A references B with CascadeDeletion set, and
150 B references C also with CascadeDeletion; if C gets deleted, both B and A will be deleted as well.
152 """
153 type = "relational"
154 kind = None
156 def __init__(
157 self,
158 *,
159 consistency: RelationalConsistency = RelationalConsistency.Ignore,
160 format: str = "$(dest.name)",
161 kind: str = None,
162 module: t.Optional[str] = None,
163 parentKeys: t.Optional[t.Iterable[str]] = {"name"},
164 refKeys: t.Optional[t.Iterable[str]] = {"name"},
165 updateLevel: RelationalUpdateLevel = RelationalUpdateLevel.Always,
166 using: t.Optional["RelSkel"] = None,
167 **kwargs
168 ):
169 """
170 Initialize a new RelationalBone.
172 :param kind:
173 KindName of the referenced property.
174 :param module:
175 Name of the module which should be used to select entities of kind "type". If not set,
176 the value of "type" will be used (the kindName must match the moduleName)
177 :param refKeys:
178 An iterable of properties to include from the referenced property. These properties will be
179 available in the template without having to fetch the referenced property. Filtering is also only
180 possible by properties named here!
181 :param parentKeys:
182 An iterable of properties from the current skeleton to include. If mixing filtering by
183 relational properties and properties of the class itself, these must be named here.
184 :param multiple:
185 If True, allow referencing multiple Elements of the given class. (Eg. n:n-relation).
186 Otherwise its n:1, (you can only select exactly one). It's possible to use a unique constraint on this
187 bone, allowing for at-most-1:1 or at-most-1:n relations. Instead of true, it's also possible to use
188 a :class:MultipleConstraints instead.
190 :param format: Hint for the frontend how to display such an relation. This is now a python expression
191 evaluated by safeeval on the client side. The following values will be passed to the expression
193 :param value:
194 The value to display. This will be always a dict (= a single value) - even if the
195 relation is multiple (in which case the expression is evaluated once per referenced entity)
196 :param structure:
197 The structure of the skeleton this bone is part of as a dictionary as it's
198 transferred to the fronted by the admin/vi-render.
199 :param language:
200 The current language used by the frontend in ISO2 code (eg. "de"). This will be
201 always set, even if the project did not enable the multi-language feature.
203 :param updateLevel:
204 Indicates how ViUR should keep the values copied from the referenced entity into our
205 entity up to date. If this bone is indexed, it's recommended to leave this set to
206 RelationalUpdateLevel.Always, as filtering/sorting by this bone will produce stale results.
208 :param RelationalUpdateLevel.Always:
209 always update refkeys (old behavior). If the referenced entity is edited, ViUR will update this
210 entity also (after a small delay, as these updates happen deferred)
211 :param RelationalUpdateLevel.OnRebuildSearchIndex:
212 update refKeys only on rebuildSearchIndex. If the
213 referenced entity changes, this entity will remain unchanged
214 (this RelationalBone will still have the old values), but it can be updated
215 by either by editing this entity or running a rebuildSearchIndex over our kind.
216 :param RelationalUpdateLevel.OnValueAssignment:
217 update only if explicitly set. A rebuildSearchIndex will not trigger
218 an update, this bone has to be explicitly modified (in an edit) to have it's values updated
220 :param consistency:
221 Can be used to implement SQL-like constrains on this relation.
223 :param RelationalConsistency.Ignore:
224 If the referenced entity gets deleted, this bone will not change. It
225 will still reflect the old values. This will be even be preserved over edits, however if that
226 referenced value is once deleted by the user (assigning a different value to this bone or
227 removing that value of the list of relations if we are multiple) there's no way of restoring it
229 :param RelationalConsistency.PreventDeletion:
230 Will prevent deleting the referenced entity as long as it's
231 selected in this bone (calling skel.delete() on the referenced entity will raise errors.Locked).
232 It's still (technically) possible to remove the underlying datastore entity using db.delete
233 manually, but this *must not* be used on a skeleton object as it will leave a whole bunch of
234 references in a stale state.
236 :param RelationalConsistency.SetNull:
237 Will set this bone to None (or remove the relation from the list in
238 case we are multiple) when the referenced entity is deleted.
240 :param RelationalConsistency.CascadeDeletion:
241 (Dangerous!) Will delete this entity when the referenced entity
242 is deleted. Warning: Unlike relational updates this will cascade. If Entity A references B with
243 CascadeDeletion set, and B references C also with CascadeDeletion; if C gets deleted, both B and
244 A will be deleted as well.
245 """
246 super().__init__(**kwargs)
247 self.format = format
249 if kind:
250 self.kind = kind
252 if module:
253 self.module = module
254 elif self.kind: 254 ↛ 257line 254 didn't jump to line 257 because the condition on line 254 was always true
255 self.module = self.kind
257 if self.kind is None or self.module is None: 257 ↛ 258line 257 didn't jump to line 258 because the condition on line 257 was never true
258 raise NotImplementedError("'kind' and 'module' of RelationalBone must not be None")
260 # Referenced keys
261 self.refKeys = {"key", "shortkey"}
262 if refKeys: 262 ↛ 266line 262 didn't jump to line 266 because the condition on line 262 was always true
263 self.refKeys |= set(refKeys)
265 # Parent keys
266 self.parentKeys = {"key"}
267 if parentKeys: 267 ↛ 270line 267 didn't jump to line 270 because the condition on line 267 was always true
268 self.parentKeys |= set(parentKeys)
270 self.using = using
272 # FIXME: Remove in VIUR4!!
273 if isinstance(updateLevel, int): 273 ↛ 274line 273 didn't jump to line 274 because the condition on line 273 was never true
274 msg = f"parameter updateLevel={updateLevel} in RelationalBone is deprecated. " \
275 f"Please use the RelationalUpdateLevel enum instead"
276 logging.warning(msg, stacklevel=3)
277 warnings.warn(msg, DeprecationWarning, stacklevel=3)
279 assert 0 <= updateLevel < 3
280 for n in RelationalUpdateLevel:
281 if updateLevel == n.value:
282 updateLevel = n
284 self.updateLevel = updateLevel
285 self.consistency = consistency
287 if getSystemInitialized(): 287 ↛ 288line 287 didn't jump to line 288 because the condition on line 287 was never true
288 from viur.core.skeleton import RefSkel, SkeletonInstance
289 self._refSkelCache = RefSkel.fromSkel(self.kind, *self.refKeys)
290 self._skeletonInstanceClassRef = SkeletonInstance
291 self._ref_keys = set(self._refSkelCache.__boneMap__.keys())
293 def setSystemInitialized(self):
294 """
295 Set the system initialized for the current class and cache the RefSkel and SkeletonInstance.
297 This method calls the superclass's setSystemInitialized method and initializes the RefSkel
298 and SkeletonInstance classes. The RefSkel is created from the current kind and refKeys,
299 while the SkeletonInstance class is stored as a reference.
301 :rtype: None
302 """
303 super().setSystemInitialized()
304 from viur.core.skeleton import RefSkel, SkeletonInstance
306 try:
307 self._refSkelCache = RefSkel.fromSkel(self.kind, *self.refKeys)
308 except AssertionError:
309 raise NotImplementedError(
310 f"Skeleton {self.skel_cls!r} {self.__class__.__name__} {self.name!r}: Kind {self.kind!r} unknown"
311 )
313 self._skeletonInstanceClassRef = SkeletonInstance
314 self._ref_keys = set(self._refSkelCache.__boneMap__.keys())
316 def _getSkels(self):
317 """
318 Retrieve the reference skeleton and the 'using' skeleton for the current RelationalBone instance.
320 This method returns a tuple containing the reference skeleton (RefSkel) and the 'using' skeleton
321 (UsingSkel) associated with the current RelationalBone instance. The 'using' skeleton is only
322 retrieved if the 'using' attribute is defined.
324 :return: A tuple containing the reference skeleton and the 'using' skeleton.
325 :rtype: tuple
326 """
327 refSkel = self._refSkelCache()
328 usingSkel = self.using() if self.using else None
329 return refSkel, usingSkel
331 def singleValueUnserialize(self, val):
332 """
333 Restore a value, including the Rel- and Using-Skeleton, from the serialized data read from the datastore.
335 This method takes a serialized value from the datastore, deserializes it, and returns the corresponding
336 value with restored RelSkel and Using-Skel. It also handles ViUR 2 compatibility by handling string values.
338 :param val: A JSON-encoded datastore property.
339 :type val: str or dict
340 :return: The deserialized value with restored RelSkel and Using-Skel.
341 :rtype: dict
343 :raises AssertionError: If the deserialized value is not a dictionary.
344 """
346 def fixFromDictToEntry(inDict):
347 """
348 Convert a dictionary to an entry with properly restored keys and values.
350 :param dict inDict: The input dictionary to convert.
351 : return: The resulting entry.
352 :rtype: dict
353 """
354 if not isinstance(inDict, dict):
355 return None
356 res = {}
357 if "dest" in inDict:
358 res["dest"] = db.Entity()
359 for k, v in inDict["dest"].items():
360 res["dest"][k] = v
361 if "key" in res["dest"]:
362 res["dest"].key = db.normalize_key(res["dest"]["key"])
363 if "rel" in inDict and inDict["rel"]:
364 res["rel"] = db.Entity()
365 for k, v in inDict["rel"].items():
366 res["rel"][k] = v
367 else:
368 res["rel"] = None
369 return res
371 if isinstance(val, str): # ViUR2 compatibility
372 try:
373 value = json.loads(val)
374 if isinstance(value, list):
375 value = [fixFromDictToEntry(x) for x in value]
376 elif isinstance(value, dict):
377 value = fixFromDictToEntry(value)
378 else:
379 value = None
380 except ValueError:
381 value = None
382 else:
383 value = val
384 if not value:
385 return None
386 elif isinstance(value, list) and value:
387 value = value[0]
388 assert isinstance(value, dict), \
389 f"Read something from the datastore that's not a dict: {self.name=} -> {type(value)}"
390 if "dest" not in value:
391 return None
392 relSkel, usingSkel = self._getSkels()
393 relSkel.unserialize(value["dest"])
394 if self.using is not None:
395 usingSkel.unserialize(value["rel"] or db.Entity())
396 usingData = usingSkel
397 else:
398 usingData = None
399 return {"dest": relSkel, "rel": usingData}
401 def serialize(self, skel: "SkeletonInstance", name: str, parentIndexed: bool) -> bool:
402 """
403 Serialize the RelationalBone for the given skeleton, updating relational locks as necessary.
405 This method serializes the RelationalBone values for a given skeleton and stores the serialized
406 values in the skeleton's dbEntity. It also updates the relational locks, adding new locks and
407 removing old ones as needed.
409 :param SkeletonInstance skel: The skeleton instance containing the values to be serialized.
410 :param str name: The name of the bone to be serialized.
411 :param bool parentIndexed: A flag indicating whether the parent bone is indexed.
412 :return: True if the serialization is successful, False otherwise.
413 :rtype: bool
415 :raises AssertionError: If a programming error is detected.
416 """
418 def serialize_dest_rel(in_value: dict | None = None) -> (dict | None, dict | None):
419 if not in_value:
420 return None, None
421 if dest_val := in_value.get("dest"):
422 ref_data_serialized = dest_val.serialize(parentIndexed=indexed)
423 else:
424 ref_data_serialized = None
425 if rel_data := in_value.get("rel"):
426 using_data_serialized = rel_data.serialize(parentIndexed=indexed)
427 else:
428 using_data_serialized = None
430 return using_data_serialized, ref_data_serialized
432 super().serialize(skel, name, parentIndexed)
434 # Clean old properties from entry (prevent name collision)
435 for key in tuple(skel.dbEntity.keys()):
436 if key.startswith(f"{name}."):
437 del skel.dbEntity[key]
439 indexed = self.indexed and parentIndexed
441 if not (new_vals := skel.accessedValues.get(name)):
442 return False
444 # TODO: The good old leier... modernize this.
445 if self.languages:
446 res = {"_viurLanguageWrapper_": True}
447 for language in self.languages:
448 if language in new_vals:
449 if self.multiple:
450 res[language] = []
451 for val in new_vals[language]:
452 if val:
453 using_data, ref_data = serialize_dest_rel(val)
454 res[language].append({"rel": using_data, "dest": ref_data})
455 else:
456 if (val := new_vals[language]) and val["dest"]:
457 using_data, ref_data = serialize_dest_rel(val)
458 res[language] = {"rel": using_data, "dest": ref_data}
459 elif self.multiple:
460 res = []
461 for val in new_vals:
462 if val:
463 using_data, ref_data = serialize_dest_rel(val)
464 res.append({"rel": using_data, "dest": ref_data})
465 elif new_vals:
466 using_data, ref_data = serialize_dest_rel(new_vals)
467 res = {"rel": using_data, "dest": ref_data}
469 skel.dbEntity[name] = res
471 # Ensure our indexed flag is up2date
472 if indexed and name in skel.dbEntity.exclude_from_indexes:
473 skel.dbEntity.exclude_from_indexes.discard(name)
474 elif not indexed and name not in skel.dbEntity.exclude_from_indexes:
475 skel.dbEntity.exclude_from_indexes.add(name)
477 # Delete legacy property (PR #1244) #TODO: Remove in ViUR4
478 skel.dbEntity.pop(f"{name}_outgoingRelationalLocks", None)
480 return True
482 def _get_single_destinct_hash(self, value):
483 parts = [value["dest"]["key"]]
485 if self.using:
486 for name, bone in self.using.__boneMap__.items():
487 parts.append(bone._get_destinct_hash(value["rel"], name))
489 return tuple(parts)
491 def postSavedHandler(self, skel, boneName, key) -> None:
492 """
493 Handle relational updates after a skeleton is saved.
495 This method updates, removes, or adds relations between the saved skeleton and the referenced entities.
496 It also takes care of updating the relational properties and consistency levels.
498 :param skel: The saved skeleton instance.
499 :param boneName: The name of the relational bone.
500 :param key: The key of the saved skeleton instance.
501 """
502 viur_src_kind = key.kind
503 viur_src_property = boneName
505 # Hack for RelationalBones in containers (like RecordBones)
506 if "." in boneName:
507 _, boneName = boneName.rsplit(".", 1) # bone name to fummel out of the skeleton (again...)
509 if not skel[boneName]:
510 values = []
511 elif self.multiple and self.languages:
512 values = chain(*skel[boneName].values())
513 elif self.languages:
514 values = list(skel[boneName].values())
515 elif self.multiple:
516 values = skel[boneName]
517 else:
518 values = [skel[boneName]]
520 # Keep a set of all referenced keys
521 values = [value for value in values if value]
522 values_keys = {value["dest"]["key"] for value in values}
524 # Referenced parent values
525 src_values = db.Entity(key)
526 if skel.dbEntity:
527 src_values |= {bone: skel.dbEntity.get(bone) for bone in self.parentKeys or ()}
529 # Now is now, nana nananaaaaaaa...
530 now = time.time()
532 # All relation entities share the source entity's group (parent=key), so they are
533 # collected here and written in one commit instead of one put per relation: that is a
534 # single round-trip, and a single write against the one-write-per-second-and-entity-group
535 # rate limit rather than one per relation.
536 to_put: list[db.Entity] = []
537 to_delete: list[db.Key] = []
539 # Helper function to fill a relation entity from a bone value
540 def __update_relation(entity: db.Entity, data: dict):
541 ref_skel = data["dest"]
542 rel_skel = data["rel"]
544 entity["dest"] = ref_skel.serialize(parentIndexed=True)
545 entity["rel"] = rel_skel.serialize(parentIndexed=True) if rel_skel else None
546 entity["src"] = src_values
548 entity["viur_src_kind"] = viur_src_kind
549 entity["viur_src_property"] = viur_src_property
550 entity["viur_dest_kind"] = self.kind
551 entity["viur_delayed_update_tag"] = now
552 entity["viur_relational_updateLevel"] = self.updateLevel.value
553 entity["viur_relational_consistency"] = self.consistency.value
554 # Store expanded bone names, not raw refKeys patterns.
555 # refKeys may contain fnmatch wildcards (e.g. "delivery_time_*" matching
556 # "delivery_time_min", "delivery_time_max", "delivery_time_range").
557 # update_relations filters viur-relations via Datastore IN-query with the
558 # literal changed bone name — wildcard patterns would never match there.
559 entity["viur_foreign_keys"] = list(self._ref_keys)
560 entity["viurTags"] = skel.dbEntity.get("viurTags") if skel.dbEntity else None
562 to_put.append(entity)
564 # Query and update existing entries pointing to this bone
565 query = db.Query("viur-relations") \
566 .filter("viur_src_kind =", viur_src_kind) \
567 .filter("viur_dest_kind =", self.kind) \
568 .filter("viur_src_property =", viur_src_property) \
569 .filter("src.__key__ =", key)
571 for entity in query.iter():
572 try:
573 if entity["dest"].key not in values_keys: # Relation has been removed
574 to_delete.append(entity.key)
575 continue
577 except KeyError: # This entry is corrupt
578 to_delete.append(entity.key)
580 else: # Relation: Updated
581 # Find the newest item matching this key (this has to been done this way)...
582 value = [value for value in values if value["dest"]["key"] == entity["dest"].key][0]
583 # ... and remove it from the list of values
584 values.remove(value)
585 values_keys.remove(value["dest"]["key"])
587 # Update existing database entry
588 __update_relation(entity, value)
590 # Add new database entries for the remaining values
591 for value in values:
592 __update_relation(db.Entity(db.Key("viur-relations", parent=key)), value)
594 # A key is either deleted or written, never both, so the order of the two is irrelevant
595 if to_delete:
596 db.delete(to_delete)
598 if to_put:
599 db.put(to_put)
601 # Call postSavedHandler on UsingSkel (RelSkel)
602 if self.using:
603 for idx, lang, value in self.iter_bone_value(skel, boneName):
604 if not value or not value["rel"]:
605 continue
606 for bone_name, bone in value["rel"].items():
607 bone.postSavedHandler(value["rel"], bone_name, key)
609 def postDeletedHandler(self, skel: "SkeletonInstance", boneName: str, key: db.Key) -> None:
610 """
611 Handle relational updates after a skeleton is deleted.
613 This method deletes all relations associated with the deleted skeleton and the referenced entities
614 for the given relational bone.
616 :param skel: The deleted SkeletonInstance.
617 :param boneName: The name of the RelationalBone in the Skeleton.
618 :param key: The key of the deleted Entity.
619 """
620 query = db.Query("viur-relations") \
621 .filter("viur_src_kind =", key.kind) \
622 .filter("viur_dest_kind =", self.kind) \
623 .filter("viur_src_property =", boneName) \
624 .filter("src.__key__ =", key)
626 # iter() deliberately ignores the query limit, run() would stop after
627 # conf.db.query_default_limit entries and orphan every relation beyond it
628 db.delete(list(query.iter(keys_only=True)))
630 def isInvalid(self, key) -> None:
631 """
632 Check if the given key is invalid for this relational bone.
634 This method always returns None, as the actual validation of the key
635 is performed in other methods of the RelationalBone class.
637 :param key: The key to be checked for validity.
638 :return: None, as the actual validation is performed elsewhere.
639 """
640 return None
642 def parseSubfieldsFromClient(self):
643 """
644 Determine if the RelationalBone should parse subfields from the client.
646 This method returns True if the `using` attribute is not None, indicating
647 that this RelationalBone has a using-skeleton, and its subfields should
648 be parsed. Otherwise, it returns False.
650 :return: True if the using-skeleton is not None and subfields should be parsed, False otherwise.
651 :rtype: bool
652 """
653 return self.using is not None
655 def singleValueFromClient(self, value, skel, bone_name, client_data):
656 errors = []
658 if isinstance(value, dict):
659 dest_key = value.pop("key", None)
660 else:
661 dest_key = value
662 value = {}
664 if not isinstance(dest_key, db.KeyType):
665 errors.append(ReadFromClientError(ReadFromClientErrorSeverity.Invalid))
666 return self.getEmptyValue(), errors
668 if self.using:
669 rel = self.using()
670 if not rel.fromClient(value):
671 errors.append(
672 ReadFromClientError(
673 ReadFromClientErrorSeverity.Invalid,
674 i18n.translate("core.bones.error.incomplete", "Incomplete data"),
675 )
676 )
678 errors.extend(rel.errors)
679 else:
680 rel = None
682 # FIXME VIUR4: createRelSkelFromKey doesn't accept an instance of a RelSkel...
683 if ret := self.createRelSkelFromKey(dest_key, None): # ...therefore we need to first give None...
684 ret["rel"] = rel # ...and then assign it manually.
686 if err := self.isInvalid(ret):
687 ret = self.getEmptyValue()
688 errors.append(ReadFromClientError(ReadFromClientErrorSeverity.Invalid, err))
690 return ret, errors
692 elif self.consistency == RelationalConsistency.Ignore:
693 # when RelationalConsistency.Ignore is on, keep existing relations, even when they where deleted
694 for _, _, value in self.iter_bone_value(skel, bone_name):
695 if str(value["dest"]["key"]) == str(dest_key):
696 value["rel"] = rel
697 return value, errors
699 errors.append(ReadFromClientError(ReadFromClientErrorSeverity.Invalid))
700 return self.getEmptyValue(), errors
702 def _rewriteQuery(self, name, skel, dbFilter, rawFilter):
703 """
704 Rewrites a datastore query to operate on "viur-relations" instead of the original kind.
706 This method is needed to perform relational queries on n:m relations. It takes the original datastore query
707 and rewrites it to target the "viur-relations" kind. It also adjusts filters and sort orders accordingly.
709 :param str name: The name of the bone.
710 :param SkeletonInstance skel: The skeleton instance the bone is a part of.
711 :param viur.core.db.Query dbFilter: The original datastore query to be rewritten.
712 :param dict rawFilter: The raw filter applied to the original datastore query.
714 :return: A tuple containing the name, skeleton, rewritten query, and raw filter.
715 :rtype: Tuple[str, 'viur.core.skeleton.SkeletonInstance', 'viur.core.db.Query', dict]
717 :raises NotImplementedError: If the original query contains multiple filters with "IN" or "!=" operators.
718 :raises RuntimeError: If the filtering is invalid, e.g., using multiple key filters or querying
719 properties not in parentKeys.
720 """
721 origQueries = dbFilter.queries
722 if isinstance(origQueries, list):
723 raise NotImplementedError(
724 "Doing a relational Query with multiple=True and \"IN or !=\"-filters is currently unsupported!")
725 dbFilter.queries = db.QueryDefinition("viur-relations", {
726 "viur_src_kind =": skel.kindName,
727 "viur_dest_kind =": self.kind,
728 "viur_src_property =": name
730 }, orders=[], startCursor=origQueries.startCursor, endCursor=origQueries.endCursor)
731 for k, v in origQueries.filters.items(): # Merge old filters in
732 # Ensure that all non-relational-filters are in parentKeys
733 if k == db.KEY_SPECIAL_PROPERTY:
734 # We must process the key-property separately as its meaning changes as we change the datastore kind were querying
735 if isinstance(v, list) or isinstance(v, tuple):
736 logging.warning(f"Invalid filtering! Doing an relational Query on {name} with multiple key= "
737 f"filters is unsupported!")
738 raise RuntimeError()
739 if not isinstance(v, db.Key):
740 v = db.Key(v)
741 dbFilter.ancestor(v)
742 continue
743 boneName = k.split(".")[0].split(" ")[0]
744 if boneName not in self.parentKeys and boneName != "__key__":
745 logging.warning(f"Invalid filtering! {boneName} is not in parentKeys of RelationalBone {name}!")
746 raise RuntimeError()
747 dbFilter.filter(f"src.{k}", v)
748 orderList = []
749 for k, d in origQueries.orders: # Merge old sort orders in
750 if k == db.KEY_SPECIAL_PROPERTY:
751 orderList.append((f"{k}", d))
752 elif not k in self.parentKeys:
753 logging.warning(f"Invalid filtering! {k} is not in parentKeys of RelationalBone {name}!")
754 raise RuntimeError()
755 else:
756 orderList.append((f"src.{k}", d))
757 if orderList:
758 dbFilter.order(*orderList)
759 return name, skel, dbFilter, rawFilter
761 def buildDBFilter(
762 self,
763 name: str,
764 skel: "SkeletonInstance",
765 dbFilter: db.Query,
766 rawFilter: dict,
767 prefix: t.Optional[str] = None
768 ) -> db.Query:
769 """
770 Builds a datastore query by modifying the given filter based on the RelationalBone's properties.
772 This method takes a datastore query and modifies it according to the relational bone properties.
773 It also merges any related filters based on the 'refKeys' and 'using' attributes of the bone.
775 :param str name: The name of the bone.
776 :param SkeletonInstance skel: The skeleton instance the bone is a part of.
777 :param db.Query dbFilter: The original datastore query to be modified.
778 :param dict rawFilter: The raw filter applied to the original datastore query.
779 :param str prefix: Optional prefix to be applied to filter keys.
781 :return: The modified datastore query.
782 :rtype: db.Query
784 :raises RuntimeError: If the filtering is invalid, e.g., querying properties not in 'refKeys'
785 or not a bone in 'using'.
786 """
787 relSkel, _usingSkelCache = self._getSkels()
788 origQueries = dbFilter.queries
790 if origQueries is None: # This query is unsatisfiable
791 return dbFilter
793 myKeys = [x for x in rawFilter.keys() if x.startswith(f"{name}.")]
794 if len(myKeys) > 0: # We filter by some properties
795 if dbFilter.getKind() != "viur-relations" and self.multiple:
796 name, skel, dbFilter, rawFilter = self._rewriteQuery(name, skel, dbFilter, rawFilter)
798 # Merge the relational filters in
799 for myKey in myKeys:
800 value = rawFilter[myKey]
802 try:
803 unused, _type, key = myKey.split(".", 2)
804 assert _type in ["dest", "rel"]
805 except:
806 if self.using is None:
807 # This will be a "dest" query
808 _type = "dest"
809 try:
810 unused, key = myKey.split(".", 1)
811 except:
812 continue
813 else:
814 continue
816 # just use the first part of "key" to check against our refSkel / relSkel (strip any leading .something and $something)
817 checkKey = key
818 if "." in checkKey:
819 checkKey = checkKey.split(".")[0]
821 if "$" in checkKey:
822 checkKey = checkKey.split("$")[0]
824 if _type == "dest":
826 # Ensure that the relational-filter is in refKeys
827 if checkKey not in self._ref_keys:
828 logging.warning(f"Invalid filtering! {key} is not in refKeys of RelationalBone {name}!")
829 raise RuntimeError()
831 # Iterate our relSkel and let these bones write their filters in
832 for bname, bone in relSkel.items():
833 if checkKey == bname:
834 newFilter = {key: value}
835 if self.multiple:
836 bone.buildDBFilter(bname, relSkel, dbFilter, newFilter, prefix=(prefix or "") + "dest.")
837 else:
838 bone.buildDBFilter(bname, relSkel, dbFilter, newFilter,
839 prefix=(prefix or "") + name + ".dest.")
841 elif _type == "rel":
843 # Ensure that the relational-filter is in refKeys
844 if self.using is None or checkKey not in self.using():
845 logging.warning(f"Invalid filtering! {key} is not a bone in 'using' of {name}")
846 raise RuntimeError()
848 # Iterate our usingSkel and let these bones write their filters in
849 for bname, bone in self.using().items():
850 if key.startswith(bname):
851 newFilter = {key: value}
852 if self.multiple:
853 bone.buildDBFilter(bname, relSkel, dbFilter, newFilter, prefix=(prefix or "") + "rel.")
854 else:
855 bone.buildDBFilter(bname, relSkel, dbFilter, newFilter,
856 prefix=(prefix or "") + name + ".rel.")
858 if self.multiple:
859 dbFilter.setFilterHook(lambda s, filter, value: self.filterHook(name, s, filter, value))
860 dbFilter.setOrderHook(lambda s, orderings: self.orderHook(name, s, orderings))
862 elif name in rawFilter and isinstance(rawFilter[name], str) and rawFilter[name].lower() == "none":
863 dbFilter = dbFilter.filter(f"{name} =", None)
865 return dbFilter
867 def buildDBSort(
868 self,
869 name: str,
870 skel: "SkeletonInstance",
871 query: db.Query,
872 params: dict,
873 postfix: str = "",
874 ) -> t.Optional[db.Query]:
875 """
876 Builds a datastore query by modifying the given filter based on the RelationalBone's properties for sorting.
878 This method takes a datastore query and modifies its sorting behavior according to the relational bone
879 properties. It also checks if the sorting is valid based on the 'refKeys' and 'using' attributes of the bone.
881 :param name: The name of the bone.
882 :param skel: The skeleton instance the bone is a part of.
883 :param query: The original datastore query to be modified.
884 :param params: The raw filter applied to the original datastore query.
886 :return: The modified datastore query with updated sorting behavior.
887 :rtype: t.Optional[db.Query]
889 :raises RuntimeError: If the sorting is invalid, e.g., using properties not in 'refKeys'
890 or not a bone in 'using'.
891 """
892 if query.queries and (orderby := params.get("orderby")) and utils.string.is_prefix(orderby, name):
893 if self.multiple and query.getKind() != "viur-relations":
894 # This query has not been rewritten (yet)
895 name, skel, query, params = self._rewriteQuery(name, skel, query, params)
897 try:
898 _, _type, param = orderby.split(".")
899 except ValueError as e:
900 logging.exception(f"Invalid layout of {orderby=}: {e}")
901 return query
902 if _type not in ("dest", "rel"):
903 logging.error("Invalid type {_type}")
904 return query
906 # Ensure that the relational-filter is in refKeys
907 if _type == "dest" and param not in self._ref_keys:
908 raise RuntimeError(f"Invalid filtering! {param!r} is not in refKeys of RelationalBone {name!r}!")
909 elif _type == "rel" and (self.using is None or param not in self.using()):
910 raise RuntimeError(f"Invalid filtering! {param!r} is not a bone in 'using' of RelationalBone {name!r}")
912 if self.multiple:
913 path = f"{_type}.{param}"
914 else:
915 path = f"{name}.{_type}.{param}"
917 order = db.SortOrder.from_str(params.get("orderdir"))
918 query = query.order((path, order))
920 if self.multiple:
921 query.setFilterHook(lambda s, query, value: self.filterHook(name, s, query, value))
922 query.setOrderHook(lambda s, orderings: self.orderHook(name, s, orderings))
924 return query
926 def filterHook(self, name, query, param, value): # FIXME
927 """
928 Hook installed by buildDbFilter that rewrites filters added to the query to match the layout of the
929 viur-relations index and performs sanity checks on the query.
931 This method rewrites and validates filters added to a datastore query after the `buildDbFilter` method
932 has been executed. It ensures that the filters are compatible with the structure of the viur-relations
933 index and checks if the query is possible.
935 :param str name: The name of the bone.
936 :param db.Query query: The datastore query to be modified.
937 :param str param: The filter parameter to be checked and potentially modified.
938 :param value: The value associated with the filter parameter.
940 :return: A tuple containing the modified filter parameter and its associated value, or None if
941 the filter parameter is a key special property.
942 :rtype: Tuple[str, Any] or None
944 :raises RuntimeError: If the filtering is invalid, e.g., using properties not in 'refKeys' or 'parentKeys'.
945 """
946 if param.startswith("src.") or param.startswith("dest.") or param.startswith("viur_"):
947 # This filter is already valid in our relation
948 return param, value
949 if param.startswith(f"{name}."):
950 # We add a constrain filtering by properties of the referenced entity
951 refKey = param.replace(f"{name}.", "")
952 if " " in refKey: # Strip >, < or = params
953 refKey = refKey[:refKey.find(" ")]
954 if refKey not in self._ref_keys:
955 logging.warning(f"Invalid filtering! {refKey} is not in refKeys of RelationalBone {name}!")
956 raise RuntimeError()
957 if self.multiple:
958 return param.replace(f"{name}.", "dest."), value
959 else:
960 return param, value
961 else:
962 # We filter by a property of this entity
963 if not self.multiple:
964 # Not relational, not multiple - nothing to do here
965 return param, value
966 # Prepend "src."
967 srcKey = param
968 if " " in srcKey:
969 srcKey = srcKey[: srcKey.find(" ")] # Cut <, >, and =
970 if srcKey == db.KEY_SPECIAL_PROPERTY: # Rewrite key= filter as its meaning has changed
971 if isinstance(value, list) or isinstance(value, tuple):
972 logging.warning(f"Invalid filtering! Doing an relational Query on {name} "
973 f"with multiple key= filters is unsupported!")
974 raise RuntimeError()
975 if not isinstance(value, db.Key):
976 value = db.Key(value)
977 query.ancestor(value)
978 return None
979 if srcKey not in self.parentKeys:
980 logging.warning(f"Invalid filtering! {srcKey} is not in parentKeys of RelationalBone {name}!")
981 raise RuntimeError()
982 return f"src.{param}", value
984 def orderHook(
985 self,
986 name: str,
987 query: db.Query,
988 orderings: list[db.QueryOrder | str] | tuple[db.QueryOrder | str, ...],
989 ) -> list[db.QueryOrder | str] | tuple[db.QueryOrder | str]:
990 """
991 Hook installed by buildDbFilter that rewrites orderings added to the query to match the layout of the
992 viur-relations index and performs sanity checks on the query.
994 This method rewrites and validates orderings added to a datastore query after the `buildDbFilter` method
995 has been executed. It ensures that the orderings are compatible with the structure of the viur-relations
996 index and checks if the query is possible.
998 :param name: The name of the bone.
999 :param query: The datastore query to be modified.
1000 :param orderings: A list or tuple of orderings to be checked and potentially modified.
1002 :return: A list of modified orderings that are compatible with the viur-relations index.
1004 :raises RuntimeError: If the ordering is invalid, e.g., using properties not in 'refKeys' or 'parentKeys'.
1005 """
1006 res = []
1007 if isinstance(orderings, (str, db.QueryOrder)):
1008 orderings = [orderings]
1009 elif not isinstance(orderings, list):
1010 orderings = list(orderings)
1011 for order in orderings:
1012 if isinstance(order, db.QueryOrder):
1013 orderKey = order.name
1014 elif isinstance(order, str):
1015 orderKey = order
1016 else:
1017 raise TypeError(f"Invalid ordering {order!r} in orderHook")
1018 if orderKey.startswith("dest.") or orderKey.startswith("rel.") or orderKey.startswith("src."):
1019 # This is already valid for our relational index
1020 res.append(order)
1021 continue
1022 if orderKey.startswith(f"{name}."):
1023 k = orderKey.replace(f"{name}.", "")
1024 if k not in self._ref_keys:
1025 logging.warning(f"Invalid ordering! {k} is not in refKeys of RelationalBone {name}!")
1026 raise RuntimeError()
1027 if not self.multiple:
1028 res.append(order)
1029 else:
1030 if isinstance(order, tuple):
1031 res.append(db.QueryOrder(f"dest.{k}", order[1]))
1032 else:
1033 res.append(f"dest.{k}")
1034 else:
1035 if not self.multiple:
1036 # Nothing to do here
1037 res.append(order)
1038 continue
1039 else:
1040 if orderKey not in self.parentKeys:
1041 logging.warning(
1042 f"Invalid ordering! {orderKey} is not in parentKeys of RelationalBone {name}!")
1043 raise RuntimeError()
1044 if isinstance(order, tuple):
1045 res.append(db.QueryOrder(f"src.{orderKey}", order[1]))
1046 else:
1047 res.append(f"src.{orderKey}")
1048 return res
1050 def refresh(self, skel: "SkeletonInstance", name: str) -> None:
1051 """
1052 Refreshes all values that might be cached from other entities in the provided skeleton.
1054 This method updates the cached values for relational bones in the provided skeleton, which
1055 correspond to other entities. It fetches the updated values for the relational bone's
1056 reference keys and replaces the cached values in the skeleton with the fetched values.
1058 :param SkeletonInstance skel: The skeleton containing the bone to be refreshed.
1059 :param str boneName: The name of the bone to be refreshed.
1060 """
1061 if not skel[name] or self.updateLevel == RelationalUpdateLevel.OnValueAssignment:
1062 return
1064 for _, _, value in self.iter_bone_value(skel, name):
1065 if value and value["dest"]:
1066 try:
1067 target_skel = value["dest"].read()
1068 except ValueError:
1070 # Handle removed reference according to the RelationalConsistency settings
1071 match self.consistency:
1072 case RelationalConsistency.CascadeDeletion:
1073 logging.info(
1074 f"{name}: "
1075 f"Cascade deleting {skel["key"]!r} ({skel["name"]!r}) "
1076 f"due removal of relation {value["dest"]["key"]!r} ({value["dest"]["name"]!r})"
1077 )
1078 skel._cascade_deletion = True
1079 break
1081 case RelationalConsistency.SetNull:
1082 logging.info(
1083 f"{name}: "
1084 f"Emptying relation {skel["key"]!r} ({skel["name"]!r}) "
1085 f"due removal of {value["dest"]["key"]!r} ({value["dest"]["name"]!r})"
1086 )
1087 value.clear()
1089 case _:
1090 logging.info(
1091 f"{name}: "
1092 f"Relation from {skel["key"]!r} ({skel["name"]!r}) "
1093 f"refers to deleted {value["dest"]["key"]!r} ({value["dest"]["name"]!r}), skipping"
1094 )
1096 continue
1098 # Reset the dbEntity for a clean rewrite
1099 value["dest"].dbEntity = None
1101 # Copy over the refKey values using expanded bone names (_ref_keys),
1102 # not raw refKeys patterns. refKeys may contain fnmatch wildcards
1103 # (e.g. "delivery_time_*" → "delivery_time_min", "delivery_time_max",
1104 # "delivery_time_range"). Iterating raw patterns would attempt
1105 # target_skel["delivery_time_*"] which doesn't exist → copies None.
1106 for key in self._ref_keys:
1107 value["dest"][key] = target_skel[key]
1108 # logging.debug(f"Refreshed {key=} to {value["dest"][key]!r} ({str(value["dest"][key])!r})")
1110 def getSearchTags(self, skel: "SkeletonInstance", name: str) -> set[str]:
1111 """
1112 Retrieves the search tags for the given RelationalBone in the provided skeleton.
1114 This method iterates over the values of the relational bone and gathers search tags from the
1115 reference and using skeletons. It combines all the tags into a set to avoid duplicates.
1117 :param skel: The skeleton containing the bone for which search tags are to be retrieved.
1118 :param name: The name of the bone for which search tags are to be retrieved.
1120 :return: A set of search tags for the specified relational bone.
1121 """
1122 result = set()
1124 def get_values(skel_, values_cache):
1125 for key, bone in skel_.items():
1126 if not bone.searchable:
1127 continue
1128 for tag in bone.getSearchTags(values_cache, key):
1129 result.add(tag)
1131 ref_skel_cache, using_skel_cache = self._getSkels()
1132 for idx, lang, value in self.iter_bone_value(skel, name):
1133 if not value:
1134 continue
1135 if value["dest"]:
1136 get_values(ref_skel_cache, value["dest"])
1137 if value["rel"]:
1138 get_values(using_skel_cache, value["rel"])
1140 return result
1142 def createRelSkelFromKey(self, key: db.Key, rel: dict | None = None) -> RelDict | None:
1143 if rel_skel := self.relskels_from_keys([(key, rel)]):
1144 return rel_skel[0]
1145 return None
1147 def relskels_from_keys(self, key_rel_list: list[tuple[db.Key, dict | None]]) -> list[RelDict]:
1148 """
1149 Resolves a list of keys into reference skeletons valid for this bone.
1151 Each key is loaded from the datastore and unserialized into a reference skeleton.
1152 Resolution is all-or-nothing: if any requested key cannot be resolved, an empty
1153 list is returned.
1155 :param key_rel_list: List of ``(key, rel)`` tuples, where ``rel`` is a RelSkel dict or None.
1157 :return: A list of dicts, each with the reference skeleton under ``dest`` and the
1158 optional relation data under ``rel``. Empty if not all keys resolved.
1159 """
1161 keys = [db.key_helper(value[0], self.kind, adjust_kind=True) for value in key_rel_list]
1162 db_objs = {db_obj.key: db_obj for db_obj in db.get(keys)}
1163 if any(key not in db_objs for key in keys):
1164 return [] # return empty data when not all data is found
1166 res_rel_skels = []
1168 for key, (_, rel) in zip(keys, key_rel_list):
1169 dest_skel = self._refSkelCache()
1170 dest_skel.unserialize(db_objs[key])
1171 for bone_name in dest_skel:
1172 # Unserialize all bones from refKeys, then drop dbEntity - otherwise all properties will be copied
1173 _ = dest_skel[bone_name]
1174 dest_skel.dbEntity = None
1175 res_rel_skels.append(
1176 {
1177 "dest": dest_skel,
1178 "rel": rel or None
1179 }
1180 )
1182 return res_rel_skels
1184 def setBoneValue(
1185 self,
1186 skel: "SkeletonInstance",
1187 boneName: str,
1188 value: t.Any,
1189 append: bool,
1190 language: None | str = None
1191 ) -> bool:
1192 """
1193 Sets the value of the specified bone in the given skeleton. Sanity checks are performed to ensure the
1194 value is valid. If the value is invalid, no modifications are made.
1196 :param skel: Dictionary with the current values from the skeleton we belong to.
1197 :param boneName: The name of the bone to be modified.
1198 :param value: The value to be assigned. The type depends on the bone type.
1199 :param append: If true, the given value is appended to the values of the bone instead of replacing it.
1200 Only supported on bones with multiple=True.
1201 :param language: Set/append for a specific language (optional). Required if the bone
1202 supports languages.
1204 :return: True if the operation succeeded, False otherwise.
1205 """
1206 assert not (bool(self.languages) ^ bool(language)), "Language is required or not supported"
1207 assert not append or self.multiple, "Can't append - bone is not multiple"
1209 def tuple_check(in_value: tuple | None = None) -> bool:
1210 """
1211 Return True if the given value is a tuple with a length of two.
1212 In addition, the first field in the tuple must be a str,int or db.key.
1213 Furthermore, the second field must be a skeletonInstanceClassRef.
1214 """
1215 return (isinstance(in_value, tuple) and len(in_value) == 2
1216 and isinstance(in_value[0], db.KeyType)
1217 and isinstance(in_value[1], self._skeletonInstanceClassRef))
1219 if not self.multiple and not self.using:
1220 if not isinstance(value, db.KeyType):
1221 raise ValueError(f"You must supply exactly one Database-Key str or int to {boneName}")
1222 parsed_value = (value, None)
1223 elif not self.multiple and self.using:
1224 if not tuple_check(value):
1225 raise ValueError(f"You must supply a tuple of (Database-Key, relSkel) to {boneName}")
1226 parsed_value = value
1227 elif self.multiple and not self.using:
1228 if (
1229 not isinstance(value, db.KeyType)
1230 and not (isinstance(value, list))
1231 and all(isinstance(val, db.KeyType) for val in value)
1232 ):
1233 raise ValueError(f"You must supply a Database-Key or a list hereof to {boneName}")
1234 if isinstance(value, list):
1235 parsed_value = [(key, None) for key in value]
1236 else:
1237 parsed_value = [(value, None)]
1238 else: # which means (self.multiple and self.using)
1239 if not tuple_check(value) and (not isinstance(value, list) or not all(tuple_check(val) for val in value)):
1240 raise ValueError(f"You must supply (db.Key, RelSkel) or a list hereof to {boneName}")
1241 if isinstance(value, list):
1242 parsed_value = value
1243 else:
1244 parsed_value = [value]
1246 if boneName not in skel:
1247 skel[boneName] = {}
1248 if language:
1249 skel[boneName].setdefault(language, [])
1251 if self.multiple:
1252 rel_list = self.relskels_from_keys(parsed_value)
1253 if append:
1254 if language:
1255 skel[boneName][language].extend(rel_list)
1256 else:
1257 if not isinstance(skel[boneName], list):
1258 skel[boneName] = []
1259 skel[boneName].extend(rel_list)
1260 else:
1261 if language:
1262 skel[boneName][language] = rel_list
1263 else:
1264 skel[boneName] = rel_list
1265 else:
1266 if not (rel := self.createRelSkelFromKey(parsed_value[0], parsed_value[1])):
1267 return False
1268 if language:
1269 skel[boneName][language] = rel
1270 else:
1271 skel[boneName] = rel
1272 return True
1274 def getReferencedBlobs(self, skel: "SkeletonInstance", name: str) -> set[str]:
1275 """
1276 Retrieves the set of referenced blobs from the specified bone in the given skeleton instance.
1278 :param SkeletonInstance skel: The skeleton instance to extract the referenced blobs from.
1279 :param str name: The name of the bone to retrieve the referenced blobs from.
1281 :return: A set containing the unique blob keys referenced by the specified bone.
1282 :rtype: Set[str]
1283 """
1284 result = set()
1286 for idx, lang, value in self.iter_bone_value(skel, name):
1287 if not value:
1288 continue
1290 for key, bone in value["dest"].items():
1291 result.update(bone.getReferencedBlobs(value["dest"], key))
1293 if value["rel"]:
1294 for key, bone in value["rel"].items():
1295 result.update(bone.getReferencedBlobs(value["rel"], key))
1297 return result
1299 def getUniquePropertyIndexValues(self, skel: "SkeletonInstance", name: str) -> list[str]:
1300 """
1301 Generates unique property index values for the RelationalBone based on the referenced keys.
1302 Can be overridden if different behavior is required (e.g., examining values from `prop:usingSkel`).
1304 :param skel: The skeleton instance.
1305 :param str name: The name of the bone for which to generate unique property index values.
1307 :return: A list containing the unique property index values for the specified bone.
1308 :rtype: List[str]
1309 """
1310 values = []
1312 for _, _, v in self.iter_bone_value(skel, name):
1313 if not v:
1314 continue
1316 if self.using and (rel_skel := v.get("rel")):
1317 values.append(json.dumps(
1318 {"key": str(v["dest"]["key"]), "rel": rel_skel.dump()},
1319 sort_keys=True, default=str,
1320 ))
1321 else:
1322 values.append(v["dest"]["key"])
1324 return self._hashValueForUniquePropertyIndex(values) if values else []
1326 def structure(self) -> dict:
1327 return super().structure() | {
1328 "type": f"{self.type}.{self.kind}",
1329 "module": self.module,
1330 "format": self.format,
1331 "using": self.using().structure() if self.using else None,
1332 "relskel": self._refSkelCache().structure(),
1333 }
1335 def _atomic_dump(self, value: dict[str, "SkeletonInstance"]) -> dict | None:
1336 if value and isinstance(value, dict): # can be an empty dict due RelationalConsistency.SetNull
1337 return {
1338 "dest": value["dest"].dump(),
1339 "rel": value["rel"].dump() if value["rel"] else None,
1340 }