simplibs-object 0.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (580) hide show
  1. simplibs/object/SimpleBase.py +115 -0
  2. simplibs/object/SimpleConstant.py +271 -0
  3. simplibs/object/SimpleObject.py +293 -0
  4. simplibs/object/__init__.py +7 -0
  5. simplibs/object/_core/__init__.py +66 -0
  6. simplibs/object/_core/logic/__init__.py +0 -0
  7. simplibs/object/_core/logic/constant_methods/__init__.py +22 -0
  8. simplibs/object/_core/logic/constant_methods/bool_or_raise_validate_error.py +76 -0
  9. simplibs/object/_core/logic/constant_methods/normalize.py +92 -0
  10. simplibs/object/_core/logic/constant_methods/validate.py +99 -0
  11. simplibs/object/_core/logic/constant_methods/validate_type.py +48 -0
  12. simplibs/object/_core/logic/constant_methods/validations/__init__.py +22 -0
  13. simplibs/object/_core/logic/constant_methods/validations/_extract_clean_code_lines.py +86 -0
  14. simplibs/object/_core/logic/constant_methods/validations/raise_missing_value_error.py +71 -0
  15. simplibs/object/_core/logic/constant_methods/validations/raise_type_error.py +59 -0
  16. simplibs/object/_core/logic/constant_methods/validations/raise_unexpected_validation_error.py +66 -0
  17. simplibs/object/_core/logic/constant_methods/validations/raise_validation_error.py +78 -0
  18. simplibs/object/_core/logic/object_methods/__init__.py +18 -0
  19. simplibs/object/_core/logic/object_methods/_process_calculate_value_params.py +108 -0
  20. simplibs/object/_core/logic/object_methods/calculate_value.py +81 -0
  21. simplibs/object/_core/logic/object_methods/decompose_value.py +91 -0
  22. simplibs/object/_core/logic/object_methods/validations/__init__.py +22 -0
  23. simplibs/object/_core/logic/object_methods/validations/raise_class_not_decomposeable.py +82 -0
  24. simplibs/object/_core/logic/object_methods/validations/raise_duplicate_argument_error.py +77 -0
  25. simplibs/object/_core/logic/object_methods/validations/raise_too_many_positional_args_error.py +81 -0
  26. simplibs/object/_core/logic/object_methods/validations/raise_unknown_parameter_error.py +77 -0
  27. simplibs/object/_core/logic/property_builders/__init__.py +20 -0
  28. simplibs/object/_core/logic/property_builders/create_instance_property.py +66 -0
  29. simplibs/object/_core/logic/property_builders/create_properties_for_inner.py +97 -0
  30. simplibs/object/_core/logic/property_builders/create_value_property.py +98 -0
  31. simplibs/object/_core/logic/property_builders/value_helpers/__init__.py +18 -0
  32. simplibs/object/_core/logic/property_builders/value_helpers/create_value_getter.py +52 -0
  33. simplibs/object/_core/logic/property_builders/value_helpers/create_value_setter.py +95 -0
  34. simplibs/object/_core/logic/property_builders/value_helpers/validations/__init__.py +16 -0
  35. simplibs/object/_core/logic/property_builders/value_helpers/validations/raise_locked_value_error.py +103 -0
  36. simplibs/object/_core/metadata/SimpleBaseMetadata.py +139 -0
  37. simplibs/object/_core/metadata/SimpleConstantMetadata.py +108 -0
  38. simplibs/object/_core/metadata/SimpleMeta.py +214 -0
  39. simplibs/object/_core/metadata/SimpleObjectMetadata.py +165 -0
  40. simplibs/object/_core/metadata/__init__.py +16 -0
  41. simplibs/object/_core/metadata/constants/BASE_CLASS_NAMES.py +23 -0
  42. simplibs/object/_core/metadata/constants/__init__.py +16 -0
  43. simplibs/object/_core/metadata/init_processors/__init__.py +47 -0
  44. simplibs/object/_core/metadata/init_processors/blueprint_path/__init__.py +15 -0
  45. simplibs/object/_core/metadata/init_processors/blueprint_path/calculate_blueprint_path.py +81 -0
  46. simplibs/object/_core/metadata/init_processors/default/__init__.py +17 -0
  47. simplibs/object/_core/metadata/init_processors/default/process_default_for_constant.py +71 -0
  48. simplibs/object/_core/metadata/init_processors/default/validations/__init__.py +19 -0
  49. simplibs/object/_core/metadata/init_processors/default/validations/_exception_info_for_default.py +66 -0
  50. simplibs/object/_core/metadata/init_processors/default/validations/raise_default_is_defined_in_composition.py +78 -0
  51. simplibs/object/_core/metadata/init_processors/default/validations/validate_default_is_defined.py +77 -0
  52. simplibs/object/_core/metadata/init_processors/default/validations/validate_default_matches_annotation.py +93 -0
  53. simplibs/object/_core/metadata/init_processors/inners/__init__.py +15 -0
  54. simplibs/object/_core/metadata/init_processors/inners/process_inners.py +143 -0
  55. simplibs/object/_core/metadata/init_processors/inners/validations/__init__.py +33 -0
  56. simplibs/object/_core/metadata/init_processors/inners/validations/_exception_info_for_inners.py +43 -0
  57. simplibs/object/_core/metadata/init_processors/inners/validations/_get_collision_path.py +45 -0
  58. simplibs/object/_core/metadata/init_processors/inners/validations/validate_collision_within_inners.py +78 -0
  59. simplibs/object/_core/metadata/init_processors/inners/validations/validate_if_collision_with_owner_class.py +66 -0
  60. simplibs/object/_core/metadata/init_processors/inners/validations/validate_inner_is_class.py +58 -0
  61. simplibs/object/_core/metadata/init_processors/inners/validations/validate_inner_is_not_simple_class.py +60 -0
  62. simplibs/object/_core/metadata/init_processors/inners/validations/validate_inner_is_simple_subclass.py +61 -0
  63. simplibs/object/_core/metadata/init_processors/inners/validations/validate_inners_is_defined.py +56 -0
  64. simplibs/object/_core/metadata/init_processors/inners/validations/validate_inners_is_not_empty.py +57 -0
  65. simplibs/object/_core/metadata/init_processors/inners/validations/validate_inners_is_tuple.py +57 -0
  66. simplibs/object/_core/metadata/init_processors/methods/__init__.py +15 -0
  67. simplibs/object/_core/metadata/init_processors/methods/process_classmethod.py +130 -0
  68. simplibs/object/_core/metadata/init_processors/methods/verifiers/__init__.py +16 -0
  69. simplibs/object/_core/metadata/init_processors/methods/verifiers/_exceptions_helpers/__init__.py +17 -0
  70. simplibs/object/_core/metadata/init_processors/methods/verifiers/_exceptions_helpers/exception_info_for_classmethod.py +52 -0
  71. simplibs/object/_core/metadata/init_processors/methods/verifiers/_exceptions_helpers/expected_structure_for_classmethod.py +80 -0
  72. simplibs/object/_core/metadata/init_processors/methods/verifiers/annotations_and_defaults/__init__.py +15 -0
  73. simplibs/object/_core/metadata/init_processors/methods/verifiers/annotations_and_defaults/validations/__init__.py +19 -0
  74. simplibs/object/_core/metadata/init_processors/methods/verifiers/annotations_and_defaults/validations/_convert_annotation_to_type_set.py +38 -0
  75. simplibs/object/_core/metadata/init_processors/methods/verifiers/annotations_and_defaults/validations/validate_annotations.py +84 -0
  76. simplibs/object/_core/metadata/init_processors/methods/verifiers/annotations_and_defaults/validations/validate_args_defaults.py +76 -0
  77. simplibs/object/_core/metadata/init_processors/methods/verifiers/annotations_and_defaults/validations/validate_kwargs_defaults.py +74 -0
  78. simplibs/object/_core/metadata/init_processors/methods/verifiers/annotations_and_defaults/verify_annotations_and_defaults.py +100 -0
  79. simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/__init__.py +15 -0
  80. simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/decompose_method/__init__.py +15 -0
  81. simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/decompose_method/validations/__init__.py +19 -0
  82. simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/decompose_method/validations/raise_decompose_unvalide_outcome_length.py +64 -0
  83. simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/decompose_method/validations/validate_decompose_unvalide_item_type.py +77 -0
  84. simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/decompose_method/validations/validate_decompose_unvalide_item_value.py +72 -0
  85. simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/decompose_method/verify_decompose_outcome.py +87 -0
  86. simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/validations/__init__.py +17 -0
  87. simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/validations/raise_method_raised_exceptions.py +56 -0
  88. simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/validations/raise_method_return_unvalide_outcome_type.py +80 -0
  89. simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/verify_calculation.py +89 -0
  90. simplibs/object/_core/metadata/init_processors/methods/verifiers/classmethod/__init__.py +15 -0
  91. simplibs/object/_core/metadata/init_processors/methods/verifiers/classmethod/_clone_classmethod.py +81 -0
  92. simplibs/object/_core/metadata/init_processors/methods/verifiers/classmethod/validations/__init__.py +19 -0
  93. simplibs/object/_core/metadata/init_processors/methods/verifiers/classmethod/validations/validate_method_is_callable.py +60 -0
  94. simplibs/object/_core/metadata/init_processors/methods/verifiers/classmethod/validations/validate_method_is_classmethod.py +60 -0
  95. simplibs/object/_core/metadata/init_processors/methods/verifiers/classmethod/validations/validate_method_is_defined.py +67 -0
  96. simplibs/object/_core/metadata/init_processors/methods/verifiers/classmethod/verify_classmethod.py +117 -0
  97. simplibs/object/_core/metadata/init_processors/methods/verifiers/params/__init__.py +15 -0
  98. simplibs/object/_core/metadata/init_processors/methods/verifiers/params/validations/__init__.py +19 -0
  99. simplibs/object/_core/metadata/init_processors/methods/verifiers/params/validations/validate_method_has_exact_args_count.py +59 -0
  100. simplibs/object/_core/metadata/init_processors/methods/verifiers/params/validations/validate_method_not_use_param_placeholders.py +66 -0
  101. simplibs/object/_core/metadata/init_processors/methods/verifiers/params/validations/validate_method_param_match_expected.py +61 -0
  102. simplibs/object/_core/metadata/init_processors/methods/verifiers/params/verify_params.py +123 -0
  103. simplibs/object/_core/metadata/init_processors/names/__init__.py +15 -0
  104. simplibs/object/_core/metadata/init_processors/names/_class_name_splitter.py +242 -0
  105. simplibs/object/_core/metadata/init_processors/names/create_names.py +119 -0
  106. simplibs/object/_core/metadata/init_processors/names/validations/__init__.py +19 -0
  107. simplibs/object/_core/metadata/init_processors/names/validations/validate_class_name_has_no_underscores.py +94 -0
  108. simplibs/object/_core/metadata/init_processors/names/validations/validate_class_name_is_ascii.py +95 -0
  109. simplibs/object/_core/metadata/init_processors/names/validations/validate_class_name_is_identifier.py +83 -0
  110. simplibs/object/_core/metadata/init_processors/type/__init__.py +15 -0
  111. simplibs/object/_core/metadata/init_processors/type/process_type.py +117 -0
  112. simplibs/object/_core/metadata/init_processors/type/validations/__init__.py +29 -0
  113. simplibs/object/_core/metadata/init_processors/type/validations/_exception_info_for_type.py +88 -0
  114. simplibs/object/_core/metadata/init_processors/type/validations/raise_union_type_contain_none.py +70 -0
  115. simplibs/object/_core/metadata/init_processors/type/validations/raise_validate_type_is_not_valid.py +92 -0
  116. simplibs/object/_core/metadata/init_processors/type/validations/validate_type_from_tuple_is_not_none.py +94 -0
  117. simplibs/object/_core/metadata/init_processors/type/validations/validate_type_is_defined.py +85 -0
  118. simplibs/object/_core/metadata/init_processors/type/validations/validate_type_is_not_empty.py +93 -0
  119. simplibs/object/_core/metadata/init_processors/type/validations/validate_type_is_not_none.py +87 -0
  120. simplibs/object/_core/metadata/init_processors/type/validations/validate_type_tuple_is_not_nested.py +92 -0
  121. simplibs/object/_core/metadata/instance_builders/__init__.py +55 -0
  122. simplibs/object/_core/metadata/instance_builders/atom_class/InstanceBase.py +77 -0
  123. simplibs/object/_core/metadata/instance_builders/atom_class/__init__.py +16 -0
  124. simplibs/object/_core/metadata/instance_builders/atom_class/helpers/__init__.py +16 -0
  125. simplibs/object/_core/metadata/instance_builders/atom_class/helpers/create_atom_init.py +51 -0
  126. simplibs/object/_core/metadata/instance_builders/atom_class/helpers/create_root_value_setter.py +67 -0
  127. simplibs/object/_core/metadata/instance_builders/atom_class/make_atom_class.py +101 -0
  128. simplibs/object/_core/metadata/instance_builders/composite_class/__init__.py +14 -0
  129. simplibs/object/_core/metadata/instance_builders/composite_class/helpers/__init__.py +20 -0
  130. simplibs/object/_core/metadata/instance_builders/composite_class/helpers/_get_inner_instance_class.py +51 -0
  131. simplibs/object/_core/metadata/instance_builders/composite_class/helpers/create_composite_init.py +74 -0
  132. simplibs/object/_core/metadata/instance_builders/composite_class/helpers/create_properties_for_inners.py +50 -0
  133. simplibs/object/_core/metadata/instance_builders/composite_class/helpers/create_recalculate_inners.py +57 -0
  134. simplibs/object/_core/metadata/instance_builders/composite_class/helpers/create_recalculate_self.py +69 -0
  135. simplibs/object/_core/metadata/instance_builders/composite_class/make_composite_class.py +93 -0
  136. simplibs/object/_core/metadata/instance_builders/instance/__init__.py +17 -0
  137. simplibs/object/_core/metadata/instance_builders/instance/create_instance.py +107 -0
  138. simplibs/object/_core/metadata/instance_builders/instance/helpers/__init__.py +25 -0
  139. simplibs/object/_core/metadata/instance_builders/instance/helpers/_build_combined_init_mixins.py +40 -0
  140. simplibs/object/_core/metadata/instance_builders/instance/helpers/_build_instance_class_dict.py +127 -0
  141. simplibs/object/_core/metadata/instance_builders/instance/helpers/_extend_instance_class.py +59 -0
  142. simplibs/object/_core/metadata/instance_builders/instance/helpers/_resolve_flat_mixins.py +74 -0
  143. simplibs/object/_core/metadata/instance_builders/instance/helpers/_verify_mixin_compatibility.py +83 -0
  144. simplibs/object/_core/metadata/instance_builders/instance/helpers/create_instance_class.py +76 -0
  145. simplibs/object/_core/metadata/instance_builders/instance/helpers/get_base_class.py +53 -0
  146. simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/__init__.py +20 -0
  147. simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/__init__.py +29 -0
  148. simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/raise_mixin_not_allowed_for_composite.py +61 -0
  149. simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/raise_mixin_not_allowed_for_constant.py +61 -0
  150. simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/raise_mixin_not_allowed_for_immutable.py +61 -0
  151. simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/raise_mixin_not_allowed_for_mutable.py +60 -0
  152. simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/raise_mixin_not_support_default_value_type.py +66 -0
  153. simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/validate_mixin_is_class.py +56 -0
  154. simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/validate_mixin_is_simple_base_subclass.py +60 -0
  155. simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/raise_invalide_extend_instance_class_definition.py +62 -0
  156. simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/raise_mixin_slot_collision.py +56 -0
  157. simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/raise_mixin_slot_collision_with_base_class.py +56 -0
  158. simplibs/object/_core/metadata/instance_builders/instance/validations/__init__.py +21 -0
  159. simplibs/object/_core/metadata/instance_builders/instance/validations/validate_class_is_not_base_class.py +54 -0
  160. simplibs/object/_core/metadata/instance_builders/instance/validations/validate_hashing_for_immutable_value.py +66 -0
  161. simplibs/object/_core/metadata/instance_builders/instance/validations/validate_param_is_bool.py +47 -0
  162. simplibs/object/_core/metadata/validations/__init__.py +18 -0
  163. simplibs/object/_core/metadata/validations/raise_attribut_allready_set.py +57 -0
  164. simplibs/object/_core/metadata/validations/raise_metadata_is_immutable.py +73 -0
  165. simplibs/object/_core/protocols/__init__.py +118 -0
  166. simplibs/object/_core/protocols/alias_typings/__init__.py +137 -0
  167. simplibs/object/_core/protocols/alias_typings/changes/ChangeTuple.py +5 -0
  168. simplibs/object/_core/protocols/alias_typings/changes/ChangesDict.py +5 -0
  169. simplibs/object/_core/protocols/alias_typings/changes/ChangesTuple.py +8 -0
  170. simplibs/object/_core/protocols/alias_typings/changes/__init__.py +18 -0
  171. simplibs/object/_core/protocols/alias_typings/history/HistoryDict.py +5 -0
  172. simplibs/object/_core/protocols/alias_typings/history/HistoryEntry.py +10 -0
  173. simplibs/object/_core/protocols/alias_typings/history/__init__.py +16 -0
  174. simplibs/object/_core/protocols/alias_typings/inners/InnersMap.py +8 -0
  175. simplibs/object/_core/protocols/alias_typings/inners/InnersTuple.py +8 -0
  176. simplibs/object/_core/protocols/alias_typings/inners/__init__.py +16 -0
  177. simplibs/object/_core/protocols/alias_typings/mixins/MixinsTuple.py +8 -0
  178. simplibs/object/_core/protocols/alias_typings/mixins/__init__.py +14 -0
  179. simplibs/object/_core/protocols/alias_typings/names/NamesSet.py +5 -0
  180. simplibs/object/_core/protocols/alias_typings/names/NamesTuple.py +5 -0
  181. simplibs/object/_core/protocols/alias_typings/names/__init__.py +16 -0
  182. simplibs/object/_core/protocols/alias_typings/nodes/NodeItem.py +9 -0
  183. simplibs/object/_core/protocols/alias_typings/nodes/NodesDict.py +9 -0
  184. simplibs/object/_core/protocols/alias_typings/nodes/NodesIndexMap.py +6 -0
  185. simplibs/object/_core/protocols/alias_typings/nodes/NodesInstanceDict.py +9 -0
  186. simplibs/object/_core/protocols/alias_typings/nodes/NodesPathDict.py +9 -0
  187. simplibs/object/_core/protocols/alias_typings/nodes/NodesTuple.py +8 -0
  188. simplibs/object/_core/protocols/alias_typings/nodes/__init__.py +24 -0
  189. simplibs/object/_core/protocols/alias_typings/paths/PathDict.py +8 -0
  190. simplibs/object/_core/protocols/alias_typings/paths/PathTuple.py +5 -0
  191. simplibs/object/_core/protocols/alias_typings/paths/__init__.py +16 -0
  192. simplibs/object/_core/protocols/alias_typings/snapshots/SnapshotDict.py +5 -0
  193. simplibs/object/_core/protocols/alias_typings/snapshots/SnapshotDiffItem.py +5 -0
  194. simplibs/object/_core/protocols/alias_typings/snapshots/SnapshotDiffTuple.py +8 -0
  195. simplibs/object/_core/protocols/alias_typings/snapshots/SnapshotTuple.py +5 -0
  196. simplibs/object/_core/protocols/alias_typings/snapshots/__init__.py +20 -0
  197. simplibs/object/_core/protocols/alias_typings/state/StateDict.py +5 -0
  198. simplibs/object/_core/protocols/alias_typings/state/__init__.py +14 -0
  199. simplibs/object/_core/protocols/alias_typings/types/ValidTypes.py +6 -0
  200. simplibs/object/_core/protocols/alias_typings/types/__init__.py +14 -0
  201. simplibs/object/_core/protocols/classes/SimpleBaseProtocol.py +25 -0
  202. simplibs/object/_core/protocols/classes/SimpleConstantProtocol.py +54 -0
  203. simplibs/object/_core/protocols/classes/SimpleObjectProtocol.py +50 -0
  204. simplibs/object/_core/protocols/classes/__init__.py +26 -0
  205. simplibs/object/_core/protocols/instance/SimpleConstantInstanceProtocol.py +13 -0
  206. simplibs/object/_core/protocols/instance/SimpleInstanceBaseProtocol.py +24 -0
  207. simplibs/object/_core/protocols/instance/SimpleObjectInstanceProtocol.py +13 -0
  208. simplibs/object/_core/protocols/instance/__init__.py +29 -0
  209. simplibs/object/_core/protocols/instance/core_classes/AtomInstanceProtocol.py +46 -0
  210. simplibs/object/_core/protocols/instance/core_classes/CompositeInstanceProtocol.py +37 -0
  211. simplibs/object/_core/protocols/instance/core_classes/InstanceBaseProtocol.py +28 -0
  212. simplibs/object/_core/protocols/instance/core_classes/__init__.py +19 -0
  213. simplibs/object/_core/protocols/metadata/SimpleBaseMetadataProtocol.py +37 -0
  214. simplibs/object/_core/protocols/metadata/SimpleConstantMetadataProtocol.py +45 -0
  215. simplibs/object/_core/protocols/metadata/SimpleMetaProtocol.py +39 -0
  216. simplibs/object/_core/protocols/metadata/SimpleObjectMetadataProtocol.py +49 -0
  217. simplibs/object/_core/protocols/metadata/__init__.py +28 -0
  218. simplibs/object/_core/protocols/methods/ClassMethodProtocol.py +29 -0
  219. simplibs/object/_core/protocols/methods/LogicSignature.py +20 -0
  220. simplibs/object/_core/protocols/methods/__init__.py +18 -0
  221. simplibs/object/_core/protocols/mixins/__init__.py +120 -0
  222. simplibs/object/_core/protocols/mixins/base_class/SimpleMixinProtocol.py +46 -0
  223. simplibs/object/_core/protocols/mixins/base_class/__init__.py +18 -0
  224. simplibs/object/_core/protocols/mixins/core_mixins/InfrastructureProtocol.py +16 -0
  225. simplibs/object/_core/protocols/mixins/core_mixins/NodesDictsProtocol.py +38 -0
  226. simplibs/object/_core/protocols/mixins/core_mixins/NodesTupleProtocol.py +30 -0
  227. simplibs/object/_core/protocols/mixins/core_mixins/SerializationProtocol.py +55 -0
  228. simplibs/object/_core/protocols/mixins/core_mixins/SnapshotProtocol.py +42 -0
  229. simplibs/object/_core/protocols/mixins/core_mixins/__init__.py +27 -0
  230. simplibs/object/_core/protocols/mixins/dunders/__init__.py +123 -0
  231. simplibs/object/_core/protocols/mixins/dunders/collections/CollectionBaseProtocol.py +37 -0
  232. simplibs/object/_core/protocols/mixins/dunders/collections/CollectionProtocol.py +20 -0
  233. simplibs/object/_core/protocols/mixins/dunders/collections/IterableProtocol.py +37 -0
  234. simplibs/object/_core/protocols/mixins/dunders/collections/MappingProtocol.py +52 -0
  235. simplibs/object/_core/protocols/mixins/dunders/collections/__init__.py +21 -0
  236. simplibs/object/_core/protocols/mixins/dunders/comparison/EqualityProtocol.py +31 -0
  237. simplibs/object/_core/protocols/mixins/dunders/comparison/OrderingProtocol.py +32 -0
  238. simplibs/object/_core/protocols/mixins/dunders/comparison/__init__.py +16 -0
  239. simplibs/object/_core/protocols/mixins/dunders/generics/ClassGetItemProtocol.py +23 -0
  240. simplibs/object/_core/protocols/mixins/dunders/generics/__init__.py +14 -0
  241. simplibs/object/_core/protocols/mixins/dunders/interfaces/CallProtocol.py +26 -0
  242. simplibs/object/_core/protocols/mixins/dunders/interfaces/ContextProtocol.py +38 -0
  243. simplibs/object/_core/protocols/mixins/dunders/interfaces/__init__.py +16 -0
  244. simplibs/object/_core/protocols/mixins/dunders/lifecycles/CopyableProtocol.py +33 -0
  245. simplibs/object/_core/protocols/mixins/dunders/lifecycles/LifecycleProtocol.py +21 -0
  246. simplibs/object/_core/protocols/mixins/dunders/lifecycles/PickleReduceProtocol.py +30 -0
  247. simplibs/object/_core/protocols/mixins/dunders/lifecycles/PickleStateProtocol.py +42 -0
  248. simplibs/object/_core/protocols/mixins/dunders/lifecycles/__init__.py +20 -0
  249. simplibs/object/_core/protocols/mixins/dunders/lifecycles/internal_types/PicklePlan.py +5 -0
  250. simplibs/object/_core/protocols/mixins/dunders/lifecycles/internal_types/__init__.py +14 -0
  251. simplibs/object/_core/protocols/mixins/dunders/numeric/ArithmeticProtocol.py +95 -0
  252. simplibs/object/_core/protocols/mixins/dunders/numeric/BitwiseProtocol.py +79 -0
  253. simplibs/object/_core/protocols/mixins/dunders/numeric/ConversionProtocol.py +57 -0
  254. simplibs/object/_core/protocols/mixins/dunders/numeric/InplaceProtocol.py +66 -0
  255. simplibs/object/_core/protocols/mixins/dunders/numeric/UnaryProtocol.py +35 -0
  256. simplibs/object/_core/protocols/mixins/dunders/numeric/__init__.py +22 -0
  257. simplibs/object/_core/protocols/mixins/dunders/numeric/internal_types/Operator.py +5 -0
  258. simplibs/object/_core/protocols/mixins/dunders/numeric/internal_types/UnaryOperator.py +5 -0
  259. simplibs/object/_core/protocols/mixins/dunders/numeric/internal_types/__init__.py +16 -0
  260. simplibs/object/_core/protocols/mixins/dunders/representation/ValueDisplayProtocol.py +30 -0
  261. simplibs/object/_core/protocols/mixins/dunders/representation/ValueFormattingProtocol.py +42 -0
  262. simplibs/object/_core/protocols/mixins/dunders/representation/__init__.py +16 -0
  263. simplibs/object/_core/protocols/mixins/immutable/ImmutableMethodsProtocol.py +69 -0
  264. simplibs/object/_core/protocols/mixins/immutable/ImmutableMethodsWithInnersProtocol.py +27 -0
  265. simplibs/object/_core/protocols/mixins/immutable/__init__.py +18 -0
  266. simplibs/object/_core/protocols/mixins/numerical/EqualizerProtocol.py +37 -0
  267. simplibs/object/_core/protocols/mixins/numerical/VolumeProtocol.py +32 -0
  268. simplibs/object/_core/protocols/mixins/numerical/__init__.py +17 -0
  269. simplibs/object/_core/protocols/mixins/numerical/internal_types/SteppersMap.py +8 -0
  270. simplibs/object/_core/protocols/mixins/numerical/internal_types/__init__.py +14 -0
  271. simplibs/object/_core/protocols/mixins/numerical/stepper/StepperProtocol.py +95 -0
  272. simplibs/object/_core/protocols/mixins/numerical/stepper/__init__.py +14 -0
  273. simplibs/object/_core/protocols/mixins/numerical/stepper/internal_types/LimitAction.py +5 -0
  274. simplibs/object/_core/protocols/mixins/numerical/stepper/internal_types/StepValue.py +6 -0
  275. simplibs/object/_core/protocols/mixins/numerical/stepper/internal_types/__init__.py +16 -0
  276. simplibs/object/_core/protocols/mixins/properties/InnersPropertyProtocol.py +31 -0
  277. simplibs/object/_core/protocols/mixins/properties/MetaShortcutsProtocol.py +49 -0
  278. simplibs/object/_core/protocols/mixins/properties/__init__.py +17 -0
  279. simplibs/object/_core/protocols/mixins/state/DefaultStateProtocol.py +41 -0
  280. simplibs/object/_core/protocols/mixins/state/DirtyTrackingProtocol.py +61 -0
  281. simplibs/object/_core/protocols/mixins/state/HistoryProtocol.py +112 -0
  282. simplibs/object/_core/protocols/mixins/state/PermissionProtocol.py +35 -0
  283. simplibs/object/_core/protocols/mixins/state/__init__.py +22 -0
  284. simplibs/object/exceptions/SimpleDefinitionError.py +45 -0
  285. simplibs/object/exceptions/SimpleInitializationError.py +43 -0
  286. simplibs/object/exceptions/SimpleRuntimeError.py +50 -0
  287. simplibs/object/exceptions/__init__.py +62 -0
  288. simplibs/object/exceptions/base_exception/SimpleObjectError.py +107 -0
  289. simplibs/object/exceptions/base_exception/__init__.py +19 -0
  290. simplibs/object/mixins/__init__.py +99 -0
  291. simplibs/object/mixins/_common_logic/__init__.py +41 -0
  292. simplibs/object/mixins/_common_logic/constants/__init__.py +27 -0
  293. simplibs/object/mixins/_common_logic/constants/names/HISTORY.py +14 -0
  294. simplibs/object/mixins/_common_logic/constants/names/OWNER_CLASS.py +14 -0
  295. simplibs/object/mixins/_common_logic/constants/names/STEPPER.py +14 -0
  296. simplibs/object/mixins/_common_logic/constants/names/VALUE.py +14 -0
  297. simplibs/object/mixins/_common_logic/constants/names/__init__.py +28 -0
  298. simplibs/object/mixins/_common_logic/constants/sets/FORBIDDEN_NAMES.py +27 -0
  299. simplibs/object/mixins/_common_logic/constants/sets/RESTRICTION_FLAGS.py +18 -0
  300. simplibs/object/mixins/_common_logic/constants/sets/__init__.py +22 -0
  301. simplibs/object/mixins/_common_logic/immutability/__init__.py +28 -0
  302. simplibs/object/mixins/_common_logic/immutability/with_any/__init__.py +17 -0
  303. simplibs/object/mixins/_common_logic/immutability/with_any/utils/__init__.py +22 -0
  304. simplibs/object/mixins/_common_logic/immutability/with_any/utils/get_top_composite_paths.py +142 -0
  305. simplibs/object/mixins/_common_logic/immutability/with_any/utils/process_single_change.py +143 -0
  306. simplibs/object/mixins/_common_logic/immutability/with_any/utils/split_changes.py +142 -0
  307. simplibs/object/mixins/_common_logic/immutability/with_any/utils/split_constants_paths.py +147 -0
  308. simplibs/object/mixins/_common_logic/immutability/with_any/utils/split_constants_paths2.py +142 -0
  309. simplibs/object/mixins/_common_logic/immutability/with_any/utils/validations/__init__.py +23 -0
  310. simplibs/object/mixins/_common_logic/immutability/with_any/utils/validations/raise_split_changes_unknown_name.py +107 -0
  311. simplibs/object/mixins/_common_logic/immutability/with_any/utils/validations/raise_with_any_unknown_name.py +71 -0
  312. simplibs/object/mixins/_common_logic/immutability/with_any/vaidations/__init__.py +24 -0
  313. simplibs/object/mixins/_common_logic/immutability/with_any/vaidations/raise_with_any_changes_is_not_tuple.py +65 -0
  314. simplibs/object/mixins/_common_logic/immutability/with_any/vaidations/raise_with_any_child_composite_mismatch.py +68 -0
  315. simplibs/object/mixins/_common_logic/immutability/with_any/vaidations/raise_with_any_contained_constant_mismatch.py +67 -0
  316. simplibs/object/mixins/_common_logic/immutability/with_any/with_any.py +238 -0
  317. simplibs/object/mixins/_common_logic/immutability/with_composite/__init__.py +17 -0
  318. simplibs/object/mixins/_common_logic/immutability/with_composite/utils/__init__.py +15 -0
  319. simplibs/object/mixins/_common_logic/immutability/with_composite/utils/reacalculate_inners.py +112 -0
  320. simplibs/object/mixins/_common_logic/immutability/with_composite/vaidations/__init__.py +21 -0
  321. simplibs/object/mixins/_common_logic/immutability/with_composite/vaidations/validate_composite_is_decomposeable.py +71 -0
  322. simplibs/object/mixins/_common_logic/immutability/with_composite/vaidations/validate_composite_name_exists.py +71 -0
  323. simplibs/object/mixins/_common_logic/immutability/with_composite/with_composite.py +176 -0
  324. simplibs/object/mixins/_common_logic/immutability/with_constant/__init__.py +17 -0
  325. simplibs/object/mixins/_common_logic/immutability/with_constant/utils/__init__.py +20 -0
  326. simplibs/object/mixins/_common_logic/immutability/with_constant/utils/create_new_instance.py +130 -0
  327. simplibs/object/mixins/_common_logic/immutability/with_constant/utils/create_snapshot_dict.py +83 -0
  328. simplibs/object/mixins/_common_logic/immutability/with_constant/utils/reacalculate_owner_value.py +131 -0
  329. simplibs/object/mixins/_common_logic/immutability/with_constant/vaidations/__init__.py +16 -0
  330. simplibs/object/mixins/_common_logic/immutability/with_constant/vaidations/raise_immutability_constant_not_found.py +93 -0
  331. simplibs/object/mixins/_common_logic/immutability/with_constant/with_constant.py +147 -0
  332. simplibs/object/mixins/_common_logic/immutability/with_constants/__init__.py +17 -0
  333. simplibs/object/mixins/_common_logic/immutability/with_constants/utils/__init__.py +15 -0
  334. simplibs/object/mixins/_common_logic/immutability/with_constants/utils/find_longest_keys.py +112 -0
  335. simplibs/object/mixins/_common_logic/immutability/with_constants/vaidations/__init__.py +25 -0
  336. simplibs/object/mixins/_common_logic/immutability/with_constants/vaidations/raise_immutability_batch_constant_not_found.py +94 -0
  337. simplibs/object/mixins/_common_logic/immutability/with_constants/vaidations/raise_immutability_constants_changes_not_tuple.py +94 -0
  338. simplibs/object/mixins/_common_logic/immutability/with_constants/vaidations/validate_inner_tuple_has_length_two.py +91 -0
  339. simplibs/object/mixins/_common_logic/immutability/with_constants/vaidations/validate_inner_tuple_is_tuple.py +99 -0
  340. simplibs/object/mixins/_common_logic/immutability/with_constants/vaidations/validate_inner_tuple_name_is_str.py +90 -0
  341. simplibs/object/mixins/_common_logic/immutability/with_constants/with_constants.py +193 -0
  342. simplibs/object/mixins/base_class/SimpleMixin.py +118 -0
  343. simplibs/object/mixins/base_class/__init__.py +17 -0
  344. simplibs/object/mixins/base_class/_meta/SimpleMixinMeta.py +59 -0
  345. simplibs/object/mixins/base_class/_meta/__init__.py +21 -0
  346. simplibs/object/mixins/base_class/_meta/_verify_mixin_definition.py +161 -0
  347. simplibs/object/mixins/base_class/_meta/validations/__init__.py +34 -0
  348. simplibs/object/mixins/base_class/_meta/validations/raise_mixin_dict_contains_forbidden_attributes.py +101 -0
  349. simplibs/object/mixins/base_class/_meta/validations/raise_mixin_flag_is_not_bool.py +122 -0
  350. simplibs/object/mixins/base_class/_meta/validations/raise_mixin_init_mixins_contains_super_call.py +75 -0
  351. simplibs/object/mixins/base_class/_meta/validations/raise_mixin_only_types_invalid.py +107 -0
  352. simplibs/object/mixins/base_class/_meta/validations/raise_mixin_slots_contain_unvalid_type.py +85 -0
  353. simplibs/object/mixins/base_class/_meta/validations/raise_mixin_slots_contains_forbidden_slot_names.py +102 -0
  354. simplibs/object/mixins/base_class/_meta/validations/raise_mixin_slots_is_not_defined.py +79 -0
  355. simplibs/object/mixins/base_class/_meta/validations/raise_mixin_slots_unsuport_type.py +88 -0
  356. simplibs/object/mixins/core_mixins/Infrastructure.py +49 -0
  357. simplibs/object/mixins/core_mixins/NodesDicts.py +104 -0
  358. simplibs/object/mixins/core_mixins/NodesTuple.py +86 -0
  359. simplibs/object/mixins/core_mixins/Serialization.py +120 -0
  360. simplibs/object/mixins/core_mixins/Snapshot.py +104 -0
  361. simplibs/object/mixins/core_mixins/__init__.py +32 -0
  362. simplibs/object/mixins/core_mixins/_utils/__init__.py +49 -0
  363. simplibs/object/mixins/core_mixins/_utils/nodes_tuple/__init__.py +17 -0
  364. simplibs/object/mixins/core_mixins/_utils/nodes_tuple/_collect_nodes_data.py +131 -0
  365. simplibs/object/mixins/core_mixins/_utils/nodes_tuple/build_nodes_tuple.py +104 -0
  366. simplibs/object/mixins/core_mixins/_utils/serialization/__init__.py +20 -0
  367. simplibs/object/mixins/core_mixins/_utils/serialization/from_dict.py +190 -0
  368. simplibs/object/mixins/core_mixins/_utils/serialization/from_dict_constants.py +151 -0
  369. simplibs/object/mixins/core_mixins/_utils/serialization/to_dict.py +158 -0
  370. simplibs/object/mixins/core_mixins/_utils/serialization/validations/__init__.py +30 -0
  371. simplibs/object/mixins/core_mixins/_utils/serialization/validations/raise_invalid_composite_structure.py +65 -0
  372. simplibs/object/mixins/core_mixins/_utils/serialization/validations/raise_missing_composite_key.py +64 -0
  373. simplibs/object/mixins/core_mixins/_utils/serialization/validations/raise_missing_value_key.py +66 -0
  374. simplibs/object/mixins/core_mixins/_utils/serialization/validations/raise_unvalid_owner_class_mismatch_for_state_dict.py +77 -0
  375. simplibs/object/mixins/core_mixins/_utils/serialization/validations/raise_unvalid_state_dict_input.py +67 -0
  376. simplibs/object/mixins/core_mixins/_utils/snapshot/__init__.py +15 -0
  377. simplibs/object/mixins/core_mixins/_utils/snapshot/compare_snapshots.py +102 -0
  378. simplibs/object/mixins/core_mixins/_utils/snapshot/validations/__init__.py +16 -0
  379. simplibs/object/mixins/core_mixins/_utils/snapshot/validations/raise_snapshot_incompatible_error.py +101 -0
  380. simplibs/object/mixins/dunders/__init__.py +61 -0
  381. simplibs/object/mixins/dunders/collections/CollectionBase.py +129 -0
  382. simplibs/object/mixins/dunders/collections/Iterable.py +81 -0
  383. simplibs/object/mixins/dunders/collections/Mapping.py +131 -0
  384. simplibs/object/mixins/dunders/collections/__init__.py +29 -0
  385. simplibs/object/mixins/dunders/collections/main/Collection.py +47 -0
  386. simplibs/object/mixins/dunders/collections/main/__init__.py +20 -0
  387. simplibs/object/mixins/dunders/comparison/Equality.py +128 -0
  388. simplibs/object/mixins/dunders/comparison/Ordering.py +130 -0
  389. simplibs/object/mixins/dunders/comparison/__init__.py +25 -0
  390. simplibs/object/mixins/dunders/generics/ClassGetItem.py +105 -0
  391. simplibs/object/mixins/dunders/generics/__init__.py +20 -0
  392. simplibs/object/mixins/dunders/interfaces/Call.py +101 -0
  393. simplibs/object/mixins/dunders/interfaces/Context.py +100 -0
  394. simplibs/object/mixins/dunders/interfaces/__init__.py +23 -0
  395. simplibs/object/mixins/dunders/lifecycles/Copyable.py +103 -0
  396. simplibs/object/mixins/dunders/lifecycles/PickleReduce.py +88 -0
  397. simplibs/object/mixins/dunders/lifecycles/PickleState.py +104 -0
  398. simplibs/object/mixins/dunders/lifecycles/__init__.py +29 -0
  399. simplibs/object/mixins/dunders/lifecycles/_utils/__init__.py +20 -0
  400. simplibs/object/mixins/dunders/lifecycles/_utils/rebuild_simple_instance.py +51 -0
  401. simplibs/object/mixins/dunders/lifecycles/main/Lifecycle.py +45 -0
  402. simplibs/object/mixins/dunders/lifecycles/main/__init__.py +20 -0
  403. simplibs/object/mixins/dunders/numeric/Arithmetic.py +195 -0
  404. simplibs/object/mixins/dunders/numeric/Bitwise.py +172 -0
  405. simplibs/object/mixins/dunders/numeric/Conversion.py +149 -0
  406. simplibs/object/mixins/dunders/numeric/Inplace.py +124 -0
  407. simplibs/object/mixins/dunders/numeric/Unary.py +89 -0
  408. simplibs/object/mixins/dunders/numeric/__init__.py +31 -0
  409. simplibs/object/mixins/dunders/numeric/_utils/__init__.py +41 -0
  410. simplibs/object/mixins/dunders/numeric/_utils/_align_operand_type.py +111 -0
  411. simplibs/object/mixins/dunders/numeric/_utils/execute_arithmetic_op.py +157 -0
  412. simplibs/object/mixins/dunders/numeric/_utils/execute_bitwise_op.py +116 -0
  413. simplibs/object/mixins/dunders/numeric/_utils/execute_conversion.py +107 -0
  414. simplibs/object/mixins/dunders/numeric/_utils/execute_inplace_op.py +139 -0
  415. simplibs/object/mixins/dunders/numeric/_utils/execute_unary_op.py +121 -0
  416. simplibs/object/mixins/dunders/representation/ValueDisplay.py +96 -0
  417. simplibs/object/mixins/dunders/representation/ValueFormatting.py +144 -0
  418. simplibs/object/mixins/dunders/representation/__init__.py +24 -0
  419. simplibs/object/mixins/others/__init__.py +48 -0
  420. simplibs/object/mixins/others/immutable/ImmutableMethods.py +142 -0
  421. simplibs/object/mixins/others/immutable/ImmutableMethodsWithInners.py +111 -0
  422. simplibs/object/mixins/others/immutable/__init__.py +24 -0
  423. simplibs/object/mixins/others/immutable/_validations/__init__.py +19 -0
  424. simplibs/object/mixins/others/immutable/_validations/raise_with_changes_input_not_dict.py +60 -0
  425. simplibs/object/mixins/others/numerical/Equalizer.py +129 -0
  426. simplibs/object/mixins/others/numerical/Volume.py +100 -0
  427. simplibs/object/mixins/others/numerical/__init__.py +25 -0
  428. simplibs/object/mixins/others/numerical/_stepper_class/Stepper.py +227 -0
  429. simplibs/object/mixins/others/numerical/_stepper_class/__init__.py +31 -0
  430. simplibs/object/mixins/others/numerical/_stepper_class/methods/__init__.py +35 -0
  431. simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/__init__.py +33 -0
  432. simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/process_step_value.py +114 -0
  433. simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/validations/__init__.py +29 -0
  434. simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/validations/raise_stepper_down_limit_reached.py +115 -0
  435. simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/validations/raise_stepper_up_limit_reached.py +110 -0
  436. simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/verify_down_limit.py +141 -0
  437. simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/verify_up_limit.py +141 -0
  438. simplibs/object/mixins/others/numerical/_stepper_class/methods/set_value.py +163 -0
  439. simplibs/object/mixins/others/numerical/_stepper_class/methods/step_down.py +154 -0
  440. simplibs/object/mixins/others/numerical/_stepper_class/methods/step_up.py +154 -0
  441. simplibs/object/mixins/others/numerical/_stepper_class/processors/__init__.py +38 -0
  442. simplibs/object/mixins/others/numerical/_stepper_class/processors/process_down_limit_value.py +143 -0
  443. simplibs/object/mixins/others/numerical/_stepper_class/processors/process_limit_action.py +118 -0
  444. simplibs/object/mixins/others/numerical/_stepper_class/processors/process_up_limit_value.py +143 -0
  445. simplibs/object/mixins/others/numerical/_stepper_class/processors/process_value.py +142 -0
  446. simplibs/object/mixins/others/numerical/_stepper_class/processors/validate_instance.py +138 -0
  447. simplibs/object/mixins/others/numerical/_stepper_class/processors/validations/__init__.py +39 -0
  448. simplibs/object/mixins/others/numerical/_stepper_class/processors/validations/raise_stepper_invalid_action.py +118 -0
  449. simplibs/object/mixins/others/numerical/_stepper_class/processors/validations/raise_stepper_invalid_down_limit.py +125 -0
  450. simplibs/object/mixins/others/numerical/_stepper_class/processors/validations/raise_stepper_invalid_instance.py +117 -0
  451. simplibs/object/mixins/others/numerical/_stepper_class/processors/validations/raise_stepper_invalid_up_limit.py +125 -0
  452. simplibs/object/mixins/others/numerical/_stepper_class/processors/validations/raise_stepper_non_numeric_value.py +122 -0
  453. simplibs/object/mixins/others/properties/InnersProperty.py +91 -0
  454. simplibs/object/mixins/others/properties/MetaShortcuts.py +113 -0
  455. simplibs/object/mixins/others/properties/__init__.py +24 -0
  456. simplibs/object/mixins/others/properties/_inners_property_utils/__init__.py +23 -0
  457. simplibs/object/mixins/others/properties/_inners_property_utils/_collect_nested_inner_properties.py +134 -0
  458. simplibs/object/mixins/others/properties/_inners_property_utils/collect_all_nested_properties.py +132 -0
  459. simplibs/object/mixins/others/state/DefaultState.py +119 -0
  460. simplibs/object/mixins/others/state/DirtyTracking.py +144 -0
  461. simplibs/object/mixins/others/state/History.py +248 -0
  462. simplibs/object/mixins/others/state/Permission.py +102 -0
  463. simplibs/object/mixins/others/state/__init__.py +31 -0
  464. simplibs/object/mixins/others/state/_history_utils/__init__.py +50 -0
  465. simplibs/object/mixins/others/state/_history_utils/core/__init__.py +32 -0
  466. simplibs/object/mixins/others/state/_history_utils/core/find_snapshot.py +142 -0
  467. simplibs/object/mixins/others/state/_history_utils/core/record_state.py +130 -0
  468. simplibs/object/mixins/others/state/_history_utils/core/set_history_limit.py +114 -0
  469. simplibs/object/mixins/others/state/_history_utils/core/validations/__init__.py +31 -0
  470. simplibs/object/mixins/others/state/_history_utils/core/validations/raise_history_limit_not_positive_integer.py +65 -0
  471. simplibs/object/mixins/others/state/_history_utils/core/validations/raise_unvalide_snapshot_index.py +67 -0
  472. simplibs/object/mixins/others/state/_history_utils/core/validations/raise_unvalide_snopshot_reference.py +67 -0
  473. simplibs/object/mixins/others/state/_history_utils/core/validations/raise_unvalide_snopshot_timestamp.py +66 -0
  474. simplibs/object/mixins/others/state/_history_utils/core/validations/raise_unvalide_timestamp.py +63 -0
  475. simplibs/object/mixins/others/state/_history_utils/navigations/__init__.py +38 -0
  476. simplibs/object/mixins/others/state/_history_utils/navigations/go_to_history_on_index.py +103 -0
  477. simplibs/object/mixins/others/state/_history_utils/navigations/go_to_history_on_timestamp.py +115 -0
  478. simplibs/object/mixins/others/state/_history_utils/navigations/go_to_last_history.py +103 -0
  479. simplibs/object/mixins/others/state/_history_utils/navigations/history_redo.py +103 -0
  480. simplibs/object/mixins/others/state/_history_utils/navigations/history_undo.py +104 -0
  481. simplibs/object/mixins/others/state/_history_utils/transfer/__init__.py +31 -0
  482. simplibs/object/mixins/others/state/_history_utils/transfer/export_history_to_dict.py +110 -0
  483. simplibs/object/mixins/others/state/_history_utils/transfer/import_history_from_dict.py +169 -0
  484. simplibs/object/mixins/others/state/_history_utils/transfer/validations/__init__.py +24 -0
  485. simplibs/object/mixins/others/state/_history_utils/transfer/validations/raise_unvalide_history_import_file.py +66 -0
  486. simplibs/object/mixins/others/state/_history_utils/transfer/validations/raise_unvalide_owner_class_mismatch.py +69 -0
  487. simplibs/object/settings/__init__.py +90 -0
  488. simplibs/object/settings/logging.py +138 -0
  489. simplibs/object/testing/__init__.py +90 -0
  490. simplibs/object/testing/assert_simple_mixin.py +150 -0
  491. simplibs/object/testing/assert_simple_object.py +219 -0
  492. simplibs/object/testing/asserts/__init__.py +53 -0
  493. simplibs/object/testing/asserts/base/__init__.py +22 -0
  494. simplibs/object/testing/asserts/base/assert_class_inheritance.py +75 -0
  495. simplibs/object/testing/asserts/base/assert_instance_creation.py +119 -0
  496. simplibs/object/testing/asserts/base/assert_user_instance_creation.py +97 -0
  497. simplibs/object/testing/asserts/base/assert_value_change.py +142 -0
  498. simplibs/object/testing/asserts/methods/__init__.py +20 -0
  499. simplibs/object/testing/asserts/methods/assert_calculate_value_method.py +113 -0
  500. simplibs/object/testing/asserts/methods/assert_decompose_value_method.py +109 -0
  501. simplibs/object/testing/asserts/methods/assert_validate_method.py +111 -0
  502. simplibs/object/testing/asserts/mixins/__init__.py +22 -0
  503. simplibs/object/testing/asserts/mixins/assert_instance_hasattr.py +94 -0
  504. simplibs/object/testing/asserts/mixins/assert_mixin_inheritance.py +72 -0
  505. simplibs/object/testing/asserts/mixins/assert_mixin_instance_creation.py +142 -0
  506. simplibs/object/testing/asserts/mixins/assert_mixins_slots_values.py +126 -0
  507. simplibs/object/testing/asserts/mutability/__init__.py +18 -0
  508. simplibs/object/testing/asserts/mutability/assert_immutable_behavior.py +118 -0
  509. simplibs/object/testing/asserts/mutability/assert_mutable_behavior.py +108 -0
  510. simplibs/object/testing/asserts/reactivity/__init__.py +17 -0
  511. simplibs/object/testing/asserts/reactivity/assert_reactivity_downward.py +141 -0
  512. simplibs/object/testing/asserts/reactivity/assert_reactivity_upward.py +109 -0
  513. simplibs/object/testing/bulk_test.py +150 -0
  514. simplibs/object/testing/containers/InnerValue.py +102 -0
  515. simplibs/object/testing/containers/MixinCase.py +89 -0
  516. simplibs/object/testing/containers/ObjectCase.py +101 -0
  517. simplibs/object/testing/containers/TestMixin.py +122 -0
  518. simplibs/object/testing/containers/__init__.py +20 -0
  519. simplibs/object/testing/containers/_validations/__init__.py +18 -0
  520. simplibs/object/testing/containers/_validations/raise_inner_value_empty_path.py +39 -0
  521. simplibs/object/testing/containers/_validations/raise_inner_value_invalid_path_type.py +44 -0
  522. simplibs/object/tools/__init__.py +0 -0
  523. simplibs/object/tools/automate_creators/__init__.py +0 -0
  524. simplibs/object/tools/automate_creators/_helpers/__init__.py +5 -0
  525. simplibs/object/tools/automate_creators/_helpers/_is_lambda.py +34 -0
  526. simplibs/object/tools/automate_creators/_helpers/_validations/__init__.py +3 -0
  527. simplibs/object/tools/automate_creators/_helpers/_validations/raise_calculate_default_failed.py +51 -0
  528. simplibs/object/tools/automate_creators/_helpers/_validations/raise_inner_is_not_simple_constant_subclass.py +44 -0
  529. simplibs/object/tools/automate_creators/_helpers/_validations/raise_inners_is_not_tuple.py +41 -0
  530. simplibs/object/tools/automate_creators/_helpers/calculate_default.py +51 -0
  531. simplibs/object/tools/automate_creators/_helpers/load_parameters_from_inners.py +72 -0
  532. simplibs/object/tools/automate_creators/_helpers/process_decompose.py +47 -0
  533. simplibs/object/tools/automate_creators/_helpers/process_logic.py +57 -0
  534. simplibs/object/tools/automate_creators/_helpers/process_validate.py +48 -0
  535. simplibs/object/tools/automate_creators/_validations/__init__.py +7 -0
  536. simplibs/object/tools/automate_creators/_validations/validate_class_name_is_str.py +36 -0
  537. simplibs/object/tools/automate_creators/_validations/validate_composite_has_inners.py +43 -0
  538. simplibs/object/tools/automate_creators/_validations/validate_composite_has_logic.py +44 -0
  539. simplibs/object/tools/automate_creators/_validations/validate_composite_has_not_default.py +37 -0
  540. simplibs/object/tools/automate_creators/_validations/validate_constant_has_default.py +48 -0
  541. simplibs/object/tools/automate_creators/_validations/validate_constant_has_not_decompose.py +37 -0
  542. simplibs/object/tools/automate_creators/_validations/validate_constant_has_not_logic.py +37 -0
  543. simplibs/object/tools/automate_creators/bulk/BulkCase.py +100 -0
  544. simplibs/object/tools/automate_creators/bulk/__init__.py +0 -0
  545. simplibs/object/tools/automate_creators/bulk/create_simple_object_bulk.py +77 -0
  546. simplibs/object/tools/automate_creators/bulk/specific_bulks/__init__.py +0 -0
  547. simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/__init__.py +8 -0
  548. simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_csv_callable_not_supported.py +26 -0
  549. simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_data_not_list.py +28 -0
  550. simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_decode_failed.py +29 -0
  551. simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_input_not_sequence.py +27 -0
  552. simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_input_not_str.py +28 -0
  553. simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_item_is_not_bulk_dict.py +39 -0
  554. simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_table_row_not_sequence.py +26 -0
  555. simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_yaml_import_failed.py +22 -0
  556. simplibs/object/tools/automate_creators/bulk/specific_bulks/create_simple_object_bulk_from_bulk_case_class.py +57 -0
  557. simplibs/object/tools/automate_creators/bulk/specific_bulks/create_simple_object_bulk_from_csv.py +68 -0
  558. simplibs/object/tools/automate_creators/bulk/specific_bulks/create_simple_object_bulk_from_dicts.py +19 -0
  559. simplibs/object/tools/automate_creators/bulk/specific_bulks/create_simple_object_bulk_from_json.py +24 -0
  560. simplibs/object/tools/automate_creators/bulk/specific_bulks/create_simple_object_bulk_from_table.py +43 -0
  561. simplibs/object/tools/automate_creators/bulk/specific_bulks/create_simple_object_bulk_from_yaml.py +29 -0
  562. simplibs/object/tools/automate_creators/create_constant_class.py +84 -0
  563. simplibs/object/tools/automate_creators/create_object_class.py +110 -0
  564. simplibs/object/tools/automate_creators/create_simple_object.py +97 -0
  565. simplibs/object/tools/randomize/__init__.py +18 -0
  566. simplibs/object/tools/randomize/_validations/__init__.py +28 -0
  567. simplibs/object/tools/randomize/_validations/raise_random_data_filler_exhausted.py +55 -0
  568. simplibs/object/tools/randomize/_validations/validate_instance_is_simple_constant_base.py +52 -0
  569. simplibs/object/tools/randomize/_validations/validate_registry_is_randomize_registry_base.py +51 -0
  570. simplibs/object/tools/randomize/_validations/validate_retries_is_greater_than_zero.py +48 -0
  571. simplibs/object/tools/randomize/_validations/validate_retries_is_int.py +49 -0
  572. simplibs/object/tools/randomize/_validations/validate_skip_immutable_is_bool.py +43 -0
  573. simplibs/object/tools/randomize/_validations/validate_skip_unregistered_is_bool.py +44 -0
  574. simplibs/object/tools/randomize/random_data_filler.py +133 -0
  575. simplibs/object/tools/randomize/randomize_value.py +122 -0
  576. simplibs_object-0.1.0.dist-info/METADATA +590 -0
  577. simplibs_object-0.1.0.dist-info/RECORD +580 -0
  578. simplibs_object-0.1.0.dist-info/WHEEL +5 -0
  579. simplibs_object-0.1.0.dist-info/licenses/LICENSE +21 -0
  580. simplibs_object-0.1.0.dist-info/top_level.txt +1 -0
