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,76 @@
1
+ from typing import TYPE_CHECKING
2
+ # Inners
3
+ from ._build_instance_class_dict import _build_instance_class_dict
4
+ from ._extend_instance_class import _extend_instance_class
5
+ # Annotations
6
+ if TYPE_CHECKING:
7
+ from .....protocols.classes import SimpleClassLike
8
+ from .....protocols.alias_typings import MixinsTuple
9
+ from .....protocols.instance import SimpleInstanceLike
10
+
11
+
12
+ def create_instance_class(
13
+ cls: "SimpleClassLike",
14
+ mixins: "MixinsTuple",
15
+ base_class: type,
16
+ is_atom: bool,
17
+ mutable: bool,
18
+ ) -> "SimpleInstanceLike":
19
+ """Compiles a unified runtime instance class by synthesizing namespace, mixins, and base class."""
20
+
21
+ # 1. Define arguments for dynamic type creation
22
+ class_name = f"{cls.meta.class_name}Instance"
23
+ class_parents = (base_class,)
24
+ class_dict = _build_instance_class_dict(cls, mixins, is_atom, mutable)
25
+
26
+ # 2. Compile dynamic instance class
27
+ _instance_cls = type(class_name, class_parents, class_dict)
28
+
29
+ # 3. Standardize qualname for introspection
30
+ _instance_cls.__qualname__ = class_name
31
+
32
+ # 4. Apply metaprogramming extension hooks in-place
33
+ _instance_cls: "SimpleInstanceLike"
34
+ _extend_instance_class(class_dict["__mixins__"], _instance_cls)
35
+
36
+ # 5. Return compiled instance class
37
+ return _instance_cls
38
+
39
+
40
+ _DESIGN_NOTES = """
41
+ # create_instance_class
42
+
43
+ ## Purpose
44
+ Compiles the dynamic runtime class (`*_Instance`) for a given blueprint and mixin set.
45
+ Rather than placing mixins directly into Python's MRO (`class_parents`), this function
46
+ implements a **Namespace Injection Pattern**: mixins are flattened, validated, and merged
47
+ into `class_dict`, leaving `base_class` as the sole parent in MRO.
48
+
49
+ ## Compilation Steps
50
+ 1. **Namespace Assembly (`_build_instance_class_dict`)**
51
+ Flattens the MRO tree of all provided mixins, validates individual mixin compatibility,
52
+ checks for slot collision, merges attributes/methods, and chains `init_mixins` hooks.
53
+ Also attaches `__mixins__` (tuple of flattened mixin classes) to `class_dict`.
54
+
55
+ 2. **Class Creation (`type()`)**
56
+ Constructs the new type with single inheritance `(base_class,)`. This eliminates C-level
57
+ slot arrangement conflicts in Python's MRO while preserving clean behavior.
58
+
59
+ 3. **Qualname Standardization**
60
+ Sets `__qualname__` to match `class_name` for clean stack traces, help(), and debugging.
61
+
62
+ 4. **In-Place Metaprogramming Extension (`_extend_instance_class`)**
63
+ Executes static `__extend_instance_class__` hooks present on flattened mixins. This allows
64
+ advanced mixins (e.g., `InnersProperty`, `Equalizer`, `ImmutableWithInners`) to dynamically
65
+ attach generated properties or setters directly onto `_instance_cls`.
66
+
67
+ ## Why Single Parent in MRO `(base_class,)`?
68
+ - **No Slot Layout Conflicts**: Mixins define their own slots. In standard Python multiple inheritance,
69
+ combining multiple classes with non-empty `__slots__` raises a `TypeError`. Injecting mixin slots
70
+ and attributes directly into `class_dict` bypasses MRO slot limitations completely.
71
+ - **Explicit Ancestry Tracking**: Mixin membership is tracked explicitly via `class_dict["__mixins__"]`
72
+ and validated at runtime via `SimpleMixinMeta.__instancecheck__`, making `isinstance(obj, Mixin)`
73
+ work seamlessly without MRO complexity.
74
+ - **Predictable Method Resolution**: Attribute collisions are caught and resolved predictably during
75
+ `class_dict` assembly rather than relying on complex MRO ordering.
76
+ """
@@ -0,0 +1,53 @@
1
+ from typing import TYPE_CHECKING
2
+ # Annotations
3
+ if TYPE_CHECKING:
4
+ from .....protocols.classes import SimpleClassLike
5
+ from .....protocols.instance.core_classes import AtomInstanceProtocol, CompositeInstanceProtocol
6
+
7
+
8
+ def get_base_class(
9
+ cls: "SimpleClassLike",
10
+ is_atom: bool,
11
+ mutable: bool,
12
+ ) -> "AtomInstanceProtocol | CompositeInstanceProtocol":
13
+ """Returns the correct base instance class based on structural mode and mutability."""
14
+
15
+ # 1. Atomic branch
16
+ if is_atom:
17
+ return (
18
+ cls.meta.atom_class_mutable
19
+ if mutable else
20
+ cls.meta.atom_class_immutable
21
+ )
22
+
23
+ # 2. Composite branch
24
+ return (
25
+ cls.meta.composite_class_mutable
26
+ if mutable else
27
+ cls.meta.composite_class_immutable
28
+ )
29
+
30
+
31
+
32
+ _DESIGN_NOTES = """
33
+ # get_base_class
34
+
35
+ ## Purpose
36
+ Resolves the correct runtime base class for a new instance.
37
+ This determines the entire structural behavior of the instance: slots, init pipeline,
38
+ reactive methods, and memory layout.
39
+
40
+ ## Behavior
41
+ 1. If the instance is atomic:
42
+ - returns `atom_class_mutable` or `atom_class_immutable`
43
+ 2. If the instance is composite:
44
+ - returns `composite_class_mutable` or `composite_class_immutable`
45
+
46
+ ## Notes
47
+ - This function is the structural routing gate of the instance‑builder.
48
+ - Delegates fully to metadata (`cls.meta`), which handles lazy compilation and caching.
49
+ - Guarantees deterministic selection across two orthogonal axes:
50
+ - **Topology:** atom vs composite
51
+ - **Mutability:** mutable vs immutable
52
+ - Keeps the instance‑builder minimal and avoids branching duplication.
53
+ """
@@ -0,0 +1,20 @@
1
+ from .raise_invalide_extend_instance_class_definition import raise_invalide_extend_instance_class_definition
2
+ from .raise_mixin_slot_collision import raise_mixin_slot_collision
3
+ from .raise_mixin_slot_collision_with_base_class import raise_mixin_slot_collision_with_base_class
4
+
5
+
6
+ _DESIGN_NOTES = """
7
+ # Instance Helper Validations Sub-Package
8
+
9
+ ## Purpose
10
+ Provides specialized diagnostic and validation helpers used during dynamic instance class
11
+ compilation and mixin resolution. Guarantees mixin compatibility and prevents attribute slot collisions.
12
+
13
+ ## Internal Components Registry
14
+
15
+ | Component | Type | Description |
16
+ | :------------------------------------------------ | :------- | :------------------------------------------------------------------------------ |
17
+ | `raise_invalide_extend_instance_class_definition` | Function | Raised when `__extend_instance_class__` is not a staticmethod or classmethod. |
18
+ | `raise_mixin_slot_collision` | Function | Raised when multiple mixins declare overlapping `__slots__` attribute names. |
19
+ | `raise_mixin_slot_collision_with_base_class` | Function | Raised when a mixin declares a slot that shadows an existing base class slot. |
20
+ """
@@ -0,0 +1,29 @@
1
+ from .validate_mixin_is_class import validate_mixin_is_class
2
+ from .validate_mixin_is_simple_base_subclass import validate_mixin_is_simple_base_subclass
3
+ from .raise_mixin_not_allowed_for_composite import raise_mixin_not_allowed_for_composite
4
+ from .raise_mixin_not_allowed_for_constant import raise_mixin_not_allowed_for_constant
5
+ from .raise_mixin_not_allowed_for_immutable import raise_mixin_not_allowed_for_immutable
6
+ from .raise_mixin_not_allowed_for_mutable import raise_mixin_not_allowed_for_mutable
7
+ from .raise_mixin_not_support_default_value_type import raise_mixin_not_support_default_value_type
8
+
9
+
10
+ _DESIGN_NOTES = """
11
+ # Mixin Validations Sub-Package
12
+
13
+ ## Purpose
14
+ Provides identity and compatibility validators for mixins used during instance
15
+ construction. Ensures that mixins match structural mode, mutability, and default
16
+ value constraints.
17
+
18
+ ## Internal Components Registry
19
+
20
+ | Component | Type | Description |
21
+ | :------------------------------------------ | :------- | :------------------------------------------------------- |
22
+ | `validate_mixin_is_class` | Function | Ensures mixin is a class object. |
23
+ | `validate_mixin_is_simple_base_subclass` | Function | Verifies mixin inherits from SimpleMixin. |
24
+ | `raise_mixin_not_allowed_for_composite` | Function | Blocks `_constant_only` mixins on composite instances. |
25
+ | `raise_mixin_not_allowed_for_constant` | Function | Blocks `_composite_only` mixins on atomic instances. |
26
+ | `raise_mixin_not_allowed_for_immutable` | Function | Blocks `_mutable_only` mixins on immutable instances. |
27
+ | `raise_mixin_not_allowed_for_mutable` | Function | Blocks `_immutable_only` mixins on mutable instances. |
28
+ | `raise_mixin_not_support_default_value_type`| Function | Enforces `_only_types` default value type constraints. |
29
+ """
@@ -0,0 +1,61 @@
1
+ from typing import TYPE_CHECKING
2
+ # Outers
3
+ from ........exceptions import SimpleInitializationError
4
+ # Annotations
5
+ if TYPE_CHECKING:
6
+ from .......protocols.classes import SimpleClassLike
7
+ from .......protocols.mixins.base_class import SimpleMixinProtocol
8
+
9
+
10
+ def raise_mixin_not_allowed_for_composite(
11
+ cls: "SimpleClassLike",
12
+ mixin: "SimpleMixinProtocol",
13
+ ) -> None:
14
+ """Raises an error when a constant-only mixin is applied to a composite instance."""
15
+
16
+ raise SimpleInitializationError(
17
+ error_name="INVALID MIXIN USAGE",
18
+ label="mixin_constant_only_not_allowed_for_composite",
19
+ expected="Mixin usable only for atomic (constant) instances",
20
+ value=mixin,
21
+ problem=(
22
+ f"Mixin '{mixin.__name__}' is marked as _constant_only=True and "
23
+ f"cannot be applied to composite class '{cls.__name__}'."
24
+ ),
25
+ context=f"create_instance(cls={cls.__name__}, mixin={mixin.__name__})",
26
+ how_to_fix=(
27
+ "Use this mixin only when creating atomic instances (as_atom=True).",
28
+ "Example:",
29
+ " create_instance(MyClass, mixins=(MyMixin,), as_atom=True)\n",
30
+ "If the mixin should support composite instances, remove the flag:",
31
+ " _constant_only = False",
32
+ ),
33
+ exception=TypeError,
34
+ )
35
+
36
+
37
+ _DESIGN_NOTES = """
38
+ # raise_mixin_not_allowed_for_composite
39
+
40
+ ## Purpose
41
+ Signals that a mixin marked with `_constant_only=True` was incorrectly applied to
42
+ a composite instance. Constant-only mixins are designed exclusively for atomic
43
+ nodes and cannot operate on composite structures.
44
+
45
+ ## Behavior
46
+ - Triggered when:
47
+ - `mixin._constant_only is True`
48
+ - AND the target instance is composite (`is_atom=False`)
49
+ - Raises `SimpleInitializationError` with a clear diagnostic message and remediation steps.
50
+
51
+ ## Notes
52
+ - Constant-only mixins typically assume a single-value topology and cannot
53
+ interact with composite nodes that contain nested children.
54
+ - This validator enforces strict compatibility rules defined on `SimpleMixin`.
55
+ - Part of the five-rule compatibility matrix:
56
+ - `_constant_only`
57
+ - `_composite_only`
58
+ - `_mutable_only`
59
+ - `_immutable_only`
60
+ - `_only_types`
61
+ """
@@ -0,0 +1,61 @@
1
+ from typing import TYPE_CHECKING
2
+ # Outers
3
+ from ........exceptions import SimpleInitializationError
4
+ # Annotations
5
+ if TYPE_CHECKING:
6
+ from .......protocols.classes import SimpleClassLike
7
+ from .......protocols.mixins.base_class import SimpleMixinProtocol
8
+
9
+
10
+ def raise_mixin_not_allowed_for_constant(
11
+ cls: "SimpleClassLike",
12
+ mixin: "SimpleMixinProtocol",
13
+ ) -> None:
14
+ """Raises an error when a composite-only mixin is applied to an atomic instance."""
15
+
16
+ raise SimpleInitializationError(
17
+ error_name="INVALID MIXIN USAGE",
18
+ label="mixin_composite_only_not_allowed_for_constant",
19
+ expected="Mixin usable only for composite instances",
20
+ value=mixin,
21
+ problem=(
22
+ f"Mixin '{mixin.__name__}' is marked as _composite_only=True and "
23
+ f"cannot be applied to atomic class '{cls.__name__}'."
24
+ ),
25
+ context=f"create_instance(cls={cls.__name__}, mixin={mixin.__name__})",
26
+ how_to_fix=(
27
+ "Use this mixin only when creating composite instances (as_atom=False).",
28
+ "Example:",
29
+ " create_instance(MyClass, mixins=(MyMixin,), as_atom=False)\n",
30
+ "If the mixin should support atomic instances, remove the flag:",
31
+ " _composite_only = False",
32
+ ),
33
+ exception=TypeError,
34
+ )
35
+
36
+
37
+ _DESIGN_NOTES = """
38
+ # raise_mixin_not_allowed_for_constant
39
+
40
+ ## Purpose
41
+ Signals that a mixin marked with `_composite_only=True` was incorrectly applied to
42
+ an atomic instance. Composite-only mixins assume a multi‑node structure and cannot
43
+ operate on atomic nodes.
44
+
45
+ ## Behavior
46
+ - Triggered when:
47
+ - `mixin._composite_only is True`
48
+ - AND the target instance is atomic (`is_atom=True`)
49
+ - Raises `SimpleInitializationError` with a clear diagnostic message and remediation steps.
50
+
51
+ ## Notes
52
+ - Composite-only mixins typically rely on child-node traversal, decomposition,
53
+ or multi‑value logic that atomic nodes do not support.
54
+ - This validator enforces strict compatibility rules defined on `SimpleMixin`.
55
+ - Part of the five-rule compatibility matrix:
56
+ - `_constant_only`
57
+ - `_composite_only`
58
+ - `_mutable_only`
59
+ - `_immutable_only`
60
+ - `_only_types`
61
+ """
@@ -0,0 +1,61 @@
1
+ from typing import TYPE_CHECKING
2
+ # Outers
3
+ from ........exceptions import SimpleInitializationError
4
+ # Annotations
5
+ if TYPE_CHECKING:
6
+ from .......protocols.classes import SimpleClassLike
7
+ from .......protocols.mixins.base_class import SimpleMixinProtocol
8
+
9
+
10
+ def raise_mixin_not_allowed_for_immutable(
11
+ cls: "SimpleClassLike",
12
+ mixin: "SimpleMixinProtocol",
13
+ ) -> None:
14
+ """Raises an error when a mutable-only mixin is applied to an immutable instance."""
15
+
16
+ raise SimpleInitializationError(
17
+ error_name="INVALID MIXIN USAGE",
18
+ label="mixin_mutable_only_not_allowed_for_immutable",
19
+ expected="Mixin usable only for mutable instances",
20
+ value=mixin,
21
+ problem=(
22
+ f"Mixin '{mixin.__name__}' is marked as _mutable_only=True and "
23
+ f"cannot be applied to immutable class '{cls.__name__}'."
24
+ ),
25
+ context=f"create_instance(cls={cls.__name__}, mixin={mixin.__name__})",
26
+ how_to_fix=(
27
+ "Use this mixin only when creating mutable instances (mutable=True).",
28
+ "Example:",
29
+ " create_instance(MyClass, mixins=(MyMixin,), mutable=True)\n",
30
+ "If the mixin should support immutable instances, remove the flag:",
31
+ " _mutable_only = False",
32
+ ),
33
+ exception=TypeError,
34
+ )
35
+
36
+
37
+ _DESIGN_NOTES = """
38
+ # raise_mixin_not_allowed_for_immutable
39
+
40
+ ## Purpose
41
+ Signals that a mixin marked with `_mutable_only=True` was incorrectly applied to
42
+ an immutable instance. Mutable-only mixins assume that the instance supports
43
+ state changes and reactive recalculation, which immutable nodes forbid.
44
+
45
+ ## Behavior
46
+ - Triggered when:
47
+ - `mixin._mutable_only is True`
48
+ - AND the target instance is immutable (`mutable=False`)
49
+ - Raises `SimpleInitializationError` with a clear diagnostic message and remediation steps.
50
+
51
+ ## Notes
52
+ - Mutable-only mixins typically rely on mutation hooks, reactive bubbling, or
53
+ dynamic state updates that immutable nodes cannot perform.
54
+ - This validator enforces strict compatibility rules defined on `SimpleMixin`.
55
+ - Part of the five-rule compatibility matrix:
56
+ - `_constant_only`
57
+ - `_composite_only`
58
+ - `_mutable_only`
59
+ - `_immutable_only`
60
+ - `_only_types`
61
+ """
@@ -0,0 +1,60 @@
1
+ from typing import TYPE_CHECKING
2
+ # Outers
3
+ from ........exceptions import SimpleInitializationError
4
+ # Annotations
5
+ if TYPE_CHECKING:
6
+ from .......protocols.classes import SimpleClassLike
7
+ from .......protocols.mixins.base_class import SimpleMixinProtocol
8
+
9
+
10
+ def raise_mixin_not_allowed_for_mutable(
11
+ cls: "SimpleClassLike",
12
+ mixin: "SimpleMixinProtocol",
13
+ ) -> None:
14
+ """Raises an error when an immutable-only mixin is applied to a mutable instance."""
15
+
16
+ raise SimpleInitializationError(
17
+ error_name="INVALID MIXIN USAGE",
18
+ label="mixin_immutable_only_not_allowed_for_mutable",
19
+ expected="Mixin usable only for immutable instances",
20
+ value=mixin,
21
+ problem=(
22
+ f"Mixin '{mixin.__name__}' is marked as _immutable_only=True and "
23
+ f"cannot be applied to mutable class '{cls.__name__}'."
24
+ ),
25
+ context=f"create_instance(cls={cls.__name__}, mixin={mixin.__name__})",
26
+ how_to_fix=(
27
+ "Use this mixin only when creating immutable instances (mutable=False).",
28
+ "Example:",
29
+ " create_instance(MyClass, mixins=(MyMixin,), mutable=False)\n",
30
+ "If the mixin should support mutable instances, remove the flag:",
31
+ " _immutable_only = False",
32
+ ),
33
+ exception=TypeError,
34
+ )
35
+
36
+
37
+ _DESIGN_NOTES = """
38
+ # raise_mixin_not_allowed_for_mutable
39
+
40
+ ## Purpose
41
+ Signals that a mixin marked with `_immutable_only=True` was incorrectly applied to
42
+ a mutable instance. Immutable-only mixins assume that the instance has a fixed,
43
+ non‑changing value and does not support mutation or reactive recalculation.
44
+
45
+ ## Behavior
46
+ - Triggered when:
47
+ - `mixin._immutable_only is True`
48
+ - AND the target instance is mutable (`mutable=True`)
49
+ - Raises `SimpleInitializationError` with a clear diagnostic message and remediation steps.
50
+
51
+ ## Notes
52
+ - Immutable-only mixins typically rely on stable, non‑changing state semantics.
53
+ - This validator enforces strict compatibility rules defined on `SimpleMixin`.
54
+ - Part of the five-rule compatibility matrix:
55
+ - `_constant_only`
56
+ - `_composite_only`
57
+ - `_mutable_only`
58
+ - `_immutable_only`
59
+ - `_only_types`
60
+ """
@@ -0,0 +1,66 @@
1
+ from typing import TYPE_CHECKING
2
+ # Outers
3
+ from ........exceptions import SimpleInitializationError
4
+ # Annotations
5
+ if TYPE_CHECKING:
6
+ from .......protocols.classes import SimpleClassLike
7
+ from .......protocols.mixins.base_class import SimpleMixinProtocol
8
+
9
+
10
+ def raise_mixin_not_support_default_value_type(
11
+ cls: "SimpleClassLike",
12
+ mixin: "SimpleMixinProtocol",
13
+ ) -> None:
14
+ """Raises an error when a mixin's _only_types constraint does not match the class default value."""
15
+
16
+ default_value = cls.meta.default
17
+ allowed_types = mixin._only_types
18
+
19
+ raise SimpleInitializationError(
20
+ error_name="INVALID MIXIN USAGE",
21
+ label="mixin_default_type_not_supported",
22
+ expected=f"Default value of type {allowed_types}",
23
+ value=default_value,
24
+ problem=(
25
+ f"Mixin '{mixin.__name__}' declares _only_types={allowed_types}, ",
26
+ f"but the default value of class '{cls.__name__}' is "
27
+ f"{default_value!r} ({type(default_value).__name__})."
28
+ ),
29
+ context=f"create_instance(cls={cls.__name__}, mixin={mixin.__name__})",
30
+ how_to_fix=(
31
+ "Use this mixin only with classes whose default value matches the required types.",
32
+ "Example:",
33
+ " class MyClass(SimpleObject):",
34
+ " _default = 10\n",
35
+ "Or adjust the mixin to accept the desired type:",
36
+ " _only_types = (int, str)",
37
+ ),
38
+ exception=TypeError,
39
+ )
40
+
41
+
42
+ _DESIGN_NOTES = """
43
+ # raise_mixin_not_support_default_value_type
44
+
45
+ ## Purpose
46
+ Signals that a mixin with a declared `_only_types` constraint was applied to a
47
+ class whose default value does not match any of the allowed types.
48
+
49
+ ## Behavior
50
+ - Triggered when:
51
+ - `mixin._only_types is not UNSET`
52
+ - AND `not isinstance(cls.meta.default, mixin._only_types)`
53
+ - Raises `SimpleInitializationError` with a clear diagnostic message and remediation steps.
54
+
55
+ ## Notes
56
+ - `_only_types` is a strong compatibility constraint used by mixins that operate
57
+ only on specific value domains (e.g., numeric mixins, string mixins, tuple mixins).
58
+ - This validator ensures that mixins cannot be attached to incompatible classes,
59
+ preventing runtime errors in mixin logic.
60
+ - Completes the five-rule compatibility matrix:
61
+ - `_constant_only`
62
+ - `_composite_only`
63
+ - `_mutable_only`
64
+ - `_immutable_only`
65
+ - `_only_types`
66
+ """
@@ -0,0 +1,56 @@
1
+ from typing import TYPE_CHECKING
2
+ # Outers
3
+ from ........exceptions import SimpleInitializationError
4
+ # Annotations
5
+ if TYPE_CHECKING:
6
+ from .......protocols.classes import SimpleClassLike
7
+
8
+
9
+ def validate_mixin_is_class(
10
+ cls: "SimpleClassLike",
11
+ mixin: object,
12
+ ) -> None:
13
+ """Validates that the mixin is a class object."""
14
+
15
+ # 1. Check class identity
16
+ if isinstance(mixin, type):
17
+ return
18
+
19
+ # 2. Raise error
20
+ raise SimpleInitializationError(
21
+ error_name="INVALID MIXIN",
22
+ label="mixin_not_class",
23
+ expected="Class derived from SimpleMixin",
24
+ value=mixin,
25
+ problem=f"Object '{mixin!r}' is not a class and cannot be used as a mixin for '{cls.__name__}'.",
26
+ context=f"create_instance(cls={cls.__name__}, mixin={mixin!r})",
27
+ how_to_fix=(
28
+ "Pass a class, not an instance or other object.",
29
+ "Correct usage:",
30
+ " create_instance(MyClass, mixins=(MyMixin,), as_atom=False)",
31
+ ),
32
+ exception=TypeError,
33
+ )
34
+
35
+
36
+ _DESIGN_NOTES = """
37
+ # validate_mixin_is_class
38
+
39
+ ## Purpose
40
+ Ensures that every mixin passed to the instance‑builder is a valid class object.
41
+ Mixins must be classes because they participate in inheritance, slot merging,
42
+ and optional class‑extension hooks.
43
+
44
+ ## Behavior
45
+ 1. Checks whether `mixin` is an instance of `type`.
46
+ 2. If not, raises `SimpleInitializationError` with a clear remediation message.
47
+
48
+ ## Notes
49
+ - Mixins cannot be instances, functions, modules, or any other object type.
50
+ - This validator is the first gate in the mixin pipeline and prevents invalid
51
+ objects from entering deeper compatibility checks.
52
+ - Guarantees deterministic behavior for subsequent validators:
53
+ - `validate_mixin_is_simple_base_subclass`
54
+ - structural flags (`_constant_only`, `_composite_only`, …)
55
+ - `_only_types` compatibility
56
+ """
@@ -0,0 +1,60 @@
1
+ from typing import TYPE_CHECKING
2
+ # Outers
3
+ from ........exceptions import SimpleInitializationError
4
+ # Annotations
5
+ if TYPE_CHECKING:
6
+ from .......protocols.classes import SimpleClassLike
7
+ from .......protocols.mixins.base_class import SimpleMixinProtocol
8
+
9
+
10
+ def validate_mixin_is_simple_base_subclass(
11
+ cls: "SimpleClassLike",
12
+ mixin: "SimpleMixinProtocol",
13
+ ) -> None:
14
+ """Validates that the mixin inherits from SimpleMixin."""
15
+
16
+ from ........mixins.base_class import SimpleMixin
17
+
18
+ # 1. Check inheritance
19
+ if issubclass(mixin, SimpleMixin):
20
+ return
21
+
22
+ # 2. Raise error
23
+ raise SimpleInitializationError(
24
+ error_name="INVALID MIXIN",
25
+ label="mixin_not_subclass_of_simplemixin",
26
+ expected="Subclass of SimpleMixin",
27
+ value=mixin,
28
+ problem=f"Class '{mixin.__name__}' does not inherit from SimpleMixin and cannot be used as a mixin for '{cls.__name__}'.",
29
+ context=f"create_instance(cls={cls.__name__}, mixin={mixin.__name__})",
30
+ how_to_fix=(
31
+ "Ensure the mixin inherits from SimpleMixin.",
32
+ "Example:",
33
+ " class MyMixin(SimpleMixin):",
34
+ " __slots__ = ()\n",
35
+ "If the class is not intended to be a mixin, do not pass it to create_instance.",
36
+ ),
37
+ exception=TypeError,
38
+ )
39
+
40
+
41
+ _DESIGN_NOTES = """
42
+ # validate_mixin_is_simple_base_subclass
43
+
44
+ ## Purpose
45
+ Ensures that every mixin used in instance creation is a proper subclass of
46
+ `SimpleMixin`. This is required because mixins participate in inheritance,
47
+ slot merging, initialization hooks, and optional class‑extension mechanisms.
48
+
49
+ ## Behavior
50
+ 1. Imports `SimpleMixin` lazily to avoid circular dependencies.
51
+ 2. Checks whether `mixin` is a subclass of `SimpleMixin`.
52
+ 3. If not, raises `SimpleInitializationError` with a clear remediation message.
53
+
54
+ ## Notes
55
+ - This validator is the second gate in the mixin pipeline, following
56
+ `validate_mixin_is_class`.
57
+ - Guarantees that only structurally valid mixins enter deeper compatibility
58
+ checks (constant‑only, composite‑only, mutable‑only, immutable‑only, `_only_types`).
59
+ - Prevents accidental misuse of arbitrary classes as mixins.
60
+ """
@@ -0,0 +1,62 @@
1
+ from typing import TYPE_CHECKING
2
+ # Outers
3
+ from .......exceptions import SimpleInitializationError
4
+ # Annotations
5
+ if TYPE_CHECKING:
6
+ from ......protocols.classes import SimpleClassLike
7
+ from ......protocols.mixins.base_class import SimpleMixinProtocol
8
+
9
+
10
+ def raise_invalide_extend_instance_class_definition(
11
+ cls: "SimpleClassLike",
12
+ mixin: "SimpleMixinProtocol",
13
+ ) -> None:
14
+ """Raises an error when __extend_instance_class__ hook on a mixin is not a classmethod or staticmethod."""
15
+
16
+ raw_attr = mixin.__dict__["__extend_instance_class__"]
17
+
18
+ raise SimpleInitializationError(
19
+ error_name="INVALID EXTEND INSTANCE CLASS DEFINITION",
20
+ label="mixin_invalid_extend_instance_class_definition",
21
+ expected="@classmethod or @staticmethod decorator on __extend_instance_class__",
22
+ value=type(raw_attr).__name__,
23
+ problem=(
24
+ f"Mixin '{mixin.__name__}' defines '__extend_instance_class__' as an "
25
+ f"un-decorated method or invalid descriptor ({type(raw_attr).__name__}) "
26
+ f"when compiling instance class for '{cls.__name__}'."
27
+ ),
28
+ context=f"create_instance(cls={cls.__name__}, mixin={mixin.__name__})",
29
+ how_to_fix=(
30
+ "Decorate '__extend_instance_class__' on the mixin with @classmethod or @staticmethod.",
31
+ "Example:",
32
+ " class MyMixin(SimpleMixin):",
33
+ " @classmethod",
34
+ " def __extend_instance_class__(cls, instance_cls):",
35
+ " # In-place class modification logic",
36
+ " ...",
37
+ ),
38
+ exception=TypeError,
39
+ )
40
+
41
+
42
+ _DESIGN_NOTES = """
43
+ # raise_invalide_extend_instance_class_definition
44
+
45
+ ## Purpose
46
+ Signals that a mixin defines the `__extend_instance_class__` metaprogramming hook without
47
+ properly wrapping it in `@classmethod` or `@staticmethod`.
48
+
49
+ ## Behavior
50
+ - Triggered when:
51
+ - `"__extend_instance_class__" in mixin.__dict__`
52
+ - AND `not isinstance(raw_attr, (staticmethod, classmethod))`
53
+ - Raises `SimpleInitializationError` with a detailed diagnostic message and clear resolution steps.
54
+
55
+ ## Notes
56
+ - Direct dictionary inspection (`mixin.__dict__`) retrieves raw attributes before descriptor
57
+ binding occurs.
58
+ - Raw instance methods are not callable at class-compilation time because no instance of
59
+ the mixin exists yet.
60
+ - Requiring `@classmethod` or `@staticmethod` guarantees that the extension hook can be
61
+ safely executed against the newly created runtime instance class (`_instance_cls`).
62
+ """