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,104 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
# Inners
|
|
3
|
+
from .NodesTuple import NodesTuple
|
|
4
|
+
from ._utils.snapshot import compare_snapshots
|
|
5
|
+
# Annotations
|
|
6
|
+
if TYPE_CHECKING:
|
|
7
|
+
from ..._core.protocols.mixins.core_mixins import SnapshotProtocol
|
|
8
|
+
from ..._core.protocols.alias_typings import SnapshotTuple, SnapshotDiffTuple
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class Snapshot(NodesTuple):
|
|
12
|
+
"""
|
|
13
|
+
Stores complete snapshots of the instance's state and allows
|
|
14
|
+
restoring them. A snapshot is a plain tuple of values in the same
|
|
15
|
+
order as _nodes_tuple.
|
|
16
|
+
"""
|
|
17
|
+
|
|
18
|
+
# ----------------------------------------
|
|
19
|
+
# Basic interface
|
|
20
|
+
# ----------------------------------------
|
|
21
|
+
|
|
22
|
+
# Slot definition
|
|
23
|
+
__slots__ = ()
|
|
24
|
+
|
|
25
|
+
# ----------------------------------------
|
|
26
|
+
# Methods - BUILD / RESTORE / COMPARE
|
|
27
|
+
# ----------------------------------------
|
|
28
|
+
|
|
29
|
+
def _build_snapshot(
|
|
30
|
+
self: "SnapshotProtocol"
|
|
31
|
+
) -> "SnapshotTuple":
|
|
32
|
+
"""Builds a snapshot as a tuple of values according to _nodes_tuple."""
|
|
33
|
+
# noinspection PyProtectedMember
|
|
34
|
+
return tuple(
|
|
35
|
+
instance._value for instance, _
|
|
36
|
+
in self._nodes_tuple
|
|
37
|
+
)
|
|
38
|
+
|
|
39
|
+
def _restore_snapshot(
|
|
40
|
+
self: "SnapshotProtocol",
|
|
41
|
+
snapshot: "SnapshotTuple"
|
|
42
|
+
) -> None:
|
|
43
|
+
"""Restores the instance's state from a snapshot."""
|
|
44
|
+
for (instance, _), value in zip(self._nodes_tuple, snapshot):
|
|
45
|
+
instance._value = value
|
|
46
|
+
|
|
47
|
+
def _compare_snapshots(
|
|
48
|
+
self: "SnapshotProtocol",
|
|
49
|
+
snapshot1: "SnapshotTuple",
|
|
50
|
+
snapshot2: "SnapshotTuple",
|
|
51
|
+
*,
|
|
52
|
+
constants_only: bool = False
|
|
53
|
+
) -> "SnapshotDiffTuple":
|
|
54
|
+
"""Compares two snapshots."""
|
|
55
|
+
return compare_snapshots(
|
|
56
|
+
self._nodes_tuple,
|
|
57
|
+
snapshot1,
|
|
58
|
+
snapshot2,
|
|
59
|
+
constants_only=constants_only
|
|
60
|
+
)
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
_DESIGN_NOTES = """
|
|
64
|
+
# Snapshot
|
|
65
|
+
|
|
66
|
+
## Purpose
|
|
67
|
+
Gives an instance the ability to capture its entire state as a plain,
|
|
68
|
+
inert tuple of values, and later restore or compare against that
|
|
69
|
+
captured state. This is the shared foundation behind copying, pickling,
|
|
70
|
+
default-state resets, dirty tracking, and undo/redo history — anywhere
|
|
71
|
+
the ecosystem needs "what did this look like at some point."
|
|
72
|
+
|
|
73
|
+
## Compatibility
|
|
74
|
+
- No compatibility flags — the three methods are pure data operations
|
|
75
|
+
over `_nodes_tuple`, valid for atoms and composites, mutable and
|
|
76
|
+
immutable alike. Restrictions (e.g. `_mutable_only`) belong to the
|
|
77
|
+
higher-level mixins that *use* this foundation (`DirtyTracking`,
|
|
78
|
+
`DefaultState`), not to `Snapshot` itself.
|
|
79
|
+
|
|
80
|
+
## Logic
|
|
81
|
+
- `_build_snapshot()` walks `_nodes_tuple` and pulls out each node's raw
|
|
82
|
+
`_value`, in the same fixed order — the snapshot is just a tuple of
|
|
83
|
+
values, position-matched to `_nodes_tuple`, nothing more.
|
|
84
|
+
- `_restore_snapshot(snapshot)` does the reverse: zips `_nodes_tuple`
|
|
85
|
+
against the given snapshot and writes each value back directly onto
|
|
86
|
+
`instance._value`. This bypasses the normal setter/validation pipeline
|
|
87
|
+
by design — a restore is trusted to already be a value the instance
|
|
88
|
+
previously held.
|
|
89
|
+
- `_compare_snapshots(snapshot1, snapshot2, constants_only=...)`
|
|
90
|
+
delegates to the `compare_snapshots` utility, using `_nodes_tuple` to
|
|
91
|
+
translate positional differences back into meaningful `(path, old,
|
|
92
|
+
new)` triples. `constants_only` lets a caller ignore composite-level
|
|
93
|
+
"value" nodes and diff only the leaf constants.
|
|
94
|
+
|
|
95
|
+
## Notes
|
|
96
|
+
- A snapshot is intentionally "dumb" — a bare tuple with no metadata
|
|
97
|
+
about which mixin produced it. Its meaning only exists relative to the
|
|
98
|
+
`_nodes_tuple` it was built from, which is why restore/compare always
|
|
99
|
+
take the *current* instance's `_nodes_tuple` as context.
|
|
100
|
+
- `_restore_snapshot` writing straight to `instance._value` (not through
|
|
101
|
+
a public setter) is the same category of deliberate low-level access
|
|
102
|
+
seen elsewhere in the ecosystem (e.g. `validate=False` in internal
|
|
103
|
+
calls) — an architectural choice, not an oversight.
|
|
104
|
+
"""
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
from .Infrastructure import Infrastructure
|
|
2
|
+
from .NodesDicts import NodesDicts
|
|
3
|
+
from .NodesTuple import NodesTuple
|
|
4
|
+
from .Serialization import Serialization
|
|
5
|
+
from .Snapshot import Snapshot
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
_DESIGN_NOTES = """
|
|
9
|
+
# Core Mixins
|
|
10
|
+
|
|
11
|
+
## Purpose
|
|
12
|
+
Shared infrastructure used throughout the mixin ecosystem for walking an
|
|
13
|
+
instance's node tree, snapshotting its state, and serializing it. Every
|
|
14
|
+
mixin in `dunders` and `others` that needs to read/restore/compare state
|
|
15
|
+
is ultimately built on top of one of these.
|
|
16
|
+
|
|
17
|
+
## Components
|
|
18
|
+
|
|
19
|
+
| Component | Type | Description |
|
|
20
|
+
| :----------------- | :---- | :--------------------------------------------------------------- |
|
|
21
|
+
| `NodesTuple` | Mixin | Builds `_nodes_tuple`, the flat ordered source of every node. |
|
|
22
|
+
| `NodesDicts` | Mixin | Turns `_nodes_tuple` into fast name-keyed lookup dicts. |
|
|
23
|
+
| `Snapshot` | Mixin | Builds, restores, and compares full-state value tuples. |
|
|
24
|
+
| `Infrastructure` | Mixin | Bundles `NodesDicts` + `Snapshot` into one shared foundation. |
|
|
25
|
+
| `Serialization` | Mixin | Full `to_dict`/`to_json`/`from_dict`/`from_json` API. |
|
|
26
|
+
|
|
27
|
+
## Notes
|
|
28
|
+
- Dependency order: `NodesTuple` → `NodesDicts` / `Snapshot` →
|
|
29
|
+
`Infrastructure` → `Serialization`.
|
|
30
|
+
- `Infrastructure` is the base class most higher-level mixins should
|
|
31
|
+
inherit from when they need both node lookup and snapshot access.
|
|
32
|
+
"""
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
_DESIGN_NOTES = """
|
|
2
|
+
# Core Mixins Utilities Overview
|
|
3
|
+
|
|
4
|
+
The `_utils` package aggregates foundational helper subsystems used by the
|
|
5
|
+
core mixins. Each sub-package focuses on a specific structural domain:
|
|
6
|
+
node traversal, serialization, and snapshot comparison.
|
|
7
|
+
|
|
8
|
+
This package does not re-export any components. All functionality is accessed
|
|
9
|
+
directly through the corresponding sub-packages.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Sub-Packages
|
|
14
|
+
|
|
15
|
+
### 1. nodes_tuple
|
|
16
|
+
Provides structural traversal utilities:
|
|
17
|
+
- collection of node data,
|
|
18
|
+
- canonical tuple construction,
|
|
19
|
+
- foundational support for snapshot creation and immutability pipelines.
|
|
20
|
+
|
|
21
|
+
These utilities define the stable ordering of nodes inside every instance.
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
### 2. serialization
|
|
26
|
+
Provides import/export utilities:
|
|
27
|
+
- dictionary serialization,
|
|
28
|
+
- dictionary-based reconstruction,
|
|
29
|
+
- partial constant updates.
|
|
30
|
+
|
|
31
|
+
These functions form the backbone of the Serialization mixin.
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
### 3. snapshot
|
|
36
|
+
Provides snapshot utilities:
|
|
37
|
+
- structural diffing,
|
|
38
|
+
- compatibility validation,
|
|
39
|
+
- debugging support.
|
|
40
|
+
|
|
41
|
+
Snapshots are used across immutability, history tracking, and debugging tools.
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## Notes
|
|
46
|
+
- This package is internal and not intended for direct user interaction.
|
|
47
|
+
- Each sub-package is self-contained and exposes its own public API.
|
|
48
|
+
- The structure is designed for clarity, modularity, and predictable behavior.
|
|
49
|
+
"""
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
from .build_nodes_tuple import build_nodes_tuple
|
|
2
|
+
|
|
3
|
+
_DESIGN_NOTES = """
|
|
4
|
+
# Nodes Tuple Utilities
|
|
5
|
+
|
|
6
|
+
## Purpose
|
|
7
|
+
Provides the core structural traversal utilities used to build the canonical
|
|
8
|
+
(nodes_tuple) representation of an object. These utilities form the foundation
|
|
9
|
+
for snapshot creation, serialization, immutability pipelines, and history
|
|
10
|
+
tracking.
|
|
11
|
+
|
|
12
|
+
## Internal Components Registry
|
|
13
|
+
|
|
14
|
+
| Component | Type | Description |
|
|
15
|
+
| :--------------------- | :------- | :-------------------------------------------------- |
|
|
16
|
+
| `build_nodes_tuple` | Function | Wraps traversal and produces the final tuple. |
|
|
17
|
+
"""
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
# Outers
|
|
3
|
+
from ...._common_logic.constants import VALUE
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ....._core.protocols.instance import SimpleInstanceLike
|
|
7
|
+
from ....._core.protocols.alias_typings import PathTuple, NodeItem
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
def _collect_nodes_data(
|
|
11
|
+
instance: "SimpleInstanceLike",
|
|
12
|
+
path: "PathTuple",
|
|
13
|
+
nodes_list: list["NodeItem"],
|
|
14
|
+
) -> None:
|
|
15
|
+
"""
|
|
16
|
+
Recursively traverses the entire instance structure and appends
|
|
17
|
+
(instance, path) pairs into `nodes_list`.
|
|
18
|
+
|
|
19
|
+
Each pair represents a node in the object tree, where `path` is a tuple
|
|
20
|
+
of snake_case names describing how to reach the node from the root.
|
|
21
|
+
"""
|
|
22
|
+
|
|
23
|
+
# 1. Add current node (constant)
|
|
24
|
+
if instance.meta.is_constant:
|
|
25
|
+
nodes_list.append((instance, path))
|
|
26
|
+
return
|
|
27
|
+
|
|
28
|
+
# 2. Add current node (composite)
|
|
29
|
+
else:
|
|
30
|
+
nodes_list.append((instance, path + (VALUE,)))
|
|
31
|
+
|
|
32
|
+
# 3. Process composite inners
|
|
33
|
+
for inner in instance.meta.inners:
|
|
34
|
+
|
|
35
|
+
# 3.1 Extract metadata
|
|
36
|
+
inner_meta = inner.meta
|
|
37
|
+
|
|
38
|
+
# 3.2 Load inner instance
|
|
39
|
+
inner_instance = getattr(instance, inner_meta.name_private)
|
|
40
|
+
|
|
41
|
+
# 3.3 Recursive descent
|
|
42
|
+
_collect_nodes_data(
|
|
43
|
+
instance=inner_instance,
|
|
44
|
+
path=path + (inner_meta.name_snake,),
|
|
45
|
+
nodes_list=nodes_list,
|
|
46
|
+
)
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
_DESIGN_NOTES = """
|
|
50
|
+
# _collect_nodes_data
|
|
51
|
+
|
|
52
|
+
## Purpose
|
|
53
|
+
Internal recursive walker that builds the foundational `(instance, path)` pairs
|
|
54
|
+
used throughout the Simple system. It is the core mechanism behind
|
|
55
|
+
`NodesTupleMixin`, snapshot creation, immutability pipelines, history tracking,
|
|
56
|
+
and composite recalculation.
|
|
57
|
+
|
|
58
|
+
The function produces a **flat, ordered list** representing the entire object
|
|
59
|
+
tree, where each entry contains:
|
|
60
|
+
|
|
61
|
+
- the instance of a node,
|
|
62
|
+
- the path tuple describing how to reach it from the root.
|
|
63
|
+
|
|
64
|
+
This list is later converted into `nodes_tuple`, the canonical structure used by
|
|
65
|
+
many mixins.
|
|
66
|
+
|
|
67
|
+
## Architectural role
|
|
68
|
+
This function is one of the deepest internal utilities in the Simple system.
|
|
69
|
+
It provides:
|
|
70
|
+
|
|
71
|
+
### 1. Deterministic structural traversal
|
|
72
|
+
The order of nodes is stable and predictable:
|
|
73
|
+
- root first,
|
|
74
|
+
- then all constants,
|
|
75
|
+
- then all composites,
|
|
76
|
+
- depth‑first traversal.
|
|
77
|
+
|
|
78
|
+
### 2. Unified representation of object structure
|
|
79
|
+
Every mixin that needs to understand the object tree relies on the same
|
|
80
|
+
canonical representation:
|
|
81
|
+
- immutability helpers,
|
|
82
|
+
- snapshot creation,
|
|
83
|
+
- history mixin,
|
|
84
|
+
- serialization,
|
|
85
|
+
- composite recalculation,
|
|
86
|
+
- diffing and patching.
|
|
87
|
+
|
|
88
|
+
### 3. Path construction
|
|
89
|
+
Each node receives a `path` tuple containing snake_case names of attributes
|
|
90
|
+
leading to it. This path is used for:
|
|
91
|
+
- snapshot dictionaries,
|
|
92
|
+
- change propagation,
|
|
93
|
+
- composite recalculation,
|
|
94
|
+
- debugging and introspection.
|
|
95
|
+
|
|
96
|
+
### 4. Constant vs composite distinction
|
|
97
|
+
The function uses `instance.meta.is_constant` to determine:
|
|
98
|
+
- whether the node is terminal,
|
|
99
|
+
- whether to append `(VALUE,)` to the path,
|
|
100
|
+
- how composite recalculation should treat the node.
|
|
101
|
+
|
|
102
|
+
This distinction is essential for immutability pipelines.
|
|
103
|
+
|
|
104
|
+
## Why this function is recursive
|
|
105
|
+
The Simple system supports arbitrarily deep composite structures.
|
|
106
|
+
A recursive walker ensures:
|
|
107
|
+
- clarity,
|
|
108
|
+
- correctness,
|
|
109
|
+
- minimal code,
|
|
110
|
+
- deterministic traversal order.
|
|
111
|
+
|
|
112
|
+
## Stability guarantee
|
|
113
|
+
This function is a **core invariant** of the Simple architecture.
|
|
114
|
+
Any change to traversal order or path construction would break:
|
|
115
|
+
|
|
116
|
+
- snapshot creation,
|
|
117
|
+
- immutability pipelines,
|
|
118
|
+
- composite recalculation,
|
|
119
|
+
- history tracking,
|
|
120
|
+
- serialization,
|
|
121
|
+
- diffing,
|
|
122
|
+
- and several mixins relying on `nodes_tuple`.
|
|
123
|
+
|
|
124
|
+
Therefore, modifications must be carefully reviewed.
|
|
125
|
+
|
|
126
|
+
## Notes
|
|
127
|
+
- This function is intentionally low‑level and not part of the public API.
|
|
128
|
+
- It is used exclusively by `build_nodes_tuple`.
|
|
129
|
+
- It must remain fast, predictable, and side‑effect‑free.
|
|
130
|
+
|
|
131
|
+
"""
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
# Inners
|
|
3
|
+
from ._collect_nodes_data import _collect_nodes_data
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ....._core.protocols.mixins.core_mixins import NodesTupleProtocol
|
|
7
|
+
from ....._core.protocols.alias_typings import NodesTuple
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
def build_nodes_tuple(
|
|
11
|
+
self: "NodesTupleProtocol",
|
|
12
|
+
) -> "NodesTuple":
|
|
13
|
+
"""
|
|
14
|
+
Builds a tuple of (instance, path) pairs representing the full structural
|
|
15
|
+
tree of the object. The path contains snake_case names describing how to
|
|
16
|
+
reach each node from the root.
|
|
17
|
+
"""
|
|
18
|
+
|
|
19
|
+
# 1. Prepare accumulator
|
|
20
|
+
nodes_list = []
|
|
21
|
+
|
|
22
|
+
# 2. Recursively collect all nodes
|
|
23
|
+
_collect_nodes_data(
|
|
24
|
+
instance=self,
|
|
25
|
+
path=(),
|
|
26
|
+
nodes_list=nodes_list,
|
|
27
|
+
)
|
|
28
|
+
|
|
29
|
+
# 3. Convert to tuple and return
|
|
30
|
+
return tuple(nodes_list)
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
_DESIGN_NOTES = """
|
|
34
|
+
# build_nodes_tuple
|
|
35
|
+
|
|
36
|
+
## Purpose
|
|
37
|
+
Creates the canonical `nodes_tuple` structure used throughout the Simple system.
|
|
38
|
+
This structure is a flat, ordered tuple of `(instance, path)` pairs representing
|
|
39
|
+
every node in the object tree. It serves as the **primary source of truth** for
|
|
40
|
+
mixins that need to inspect or manipulate the internal structure of an object.
|
|
41
|
+
|
|
42
|
+
## Architectural role
|
|
43
|
+
`build_nodes_tuple` is the public-facing wrapper around `_collect_nodes_data`.
|
|
44
|
+
Its responsibilities are intentionally minimal:
|
|
45
|
+
|
|
46
|
+
1. Prepare an accumulator list.
|
|
47
|
+
2. Delegate recursive traversal to `_collect_nodes_data`.
|
|
48
|
+
3. Freeze the result into an immutable tuple.
|
|
49
|
+
|
|
50
|
+
This separation keeps traversal logic isolated while providing a clean,
|
|
51
|
+
deterministic API for mixins.
|
|
52
|
+
|
|
53
|
+
## Why this function exists
|
|
54
|
+
Many mixins rely on a consistent structural representation:
|
|
55
|
+
|
|
56
|
+
- `NodesTupleMixin`
|
|
57
|
+
Builds `_nodes_tuple`, `_node_names_tuple`, `_constant_names_set`.
|
|
58
|
+
|
|
59
|
+
- Snapshot mixins
|
|
60
|
+
Use `nodes_tuple` to create and restore snapshots.
|
|
61
|
+
|
|
62
|
+
- Immutability helpers
|
|
63
|
+
Use it to compute new instances, propagate changes, and recalculate composites.
|
|
64
|
+
|
|
65
|
+
- History mixin
|
|
66
|
+
Uses it to track structural changes over time.
|
|
67
|
+
|
|
68
|
+
- Serialization mixins
|
|
69
|
+
Convert `nodes_tuple` into JSON or dict representations.
|
|
70
|
+
|
|
71
|
+
By centralizing the creation of this structure, the system ensures:
|
|
72
|
+
|
|
73
|
+
- deterministic traversal order,
|
|
74
|
+
- consistent path construction,
|
|
75
|
+
- stable behavior across all mixins.
|
|
76
|
+
|
|
77
|
+
## Deterministic output
|
|
78
|
+
The resulting tuple is:
|
|
79
|
+
|
|
80
|
+
- **ordered** — depth-first traversal,
|
|
81
|
+
- **complete** — includes constants and composites,
|
|
82
|
+
- **stable** — identical for identical object structures,
|
|
83
|
+
- **immutable** — safe for caching and snapshotting.
|
|
84
|
+
|
|
85
|
+
This determinism is essential for immutability pipelines and diffing logic.
|
|
86
|
+
|
|
87
|
+
## Stability guarantee
|
|
88
|
+
Any change to this function would affect:
|
|
89
|
+
|
|
90
|
+
- snapshot creation,
|
|
91
|
+
- immutability behavior,
|
|
92
|
+
- composite recalculation,
|
|
93
|
+
- history tracking,
|
|
94
|
+
- serialization,
|
|
95
|
+
- and all mixins relying on `nodes_tuple`.
|
|
96
|
+
|
|
97
|
+
Therefore, the function is treated as a **core invariant** of the Simple system.
|
|
98
|
+
|
|
99
|
+
## Notes
|
|
100
|
+
- This function is intentionally simple and side-effect-free.
|
|
101
|
+
- It is not part of the public API; it is used internally by mixins.
|
|
102
|
+
- All structural logic is delegated to `_collect_nodes_data`.
|
|
103
|
+
|
|
104
|
+
"""
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
from .to_dict import to_dict
|
|
2
|
+
from .from_dict import from_dict
|
|
3
|
+
from .from_dict_constants import from_dict_constants
|
|
4
|
+
|
|
5
|
+
_DESIGN_NOTES = """
|
|
6
|
+
# Serialization Utilities
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
Provides the core import/export utilities used by SerializationMixin. Handles
|
|
10
|
+
conversion between object instances and dictionary structures, supporting both
|
|
11
|
+
mutable and immutable operational modes.
|
|
12
|
+
|
|
13
|
+
## Internal Components Registry
|
|
14
|
+
|
|
15
|
+
| Component | Type | Description |
|
|
16
|
+
| :--------------------- | :------- | :-------------------------------------------------- |
|
|
17
|
+
| `to_dict` | Function | Serializes instance into a structured dictionary. |
|
|
18
|
+
| `from_dict` | Function | Reconstructs full instance state from a dictionary. |
|
|
19
|
+
| `from_dict_constants` | Function | Updates only constant values from a partial dict. |
|
|
20
|
+
"""
|
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
from simplibs.sentinels import UNSET
|
|
3
|
+
# Outers
|
|
4
|
+
from ...._common_logic.constants import OWNER_CLASS, VALUE
|
|
5
|
+
from ...._common_logic.immutability import create_new_instance
|
|
6
|
+
# Inners
|
|
7
|
+
from .validations import (
|
|
8
|
+
raise_unvalid_state_dict_input,
|
|
9
|
+
raise_unvalid_owner_class_mismatch_for_state_dict,
|
|
10
|
+
raise_missing_composite_key,
|
|
11
|
+
raise_invalid_composite_structure,
|
|
12
|
+
raise_missing_value_key
|
|
13
|
+
)
|
|
14
|
+
# Annotations
|
|
15
|
+
if TYPE_CHECKING:
|
|
16
|
+
from ....._core.protocols.mixins.core_mixins import SerializationProtocol
|
|
17
|
+
from ....._core.protocols.alias_typings import StateDict
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
def from_dict(
|
|
21
|
+
self: "SerializationProtocol",
|
|
22
|
+
user_dict: "StateDict",
|
|
23
|
+
) -> "SerializationProtocol":
|
|
24
|
+
"""
|
|
25
|
+
Universal reconstruction of instance state from a dictionary.
|
|
26
|
+
Supports both mutable (in-place) and immutable (new instance) modes.
|
|
27
|
+
"""
|
|
28
|
+
|
|
29
|
+
# 1. Validate input type
|
|
30
|
+
if not isinstance(user_dict, dict):
|
|
31
|
+
raise_unvalid_state_dict_input(self, user_dict)
|
|
32
|
+
|
|
33
|
+
# 2. Validate owner class (supports both string class_name and class reference)
|
|
34
|
+
owner_class = user_dict.get(OWNER_CLASS, UNSET)
|
|
35
|
+
if owner_class not in (self.meta.class_name, self.meta.owner_class):
|
|
36
|
+
raise_unvalid_owner_class_mismatch_for_state_dict(self, owner_class)
|
|
37
|
+
|
|
38
|
+
# 3. Prepare traversal structures
|
|
39
|
+
values = []
|
|
40
|
+
last_composite_key = UNSET
|
|
41
|
+
last_composite_dict = {}
|
|
42
|
+
|
|
43
|
+
# 4. Load and validate values according to the _nodes_tuple structure
|
|
44
|
+
for instance, path in self._nodes_tuple:
|
|
45
|
+
|
|
46
|
+
# 4.1 Define per-node variables
|
|
47
|
+
current_dict = user_dict
|
|
48
|
+
last_key = path[-1] if path else instance.meta.name_snake
|
|
49
|
+
|
|
50
|
+
# 4.2 Handle composite nodes (non-root)
|
|
51
|
+
if len(path) > 1:
|
|
52
|
+
|
|
53
|
+
# 4.2.1 Extract second-to-last key
|
|
54
|
+
before_last_key = path[-2]
|
|
55
|
+
|
|
56
|
+
# 4.2.2 Reuse previously cached composite dictionary
|
|
57
|
+
if last_composite_key == before_last_key:
|
|
58
|
+
current_dict = last_composite_dict
|
|
59
|
+
|
|
60
|
+
# 4.2.3 Traverse into a new composite dictionary
|
|
61
|
+
else:
|
|
62
|
+
|
|
63
|
+
# 4.2.3.1 Traverse into nested dictionaries
|
|
64
|
+
for key in path[:-1]:
|
|
65
|
+
current_dict = current_dict.get(key, UNSET)
|
|
66
|
+
if current_dict is UNSET:
|
|
67
|
+
raise_missing_composite_key(self, key, path)
|
|
68
|
+
if not isinstance(current_dict, dict):
|
|
69
|
+
raise_invalid_composite_structure(self, key, current_dict, path)
|
|
70
|
+
|
|
71
|
+
# 4.2.3.2 Cache composite dictionary for next iteration
|
|
72
|
+
if last_key == VALUE:
|
|
73
|
+
last_composite_key = before_last_key
|
|
74
|
+
last_composite_dict = current_dict
|
|
75
|
+
|
|
76
|
+
# 4.3 Load value
|
|
77
|
+
value = current_dict.get(last_key, UNSET)
|
|
78
|
+
if value is UNSET:
|
|
79
|
+
raise_missing_value_key(self, last_key, path)
|
|
80
|
+
|
|
81
|
+
# 4.4 Validate and store value
|
|
82
|
+
instance.validate(value)
|
|
83
|
+
values.append(value)
|
|
84
|
+
|
|
85
|
+
# 5. Mutable mode → write values in-place
|
|
86
|
+
if self.__is_mutable__:
|
|
87
|
+
for (instance, _), value in zip(self._nodes_tuple, values):
|
|
88
|
+
instance._value = value
|
|
89
|
+
return self
|
|
90
|
+
|
|
91
|
+
# 6. Immutable mode → create new instance from snapshot
|
|
92
|
+
new_snapshot = tuple(values)
|
|
93
|
+
return create_new_instance(self, new_snapshot)
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
_DESIGN_NOTES = """
|
|
97
|
+
# from_dict
|
|
98
|
+
|
|
99
|
+
## Purpose
|
|
100
|
+
Reconstructs the full state of an instance from a user‑provided dictionary.
|
|
101
|
+
This function is the central import mechanism of the Simple serialization
|
|
102
|
+
pipeline and supports both operational modes:
|
|
103
|
+
|
|
104
|
+
- **mutable mode** — values are written directly into the existing instance
|
|
105
|
+
- **immutable mode** — a new instance is created from the reconstructed snapshot
|
|
106
|
+
|
|
107
|
+
This dual behavior allows the same API to be used consistently across all
|
|
108
|
+
Simple objects regardless of their mutability configuration.
|
|
109
|
+
|
|
110
|
+
## Architectural role
|
|
111
|
+
`from_dict` is used by:
|
|
112
|
+
|
|
113
|
+
- `SerializationMixin` (`from_dict`, `from_json`)
|
|
114
|
+
- immutability helpers (`create_new_instance`)
|
|
115
|
+
- debugging tools
|
|
116
|
+
- state restoration pipelines
|
|
117
|
+
- external integrations (JSON import, API payloads)
|
|
118
|
+
|
|
119
|
+
It ensures that external data can be safely mapped back into the internal
|
|
120
|
+
object structure defined by `nodes_tuple`.
|
|
121
|
+
|
|
122
|
+
## Input validation
|
|
123
|
+
The function performs strict validation:
|
|
124
|
+
|
|
125
|
+
1. **Input type**
|
|
126
|
+
The provided value must be a dictionary.
|
|
127
|
+
|
|
128
|
+
2. **Owner class identity**
|
|
129
|
+
The dictionary must contain the matching `OWNER_CLASS` token.
|
|
130
|
+
It accepts both string identifiers (`meta.class_name`) and class references (`meta.owner_class`),
|
|
131
|
+
allowing transparent JSON restoration and in-memory Python dictionary restoration.
|
|
132
|
+
|
|
133
|
+
3. **Structural correctness**
|
|
134
|
+
The dictionary must contain all required keys according to the structural
|
|
135
|
+
paths defined in `_nodes_tuple` (resolving standalone atoms via `name_snake`).
|
|
136
|
+
|
|
137
|
+
4. **Value validation**
|
|
138
|
+
Each value is validated using the instance’s own `validate()` method.
|
|
139
|
+
|
|
140
|
+
These checks guarantee that only structurally correct and type‑safe data enters
|
|
141
|
+
the object.
|
|
142
|
+
|
|
143
|
+
## Traversal logic
|
|
144
|
+
The function reconstructs values by walking the dictionary according to the
|
|
145
|
+
paths stored in `_nodes_tuple`.
|
|
146
|
+
|
|
147
|
+
To optimize traversal:
|
|
148
|
+
|
|
149
|
+
- standalone atom nodes with empty paths safely fallback to `instance.meta.name_snake`
|
|
150
|
+
- composite dictionaries are cached (`last_composite_dict`)
|
|
151
|
+
- repeated lookups into the same composite branch are avoided
|
|
152
|
+
- missing keys or invalid structures raise clear diagnostics
|
|
153
|
+
|
|
154
|
+
This ensures linear performance even for deeply nested composite objects.
|
|
155
|
+
|
|
156
|
+
## Mutable vs immutable behavior
|
|
157
|
+
After all values are collected and validated:
|
|
158
|
+
|
|
159
|
+
### Mutable mode
|
|
160
|
+
Values are written directly into the existing instance:
|
|
161
|
+
|
|
162
|
+
- no new object is created
|
|
163
|
+
- changes happen in-place
|
|
164
|
+
- the instance identity is preserved
|
|
165
|
+
|
|
166
|
+
### Immutable mode
|
|
167
|
+
A new instance is created using:
|
|
168
|
+
|
|
169
|
+
- a freshly built snapshot
|
|
170
|
+
- `create_new_instance(self, new_snapshot)`
|
|
171
|
+
|
|
172
|
+
This ensures immutability guarantees while preserving the original instance.
|
|
173
|
+
|
|
174
|
+
## Stability guarantee
|
|
175
|
+
This function is a core part of the Simple serialization subsystem.
|
|
176
|
+
Any change affects:
|
|
177
|
+
|
|
178
|
+
- JSON import
|
|
179
|
+
- snapshot restoration
|
|
180
|
+
- immutability pipelines
|
|
181
|
+
- debugging tools
|
|
182
|
+
- external integrations
|
|
183
|
+
|
|
184
|
+
Therefore, `from_dict` is treated as a **structural invariant** of the system.
|
|
185
|
+
|
|
186
|
+
## Notes
|
|
187
|
+
- This function is intentionally low‑level and not part of the public API.
|
|
188
|
+
- All structural logic is delegated to `_nodes_tuple`.
|
|
189
|
+
- All instance creation logic is delegated to `create_new_instance`.
|
|
190
|
+
"""
|