@@ -0,0 +1,94 @@
1
+ from typing import Any
2
+ import pytest
3
+ from simplibs.exception.testing import maybe_subtest
4
+
5
+
6
+ # noinspection PyTypeChecker
7
+ def assert_instance_hasattr(
8
+ subtests: Any,
9
+ instance: Any,
10
+ *,
11
+ names: tuple[str, ...],
12
+ kind: str,
13
+ verbose: bool = True,
14
+ intro: str = "",
15
+ ) -> None:
16
+ """Assert generic attribute presence across runtime object instances.
17
+
18
+ Validates that a sequence of attribute names exists on the target instance.
19
+ This serves as a universal presence gate for verifying mixin-provided members
20
+ such as instance slots, properties, methods, or class attributes.
21
+
22
+ Args:
23
+ subtests: The native pytest subtests fixture manager instance.
24
+ instance: Runtime object instance under test.
25
+ names: Tuple of attribute name strings to verify on the instance.
26
+ kind: Textual descriptor used in error messages (e.g., "slot", "attribute", "method").
27
+ verbose: Enables isolated pytest subtests reporting.
28
+ intro: Optional prefix string added to the generated subtest identity name.
29
+ """
30
+ subintro = f"assert_instance_hasattr[{kind}]::"
31
+
32
+ # 1. Validate input parameter types
33
+ is_valid_input: bool = True
34
+ with maybe_subtest(
35
+ subtests,
36
+ name=f"{intro}{subintro}validate_input",
37
+ verbose=verbose,
38
+ ):
39
+ if not isinstance(names, tuple):
40
+ is_valid_input = False
41
+ pytest.fail(
42
+ f"Parameter 'names' for kind '{kind}' must be a tuple of strings, "
43
+ f"got: {names!r}"
44
+ )
45
+
46
+ for name in names:
47
+ if not isinstance(name, str):
48
+ is_valid_input = False
49
+ pytest.fail(
50
+ f"{kind.capitalize()} name '{name!r}' is not a string. "
51
+ f"All {kind} names must be string identifiers."
52
+ )
53
+
54
+ # 1.1 Guard clause: Halt execution if parameter structure is invalid
55
+ if not is_valid_input:
56
+ return
57
+
58
+ # 2. Validate attribute presence on target instance
59
+ with maybe_subtest(
60
+ subtests,
61
+ name=f"{intro}{subintro}check_presence",
62
+ verbose=verbose,
63
+ ):
64
+ for name in names:
65
+ if not hasattr(instance, name):
66
+ pytest.fail(
67
+ f"Instance of class '{instance.__class__.__name__}' "
68
+ f"is missing expected {kind} '{name}'. "
69
+ f"Available attributes: {dir(instance)}"
70
+ )
71
+
72
+
73
+ _DESIGN_NOTES = """
74
+ # assert_instance_hasattr (Generic Attribute Presence Gate)
75
+
76
+ ## Purpose
77
+ Acts as a re-usable, parameterized structural assertion blade that verifies whether a set
78
+ of named members exists on a target instance. It serves as the foundation for testing mixin
79
+ propagation across slots, properties, methods, and class-level attributes.
80
+
81
+ ## Verification Pipeline
82
+ 1. **Input Schema & Guard Gate:** Validates that `names` is explicitly formatted as a `tuple[str, ...]`.
83
+ If non-string identifiers or incorrect containers are supplied, it reports a failure and aborts early
84
+ via a guard clause to prevent iterating invalid payloads downstream.
85
+ 2. **Attribute Existence Intercept:** Iterates through `names` using `hasattr(instance, name)`.
86
+ If any expected attribute is absent, it raises a failure with diagnostic information, including
87
+ the class name and `dir(instance)` reflection dump.
88
+
89
+ ## Pipeline Lifecycle Role
90
+ Functions as an atomic building block for higher-level mixin assertion modules
91
+ (such as `assert_mixin_slots`, `assert_mixin_attributes`, or `assert_mixin_methods`).
92
+ By abstracting parameter validation and error logging into a single generic function,
93
+ it ensures consistent diagnostic output across all mixin structure tests.
94
+ """
@@ -0,0 +1,72 @@
1
+ from typing import Any, TYPE_CHECKING
2
+ import pytest
3
+ from simplibs.exception.testing import maybe_subtest
4
+ # Outers
5
+ from ....mixins.base_class import SimpleMixin
6
+ # Annotations
7
+ if TYPE_CHECKING:
8
+ from ...._core.protocols import SimpleMixinType
9
+
10
+
11
+ # noinspection PyTypeChecker
12
+ def assert_mixin_inheritance(
13
+ subtests: Any,
14
+ mixin_class: "SimpleMixinType",
15
+ *,
16
+ verbose: bool = True,
17
+ intro: str = "",
18
+ ) -> None:
19
+ """Assert that the target mixin class satisfies the required SimpleMixin inheritance contract.
20
+
21
+ Validates that the provided mixin target is a valid class type and explicitly derives
22
+ from the framework base class ``SimpleMixin``. Serves as the primary structural gate
23
+ for mixin validation pipelines.
24
+
25
+ Args:
26
+ subtests: The native pytest subtests fixture manager instance.
27
+ mixin_class: Target mixin class blueprint under test.
28
+ verbose: Enables isolated pytest subtests reporting.
29
+ intro: Optional prefix string added to the generated subtest identity name.
30
+ """
31
+ subintro = "assert_mixin_inheritance::"
32
+
33
+ with maybe_subtest(
34
+ subtests,
35
+ name=f"{intro}{subintro}inherits_from_simplemixin",
36
+ verbose=verbose,
37
+ ):
38
+ # 1. Target must be a valid class type
39
+ if not isinstance(mixin_class, type):
40
+ pytest.fail(
41
+ f"Provided mixin target '{mixin_class!r}' is not a class. "
42
+ f"Mixins must be class types deriving from SimpleMixin."
43
+ )
44
+
45
+ # 2. Target must inherit from SimpleMixin
46
+ if not issubclass(mixin_class, SimpleMixin):
47
+ pytest.fail(
48
+ f"Mixin class '{mixin_class.__name__}' does not inherit from SimpleMixin. "
49
+ f"All mixin classes must subclass SimpleMixin to maintain compatibility "
50
+ f"with the Simplibs instance builder."
51
+ )
52
+
53
+
54
+ _DESIGN_NOTES = """
55
+ # assert_mixin_inheritance (Mixin Base Class Inheritance Gate)
56
+
57
+ ## Purpose
58
+ Acts as the preliminary structural fail-fast boundary for verifying that a candidate mixin class
59
+ conforms to the fundamental framework interface by deriving from `SimpleMixin`.
60
+
61
+ ## Execution Pipeline Steps
62
+ 1. **Class Type Gate:** Confirms that `mixin_class` is a valid Python type (`isinstance(mixin_class, type)`),
63
+ rejecting instantiated objects or invalid types before deep checks occur.
64
+ 2. **Inheritance Contract Assertion:** Verifies `issubclass(mixin_class, SimpleMixin)`. If the target class
65
+ does not derive from `SimpleMixin`, it emits an explicit failure message highlighting incompatibility
66
+ with the dynamic instance builder.
67
+
68
+ ## Pipeline Lifecycle Role
69
+ Functions as the entry gate in mixin test orchestrators (e.g., `assert_simple_mixin`).
70
+ By asserting base inheritance upfront, it prevents subtle downstream runtime failures during dynamic
71
+ instance creation and attribute binding stages.
72
+ """
@@ -0,0 +1,142 @@
1
+ from typing import Any, TYPE_CHECKING
2
+ import pytest
3
+ from simplibs.exception.testing import maybe_subtest
4
+ # Outers
5
+ from ....mixins.base_class import SimpleMixin
6
+ from ....SimpleConstant import SimpleConstant
7
+ # Annotations
8
+ if TYPE_CHECKING:
9
+ from ...._core.protocols import SimpleClassType, SimpleMixinType
10
+
11
+
12
+ # noinspection PyTypeChecker
13
+ def assert_mixin_instance_creation(
14
+ subtests: Any,
15
+ mixin_class: "SimpleMixinType",
16
+ test_class: "SimpleClassType",
17
+ *,
18
+ mutable: bool = True,
19
+ verbose: bool = True,
20
+ intro: str = "",
21
+ ) -> Any:
22
+ """Assert that a target blueprint class can be instantiated with a specific mixin attached.
23
+
24
+ Validates that both the base blueprint class and the mixin satisfy framework inheritance requirements,
25
+ executes dynamic instantiation with ``mixins=(mixin_class,)``, and verifies that the mixin's members
26
+ are correctly injected into the resulting runtime instance/class namespace.
27
+
28
+ Args:
29
+ subtests: The native pytest subtests fixture manager instance.
30
+ mixin_class: Target mixin class blueprint under test.
31
+ mutable: Defines whether the underlying instance should be created in mutable mode (default True).
32
+ test_class: Base framework blueprint class used to bind the mixin.
33
+ verbose: Enables isolated pytest subtests reporting.
34
+ intro: Optional prefix string added to the generated subtest identity name.
35
+
36
+ Returns:
37
+ The instantiated runtime object created with the mixin attached.
38
+ """
39
+ subintro = "assert_mixin_instance_creation::"
40
+
41
+ # 1. Validate base test_class inheritance contract
42
+ with maybe_subtest(
43
+ subtests,
44
+ name=f"{intro}{subintro}validate_test_class",
45
+ verbose=verbose,
46
+ ):
47
+ test_class: type
48
+ if not issubclass(test_class, SimpleConstant):
49
+ pytest.fail(
50
+ f"Test class '{test_class.__name__}' must inherit from "
51
+ f"SimpleConstant or SimpleObject."
52
+ )
53
+
54
+ # 2. Validate mixin inheritance contract
55
+ with maybe_subtest(
56
+ subtests,
57
+ name=f"{intro}{subintro}validate_mixin_class",
58
+ verbose=verbose,
59
+ ):
60
+ mixin_class: type
61
+ if not issubclass(mixin_class, SimpleMixin):
62
+ pytest.fail(
63
+ f"Mixin '{mixin_class.__name__}' does not inherit from SimpleMixin."
64
+ )
65
+
66
+ # 3. Instantiate target class with mixin injection
67
+ instance = None
68
+ with maybe_subtest(
69
+ subtests,
70
+ name=f"{intro}{subintro}create_instance",
71
+ verbose=verbose,
72
+ ):
73
+ try:
74
+ instance = test_class(mixins=(mixin_class,), mutable=mutable)
75
+ except Exception as exc:
76
+ pytest.fail(
77
+ f"Failed to create instance of '{test_class.__name__}' "
78
+ f"with mixin '{mixin_class.__name__}': {exc}"
79
+ )
80
+
81
+ if instance is None:
82
+ pytest.fail(
83
+ f"Instance creation returned None for class '{test_class.__name__}' "
84
+ f"with mixin '{mixin_class.__name__}'."
85
+ )
86
+
87
+ # 3.1 Guard clause: If instance creation failed, abort downstream member verification
88
+ if instance is None:
89
+ return None
90
+
91
+ # 4. Verify mixin members presence in runtime instance namespace
92
+ with maybe_subtest(
93
+ subtests,
94
+ name=f"{intro}{subintro}mixin_members_injected",
95
+ verbose=verbose,
96
+ ):
97
+ # Ignorujeme atributy definované na samotném SimpleMixin a object,
98
+ # protože slouží jako kompilační direktivy a nevkládají se do cílového class_dict.
99
+ base_mixin_attrs = set(dir(SimpleMixin))
100
+
101
+ # Testujeme pouze atributy specificky deklarované na testovaném mixinu
102
+ mixin_members = {
103
+ name for name in dir(mixin_class)
104
+ if not (name.startswith("__") and name.endswith("__"))
105
+ and name not in base_mixin_attrs
106
+ }
107
+
108
+ missing_members = [
109
+ name for name in mixin_members
110
+ if not hasattr(instance, name)
111
+ ]
112
+
113
+ if missing_members:
114
+ pytest.fail(
115
+ f"Mixin '{mixin_class.__name__}' members {missing_members} "
116
+ f"were not found on the created instance of '{test_class.__name__}'."
117
+ )
118
+
119
+ return instance
120
+
121
+
122
+ _DESIGN_NOTES = """
123
+ # assert_mixin_instance_creation (Dynamic Mixin Instantiation Gate)
124
+
125
+ ## Purpose
126
+ Verifies the integration between the framework's dynamic instance builder and a given mixin class.
127
+ It ensures that a base blueprint class (`SimpleObject` or `SimpleConstant`) can be instantiated with
128
+ a candidate mixin, and that the mixin members properly bind into the runtime class namespace.
129
+
130
+ ## Verification Pipeline
131
+ 1. **Blueprint Validation:** Confirms `test_class` derives from `SimpleConstant` (which covers `SimpleObject` as well).
132
+ 2. **Mixin Contract Validation:** Confirms `mixin_class` derives from `SimpleMixin`.
133
+ 3. **Dynamic Instantiation & Guard Gate:** Invokes `test_class(mixins=(mixin_class,))` within a protected context,
134
+ ensuring zero runtime construction errors. Aborts early via a guard clause if creation fails.
135
+ 4. **Member Injection Gate:** Verifies that all non-dunder attributes, properties, and methods defined on `mixin_class`
136
+ are present on the created runtime instance namespace.
137
+
138
+ ## Pipeline Lifecycle Role
139
+ Serves as the structural setup and verification gate within mixin testing runners (e.g., `assert_simple_mixin`).
140
+ By returning the created `instance`, it enables downstream mixin assertions to inspect specific slots, properties,
141
+ and methods on a live, mixin-enriched runtime object.
142
+ """
@@ -0,0 +1,126 @@
1
+ from typing import Any
2
+ import pytest
3
+ from simplibs.exception.testing import maybe_subtest
4
+
5
+
6
+ # noinspection PyTypeChecker
7
+ def assert_mixins_slots_values(
8
+ subtests: Any,
9
+ instance: Any,
10
+ slots_values: Any,
11
+ *,
12
+ verbose: bool = True,
13
+ intro: str = "",
14
+ ) -> None:
15
+ """Assert that specific mixin-provided slots exist on an instance and contain expected values.
16
+
17
+ Validates that slot attributes defined by attached mixin classes exist on the runtime object instance
18
+ and hold expected state values. Supports both single key-value tuples and sequences of key-value pairs.
19
+
20
+ Args:
21
+ subtests: The native pytest subtests fixture manager instance.
22
+ instance: Runtime object instance under test.
23
+ slots_values: Either a single key-value tuple ``("slot_name", expected_value)``
24
+ or a sequence of tuples ``(("slot_1", val_1), ("slot_2", val_2), ...)``.
25
+ verbose: Enables isolated pytest subtests reporting.
26
+ intro: Optional prefix string added to the generated subtest identity name.
27
+ """
28
+ subintro = "assert_mixins_slots_values::"
29
+
30
+ # 1. Normalize input structure
31
+ normalized = None
32
+ with maybe_subtest(
33
+ subtests,
34
+ name=f"{intro}{subintro}normalize_input",
35
+ verbose=verbose,
36
+ ):
37
+ # Single tuple case: ("slot_name", value)
38
+ if isinstance(slots_values, tuple) and len(slots_values) == 2 and isinstance(slots_values[0], str):
39
+ normalized = (slots_values,)
40
+ # Sequence of tuples case: (("slot_1", val_1), ("slot_2", val_2))
41
+ elif isinstance(slots_values, tuple):
42
+ normalized = slots_values
43
+ else:
44
+ pytest.fail(
45
+ f"Parameter 'slots_values' must be a tuple of (name, value) pairs, "
46
+ f"got: {slots_values!r}"
47
+ )
48
+
49
+ # 1.1 Guard clause: Halt execution if input normalization failed
50
+ if normalized is None:
51
+ return
52
+
53
+ # 2. Validate structural integrity of each pair
54
+ valid_pairs = False
55
+ with maybe_subtest(
56
+ subtests,
57
+ name=f"{intro}{subintro}validate_pairs",
58
+ verbose=verbose,
59
+ ):
60
+ for pair in normalized:
61
+ if not (isinstance(pair, tuple) and len(pair) == 2):
62
+ pytest.fail(
63
+ f"Each item in 'slots_values' must be a 2-element tuple of (name, value), "
64
+ f"got: {pair!r}"
65
+ )
66
+ return
67
+
68
+ name, _ = pair
69
+ if not isinstance(name, str):
70
+ pytest.fail(
71
+ f"Slot name '{name!r}' is not a string identifier. "
72
+ f"All slot names must be strings."
73
+ )
74
+ return
75
+
76
+ valid_pairs = True
77
+
78
+ # 2.1 Guard clause: Halt execution if pair structure validation failed
79
+ if not valid_pairs:
80
+ return
81
+
82
+ # 3. Validate slot attribute presence and state values
83
+ with maybe_subtest(
84
+ subtests,
85
+ name=f"{intro}{subintro}check_slot_values",
86
+ verbose=verbose,
87
+ ):
88
+ for name, expected_value in normalized:
89
+ if not hasattr(instance, name):
90
+ pytest.fail(
91
+ f"Instance of class '{instance.__class__.__name__}' "
92
+ f"does not contain expected slot '{name}'. "
93
+ f"Available attributes: {dir(instance)}"
94
+ )
95
+
96
+ actual_value = getattr(instance, name)
97
+
98
+ if actual_value != expected_value:
99
+ pytest.fail(
100
+ f"Slot '{name}' on instance of '{instance.__class__.__name__}' "
101
+ f"has unexpected value: expected {expected_value!r}, "
102
+ f"got {actual_value!r}."
103
+ )
104
+
105
+
106
+ _DESIGN_NOTES = """
107
+ # assert_mixins_slots_values (Mixin Slot State Verification Gate)
108
+
109
+ ## Purpose
110
+ Verifies that slot attributes defined by attached mixins exist on a runtime instance and hold
111
+ expected initial or calculated values. It acts as a value-level verification step complementing
112
+ structural presence checks.
113
+
114
+ ## Input Flexibility & Normalization Pipeline
115
+ 1. **Schema Normalization & Guard Gate:** Accepts both single pairs `("slot_name", value)` and composite tuples
116
+ `(("slot_1", val_1), ("slot_2", val_2))`, automatically normalizing single-pair inputs into uniform sequences.
117
+ Halts execution early via a guard clause if input formatting is invalid.
118
+ 2. **Pair Validation & Guard Gate:** Ensures every item in the sequence is a 2-element tuple whose first element
119
+ is a string identifier, guarded by a fail-fast exit.
120
+ 3. **Presence & State Reconciliation:** Iterates over normalized pairs, verifying that `hasattr(instance, slot_name)`
121
+ evaluates to `True` and that `getattr(instance, slot_name) == expected_value`.
122
+
123
+ ## Pipeline Lifecycle Role
124
+ Functions as a specialized state-verification blade within mixin test orchestrators (e.g., `assert_simple_mixin`).
125
+ It ensures that mixins injecting stateful instance variables (`__slots__`) initialize their data members accurately.
126
+ """
@@ -0,0 +1,18 @@
1
+ from .assert_immutable_behavior import assert_immutable_behavior
2
+ from .assert_mutable_behavior import assert_mutable_behavior
3
+
4
+
5
+ _DESIGN_NOTES = """
6
+ # Testing Asserts Mutability Sub-Package
7
+
8
+ ## Purpose
9
+ Contains assertions for verifying mutability constraints on instances, ensuring read-only properties
10
+ raise proper errors and mutable fields respond correctly to state updates.
11
+
12
+ ## Internal Components Registry
13
+
14
+ | Component | Type | Description |
15
+ | :-------------------------- | :------- | :------------------------------------------------------------------------ |
16
+ | `assert_immutable_behavior` | Function | Asserts that modifications on locked or immutable instances raise errors. |
17
+ | `assert_mutable_behavior` | Function | Validates normal assignment and state mutation operations. |
18
+ """
@@ -0,0 +1,118 @@
1
+ from typing import Any
2
+ import pytest
3
+ from simplibs.exception.testing import maybe_subtest
4
+
5
+
6
+ # noinspection PyTypeChecker
7
+ def assert_immutable_behavior(
8
+ subtests: Any,
9
+ test_class: Any,
10
+ *,
11
+ new_value: Any,
12
+ verbose: bool = True,
13
+ intro: str = "",
14
+ ) -> None:
15
+ """Assert that the target class correctly enforces immutability semantics.
16
+
17
+ Validates that an instance instantiated with ``mutable=False`` rejects state updates via its value setter,
18
+ raises an exception on modification attempts, and preserves both its python object identity and internal state.
19
+
20
+ Args:
21
+ subtests: The native pytest subtests fixture manager instance.
22
+ test_class: Target class blueprint under test.
23
+ new_value: Candidate raw value to attempt applying via setter.
24
+ verbose: Enables isolated pytest subtests reporting.
25
+ intro: Optional prefix string added to the generated subtest identity name.
26
+ """
27
+ subintro = "test_immutable_behavior::"
28
+
29
+ # 1. Create immutable instance
30
+ instance = None
31
+ with maybe_subtest(
32
+ subtests,
33
+ name=f"{intro}{subintro}create_immutable_instance",
34
+ verbose=verbose,
35
+ ):
36
+ try:
37
+ instance = test_class(mutable=False)
38
+ except Exception as exc:
39
+ pytest.fail(f"Failed to create immutable instance for '{test_class.__name__}': {exc}")
40
+
41
+ assert instance is not None
42
+
43
+ # 1.1 Guard clause: Halt execution if immutable instance creation failed
44
+ if instance is None:
45
+ return
46
+
47
+ # 2. Capture original identity and value state
48
+ with maybe_subtest(
49
+ subtests,
50
+ name=f"{intro}{subintro}capture_original_state",
51
+ verbose=verbose,
52
+ ):
53
+ original_id = id(instance)
54
+ original_value = instance.value
55
+
56
+ # 3. Attempt to apply new value (must raise an exception)
57
+ with maybe_subtest(
58
+ subtests,
59
+ name=f"{intro}{subintro}setter_must_fail",
60
+ verbose=verbose,
61
+ ):
62
+ try:
63
+ instance.value = new_value
64
+ except Exception:
65
+ pass # Expected behavior for immutable instances
66
+ else:
67
+ pytest.fail(
68
+ f"Immutable instance of '{test_class.__name__}' allowed value update, "
69
+ f"but immutable instances must reject setter calls."
70
+ )
71
+
72
+ # 4. Identity MUST remain unchanged
73
+ with maybe_subtest(
74
+ subtests,
75
+ name=f"{intro}{subintro}identity_preserved",
76
+ verbose=verbose,
77
+ ):
78
+ if id(instance) != original_id:
79
+ pytest.fail(
80
+ f"Immutable instance of '{test_class.__name__}' changed python object identity "
81
+ f"after failed value update attempt."
82
+ )
83
+
84
+ # 5. Value MUST remain unchanged
85
+ with maybe_subtest(
86
+ subtests,
87
+ name=f"{intro}{subintro}value_preserved",
88
+ verbose=verbose,
89
+ ):
90
+ if instance.value != original_value:
91
+ pytest.fail(
92
+ f"Immutable instance of '{test_class.__name__}' changed its internal value "
93
+ f"from {original_value!r} to {instance.value!r} after failed setter call."
94
+ )
95
+
96
+
97
+ _DESIGN_NOTES = """
98
+ # assert_immutable_behavior (Immutability Enforcement Gate)
99
+
100
+ ## Purpose
101
+ Verifies the runtime immutability contract when an object instance is initialized with `mutable=False`.
102
+ It ensures that the property setter strictly guards internal state, throwing exceptions upon
103
+ mutation attempts while guaranteeing full preservation of object identity and value consistency.
104
+
105
+ ## Execution Pipeline Steps
106
+ 1. **Immutable Instantiation & Guard Gate:** Instantiates `test_class(mutable=False)` inside a protected context.
107
+ Halts execution early via a guard clause if instance creation fails to prevent uninitialized attribute access.
108
+ 2. **State Snapshot:** Captures the initial Python object ID (`id(instance)`) and value state (`instance.value`).
109
+ 3. **Setter Interception Gate:** Attempts `instance.value = new_value`. Asserts that an exception is raised,
110
+ failing fast via `pytest.fail` if the assignment succeeds.
111
+ 4. **Identity Preservation Assertion:** Asserts that object ID remains identical (`id(instance) == original_id`).
112
+ 5. **Value State Preservation Assertion:** Asserts that internal value remains untouched (`instance.value == original_value`).
113
+
114
+ ## Pipeline Lifecycle Role
115
+ Acts as a behavioral assertion blade in test orchestrators (such as `assert_simple_object`).
116
+ It guarantees that framework instances configured for write-once or immutable runtime patterns
117
+ strictly reject side-effect state mutations.
118
+ """
@@ -0,0 +1,108 @@
1
+ from typing import Any
2
+ import pytest
3
+ from simplibs.exception.testing import maybe_subtest
4
+ # Outers
5
+ from ..base.assert_value_change import assert_value_change
6
+
7
+
8
+ # noinspection PyTypeChecker
9
+ def assert_mutable_behavior(
10
+ subtests: Any,
11
+ test_class: Any,
12
+ *,
13
+ new_value: Any,
14
+ verbose: bool = True,
15
+ verbose_value_change: bool = True,
16
+ intro: str = "",
17
+ ) -> None:
18
+ """Assert that the target class correctly enforces mutable state semantics.
19
+
20
+ Validates that an instance instantiated with ``mutable=True`` permits in-place state updates via
21
+ ``assert_value_change`` while strictly maintaining its Python object identity (memory address).
22
+
23
+ Args:
24
+ subtests: The native pytest subtests fixture manager instance.
25
+ test_class: Target class blueprint under test.
26
+ new_value: Candidate raw value to apply to the mutable instance.
27
+ verbose: Enables isolated pytest subtests reporting for this wrapper.
28
+ verbose_value_change: Enables isolated subtests reporting inside the nested ``assert_value_change``.
29
+ intro: Optional prefix string added to the generated subtest identity name.
30
+ """
31
+ subintro = "test_mutable_behavior::"
32
+
33
+ # 1. Create mutable instance
34
+ instance = None
35
+ with maybe_subtest(
36
+ subtests,
37
+ name=f"{intro}{subintro}create_mutable_instance",
38
+ verbose=verbose,
39
+ ):
40
+ try:
41
+ instance = test_class(mutable=True)
42
+ except Exception as exc:
43
+ pytest.fail(f"Failed to create mutable instance for '{test_class.__name__}': {exc}")
44
+
45
+ assert instance is not None
46
+
47
+ # 1.1 Guard clause: Halt execution if mutable instance creation failed
48
+ if instance is None:
49
+ return
50
+
51
+ # 2. Capture original Python object identity
52
+ with maybe_subtest(
53
+ subtests,
54
+ name=f"{intro}{subintro}capture_original_identity",
55
+ verbose=verbose,
56
+ ):
57
+ original_id = id(instance)
58
+
59
+ # 3. Apply new value via shared value change assertion
60
+ with maybe_subtest(
61
+ subtests,
62
+ name=f"{intro}{subintro}apply_value",
63
+ verbose=verbose,
64
+ ):
65
+ assert_value_change(
66
+ subtests,
67
+ instance,
68
+ value=new_value,
69
+ verbose=verbose_value_change and verbose,
70
+ intro=intro,
71
+ )
72
+
73
+ # 4. Object identity MUST remain unchanged
74
+ with maybe_subtest(
75
+ subtests,
76
+ name=f"{intro}{subintro}identity_preserved",
77
+ verbose=verbose,
78
+ ):
79
+ if id(instance) != original_id:
80
+ pytest.fail(
81
+ f"Mutable instance of '{test_class.__name__}' changed identity after value update, "
82
+ f"but mutable instances must preserve identity."
83
+ )
84
+
85
+
86
+ _DESIGN_NOTES = """
87
+ # assert_mutable_behavior (Mutable State Behavior Gate)
88
+
89
+ ## Purpose
90
+ Verifies the runtime mutability contract when an object instance is initialized with `mutable=True`.
91
+ It guarantees that in-place state updates succeed via property setters while preserving the exact
92
+ Python object identity (`id(instance)`), ensuring no hidden instance re-creation occurs.
93
+
94
+ ## Execution Pipeline Steps
95
+ 1. **Mutable Instantiation & Guard Gate:** Instantiates `test_class(mutable=True)` within a protected
96
+ interception block. Halts execution early via a guard clause if instance creation fails to prevent
97
+ uninitialized attribute access in downstream steps.
98
+ 2. **Identity Snapshot:** Captures the memory address / identity of the newly created instance (`id(instance)`).
99
+ 3. **In-Place Mutation Intercept:** Delegates value validation, setter invocation, and state update
100
+ verification to `assert_value_change`.
101
+ 4. **Identity Preservation Assertion:** Asserts that the memory address remains strictly unchanged
102
+ (`id(instance) == original_id`) after the mutation pass completes.
103
+
104
+ ## Pipeline Lifecycle Role
105
+ Acts as a behavioral assertion blade within test runners like `assert_simple_object`.
106
+ By pairing with `assert_immutable_behavior`, it guarantees full symmetry and contract compliance
107
+ across both mutable and immutable execution modes of the framework.
108
+ """