simplibs-object 0.1.1__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.
- simplibs/object/SimpleBase.py +115 -0
- simplibs/object/SimpleConstant.py +271 -0
- simplibs/object/SimpleObject.py +293 -0
- simplibs/object/__init__.py +7 -0
- simplibs/object/_core/__init__.py +66 -0
- simplibs/object/_core/logic/__init__.py +0 -0
- simplibs/object/_core/logic/constant_methods/__init__.py +22 -0
- simplibs/object/_core/logic/constant_methods/bool_or_raise_validate_error.py +76 -0
- simplibs/object/_core/logic/constant_methods/normalize.py +92 -0
- simplibs/object/_core/logic/constant_methods/validate.py +99 -0
- simplibs/object/_core/logic/constant_methods/validate_type.py +48 -0
- simplibs/object/_core/logic/constant_methods/validations/__init__.py +22 -0
- simplibs/object/_core/logic/constant_methods/validations/_extract_clean_code_lines.py +86 -0
- simplibs/object/_core/logic/constant_methods/validations/raise_missing_value_error.py +71 -0
- simplibs/object/_core/logic/constant_methods/validations/raise_type_error.py +59 -0
- simplibs/object/_core/logic/constant_methods/validations/raise_unexpected_validation_error.py +66 -0
- simplibs/object/_core/logic/constant_methods/validations/raise_validation_error.py +78 -0
- simplibs/object/_core/logic/object_methods/__init__.py +18 -0
- simplibs/object/_core/logic/object_methods/_process_calculate_value_params.py +108 -0
- simplibs/object/_core/logic/object_methods/calculate_value.py +81 -0
- simplibs/object/_core/logic/object_methods/decompose_value.py +91 -0
- simplibs/object/_core/logic/object_methods/validations/__init__.py +22 -0
- simplibs/object/_core/logic/object_methods/validations/raise_class_not_decomposeable.py +82 -0
- simplibs/object/_core/logic/object_methods/validations/raise_duplicate_argument_error.py +77 -0
- simplibs/object/_core/logic/object_methods/validations/raise_too_many_positional_args_error.py +81 -0
- simplibs/object/_core/logic/object_methods/validations/raise_unknown_parameter_error.py +77 -0
- simplibs/object/_core/logic/property_builders/__init__.py +20 -0
- simplibs/object/_core/logic/property_builders/create_instance_property.py +66 -0
- simplibs/object/_core/logic/property_builders/create_properties_for_inner.py +97 -0
- simplibs/object/_core/logic/property_builders/create_value_property.py +98 -0
- simplibs/object/_core/logic/property_builders/value_helpers/__init__.py +18 -0
- simplibs/object/_core/logic/property_builders/value_helpers/create_value_getter.py +52 -0
- simplibs/object/_core/logic/property_builders/value_helpers/create_value_setter.py +95 -0
- simplibs/object/_core/logic/property_builders/value_helpers/validations/__init__.py +16 -0
- simplibs/object/_core/logic/property_builders/value_helpers/validations/raise_locked_value_error.py +103 -0
- simplibs/object/_core/metadata/SimpleBaseMetadata.py +139 -0
- simplibs/object/_core/metadata/SimpleConstantMetadata.py +108 -0
- simplibs/object/_core/metadata/SimpleMeta.py +214 -0
- simplibs/object/_core/metadata/SimpleObjectMetadata.py +165 -0
- simplibs/object/_core/metadata/__init__.py +16 -0
- simplibs/object/_core/metadata/constants/BASE_CLASS_NAMES.py +23 -0
- simplibs/object/_core/metadata/constants/__init__.py +16 -0
- simplibs/object/_core/metadata/init_processors/__init__.py +47 -0
- simplibs/object/_core/metadata/init_processors/blueprint_path/__init__.py +15 -0
- simplibs/object/_core/metadata/init_processors/blueprint_path/calculate_blueprint_path.py +81 -0
- simplibs/object/_core/metadata/init_processors/default/__init__.py +17 -0
- simplibs/object/_core/metadata/init_processors/default/process_default_for_constant.py +71 -0
- simplibs/object/_core/metadata/init_processors/default/validations/__init__.py +19 -0
- simplibs/object/_core/metadata/init_processors/default/validations/_exception_info_for_default.py +66 -0
- simplibs/object/_core/metadata/init_processors/default/validations/raise_default_is_defined_in_composition.py +78 -0
- simplibs/object/_core/metadata/init_processors/default/validations/validate_default_is_defined.py +77 -0
- simplibs/object/_core/metadata/init_processors/default/validations/validate_default_matches_annotation.py +93 -0
- simplibs/object/_core/metadata/init_processors/inners/__init__.py +15 -0
- simplibs/object/_core/metadata/init_processors/inners/process_inners.py +143 -0
- simplibs/object/_core/metadata/init_processors/inners/validations/__init__.py +33 -0
- simplibs/object/_core/metadata/init_processors/inners/validations/_exception_info_for_inners.py +43 -0
- simplibs/object/_core/metadata/init_processors/inners/validations/_get_collision_path.py +45 -0
- simplibs/object/_core/metadata/init_processors/inners/validations/validate_collision_within_inners.py +78 -0
- simplibs/object/_core/metadata/init_processors/inners/validations/validate_if_collision_with_owner_class.py +66 -0
- simplibs/object/_core/metadata/init_processors/inners/validations/validate_inner_is_class.py +58 -0
- simplibs/object/_core/metadata/init_processors/inners/validations/validate_inner_is_not_simple_class.py +60 -0
- simplibs/object/_core/metadata/init_processors/inners/validations/validate_inner_is_simple_subclass.py +61 -0
- simplibs/object/_core/metadata/init_processors/inners/validations/validate_inners_is_defined.py +56 -0
- simplibs/object/_core/metadata/init_processors/inners/validations/validate_inners_is_not_empty.py +57 -0
- simplibs/object/_core/metadata/init_processors/inners/validations/validate_inners_is_tuple.py +57 -0
- simplibs/object/_core/metadata/init_processors/methods/__init__.py +15 -0
- simplibs/object/_core/metadata/init_processors/methods/process_classmethod.py +130 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/__init__.py +16 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/_exceptions_helpers/__init__.py +17 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/_exceptions_helpers/exception_info_for_classmethod.py +52 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/_exceptions_helpers/expected_structure_for_classmethod.py +80 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/annotations_and_defaults/__init__.py +15 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/annotations_and_defaults/validations/__init__.py +19 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/annotations_and_defaults/validations/_convert_annotation_to_type_set.py +38 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/annotations_and_defaults/validations/validate_annotations.py +84 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/annotations_and_defaults/validations/validate_args_defaults.py +76 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/annotations_and_defaults/validations/validate_kwargs_defaults.py +74 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/annotations_and_defaults/verify_annotations_and_defaults.py +100 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/__init__.py +15 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/decompose_method/__init__.py +15 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/decompose_method/validations/__init__.py +19 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/decompose_method/validations/raise_decompose_unvalide_outcome_length.py +64 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/decompose_method/validations/validate_decompose_unvalide_item_type.py +77 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/decompose_method/validations/validate_decompose_unvalide_item_value.py +72 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/decompose_method/verify_decompose_outcome.py +87 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/validations/__init__.py +17 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/validations/raise_method_raised_exceptions.py +56 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/validations/raise_method_return_unvalide_outcome_type.py +80 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/verify_calculation.py +89 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/classmethod/__init__.py +15 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/classmethod/_clone_classmethod.py +81 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/classmethod/validations/__init__.py +19 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/classmethod/validations/validate_method_is_callable.py +60 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/classmethod/validations/validate_method_is_classmethod.py +60 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/classmethod/validations/validate_method_is_defined.py +67 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/classmethod/verify_classmethod.py +117 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/params/__init__.py +15 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/params/validations/__init__.py +19 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/params/validations/validate_method_has_exact_args_count.py +59 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/params/validations/validate_method_not_use_param_placeholders.py +66 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/params/validations/validate_method_param_match_expected.py +61 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/params/verify_params.py +123 -0
- simplibs/object/_core/metadata/init_processors/names/__init__.py +15 -0
- simplibs/object/_core/metadata/init_processors/names/_class_name_splitter.py +242 -0
- simplibs/object/_core/metadata/init_processors/names/create_names.py +119 -0
- simplibs/object/_core/metadata/init_processors/names/validations/__init__.py +19 -0
- simplibs/object/_core/metadata/init_processors/names/validations/validate_class_name_has_no_underscores.py +94 -0
- simplibs/object/_core/metadata/init_processors/names/validations/validate_class_name_is_ascii.py +95 -0
- simplibs/object/_core/metadata/init_processors/names/validations/validate_class_name_is_identifier.py +83 -0
- simplibs/object/_core/metadata/init_processors/type/__init__.py +15 -0
- simplibs/object/_core/metadata/init_processors/type/process_type.py +117 -0
- simplibs/object/_core/metadata/init_processors/type/validations/__init__.py +29 -0
- simplibs/object/_core/metadata/init_processors/type/validations/_exception_info_for_type.py +88 -0
- simplibs/object/_core/metadata/init_processors/type/validations/raise_union_type_contain_none.py +70 -0
- simplibs/object/_core/metadata/init_processors/type/validations/raise_validate_type_is_not_valid.py +92 -0
- simplibs/object/_core/metadata/init_processors/type/validations/validate_type_from_tuple_is_not_none.py +94 -0
- simplibs/object/_core/metadata/init_processors/type/validations/validate_type_is_defined.py +85 -0
- simplibs/object/_core/metadata/init_processors/type/validations/validate_type_is_not_empty.py +93 -0
- simplibs/object/_core/metadata/init_processors/type/validations/validate_type_is_not_none.py +87 -0
- simplibs/object/_core/metadata/init_processors/type/validations/validate_type_tuple_is_not_nested.py +92 -0
- simplibs/object/_core/metadata/instance_builders/__init__.py +55 -0
- simplibs/object/_core/metadata/instance_builders/atom_class/InstanceBase.py +77 -0
- simplibs/object/_core/metadata/instance_builders/atom_class/__init__.py +16 -0
- simplibs/object/_core/metadata/instance_builders/atom_class/helpers/__init__.py +16 -0
- simplibs/object/_core/metadata/instance_builders/atom_class/helpers/create_atom_init.py +51 -0
- simplibs/object/_core/metadata/instance_builders/atom_class/helpers/create_root_value_setter.py +67 -0
- simplibs/object/_core/metadata/instance_builders/atom_class/make_atom_class.py +101 -0
- simplibs/object/_core/metadata/instance_builders/composite_class/__init__.py +14 -0
- simplibs/object/_core/metadata/instance_builders/composite_class/helpers/__init__.py +20 -0
- simplibs/object/_core/metadata/instance_builders/composite_class/helpers/_get_inner_instance_class.py +51 -0
- simplibs/object/_core/metadata/instance_builders/composite_class/helpers/create_composite_init.py +74 -0
- simplibs/object/_core/metadata/instance_builders/composite_class/helpers/create_properties_for_inners.py +50 -0
- simplibs/object/_core/metadata/instance_builders/composite_class/helpers/create_recalculate_inners.py +57 -0
- simplibs/object/_core/metadata/instance_builders/composite_class/helpers/create_recalculate_self.py +69 -0
- simplibs/object/_core/metadata/instance_builders/composite_class/make_composite_class.py +93 -0
- simplibs/object/_core/metadata/instance_builders/instance/__init__.py +17 -0
- simplibs/object/_core/metadata/instance_builders/instance/create_instance.py +107 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/__init__.py +25 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/_build_combined_init_mixins.py +40 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/_build_instance_class_dict.py +127 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/_extend_instance_class.py +59 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/_resolve_flat_mixins.py +74 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/_verify_mixin_compatibility.py +83 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/create_instance_class.py +76 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/get_base_class.py +53 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/__init__.py +20 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/__init__.py +29 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/raise_mixin_not_allowed_for_composite.py +61 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/raise_mixin_not_allowed_for_constant.py +61 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/raise_mixin_not_allowed_for_immutable.py +61 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/raise_mixin_not_allowed_for_mutable.py +60 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/raise_mixin_not_support_default_value_type.py +66 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/validate_mixin_is_class.py +56 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/validate_mixin_is_simple_base_subclass.py +60 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/raise_invalide_extend_instance_class_definition.py +62 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/raise_mixin_slot_collision.py +56 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/raise_mixin_slot_collision_with_base_class.py +56 -0
- simplibs/object/_core/metadata/instance_builders/instance/validations/__init__.py +21 -0
- simplibs/object/_core/metadata/instance_builders/instance/validations/validate_class_is_not_base_class.py +54 -0
- simplibs/object/_core/metadata/instance_builders/instance/validations/validate_hashing_for_immutable_value.py +66 -0
- simplibs/object/_core/metadata/instance_builders/instance/validations/validate_param_is_bool.py +47 -0
- simplibs/object/_core/metadata/validations/__init__.py +18 -0
- simplibs/object/_core/metadata/validations/raise_attribut_allready_set.py +57 -0
- simplibs/object/_core/metadata/validations/raise_metadata_is_immutable.py +73 -0
- simplibs/object/_core/protocols/__init__.py +118 -0
- simplibs/object/_core/protocols/alias_typings/__init__.py +137 -0
- simplibs/object/_core/protocols/alias_typings/changes/ChangeTuple.py +5 -0
- simplibs/object/_core/protocols/alias_typings/changes/ChangesDict.py +5 -0
- simplibs/object/_core/protocols/alias_typings/changes/ChangesTuple.py +8 -0
- simplibs/object/_core/protocols/alias_typings/changes/__init__.py +18 -0
- simplibs/object/_core/protocols/alias_typings/history/HistoryDict.py +5 -0
- simplibs/object/_core/protocols/alias_typings/history/HistoryEntry.py +10 -0
- simplibs/object/_core/protocols/alias_typings/history/__init__.py +16 -0
- simplibs/object/_core/protocols/alias_typings/inners/InnersMap.py +8 -0
- simplibs/object/_core/protocols/alias_typings/inners/InnersTuple.py +8 -0
- simplibs/object/_core/protocols/alias_typings/inners/__init__.py +16 -0
- simplibs/object/_core/protocols/alias_typings/mixins/MixinsTuple.py +8 -0
- simplibs/object/_core/protocols/alias_typings/mixins/__init__.py +14 -0
- simplibs/object/_core/protocols/alias_typings/names/NamesSet.py +5 -0
- simplibs/object/_core/protocols/alias_typings/names/NamesTuple.py +5 -0
- simplibs/object/_core/protocols/alias_typings/names/__init__.py +16 -0
- simplibs/object/_core/protocols/alias_typings/nodes/NodeItem.py +9 -0
- simplibs/object/_core/protocols/alias_typings/nodes/NodesDict.py +9 -0
- simplibs/object/_core/protocols/alias_typings/nodes/NodesIndexMap.py +6 -0
- simplibs/object/_core/protocols/alias_typings/nodes/NodesInstanceDict.py +9 -0
- simplibs/object/_core/protocols/alias_typings/nodes/NodesPathDict.py +9 -0
- simplibs/object/_core/protocols/alias_typings/nodes/NodesTuple.py +8 -0
- simplibs/object/_core/protocols/alias_typings/nodes/__init__.py +24 -0
- simplibs/object/_core/protocols/alias_typings/paths/PathDict.py +8 -0
- simplibs/object/_core/protocols/alias_typings/paths/PathTuple.py +5 -0
- simplibs/object/_core/protocols/alias_typings/paths/__init__.py +16 -0
- simplibs/object/_core/protocols/alias_typings/snapshots/SnapshotDict.py +5 -0
- simplibs/object/_core/protocols/alias_typings/snapshots/SnapshotDiffItem.py +5 -0
- simplibs/object/_core/protocols/alias_typings/snapshots/SnapshotDiffTuple.py +8 -0
- simplibs/object/_core/protocols/alias_typings/snapshots/SnapshotTuple.py +5 -0
- simplibs/object/_core/protocols/alias_typings/snapshots/__init__.py +20 -0
- simplibs/object/_core/protocols/alias_typings/state/StateDict.py +5 -0
- simplibs/object/_core/protocols/alias_typings/state/__init__.py +14 -0
- simplibs/object/_core/protocols/alias_typings/types/ValidTypes.py +6 -0
- simplibs/object/_core/protocols/alias_typings/types/__init__.py +14 -0
- simplibs/object/_core/protocols/classes/SimpleBaseProtocol.py +25 -0
- simplibs/object/_core/protocols/classes/SimpleConstantProtocol.py +54 -0
- simplibs/object/_core/protocols/classes/SimpleObjectProtocol.py +50 -0
- simplibs/object/_core/protocols/classes/__init__.py +26 -0
- simplibs/object/_core/protocols/instance/SimpleConstantInstanceProtocol.py +13 -0
- simplibs/object/_core/protocols/instance/SimpleInstanceBaseProtocol.py +24 -0
- simplibs/object/_core/protocols/instance/SimpleObjectInstanceProtocol.py +13 -0
- simplibs/object/_core/protocols/instance/__init__.py +29 -0
- simplibs/object/_core/protocols/instance/core_classes/AtomInstanceProtocol.py +46 -0
- simplibs/object/_core/protocols/instance/core_classes/CompositeInstanceProtocol.py +37 -0
- simplibs/object/_core/protocols/instance/core_classes/InstanceBaseProtocol.py +28 -0
- simplibs/object/_core/protocols/instance/core_classes/__init__.py +19 -0
- simplibs/object/_core/protocols/metadata/SimpleBaseMetadataProtocol.py +37 -0
- simplibs/object/_core/protocols/metadata/SimpleConstantMetadataProtocol.py +45 -0
- simplibs/object/_core/protocols/metadata/SimpleMetaProtocol.py +39 -0
- simplibs/object/_core/protocols/metadata/SimpleObjectMetadataProtocol.py +49 -0
- simplibs/object/_core/protocols/metadata/__init__.py +28 -0
- simplibs/object/_core/protocols/methods/ClassMethodProtocol.py +29 -0
- simplibs/object/_core/protocols/methods/LogicSignature.py +20 -0
- simplibs/object/_core/protocols/methods/__init__.py +18 -0
- simplibs/object/_core/protocols/mixins/__init__.py +120 -0
- simplibs/object/_core/protocols/mixins/base_class/SimpleMixinProtocol.py +46 -0
- simplibs/object/_core/protocols/mixins/base_class/__init__.py +18 -0
- simplibs/object/_core/protocols/mixins/core_mixins/InfrastructureProtocol.py +16 -0
- simplibs/object/_core/protocols/mixins/core_mixins/NodesDictsProtocol.py +38 -0
- simplibs/object/_core/protocols/mixins/core_mixins/NodesTupleProtocol.py +30 -0
- simplibs/object/_core/protocols/mixins/core_mixins/SerializationProtocol.py +55 -0
- simplibs/object/_core/protocols/mixins/core_mixins/SnapshotProtocol.py +42 -0
- simplibs/object/_core/protocols/mixins/core_mixins/__init__.py +27 -0
- simplibs/object/_core/protocols/mixins/dunders/__init__.py +123 -0
- simplibs/object/_core/protocols/mixins/dunders/collections/CollectionBaseProtocol.py +37 -0
- simplibs/object/_core/protocols/mixins/dunders/collections/CollectionProtocol.py +20 -0
- simplibs/object/_core/protocols/mixins/dunders/collections/IterableProtocol.py +37 -0
- simplibs/object/_core/protocols/mixins/dunders/collections/MappingProtocol.py +52 -0
- simplibs/object/_core/protocols/mixins/dunders/collections/__init__.py +21 -0
- simplibs/object/_core/protocols/mixins/dunders/comparison/EqualityProtocol.py +31 -0
- simplibs/object/_core/protocols/mixins/dunders/comparison/OrderingProtocol.py +32 -0
- simplibs/object/_core/protocols/mixins/dunders/comparison/__init__.py +16 -0
- simplibs/object/_core/protocols/mixins/dunders/generics/ClassGetItemProtocol.py +23 -0
- simplibs/object/_core/protocols/mixins/dunders/generics/__init__.py +14 -0
- simplibs/object/_core/protocols/mixins/dunders/interfaces/CallProtocol.py +26 -0
- simplibs/object/_core/protocols/mixins/dunders/interfaces/ContextProtocol.py +38 -0
- simplibs/object/_core/protocols/mixins/dunders/interfaces/__init__.py +16 -0
- simplibs/object/_core/protocols/mixins/dunders/lifecycles/CopyableProtocol.py +33 -0
- simplibs/object/_core/protocols/mixins/dunders/lifecycles/LifecycleProtocol.py +21 -0
- simplibs/object/_core/protocols/mixins/dunders/lifecycles/PickleReduceProtocol.py +30 -0
- simplibs/object/_core/protocols/mixins/dunders/lifecycles/PickleStateProtocol.py +42 -0
- simplibs/object/_core/protocols/mixins/dunders/lifecycles/__init__.py +20 -0
- simplibs/object/_core/protocols/mixins/dunders/lifecycles/internal_types/PicklePlan.py +5 -0
- simplibs/object/_core/protocols/mixins/dunders/lifecycles/internal_types/__init__.py +14 -0
- simplibs/object/_core/protocols/mixins/dunders/numeric/ArithmeticProtocol.py +95 -0
- simplibs/object/_core/protocols/mixins/dunders/numeric/BitwiseProtocol.py +79 -0
- simplibs/object/_core/protocols/mixins/dunders/numeric/ConversionProtocol.py +57 -0
- simplibs/object/_core/protocols/mixins/dunders/numeric/InplaceProtocol.py +66 -0
- simplibs/object/_core/protocols/mixins/dunders/numeric/UnaryProtocol.py +35 -0
- simplibs/object/_core/protocols/mixins/dunders/numeric/__init__.py +22 -0
- simplibs/object/_core/protocols/mixins/dunders/numeric/internal_types/Operator.py +5 -0
- simplibs/object/_core/protocols/mixins/dunders/numeric/internal_types/UnaryOperator.py +5 -0
- simplibs/object/_core/protocols/mixins/dunders/numeric/internal_types/__init__.py +16 -0
- simplibs/object/_core/protocols/mixins/dunders/representation/ValueDisplayProtocol.py +30 -0
- simplibs/object/_core/protocols/mixins/dunders/representation/ValueFormattingProtocol.py +42 -0
- simplibs/object/_core/protocols/mixins/dunders/representation/__init__.py +16 -0
- simplibs/object/_core/protocols/mixins/immutable/ImmutableMethodsProtocol.py +69 -0
- simplibs/object/_core/protocols/mixins/immutable/ImmutableMethodsWithInnersProtocol.py +27 -0
- simplibs/object/_core/protocols/mixins/immutable/__init__.py +18 -0
- simplibs/object/_core/protocols/mixins/numerical/EqualizerProtocol.py +37 -0
- simplibs/object/_core/protocols/mixins/numerical/VolumeProtocol.py +32 -0
- simplibs/object/_core/protocols/mixins/numerical/__init__.py +17 -0
- simplibs/object/_core/protocols/mixins/numerical/internal_types/SteppersMap.py +8 -0
- simplibs/object/_core/protocols/mixins/numerical/internal_types/__init__.py +14 -0
- simplibs/object/_core/protocols/mixins/numerical/stepper/StepperProtocol.py +95 -0
- simplibs/object/_core/protocols/mixins/numerical/stepper/__init__.py +14 -0
- simplibs/object/_core/protocols/mixins/numerical/stepper/internal_types/LimitAction.py +5 -0
- simplibs/object/_core/protocols/mixins/numerical/stepper/internal_types/StepValue.py +6 -0
- simplibs/object/_core/protocols/mixins/numerical/stepper/internal_types/__init__.py +16 -0
- simplibs/object/_core/protocols/mixins/properties/InnersPropertyProtocol.py +31 -0
- simplibs/object/_core/protocols/mixins/properties/MetaShortcutsProtocol.py +49 -0
- simplibs/object/_core/protocols/mixins/properties/__init__.py +17 -0
- simplibs/object/_core/protocols/mixins/state/DefaultStateProtocol.py +41 -0
- simplibs/object/_core/protocols/mixins/state/DirtyTrackingProtocol.py +61 -0
- simplibs/object/_core/protocols/mixins/state/HistoryProtocol.py +112 -0
- simplibs/object/_core/protocols/mixins/state/PermissionProtocol.py +35 -0
- simplibs/object/_core/protocols/mixins/state/__init__.py +22 -0
- simplibs/object/exceptions/SimpleDefinitionError.py +45 -0
- simplibs/object/exceptions/SimpleInitializationError.py +43 -0
- simplibs/object/exceptions/SimpleRuntimeError.py +50 -0
- simplibs/object/exceptions/__init__.py +62 -0
- simplibs/object/exceptions/base_exception/SimpleObjectError.py +107 -0
- simplibs/object/exceptions/base_exception/__init__.py +19 -0
- simplibs/object/mixins/__init__.py +99 -0
- simplibs/object/mixins/_common_logic/__init__.py +41 -0
- simplibs/object/mixins/_common_logic/constants/__init__.py +27 -0
- simplibs/object/mixins/_common_logic/constants/names/HISTORY.py +14 -0
- simplibs/object/mixins/_common_logic/constants/names/OWNER_CLASS.py +14 -0
- simplibs/object/mixins/_common_logic/constants/names/STEPPER.py +14 -0
- simplibs/object/mixins/_common_logic/constants/names/VALUE.py +14 -0
- simplibs/object/mixins/_common_logic/constants/names/__init__.py +28 -0
- simplibs/object/mixins/_common_logic/constants/sets/FORBIDDEN_NAMES.py +27 -0
- simplibs/object/mixins/_common_logic/constants/sets/RESTRICTION_FLAGS.py +18 -0
- simplibs/object/mixins/_common_logic/constants/sets/__init__.py +22 -0
- simplibs/object/mixins/_common_logic/immutability/__init__.py +28 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/__init__.py +17 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/utils/__init__.py +22 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/utils/get_top_composite_paths.py +142 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/utils/process_single_change.py +143 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/utils/split_changes.py +142 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/utils/split_constants_paths.py +147 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/utils/split_constants_paths2.py +142 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/utils/validations/__init__.py +23 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/utils/validations/raise_split_changes_unknown_name.py +107 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/utils/validations/raise_with_any_unknown_name.py +71 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/vaidations/__init__.py +24 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/vaidations/raise_with_any_changes_is_not_tuple.py +65 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/vaidations/raise_with_any_child_composite_mismatch.py +68 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/vaidations/raise_with_any_contained_constant_mismatch.py +67 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/with_any.py +238 -0
- simplibs/object/mixins/_common_logic/immutability/with_composite/__init__.py +17 -0
- simplibs/object/mixins/_common_logic/immutability/with_composite/utils/__init__.py +15 -0
- simplibs/object/mixins/_common_logic/immutability/with_composite/utils/reacalculate_inners.py +112 -0
- simplibs/object/mixins/_common_logic/immutability/with_composite/vaidations/__init__.py +21 -0
- simplibs/object/mixins/_common_logic/immutability/with_composite/vaidations/validate_composite_is_decomposeable.py +71 -0
- simplibs/object/mixins/_common_logic/immutability/with_composite/vaidations/validate_composite_name_exists.py +71 -0
- simplibs/object/mixins/_common_logic/immutability/with_composite/with_composite.py +176 -0
- simplibs/object/mixins/_common_logic/immutability/with_constant/__init__.py +17 -0
- simplibs/object/mixins/_common_logic/immutability/with_constant/utils/__init__.py +20 -0
- simplibs/object/mixins/_common_logic/immutability/with_constant/utils/create_new_instance.py +130 -0
- simplibs/object/mixins/_common_logic/immutability/with_constant/utils/create_snapshot_dict.py +83 -0
- simplibs/object/mixins/_common_logic/immutability/with_constant/utils/reacalculate_owner_value.py +131 -0
- simplibs/object/mixins/_common_logic/immutability/with_constant/vaidations/__init__.py +16 -0
- simplibs/object/mixins/_common_logic/immutability/with_constant/vaidations/raise_immutability_constant_not_found.py +93 -0
- simplibs/object/mixins/_common_logic/immutability/with_constant/with_constant.py +147 -0
- simplibs/object/mixins/_common_logic/immutability/with_constants/__init__.py +17 -0
- simplibs/object/mixins/_common_logic/immutability/with_constants/utils/__init__.py +15 -0
- simplibs/object/mixins/_common_logic/immutability/with_constants/utils/find_longest_keys.py +112 -0
- simplibs/object/mixins/_common_logic/immutability/with_constants/vaidations/__init__.py +25 -0
- simplibs/object/mixins/_common_logic/immutability/with_constants/vaidations/raise_immutability_batch_constant_not_found.py +94 -0
- simplibs/object/mixins/_common_logic/immutability/with_constants/vaidations/raise_immutability_constants_changes_not_tuple.py +94 -0
- simplibs/object/mixins/_common_logic/immutability/with_constants/vaidations/validate_inner_tuple_has_length_two.py +91 -0
- simplibs/object/mixins/_common_logic/immutability/with_constants/vaidations/validate_inner_tuple_is_tuple.py +99 -0
- simplibs/object/mixins/_common_logic/immutability/with_constants/vaidations/validate_inner_tuple_name_is_str.py +90 -0
- simplibs/object/mixins/_common_logic/immutability/with_constants/with_constants.py +193 -0
- simplibs/object/mixins/base_class/SimpleMixin.py +118 -0
- simplibs/object/mixins/base_class/__init__.py +17 -0
- simplibs/object/mixins/base_class/_meta/SimpleMixinMeta.py +59 -0
- simplibs/object/mixins/base_class/_meta/__init__.py +21 -0
- simplibs/object/mixins/base_class/_meta/_verify_mixin_definition.py +161 -0
- simplibs/object/mixins/base_class/_meta/validations/__init__.py +34 -0
- simplibs/object/mixins/base_class/_meta/validations/raise_mixin_dict_contains_forbidden_attributes.py +101 -0
- simplibs/object/mixins/base_class/_meta/validations/raise_mixin_flag_is_not_bool.py +122 -0
- simplibs/object/mixins/base_class/_meta/validations/raise_mixin_init_mixins_contains_super_call.py +75 -0
- simplibs/object/mixins/base_class/_meta/validations/raise_mixin_only_types_invalid.py +107 -0
- simplibs/object/mixins/base_class/_meta/validations/raise_mixin_slots_contain_unvalid_type.py +85 -0
- simplibs/object/mixins/base_class/_meta/validations/raise_mixin_slots_contains_forbidden_slot_names.py +102 -0
- simplibs/object/mixins/base_class/_meta/validations/raise_mixin_slots_is_not_defined.py +79 -0
- simplibs/object/mixins/base_class/_meta/validations/raise_mixin_slots_unsuport_type.py +88 -0
- simplibs/object/mixins/core_mixins/Infrastructure.py +49 -0
- simplibs/object/mixins/core_mixins/NodesDicts.py +104 -0
- simplibs/object/mixins/core_mixins/NodesTuple.py +86 -0
- simplibs/object/mixins/core_mixins/Serialization.py +120 -0
- simplibs/object/mixins/core_mixins/Snapshot.py +104 -0
- simplibs/object/mixins/core_mixins/__init__.py +32 -0
- simplibs/object/mixins/core_mixins/_utils/__init__.py +49 -0
- simplibs/object/mixins/core_mixins/_utils/nodes_tuple/__init__.py +17 -0
- simplibs/object/mixins/core_mixins/_utils/nodes_tuple/_collect_nodes_data.py +131 -0
- simplibs/object/mixins/core_mixins/_utils/nodes_tuple/build_nodes_tuple.py +104 -0
- simplibs/object/mixins/core_mixins/_utils/serialization/__init__.py +20 -0
- simplibs/object/mixins/core_mixins/_utils/serialization/from_dict.py +190 -0
- simplibs/object/mixins/core_mixins/_utils/serialization/from_dict_constants.py +151 -0
- simplibs/object/mixins/core_mixins/_utils/serialization/to_dict.py +158 -0
- simplibs/object/mixins/core_mixins/_utils/serialization/validations/__init__.py +30 -0
- simplibs/object/mixins/core_mixins/_utils/serialization/validations/raise_invalid_composite_structure.py +65 -0
- simplibs/object/mixins/core_mixins/_utils/serialization/validations/raise_missing_composite_key.py +64 -0
- simplibs/object/mixins/core_mixins/_utils/serialization/validations/raise_missing_value_key.py +66 -0
- simplibs/object/mixins/core_mixins/_utils/serialization/validations/raise_unvalid_owner_class_mismatch_for_state_dict.py +77 -0
- simplibs/object/mixins/core_mixins/_utils/serialization/validations/raise_unvalid_state_dict_input.py +67 -0
- simplibs/object/mixins/core_mixins/_utils/snapshot/__init__.py +15 -0
- simplibs/object/mixins/core_mixins/_utils/snapshot/compare_snapshots.py +102 -0
- simplibs/object/mixins/core_mixins/_utils/snapshot/validations/__init__.py +16 -0
- simplibs/object/mixins/core_mixins/_utils/snapshot/validations/raise_snapshot_incompatible_error.py +101 -0
- simplibs/object/mixins/dunders/__init__.py +61 -0
- simplibs/object/mixins/dunders/collections/CollectionBase.py +129 -0
- simplibs/object/mixins/dunders/collections/Iterable.py +81 -0
- simplibs/object/mixins/dunders/collections/Mapping.py +131 -0
- simplibs/object/mixins/dunders/collections/__init__.py +29 -0
- simplibs/object/mixins/dunders/collections/main/Collection.py +47 -0
- simplibs/object/mixins/dunders/collections/main/__init__.py +20 -0
- simplibs/object/mixins/dunders/comparison/Equality.py +128 -0
- simplibs/object/mixins/dunders/comparison/Ordering.py +130 -0
- simplibs/object/mixins/dunders/comparison/__init__.py +25 -0
- simplibs/object/mixins/dunders/generics/ClassGetItem.py +105 -0
- simplibs/object/mixins/dunders/generics/__init__.py +20 -0
- simplibs/object/mixins/dunders/interfaces/Call.py +101 -0
- simplibs/object/mixins/dunders/interfaces/Context.py +100 -0
- simplibs/object/mixins/dunders/interfaces/__init__.py +23 -0
- simplibs/object/mixins/dunders/lifecycles/Copyable.py +103 -0
- simplibs/object/mixins/dunders/lifecycles/PickleReduce.py +88 -0
- simplibs/object/mixins/dunders/lifecycles/PickleState.py +104 -0
- simplibs/object/mixins/dunders/lifecycles/__init__.py +29 -0
- simplibs/object/mixins/dunders/lifecycles/_utils/__init__.py +20 -0
- simplibs/object/mixins/dunders/lifecycles/_utils/rebuild_simple_instance.py +51 -0
- simplibs/object/mixins/dunders/lifecycles/main/Lifecycle.py +45 -0
- simplibs/object/mixins/dunders/lifecycles/main/__init__.py +20 -0
- simplibs/object/mixins/dunders/numeric/Arithmetic.py +195 -0
- simplibs/object/mixins/dunders/numeric/Bitwise.py +172 -0
- simplibs/object/mixins/dunders/numeric/Conversion.py +149 -0
- simplibs/object/mixins/dunders/numeric/Inplace.py +124 -0
- simplibs/object/mixins/dunders/numeric/Unary.py +89 -0
- simplibs/object/mixins/dunders/numeric/__init__.py +31 -0
- simplibs/object/mixins/dunders/numeric/_utils/__init__.py +41 -0
- simplibs/object/mixins/dunders/numeric/_utils/_align_operand_type.py +111 -0
- simplibs/object/mixins/dunders/numeric/_utils/execute_arithmetic_op.py +157 -0
- simplibs/object/mixins/dunders/numeric/_utils/execute_bitwise_op.py +116 -0
- simplibs/object/mixins/dunders/numeric/_utils/execute_conversion.py +107 -0
- simplibs/object/mixins/dunders/numeric/_utils/execute_inplace_op.py +139 -0
- simplibs/object/mixins/dunders/numeric/_utils/execute_unary_op.py +121 -0
- simplibs/object/mixins/dunders/representation/ValueDisplay.py +96 -0
- simplibs/object/mixins/dunders/representation/ValueFormatting.py +144 -0
- simplibs/object/mixins/dunders/representation/__init__.py +24 -0
- simplibs/object/mixins/others/__init__.py +48 -0
- simplibs/object/mixins/others/immutable/ImmutableMethods.py +142 -0
- simplibs/object/mixins/others/immutable/ImmutableMethodsWithInners.py +111 -0
- simplibs/object/mixins/others/immutable/__init__.py +24 -0
- simplibs/object/mixins/others/immutable/_validations/__init__.py +19 -0
- simplibs/object/mixins/others/immutable/_validations/raise_with_changes_input_not_dict.py +60 -0
- simplibs/object/mixins/others/numerical/Equalizer.py +129 -0
- simplibs/object/mixins/others/numerical/Volume.py +100 -0
- simplibs/object/mixins/others/numerical/__init__.py +25 -0
- simplibs/object/mixins/others/numerical/_stepper_class/Stepper.py +227 -0
- simplibs/object/mixins/others/numerical/_stepper_class/__init__.py +31 -0
- simplibs/object/mixins/others/numerical/_stepper_class/methods/__init__.py +35 -0
- simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/__init__.py +33 -0
- simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/process_step_value.py +114 -0
- simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/validations/__init__.py +29 -0
- simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/validations/raise_stepper_down_limit_reached.py +115 -0
- simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/validations/raise_stepper_up_limit_reached.py +110 -0
- simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/verify_down_limit.py +141 -0
- simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/verify_up_limit.py +141 -0
- simplibs/object/mixins/others/numerical/_stepper_class/methods/set_value.py +163 -0
- simplibs/object/mixins/others/numerical/_stepper_class/methods/step_down.py +154 -0
- simplibs/object/mixins/others/numerical/_stepper_class/methods/step_up.py +154 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/__init__.py +38 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/process_down_limit_value.py +143 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/process_limit_action.py +118 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/process_up_limit_value.py +143 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/process_value.py +142 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/validate_instance.py +138 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/validations/__init__.py +39 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/validations/raise_stepper_invalid_action.py +118 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/validations/raise_stepper_invalid_down_limit.py +125 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/validations/raise_stepper_invalid_instance.py +117 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/validations/raise_stepper_invalid_up_limit.py +125 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/validations/raise_stepper_non_numeric_value.py +122 -0
- simplibs/object/mixins/others/properties/InnersProperty.py +91 -0
- simplibs/object/mixins/others/properties/MetaShortcuts.py +113 -0
- simplibs/object/mixins/others/properties/__init__.py +24 -0
- simplibs/object/mixins/others/properties/_inners_property_utils/__init__.py +23 -0
- simplibs/object/mixins/others/properties/_inners_property_utils/_collect_nested_inner_properties.py +134 -0
- simplibs/object/mixins/others/properties/_inners_property_utils/collect_all_nested_properties.py +132 -0
- simplibs/object/mixins/others/state/DefaultState.py +119 -0
- simplibs/object/mixins/others/state/DirtyTracking.py +144 -0
- simplibs/object/mixins/others/state/History.py +248 -0
- simplibs/object/mixins/others/state/Permission.py +102 -0
- simplibs/object/mixins/others/state/__init__.py +31 -0
- simplibs/object/mixins/others/state/_history_utils/__init__.py +50 -0
- simplibs/object/mixins/others/state/_history_utils/core/__init__.py +32 -0
- simplibs/object/mixins/others/state/_history_utils/core/find_snapshot.py +142 -0
- simplibs/object/mixins/others/state/_history_utils/core/record_state.py +130 -0
- simplibs/object/mixins/others/state/_history_utils/core/set_history_limit.py +114 -0
- simplibs/object/mixins/others/state/_history_utils/core/validations/__init__.py +31 -0
- simplibs/object/mixins/others/state/_history_utils/core/validations/raise_history_limit_not_positive_integer.py +65 -0
- simplibs/object/mixins/others/state/_history_utils/core/validations/raise_unvalide_snapshot_index.py +67 -0
- simplibs/object/mixins/others/state/_history_utils/core/validations/raise_unvalide_snopshot_reference.py +67 -0
- simplibs/object/mixins/others/state/_history_utils/core/validations/raise_unvalide_snopshot_timestamp.py +66 -0
- simplibs/object/mixins/others/state/_history_utils/core/validations/raise_unvalide_timestamp.py +63 -0
- simplibs/object/mixins/others/state/_history_utils/navigations/__init__.py +38 -0
- simplibs/object/mixins/others/state/_history_utils/navigations/go_to_history_on_index.py +103 -0
- simplibs/object/mixins/others/state/_history_utils/navigations/go_to_history_on_timestamp.py +115 -0
- simplibs/object/mixins/others/state/_history_utils/navigations/go_to_last_history.py +103 -0
- simplibs/object/mixins/others/state/_history_utils/navigations/history_redo.py +103 -0
- simplibs/object/mixins/others/state/_history_utils/navigations/history_undo.py +104 -0
- simplibs/object/mixins/others/state/_history_utils/transfer/__init__.py +31 -0
- simplibs/object/mixins/others/state/_history_utils/transfer/export_history_to_dict.py +110 -0
- simplibs/object/mixins/others/state/_history_utils/transfer/import_history_from_dict.py +169 -0
- simplibs/object/mixins/others/state/_history_utils/transfer/validations/__init__.py +24 -0
- simplibs/object/mixins/others/state/_history_utils/transfer/validations/raise_unvalide_history_import_file.py +66 -0
- simplibs/object/mixins/others/state/_history_utils/transfer/validations/raise_unvalide_owner_class_mismatch.py +69 -0
- simplibs/object/settings/__init__.py +90 -0
- simplibs/object/settings/logging.py +138 -0
- simplibs/object/testing/__init__.py +90 -0
- simplibs/object/testing/assert_simple_mixin.py +150 -0
- simplibs/object/testing/assert_simple_object.py +219 -0
- simplibs/object/testing/asserts/__init__.py +53 -0
- simplibs/object/testing/asserts/base/__init__.py +22 -0
- simplibs/object/testing/asserts/base/assert_class_inheritance.py +75 -0
- simplibs/object/testing/asserts/base/assert_instance_creation.py +119 -0
- simplibs/object/testing/asserts/base/assert_user_instance_creation.py +97 -0
- simplibs/object/testing/asserts/base/assert_value_change.py +142 -0
- simplibs/object/testing/asserts/methods/__init__.py +20 -0
- simplibs/object/testing/asserts/methods/assert_calculate_value_method.py +113 -0
- simplibs/object/testing/asserts/methods/assert_decompose_value_method.py +109 -0
- simplibs/object/testing/asserts/methods/assert_validate_method.py +111 -0
- simplibs/object/testing/asserts/mixins/__init__.py +22 -0
- simplibs/object/testing/asserts/mixins/assert_instance_hasattr.py +94 -0
- simplibs/object/testing/asserts/mixins/assert_mixin_inheritance.py +72 -0
- simplibs/object/testing/asserts/mixins/assert_mixin_instance_creation.py +142 -0
- simplibs/object/testing/asserts/mixins/assert_mixins_slots_values.py +126 -0
- simplibs/object/testing/asserts/mutability/__init__.py +18 -0
- simplibs/object/testing/asserts/mutability/assert_immutable_behavior.py +118 -0
- simplibs/object/testing/asserts/mutability/assert_mutable_behavior.py +108 -0
- simplibs/object/testing/asserts/reactivity/__init__.py +17 -0
- simplibs/object/testing/asserts/reactivity/assert_reactivity_downward.py +141 -0
- simplibs/object/testing/asserts/reactivity/assert_reactivity_upward.py +109 -0
- simplibs/object/testing/bulk_test.py +150 -0
- simplibs/object/testing/containers/InnerValue.py +102 -0
- simplibs/object/testing/containers/MixinCase.py +89 -0
- simplibs/object/testing/containers/ObjectCase.py +101 -0
- simplibs/object/testing/containers/TestMixin.py +122 -0
- simplibs/object/testing/containers/__init__.py +20 -0
- simplibs/object/testing/containers/_validations/__init__.py +18 -0
- simplibs/object/testing/containers/_validations/raise_inner_value_empty_path.py +39 -0
- simplibs/object/testing/containers/_validations/raise_inner_value_invalid_path_type.py +44 -0
- simplibs/object/tools/__init__.py +0 -0
- simplibs/object/tools/automate_creators/__init__.py +0 -0
- simplibs/object/tools/automate_creators/_helpers/__init__.py +5 -0
- simplibs/object/tools/automate_creators/_helpers/_is_lambda.py +34 -0
- simplibs/object/tools/automate_creators/_helpers/_validations/__init__.py +3 -0
- simplibs/object/tools/automate_creators/_helpers/_validations/raise_calculate_default_failed.py +51 -0
- simplibs/object/tools/automate_creators/_helpers/_validations/raise_inner_is_not_simple_constant_subclass.py +44 -0
- simplibs/object/tools/automate_creators/_helpers/_validations/raise_inners_is_not_tuple.py +41 -0
- simplibs/object/tools/automate_creators/_helpers/calculate_default.py +51 -0
- simplibs/object/tools/automate_creators/_helpers/load_parameters_from_inners.py +72 -0
- simplibs/object/tools/automate_creators/_helpers/process_decompose.py +47 -0
- simplibs/object/tools/automate_creators/_helpers/process_logic.py +57 -0
- simplibs/object/tools/automate_creators/_helpers/process_validate.py +48 -0
- simplibs/object/tools/automate_creators/_validations/__init__.py +7 -0
- simplibs/object/tools/automate_creators/_validations/validate_class_name_is_str.py +36 -0
- simplibs/object/tools/automate_creators/_validations/validate_composite_has_inners.py +43 -0
- simplibs/object/tools/automate_creators/_validations/validate_composite_has_logic.py +44 -0
- simplibs/object/tools/automate_creators/_validations/validate_composite_has_not_default.py +37 -0
- simplibs/object/tools/automate_creators/_validations/validate_constant_has_default.py +48 -0
- simplibs/object/tools/automate_creators/_validations/validate_constant_has_not_decompose.py +37 -0
- simplibs/object/tools/automate_creators/_validations/validate_constant_has_not_logic.py +37 -0
- simplibs/object/tools/automate_creators/bulk/BulkCase.py +100 -0
- simplibs/object/tools/automate_creators/bulk/__init__.py +0 -0
- simplibs/object/tools/automate_creators/bulk/create_simple_object_bulk.py +77 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/__init__.py +0 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/__init__.py +8 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_csv_callable_not_supported.py +26 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_data_not_list.py +28 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_decode_failed.py +29 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_input_not_sequence.py +27 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_input_not_str.py +28 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_item_is_not_bulk_dict.py +39 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_table_row_not_sequence.py +26 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_yaml_import_failed.py +22 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/create_simple_object_bulk_from_bulk_case_class.py +57 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/create_simple_object_bulk_from_csv.py +68 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/create_simple_object_bulk_from_dicts.py +19 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/create_simple_object_bulk_from_json.py +24 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/create_simple_object_bulk_from_table.py +43 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/create_simple_object_bulk_from_yaml.py +29 -0
- simplibs/object/tools/automate_creators/create_constant_class.py +84 -0
- simplibs/object/tools/automate_creators/create_object_class.py +110 -0
- simplibs/object/tools/automate_creators/create_simple_object.py +97 -0
- simplibs/object/tools/randomize/__init__.py +18 -0
- simplibs/object/tools/randomize/_validations/__init__.py +28 -0
- simplibs/object/tools/randomize/_validations/raise_random_data_filler_exhausted.py +55 -0
- simplibs/object/tools/randomize/_validations/validate_instance_is_simple_constant_base.py +52 -0
- simplibs/object/tools/randomize/_validations/validate_registry_is_randomize_registry_base.py +51 -0
- simplibs/object/tools/randomize/_validations/validate_retries_is_greater_than_zero.py +48 -0
- simplibs/object/tools/randomize/_validations/validate_retries_is_int.py +49 -0
- simplibs/object/tools/randomize/_validations/validate_skip_immutable_is_bool.py +43 -0
- simplibs/object/tools/randomize/_validations/validate_skip_unregistered_is_bool.py +44 -0
- simplibs/object/tools/randomize/random_data_filler.py +133 -0
- simplibs/object/tools/randomize/randomize_value.py +122 -0
- simplibs_object-0.1.1.dist-info/METADATA +590 -0
- simplibs_object-0.1.1.dist-info/RECORD +580 -0
- simplibs_object-0.1.1.dist-info/WHEEL +5 -0
- simplibs_object-0.1.1.dist-info/licenses/LICENSE +21 -0
- simplibs_object-0.1.1.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
from typing import Any, TYPE_CHECKING
|
|
2
|
+
from simplibs.sentinels import UNSET
|
|
3
|
+
# Outers
|
|
4
|
+
from ...._common_logic.constants import VALUE
|
|
5
|
+
from ...._common_logic.immutability import with_constants
|
|
6
|
+
# Inners
|
|
7
|
+
from .validations import raise_unvalid_state_dict_input
|
|
8
|
+
# Annotations
|
|
9
|
+
if TYPE_CHECKING:
|
|
10
|
+
from ....._core.protocols.mixins.core_mixins import SerializationProtocol
|
|
11
|
+
from ....._core.protocols.alias_typings import StateDict
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
def from_dict_constants(
|
|
15
|
+
self: "SerializationProtocol",
|
|
16
|
+
user_dict: "StateDict",
|
|
17
|
+
) -> "SerializationProtocol":
|
|
18
|
+
"""
|
|
19
|
+
Updates the object's constant (atomic) values from a partial or full dictionary.
|
|
20
|
+
|
|
21
|
+
Automatically detects the object's operational mode:
|
|
22
|
+
- Mutable mode: updates values in-place.
|
|
23
|
+
- Immutable mode: returns a new instance with applied changes.
|
|
24
|
+
"""
|
|
25
|
+
|
|
26
|
+
# 1. Validate dictionary input
|
|
27
|
+
if not isinstance(user_dict, dict):
|
|
28
|
+
raise_unvalid_state_dict_input(self, user_dict)
|
|
29
|
+
|
|
30
|
+
# 2. Prepare list for collecting changes (immutable mode)
|
|
31
|
+
changes: list[tuple[str, object]] = []
|
|
32
|
+
|
|
33
|
+
# 3. Traverse all nodes and search for values
|
|
34
|
+
for instance, path in self._nodes_tuple:
|
|
35
|
+
|
|
36
|
+
# 3.1 Skip composite VALUE nodes (only pure constants matter)
|
|
37
|
+
if path and path[-1] == VALUE:
|
|
38
|
+
continue
|
|
39
|
+
|
|
40
|
+
name = instance.meta.name_snake
|
|
41
|
+
|
|
42
|
+
# 3.2 Direct lookup by atom name first, then fallback to nested path traversal
|
|
43
|
+
if name in user_dict:
|
|
44
|
+
current = user_dict[name]
|
|
45
|
+
else:
|
|
46
|
+
target_path = path if path else (name,)
|
|
47
|
+
current = user_dict
|
|
48
|
+
for key in target_path:
|
|
49
|
+
current = current.get(key, UNSET)
|
|
50
|
+
if not isinstance(current, dict) and key != target_path[-1]:
|
|
51
|
+
current = UNSET
|
|
52
|
+
break
|
|
53
|
+
|
|
54
|
+
# 3.3 If a value was found → branch based on mutability
|
|
55
|
+
if current is not UNSET:
|
|
56
|
+
|
|
57
|
+
# 3.3.1 MUTABLE MODE → write directly in-place
|
|
58
|
+
if self.__is_mutable__:
|
|
59
|
+
instance.value = current
|
|
60
|
+
|
|
61
|
+
# 3.3.2 IMMUTABLE MODE → collect changes for batch update
|
|
62
|
+
else:
|
|
63
|
+
changes.append((name, current))
|
|
64
|
+
|
|
65
|
+
# 4. Handle mutable mode (and immutable mode with no changes)
|
|
66
|
+
if self.__is_mutable__ or not changes:
|
|
67
|
+
return self
|
|
68
|
+
|
|
69
|
+
# 5. Handle immutable mode with collected changes
|
|
70
|
+
return with_constants(self, tuple(changes))
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
_DESIGN_NOTES = """
|
|
74
|
+
# from_dict_constants
|
|
75
|
+
|
|
76
|
+
## Purpose
|
|
77
|
+
Updates only the **constant (atomic)** values of an object using a partial or
|
|
78
|
+
full dictionary. This function is the lightweight counterpart to `from_dict`,
|
|
79
|
+
focusing exclusively on constants and ignoring composite VALUE nodes.
|
|
80
|
+
|
|
81
|
+
It supports both operational modes:
|
|
82
|
+
|
|
83
|
+
- **mutable mode** — updates values directly in-place
|
|
84
|
+
- **immutable mode** — returns a new instance with updated constants
|
|
85
|
+
|
|
86
|
+
This makes it ideal for targeted updates where only atomic values change.
|
|
87
|
+
|
|
88
|
+
## Architectural role
|
|
89
|
+
`from_dict_constants` is used by:
|
|
90
|
+
|
|
91
|
+
- `SerializationMixin` (`update_constants`)
|
|
92
|
+
- immutability pipelines (`with_constants`)
|
|
93
|
+
- debugging tools
|
|
94
|
+
- partial state restoration
|
|
95
|
+
- external integrations (patch-like updates)
|
|
96
|
+
|
|
97
|
+
It provides a safe and deterministic way to update constants without touching
|
|
98
|
+
composite structure.
|
|
99
|
+
|
|
100
|
+
## Traversal logic
|
|
101
|
+
The function walks through `_nodes_tuple` and:
|
|
102
|
+
|
|
103
|
+
1. **skips composite VALUE nodes**, because constants are the only target
|
|
104
|
+
2. **supports both flat and nested keys**:
|
|
105
|
+
- first checks for the direct node name (`instance.meta.name_snake`) at top-level
|
|
106
|
+
- falls back to traversing full structural path (`target_path`)
|
|
107
|
+
3. **safely handles standalone atoms** with empty paths
|
|
108
|
+
4. **collects or applies values** depending on mutability
|
|
109
|
+
|
|
110
|
+
This flexibility allows callers to pass either flat updates (`{"first": 10}`)
|
|
111
|
+
or deeply nested structures (`{"pair": {"first": 10}}`).
|
|
112
|
+
|
|
113
|
+
## Mutable vs immutable behavior
|
|
114
|
+
### Mutable mode
|
|
115
|
+
- values are written directly into the existing instance
|
|
116
|
+
- no new object is created
|
|
117
|
+
- changes happen immediately
|
|
118
|
+
|
|
119
|
+
### Immutable mode
|
|
120
|
+
- changes are collected into a list of `(name, value)` pairs
|
|
121
|
+
- `with_constants(self, changes)` creates a new instance
|
|
122
|
+
- original instance remains unchanged
|
|
123
|
+
|
|
124
|
+
This dual behavior is consistent with the entire Simple object model.
|
|
125
|
+
|
|
126
|
+
## Partial dictionary support
|
|
127
|
+
The function accepts **partial dictionaries**:
|
|
128
|
+
|
|
129
|
+
- missing constants are ignored
|
|
130
|
+
- only provided constants are updated
|
|
131
|
+
- composite structure is not required
|
|
132
|
+
|
|
133
|
+
This makes it ideal for patch operations.
|
|
134
|
+
|
|
135
|
+
## Stability guarantee
|
|
136
|
+
This function is a core part of the Simple serialization subsystem.
|
|
137
|
+
Any change affects:
|
|
138
|
+
|
|
139
|
+
- constant updates
|
|
140
|
+
- immutability pipelines
|
|
141
|
+
- JSON import
|
|
142
|
+
- debugging tools
|
|
143
|
+
- external integrations
|
|
144
|
+
|
|
145
|
+
Therefore, `from_dict_constants` is treated as a **structural invariant**.
|
|
146
|
+
|
|
147
|
+
## Notes
|
|
148
|
+
- This function is intentionally low-level and not part of the public API.
|
|
149
|
+
- All structural logic is delegated to `_nodes_tuple`.
|
|
150
|
+
- All immutable update logic is delegated to `with_constants`.
|
|
151
|
+
"""
|
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
from typing import Any, TYPE_CHECKING
|
|
2
|
+
from simplibs.sentinels import UNSET
|
|
3
|
+
# Outers
|
|
4
|
+
from ...._common_logic.constants import OWNER_CLASS, VALUE
|
|
5
|
+
# Annotations
|
|
6
|
+
if TYPE_CHECKING:
|
|
7
|
+
from ....._core.protocols.mixins.core_mixins import SerializationProtocol
|
|
8
|
+
from ....._core.protocols.alias_typings import StateDict
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
def to_dict(
|
|
12
|
+
self: "SerializationProtocol",
|
|
13
|
+
*,
|
|
14
|
+
constant_only: bool = False,
|
|
15
|
+
) -> "StateDict":
|
|
16
|
+
"""
|
|
17
|
+
Serializes the instance into a readable dictionary structure.
|
|
18
|
+
Composite nodes are expanded into nested dictionaries according to their
|
|
19
|
+
structural path in `nodes_tuple`.
|
|
20
|
+
"""
|
|
21
|
+
|
|
22
|
+
# 1. Define base variables with serializable class name
|
|
23
|
+
result = {OWNER_CLASS: self.meta.class_name}
|
|
24
|
+
last_composite_key = UNSET
|
|
25
|
+
last_composite_dict = {}
|
|
26
|
+
|
|
27
|
+
# 2. Iterate through nodes_tuple in structural order
|
|
28
|
+
for instance, path in self._nodes_tuple:
|
|
29
|
+
|
|
30
|
+
# 2.1 Define per-node variables
|
|
31
|
+
value = instance._value
|
|
32
|
+
current_dict = result
|
|
33
|
+
last_key = path[0] if path else instance.meta.name_snake
|
|
34
|
+
|
|
35
|
+
# 2.2 Handle composite nodes (non-root)
|
|
36
|
+
if len(path) > 1:
|
|
37
|
+
|
|
38
|
+
# 2.2.1 Extract last and second-to-last keys
|
|
39
|
+
last_key = path[-1]
|
|
40
|
+
before_last_key = path[-2]
|
|
41
|
+
|
|
42
|
+
# 2.2.2 Reuse previously cached composite dictionary
|
|
43
|
+
if last_composite_key == before_last_key:
|
|
44
|
+
current_dict = last_composite_dict
|
|
45
|
+
|
|
46
|
+
# 2.2.3 Create a new composite dictionary
|
|
47
|
+
else:
|
|
48
|
+
|
|
49
|
+
# 2.2.3.1 Build nested structure for all keys except the last
|
|
50
|
+
for key in path[:-1]:
|
|
51
|
+
current_dict = current_dict.setdefault(key, {})
|
|
52
|
+
|
|
53
|
+
# 2.2.3.2 Cache composite dictionary for next iteration
|
|
54
|
+
if last_key == VALUE:
|
|
55
|
+
last_composite_key = before_last_key
|
|
56
|
+
last_composite_dict = current_dict
|
|
57
|
+
|
|
58
|
+
# 2.3 Write the node value (unless filtered out)
|
|
59
|
+
if not (constant_only and last_key == VALUE):
|
|
60
|
+
current_dict[last_key] = value
|
|
61
|
+
|
|
62
|
+
# 3. Return the final dictionary
|
|
63
|
+
return result
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
_DESIGN_NOTES = """
|
|
67
|
+
# to_dict
|
|
68
|
+
|
|
69
|
+
## Purpose
|
|
70
|
+
Converts an instance into a structured dictionary representation based on
|
|
71
|
+
`nodes_tuple`. This dictionary is the foundation for JSON serialization,
|
|
72
|
+
snapshot creation, debugging tools, immutability pipelines, and history
|
|
73
|
+
tracking.
|
|
74
|
+
|
|
75
|
+
The function stores `self.meta.class_name` under the `OWNER_CLASS` key ensuring
|
|
76
|
+
complete JSON serialization compatibility. Composite nodes are expanded into nested
|
|
77
|
+
dictionaries according to their structural path, while constants remain as flat
|
|
78
|
+
key-value pairs (or fallback to their `name_snake` identity for standalone atoms with
|
|
79
|
+
empty paths).
|
|
80
|
+
|
|
81
|
+
## Architectural role
|
|
82
|
+
`to_dict` is a core export mechanism used by:
|
|
83
|
+
|
|
84
|
+
- `SerializationMixin` (public API: `to_dict`, `to_json`)
|
|
85
|
+
- `SnapshotMixin` (snapshot creation)
|
|
86
|
+
- `HistoryMixin` (state diffs)
|
|
87
|
+
- immutability helpers (building new instances)
|
|
88
|
+
- debugging utilities (printing internal state)
|
|
89
|
+
- JSON pipelines (external integrations)
|
|
90
|
+
|
|
91
|
+
It provides a **deterministic**, **stable**, and **structure-aware** view of the
|
|
92
|
+
entire object tree.
|
|
93
|
+
|
|
94
|
+
## How it works
|
|
95
|
+
The function iterates through `nodes_tuple`, which contains `(instance, path)`
|
|
96
|
+
pairs describing the full object structure.
|
|
97
|
+
|
|
98
|
+
For each node:
|
|
99
|
+
|
|
100
|
+
1. **Determine the dictionary level & key**
|
|
101
|
+
Standalone atom nodes (`path == ()`) resolve their key from `instance.meta.name_snake`.
|
|
102
|
+
Composite nodes require nested dictionaries based on their structural path.
|
|
103
|
+
|
|
104
|
+
2. **Reuse composite dictionaries**
|
|
105
|
+
To avoid repeatedly reconstructing nested structures, the function caches
|
|
106
|
+
the last composite dictionary (`last_composite_dict`) and reuses it when
|
|
107
|
+
possible.
|
|
108
|
+
|
|
109
|
+
3. **Write the node value**
|
|
110
|
+
Constants are written directly. Composite nodes write their `_value` under
|
|
111
|
+
the `VALUE` key.
|
|
112
|
+
|
|
113
|
+
4. **Optional filtering**
|
|
114
|
+
When `constant_only=True`, composite nodes are skipped.
|
|
115
|
+
|
|
116
|
+
## Deterministic output
|
|
117
|
+
The resulting dictionary is:
|
|
118
|
+
|
|
119
|
+
- **stable** — identical for identical instance structures,
|
|
120
|
+
- **ordered** — follows the order of `nodes_tuple`,
|
|
121
|
+
- **structurally faithful** — mirrors the composite hierarchy,
|
|
122
|
+
- **safe for JSON** — contains only primitive values, strings, and nested dicts.
|
|
123
|
+
|
|
124
|
+
This determinism is essential for snapshot comparison, diffing, and immutability.
|
|
125
|
+
|
|
126
|
+
## Why composite caching exists
|
|
127
|
+
Without caching, each composite node would reconstruct its nested dictionary
|
|
128
|
+
structure from scratch, causing:
|
|
129
|
+
|
|
130
|
+
- unnecessary allocations,
|
|
131
|
+
- slower serialization,
|
|
132
|
+
- inconsistent dictionary identity,
|
|
133
|
+
- increased GC pressure.
|
|
134
|
+
|
|
135
|
+
Caching ensures:
|
|
136
|
+
|
|
137
|
+
- linear performance,
|
|
138
|
+
- predictable behavior,
|
|
139
|
+
- minimal memory churn.
|
|
140
|
+
|
|
141
|
+
## Stability guarantee
|
|
142
|
+
Any change to this function would affect:
|
|
143
|
+
|
|
144
|
+
- JSON output,
|
|
145
|
+
- snapshot creation,
|
|
146
|
+
- immutability pipelines,
|
|
147
|
+
- history tracking,
|
|
148
|
+
- debugging tools,
|
|
149
|
+
- serialization consistency.
|
|
150
|
+
|
|
151
|
+
Therefore, `to_dict` is treated as a **core invariant** of the Simple system.
|
|
152
|
+
|
|
153
|
+
## Notes
|
|
154
|
+
- This function is intentionally low-level and not part of the public API.
|
|
155
|
+
- All structural logic is delegated to `nodes_tuple`.
|
|
156
|
+
- Supports standalone atoms where `path` is empty (`()`).
|
|
157
|
+
- All composite logic is based on the `VALUE` constant.
|
|
158
|
+
"""
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
from .raise_unvalid_state_dict_input import raise_unvalid_state_dict_input
|
|
2
|
+
from .raise_unvalid_owner_class_mismatch_for_state_dict import raise_unvalid_owner_class_mismatch_for_state_dict
|
|
3
|
+
from .raise_missing_composite_key import raise_missing_composite_key
|
|
4
|
+
from .raise_invalid_composite_structure import raise_invalid_composite_structure
|
|
5
|
+
from .raise_missing_value_key import raise_missing_value_key
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
_DESIGN_NOTES = """
|
|
9
|
+
# Validations for Serialization (from_dict)
|
|
10
|
+
|
|
11
|
+
## Purpose
|
|
12
|
+
Provides structured raise functions used by the universal state reconstruction
|
|
13
|
+
pipeline (`from_dict`). These validations ensure that:
|
|
14
|
+
|
|
15
|
+
- the input container is a valid dictionary,
|
|
16
|
+
- the owner class matches the expected component type,
|
|
17
|
+
- composite branches contain all required nested keys,
|
|
18
|
+
- composite structures are valid dictionaries,
|
|
19
|
+
- atomic VALUE keys are present and correct.
|
|
20
|
+
|
|
21
|
+
## Components
|
|
22
|
+
|
|
23
|
+
| Component | Type | Description |
|
|
24
|
+
| :-------------------------------------------------- | :------- | :------------------------------------------------------- |
|
|
25
|
+
| `raise_unvalid_state_dict_input` | Function | Ensures the input is a dictionary. |
|
|
26
|
+
| `raise_unvalid_owner_class_mismatch_for_state_dict` | Function | Validates owner class identity. |
|
|
27
|
+
| `raise_missing_composite_key` | Function | Raised when a composite branch key is missing. |
|
|
28
|
+
| `raise_invalid_composite_structure` | Function | Raised when a composite branch is not a dictionary. |
|
|
29
|
+
| `raise_missing_value_key` | Function | Raised when the final VALUE key is missing. |
|
|
30
|
+
"""
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING, NoReturn, Any
|
|
2
|
+
# Outers
|
|
3
|
+
from ......exceptions import SimpleRuntimeError
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ......_core.protocols.mixins.core_mixins import SerializationProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def raise_invalid_composite_structure(
|
|
10
|
+
instance: "SerializationProtocol",
|
|
11
|
+
key: str,
|
|
12
|
+
value: Any,
|
|
13
|
+
full_path: tuple[str, ...],
|
|
14
|
+
) -> NoReturn:
|
|
15
|
+
"""
|
|
16
|
+
Raises an error when a composite dictionary branch contains an invalid
|
|
17
|
+
structure (expected a dictionary, got something else).
|
|
18
|
+
"""
|
|
19
|
+
|
|
20
|
+
raise SimpleRuntimeError(
|
|
21
|
+
error_name="STATE DICT INVALID COMPOSITE STRUCTURE",
|
|
22
|
+
label="composite structure",
|
|
23
|
+
expected=f"A dictionary at key '{key}'.",
|
|
24
|
+
value=repr(value),
|
|
25
|
+
problem=(
|
|
26
|
+
"Invalid structure encountered in composite branch.",
|
|
27
|
+
f"Expected a dictionary at key '{key}', but got {type(value).__name__}."
|
|
28
|
+
),
|
|
29
|
+
context=(
|
|
30
|
+
f"State import attempted on instance '{type(instance).__name__}'.",
|
|
31
|
+
f"Traversal path: {full_path}",
|
|
32
|
+
"Composite nodes must be represented as nested dictionaries."
|
|
33
|
+
),
|
|
34
|
+
how_to_fix=(
|
|
35
|
+
"Ensure that all composite branches in the state dictionary are dictionaries.",
|
|
36
|
+
"Use `to_dict()` to generate a correct nested structure.",
|
|
37
|
+
"Verify that no composite node was replaced by a scalar or list."
|
|
38
|
+
),
|
|
39
|
+
exception=KeyError,
|
|
40
|
+
)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
_DESIGN_NOTES = """
|
|
44
|
+
# raise_invalid_composite_structure
|
|
45
|
+
|
|
46
|
+
## Purpose
|
|
47
|
+
Raises a structured error when a composite dictionary branch contains a value
|
|
48
|
+
that is not a dictionary, even though the structural path requires one.
|
|
49
|
+
|
|
50
|
+
## Why this validation exists
|
|
51
|
+
Composite nodes represent nested structures.
|
|
52
|
+
If any branch is not a dictionary, the object cannot be reconstructed safely.
|
|
53
|
+
|
|
54
|
+
Failing early ensures:
|
|
55
|
+
- structural correctness,
|
|
56
|
+
- predictable deserialization,
|
|
57
|
+
- clear diagnostics.
|
|
58
|
+
|
|
59
|
+
## Execution context
|
|
60
|
+
Used inside `from_dict` during traversal of nested composite dictionaries.
|
|
61
|
+
|
|
62
|
+
## Notes
|
|
63
|
+
- Pure raise function, no conditional logic.
|
|
64
|
+
- Used exclusively by the Serialization mixin.
|
|
65
|
+
"""
|
simplibs/object/mixins/core_mixins/_utils/serialization/validations/raise_missing_composite_key.py
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING, NoReturn
|
|
2
|
+
# Outers
|
|
3
|
+
from ......exceptions import SimpleRuntimeError
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ......_core.protocols.mixins.core_mixins import SerializationProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def raise_missing_composite_key(
|
|
10
|
+
instance: "SerializationProtocol",
|
|
11
|
+
missing_key: str,
|
|
12
|
+
full_path: tuple[str, ...],
|
|
13
|
+
) -> NoReturn:
|
|
14
|
+
"""
|
|
15
|
+
Raises an error when a required composite dictionary key is missing
|
|
16
|
+
during state reconstruction.
|
|
17
|
+
"""
|
|
18
|
+
|
|
19
|
+
raise SimpleRuntimeError(
|
|
20
|
+
error_name="STATE DICT MISSING KEY",
|
|
21
|
+
label="composite key",
|
|
22
|
+
expected=f"Key '{missing_key}' to exist in nested dictionary structure.",
|
|
23
|
+
value=missing_key,
|
|
24
|
+
problem=(
|
|
25
|
+
"A required key is missing in the composite branch of the state dictionary.",
|
|
26
|
+
f"The key '{missing_key}' was expected but not found."
|
|
27
|
+
),
|
|
28
|
+
context=(
|
|
29
|
+
f"State import attempted on instance '{type(instance).__name__}'.",
|
|
30
|
+
f"Traversal path: {full_path}",
|
|
31
|
+
"Composite nodes must contain all required nested keys."
|
|
32
|
+
),
|
|
33
|
+
how_to_fix=(
|
|
34
|
+
"Ensure the state dictionary contains all composite keys according to the object's structure.",
|
|
35
|
+
"Use `to_dict()` to generate a correct structure.",
|
|
36
|
+
"Verify that nested dictionaries are complete and not partially missing."
|
|
37
|
+
),
|
|
38
|
+
exception=KeyError,
|
|
39
|
+
)
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
_DESIGN_NOTES = """
|
|
43
|
+
# raise_missing_composite_key
|
|
44
|
+
|
|
45
|
+
## Purpose
|
|
46
|
+
Raises a structured error when a composite dictionary branch is missing a key
|
|
47
|
+
required by the `_nodes_tuple` structural path.
|
|
48
|
+
|
|
49
|
+
## Why this validation exists
|
|
50
|
+
Composite nodes represent nested structures.
|
|
51
|
+
If any key in the path is missing, the object cannot be reconstructed safely.
|
|
52
|
+
|
|
53
|
+
Failing early ensures:
|
|
54
|
+
- structural correctness,
|
|
55
|
+
- predictable deserialization,
|
|
56
|
+
- clear diagnostics.
|
|
57
|
+
|
|
58
|
+
## Execution context
|
|
59
|
+
Used inside `from_dict` during traversal of nested composite dictionaries.
|
|
60
|
+
|
|
61
|
+
## Notes
|
|
62
|
+
- Pure raise function, no conditional logic.
|
|
63
|
+
- Used exclusively by the Serialization mixin.
|
|
64
|
+
"""
|
simplibs/object/mixins/core_mixins/_utils/serialization/validations/raise_missing_value_key.py
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING, NoReturn
|
|
2
|
+
# Outers
|
|
3
|
+
from ......exceptions import SimpleRuntimeError
|
|
4
|
+
from simplibs.sentinels import UNSET
|
|
5
|
+
|
|
6
|
+
# Annotations
|
|
7
|
+
if TYPE_CHECKING:
|
|
8
|
+
from ......_core.protocols.mixins.core_mixins import SerializationProtocol
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
def raise_missing_value_key(
|
|
12
|
+
instance: "SerializationProtocol",
|
|
13
|
+
missing_key: str,
|
|
14
|
+
full_path: tuple[str, ...],
|
|
15
|
+
) -> NoReturn:
|
|
16
|
+
"""
|
|
17
|
+
Raises an error when a required value key is missing in the state dictionary
|
|
18
|
+
during reconstruction.
|
|
19
|
+
"""
|
|
20
|
+
|
|
21
|
+
raise SimpleRuntimeError(
|
|
22
|
+
error_name="STATE DICT MISSING VALUE KEY",
|
|
23
|
+
label="value key",
|
|
24
|
+
expected=f"Key '{missing_key}' to exist in the dictionary.",
|
|
25
|
+
value=missing_key,
|
|
26
|
+
problem=(
|
|
27
|
+
"A required value key is missing in the state dictionary.",
|
|
28
|
+
f"The key '{missing_key}' was expected but not found."
|
|
29
|
+
),
|
|
30
|
+
context=(
|
|
31
|
+
f"State import attempted on instance '{type(instance).__name__}'.",
|
|
32
|
+
f"Traversal path: {full_path}",
|
|
33
|
+
"Atomic VALUE nodes must contain their final key."
|
|
34
|
+
),
|
|
35
|
+
how_to_fix=(
|
|
36
|
+
"Ensure the state dictionary contains all required VALUE keys.",
|
|
37
|
+
"Use `to_dict()` to generate a correct structure.",
|
|
38
|
+
"Verify that no VALUE field is missing or removed."
|
|
39
|
+
),
|
|
40
|
+
exception=KeyError,
|
|
41
|
+
)
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
_DESIGN_NOTES = """
|
|
45
|
+
# raise_missing_value_key
|
|
46
|
+
|
|
47
|
+
## Purpose
|
|
48
|
+
Raises a structured error when the final key of a composite path (the VALUE key)
|
|
49
|
+
is missing in the state dictionary.
|
|
50
|
+
|
|
51
|
+
## Why this validation exists
|
|
52
|
+
Every atomic node must have a final VALUE key.
|
|
53
|
+
If it is missing, the object cannot be reconstructed safely.
|
|
54
|
+
|
|
55
|
+
Failing early ensures:
|
|
56
|
+
- structural correctness,
|
|
57
|
+
- predictable deserialization,
|
|
58
|
+
- clear diagnostics.
|
|
59
|
+
|
|
60
|
+
## Execution context
|
|
61
|
+
Used inside `from_dict` during the final step of composite traversal.
|
|
62
|
+
|
|
63
|
+
## Notes
|
|
64
|
+
- Pure raise function, no conditional logic.
|
|
65
|
+
- Used exclusively by the Serialization mixin.
|
|
66
|
+
"""
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING, NoReturn, Any
|
|
2
|
+
# Outers
|
|
3
|
+
from ......exceptions import SimpleRuntimeError
|
|
4
|
+
from simplibs.sentinels import UNSET
|
|
5
|
+
|
|
6
|
+
# Annotations
|
|
7
|
+
if TYPE_CHECKING:
|
|
8
|
+
from ......_core.protocols.mixins.core_mixins import SerializationProtocol
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
def raise_unvalid_owner_class_mismatch_for_state_dict(
|
|
12
|
+
instance: "SerializationProtocol",
|
|
13
|
+
got_owner_class: Any,
|
|
14
|
+
) -> NoReturn:
|
|
15
|
+
"""
|
|
16
|
+
Raises an error when the imported state dictionary belongs to a different
|
|
17
|
+
owner class than the current instance.
|
|
18
|
+
"""
|
|
19
|
+
expected_owner_class = instance.meta.owner_class
|
|
20
|
+
|
|
21
|
+
raise SimpleRuntimeError(
|
|
22
|
+
error_name="STATE DICT OWNER CLASS MISMATCH",
|
|
23
|
+
label="owner_class",
|
|
24
|
+
expected=f"Owner class: {expected_owner_class!r}",
|
|
25
|
+
value=repr(got_owner_class),
|
|
26
|
+
problem=(
|
|
27
|
+
"Imported state dictionary belongs to a different class.",
|
|
28
|
+
"State reconstruction requires exact owner class identity."
|
|
29
|
+
),
|
|
30
|
+
context=(
|
|
31
|
+
f"State import attempted on instance '{type(instance).__name__}'.",
|
|
32
|
+
f"Expected owner class: {expected_owner_class!r}",
|
|
33
|
+
f"Got owner class: {got_owner_class!r}",
|
|
34
|
+
(
|
|
35
|
+
"Note: If the value is UNSET, the dictionary is missing the "
|
|
36
|
+
"required OWNER_CLASS field."
|
|
37
|
+
if got_owner_class is UNSET else ""
|
|
38
|
+
)
|
|
39
|
+
),
|
|
40
|
+
how_to_fix=(
|
|
41
|
+
"Ensure the dictionary was produced by the same class.",
|
|
42
|
+
"Use `to_dict()` or `export_history_to_dict()` on an instance of the correct type.",
|
|
43
|
+
"Do not mix state dictionaries between different component classes.",
|
|
44
|
+
"Verify that OWNER_CLASS is present and correct in the input dictionary."
|
|
45
|
+
),
|
|
46
|
+
exception=ValueError,
|
|
47
|
+
)
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
_DESIGN_NOTES = """
|
|
51
|
+
# raise_unvalid_owner_class_mismatch_for_state_dict
|
|
52
|
+
|
|
53
|
+
## Purpose
|
|
54
|
+
Raises a structured error when the user attempts to reconstruct instance state
|
|
55
|
+
from a dictionary that belongs to a different owner class.
|
|
56
|
+
|
|
57
|
+
## Why this validation exists
|
|
58
|
+
State dictionaries encode structural metadata tied to the component class.
|
|
59
|
+
Importing state from a different class would cause:
|
|
60
|
+
|
|
61
|
+
- corrupted internal structure,
|
|
62
|
+
- invalid node traversal,
|
|
63
|
+
- mismatched VALUE fields,
|
|
64
|
+
- unpredictable behavior.
|
|
65
|
+
|
|
66
|
+
Failing early ensures:
|
|
67
|
+
- structural safety,
|
|
68
|
+
- deterministic behavior,
|
|
69
|
+
- clear diagnostics.
|
|
70
|
+
|
|
71
|
+
## Execution context
|
|
72
|
+
Used inside `from_dict` immediately after validating the input container.
|
|
73
|
+
|
|
74
|
+
## Notes
|
|
75
|
+
- Pure raise function, no conditional logic.
|
|
76
|
+
- Used exclusively by the Serialization mixin.
|
|
77
|
+
"""
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING, NoReturn
|
|
2
|
+
# Outers
|
|
3
|
+
from ......exceptions import SimpleRuntimeError
|
|
4
|
+
|
|
5
|
+
# Annotations
|
|
6
|
+
if TYPE_CHECKING:
|
|
7
|
+
from ......_core.protocols.mixins.core_mixins import SerializationProtocol
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
def raise_unvalid_state_dict_input(
|
|
11
|
+
instance: "SerializationProtocol",
|
|
12
|
+
value: object,
|
|
13
|
+
) -> NoReturn:
|
|
14
|
+
"""
|
|
15
|
+
Raises an error when the provided state dictionary is not a valid dict.
|
|
16
|
+
"""
|
|
17
|
+
|
|
18
|
+
raise SimpleRuntimeError(
|
|
19
|
+
error_name="STATE DICT INPUT ERROR",
|
|
20
|
+
label="state dictionary",
|
|
21
|
+
expected="A dictionary mapping node paths to values.",
|
|
22
|
+
value=repr(value),
|
|
23
|
+
problem=(
|
|
24
|
+
"Invalid input provided for state reconstruction.",
|
|
25
|
+
"State import requires a dictionary structure."
|
|
26
|
+
),
|
|
27
|
+
context=(
|
|
28
|
+
f"State import attempted on instance '{type(instance).__name__}'.",
|
|
29
|
+
f"Provided value type: {type(value).__name__}"
|
|
30
|
+
),
|
|
31
|
+
how_to_fix=(
|
|
32
|
+
"Ensure the input is a dictionary.",
|
|
33
|
+
"Use `to_dict()` or `export_history_to_dict()` to generate valid structures.",
|
|
34
|
+
"Do not pass lists, tuples, strings, or other unsupported types."
|
|
35
|
+
),
|
|
36
|
+
exception=TypeError,
|
|
37
|
+
)
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
_DESIGN_NOTES = """
|
|
41
|
+
# raise_unvalid_state_dict_input
|
|
42
|
+
|
|
43
|
+
## Purpose
|
|
44
|
+
Raises a structured error when the user attempts to reconstruct instance state
|
|
45
|
+
from a value that is not a dictionary.
|
|
46
|
+
|
|
47
|
+
## Why this validation exists
|
|
48
|
+
The `from_dict` pipeline requires a strict dictionary format containing:
|
|
49
|
+
- OWNER_CLASS,
|
|
50
|
+
- nested composite structures,
|
|
51
|
+
- VALUE fields for atomic nodes.
|
|
52
|
+
|
|
53
|
+
Passing anything else (list, tuple, string, None, etc.) would make the import
|
|
54
|
+
ambiguous or impossible.
|
|
55
|
+
|
|
56
|
+
Failing early ensures:
|
|
57
|
+
- predictable import behavior,
|
|
58
|
+
- safe restoration,
|
|
59
|
+
- clear diagnostics.
|
|
60
|
+
|
|
61
|
+
## Execution context
|
|
62
|
+
Used inside `from_dict` as the first validation step.
|
|
63
|
+
|
|
64
|
+
## Notes
|
|
65
|
+
- Pure raise function, no conditional logic.
|
|
66
|
+
- Used exclusively by the Serialization mixin.
|
|
67
|
+
"""
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
from .compare_snapshots import compare_snapshots
|
|
2
|
+
|
|
3
|
+
_DESIGN_NOTES = """
|
|
4
|
+
# Snapshot Utilities
|
|
5
|
+
|
|
6
|
+
## Purpose
|
|
7
|
+
Provides core utilities for working with snapshots, including comparison logic
|
|
8
|
+
used by history tracking, debugging tools, and immutability pipelines.
|
|
9
|
+
|
|
10
|
+
## Internal Components Registry
|
|
11
|
+
|
|
12
|
+
| Component | Type | Description |
|
|
13
|
+
| :------------------ | :------- | :------------------------------------------- |
|
|
14
|
+
| `compare_snapshots` | Function | Computes structural diffs between snapshots. |
|
|
15
|
+
"""
|