simplibs-object 0.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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.0.dist-info/METADATA +590 -0
- simplibs_object-0.1.0.dist-info/RECORD +580 -0
- simplibs_object-0.1.0.dist-info/WHEEL +5 -0
- simplibs_object-0.1.0.dist-info/licenses/LICENSE +21 -0
- simplibs_object-0.1.0.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,99 @@
|
|
|
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 InfrastructureProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def validate_inner_tuple_is_tuple(
|
|
10
|
+
instance: "InfrastructureProtocol",
|
|
11
|
+
inner_tuple: object,
|
|
12
|
+
) -> None:
|
|
13
|
+
"""
|
|
14
|
+
Validates that the provided inner_tuple is actually a tuple.
|
|
15
|
+
"""
|
|
16
|
+
|
|
17
|
+
if isinstance(inner_tuple, tuple):
|
|
18
|
+
return
|
|
19
|
+
|
|
20
|
+
raise SimpleRuntimeError(
|
|
21
|
+
error_name="IMMUTABILITY BATCH UPDATE ERROR",
|
|
22
|
+
label="change item",
|
|
23
|
+
expected="Each change must be a tuple: (name, value).",
|
|
24
|
+
value=type(inner_tuple).__name__,
|
|
25
|
+
problem=(
|
|
26
|
+
"Invalid structure for change item. ",
|
|
27
|
+
"Batch immutable update requires each item to be a tuple."
|
|
28
|
+
),
|
|
29
|
+
context=(
|
|
30
|
+
f"Batch update attempted on instance '{type(instance).__name__}'. ",
|
|
31
|
+
"The provided item is not a tuple."
|
|
32
|
+
),
|
|
33
|
+
how_to_fix=(
|
|
34
|
+
"Ensure each change is provided as a tuple: (name, value).",
|
|
35
|
+
"Example: ('age', 42)",
|
|
36
|
+
"Do not use lists, dicts, or other container types.",
|
|
37
|
+
),
|
|
38
|
+
exception=TypeError,
|
|
39
|
+
)
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
_DESIGN_NOTES = """
|
|
43
|
+
# validate_inner_tuple_is_tuple
|
|
44
|
+
|
|
45
|
+
## Purpose
|
|
46
|
+
Ensures that each item inside a batch update (`with_constants`, `with_any`) is
|
|
47
|
+
actually a tuple.
|
|
48
|
+
Batch updates rely on tuple-based structures for deterministic ordering,
|
|
49
|
+
structural validation, and predictable unpacking.
|
|
50
|
+
|
|
51
|
+
If an item is not a tuple, the update cannot be interpreted safely.
|
|
52
|
+
|
|
53
|
+
## Architectural reasoning
|
|
54
|
+
The immutability pipeline expects:
|
|
55
|
+
|
|
56
|
+
- `(name, value)` for single updates,
|
|
57
|
+
- `((name, value), (name, value), ...)` for batch updates.
|
|
58
|
+
|
|
59
|
+
Using tuples guarantees:
|
|
60
|
+
|
|
61
|
+
- stable ordering,
|
|
62
|
+
- simple structural validation,
|
|
63
|
+
- predictable unpacking,
|
|
64
|
+
- no accidental key/value inversion (as with dicts),
|
|
65
|
+
- no ambiguity (as with lists).
|
|
66
|
+
|
|
67
|
+
If the item is not a tuple:
|
|
68
|
+
|
|
69
|
+
- the pipeline cannot determine the intended structure,
|
|
70
|
+
- composite/constant routing becomes impossible,
|
|
71
|
+
- debugging becomes significantly harder.
|
|
72
|
+
|
|
73
|
+
Therefore, the function fails early with a clear diagnostic error.
|
|
74
|
+
|
|
75
|
+
## Pipeline position
|
|
76
|
+
This validation is part of step **4.3.1** in `with_constants`:
|
|
77
|
+
|
|
78
|
+
1. Check if `inner_tuple` is a tuple.
|
|
79
|
+
2. If not → raise this error immediately.
|
|
80
|
+
3. No further validation is performed on this item.
|
|
81
|
+
|
|
82
|
+
This ensures that only structurally valid items enter deeper validation layers.
|
|
83
|
+
|
|
84
|
+
## Diagnostic value
|
|
85
|
+
The error message provides:
|
|
86
|
+
|
|
87
|
+
- the invalid type,
|
|
88
|
+
- the expected structure,
|
|
89
|
+
- the context of the batch update,
|
|
90
|
+
- actionable steps to fix the issue.
|
|
91
|
+
|
|
92
|
+
This makes the error friendly, actionable, and easy to understand.
|
|
93
|
+
|
|
94
|
+
## Notes
|
|
95
|
+
- This is a pure validation function: it performs no additional logic.
|
|
96
|
+
- It is used by both `with_constants` and `with_any`.
|
|
97
|
+
- All batch update items must pass this check before further validation.
|
|
98
|
+
|
|
99
|
+
"""
|
|
@@ -0,0 +1,90 @@
|
|
|
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 InfrastructureProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def validate_inner_tuple_name_is_str(
|
|
10
|
+
instance: "InfrastructureProtocol",
|
|
11
|
+
inner_tuple: object,
|
|
12
|
+
) -> None:
|
|
13
|
+
"""
|
|
14
|
+
Validates that the first element of inner_tuple (the name) is a string.
|
|
15
|
+
"""
|
|
16
|
+
|
|
17
|
+
if isinstance(inner_tuple, tuple) and isinstance(inner_tuple[0], str):
|
|
18
|
+
return
|
|
19
|
+
|
|
20
|
+
raise SimpleRuntimeError(
|
|
21
|
+
error_name="IMMUTABILITY BATCH UPDATE ERROR",
|
|
22
|
+
label="change item name",
|
|
23
|
+
expected="First element of tuple must be a string representing the node name.",
|
|
24
|
+
value=inner_tuple[0] if isinstance(inner_tuple, tuple) else inner_tuple,
|
|
25
|
+
problem=(
|
|
26
|
+
"Invalid structure for change item. ",
|
|
27
|
+
"The first element of each (name, value) tuple must be a string."
|
|
28
|
+
),
|
|
29
|
+
context=(
|
|
30
|
+
f"Batch update attempted on instance '{type(instance).__name__}'. ",
|
|
31
|
+
"The provided tuple has a non-string name element."
|
|
32
|
+
),
|
|
33
|
+
how_to_fix=(
|
|
34
|
+
"Ensure the first element of each tuple is a string.",
|
|
35
|
+
"Correct format: ('age', 42)",
|
|
36
|
+
"Incorrect formats include: (123, 42), (None, 42), (object, 42).",
|
|
37
|
+
),
|
|
38
|
+
exception=TypeError,
|
|
39
|
+
)
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
_DESIGN_NOTES = """
|
|
43
|
+
# validate_inner_tuple_name_is_str
|
|
44
|
+
|
|
45
|
+
## Purpose
|
|
46
|
+
Ensures that the first element of each change tuple is a string representing the
|
|
47
|
+
node name.
|
|
48
|
+
Immutable updates rely on string-based names to route updates to constants or
|
|
49
|
+
composites. Any other type would make routing impossible.
|
|
50
|
+
|
|
51
|
+
## Architectural reasoning
|
|
52
|
+
The immutability pipeline expects:
|
|
53
|
+
|
|
54
|
+
- `inner_tuple[0]` → node name (string),
|
|
55
|
+
- `inner_tuple[1]` → new value.
|
|
56
|
+
|
|
57
|
+
If the name is not a string:
|
|
58
|
+
|
|
59
|
+
- routing logic cannot determine whether the update targets a constant or composite,
|
|
60
|
+
- metadata lookup fails,
|
|
61
|
+
- validation cannot proceed,
|
|
62
|
+
- debugging becomes significantly harder.
|
|
63
|
+
|
|
64
|
+
Failing early prevents structural corruption.
|
|
65
|
+
|
|
66
|
+
## Pipeline position
|
|
67
|
+
This validation is part of step **4.3.1** in `with_constants`:
|
|
68
|
+
|
|
69
|
+
1. Check that `inner_tuple[0]` is a string.
|
|
70
|
+
2. If not → raise this error immediately.
|
|
71
|
+
3. No further validation is performed on this item.
|
|
72
|
+
|
|
73
|
+
This ensures that only structurally correct items enter deeper validation layers.
|
|
74
|
+
|
|
75
|
+
## Diagnostic value
|
|
76
|
+
The error message provides:
|
|
77
|
+
|
|
78
|
+
- the invalid name value,
|
|
79
|
+
- the expected type,
|
|
80
|
+
- the context of the batch update,
|
|
81
|
+
- actionable steps to fix the issue.
|
|
82
|
+
|
|
83
|
+
This makes the error friendly, actionable, and easy to understand.
|
|
84
|
+
|
|
85
|
+
## Notes
|
|
86
|
+
- This is a pure validation function: it performs no additional logic.
|
|
87
|
+
- It is used by both `with_constants` and `with_any`.
|
|
88
|
+
- All batch update items must pass this check before further validation.
|
|
89
|
+
|
|
90
|
+
"""
|
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
# Outers
|
|
3
|
+
from ..with_constant.utils import (
|
|
4
|
+
create_snapshot_dict,
|
|
5
|
+
create_new_instance,
|
|
6
|
+
reacalculate_owner_value,
|
|
7
|
+
)
|
|
8
|
+
# Inners
|
|
9
|
+
from .utils import find_longest_keys
|
|
10
|
+
from .vaidations import (
|
|
11
|
+
raise_immutability_constants_changes_not_tuple,
|
|
12
|
+
raise_immutability_batch_constant_not_found,
|
|
13
|
+
validate_inner_tuple_name_is_str,
|
|
14
|
+
validate_inner_tuple_is_tuple,
|
|
15
|
+
validate_inner_tuple_has_length_two
|
|
16
|
+
)
|
|
17
|
+
# Annotations
|
|
18
|
+
if TYPE_CHECKING:
|
|
19
|
+
from ....._core.protocols.alias_typings import ChangeTuple, ChangesTuple
|
|
20
|
+
from ....._core.protocols.mixins.core_mixins import (
|
|
21
|
+
InfrastructureProtocol,
|
|
22
|
+
InfrastructuredComponent,
|
|
23
|
+
)
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
def with_constants(
|
|
27
|
+
self: "InfrastructureProtocol",
|
|
28
|
+
changes: "ChangeTuple | ChangesTuple | None" = None,
|
|
29
|
+
) -> "InfrastructuredComponent":
|
|
30
|
+
"""
|
|
31
|
+
Integration requirement:
|
|
32
|
+
This function is designed for the core pipeline framework. The object
|
|
33
|
+
provided in `self` MUST inherit from:
|
|
34
|
+
1. Snapshot (provides _restore_snapshot)
|
|
35
|
+
2. NodesDicts (provides metadata and node access)
|
|
36
|
+
Without these mixins, the pipeline will raise AttributeError.
|
|
37
|
+
"""
|
|
38
|
+
|
|
39
|
+
# 1. Create current snapshot dictionary
|
|
40
|
+
snapshot_dict = create_snapshot_dict(self._nodes_tuple)
|
|
41
|
+
|
|
42
|
+
# 2. Prepare dictionary for path tracking
|
|
43
|
+
path_dict = {}
|
|
44
|
+
|
|
45
|
+
# 3. Build initial snapshot
|
|
46
|
+
new_snapshot = self._build_snapshot()
|
|
47
|
+
|
|
48
|
+
# 4. Apply changes if provided
|
|
49
|
+
if changes:
|
|
50
|
+
|
|
51
|
+
# 4.1 Validate that input is a tuple
|
|
52
|
+
if not isinstance(changes, tuple):
|
|
53
|
+
raise_immutability_constants_changes_not_tuple(self, changes)
|
|
54
|
+
|
|
55
|
+
# 4.2 Normalize input if single change was provided
|
|
56
|
+
if not isinstance(changes[0], tuple):
|
|
57
|
+
changes = (changes,)
|
|
58
|
+
|
|
59
|
+
# 4.3 Process each inner tuple
|
|
60
|
+
for inner_tuple in changes:
|
|
61
|
+
|
|
62
|
+
# 4.3.1 Validate tuple structure
|
|
63
|
+
if (
|
|
64
|
+
not isinstance(inner_tuple, tuple)
|
|
65
|
+
or len(inner_tuple) != 2
|
|
66
|
+
or not isinstance(inner_tuple[0], str)
|
|
67
|
+
):
|
|
68
|
+
validate_inner_tuple_is_tuple(self, inner_tuple)
|
|
69
|
+
validate_inner_tuple_has_length_two(self, inner_tuple)
|
|
70
|
+
validate_inner_tuple_name_is_str(self, inner_tuple)
|
|
71
|
+
|
|
72
|
+
# 4.3.2 Extract variables
|
|
73
|
+
inner_name, new_value = inner_tuple
|
|
74
|
+
|
|
75
|
+
# 4.3.3 Validate that the name refers to a constant
|
|
76
|
+
if inner_name not in self._constant_names_set:
|
|
77
|
+
raise_immutability_batch_constant_not_found(self, inner_name)
|
|
78
|
+
|
|
79
|
+
# 4.3.4 Validate new value
|
|
80
|
+
instance, path = self._nodes_dict[inner_name]
|
|
81
|
+
instance.validate(new_value)
|
|
82
|
+
|
|
83
|
+
# 4.3.5 Write new value into snapshot dictionary
|
|
84
|
+
snapshot_dict[inner_name] = new_value
|
|
85
|
+
|
|
86
|
+
# 4.3.6 Store path for recalculation
|
|
87
|
+
path_dict[inner_name] = path
|
|
88
|
+
|
|
89
|
+
# 4.4 Extract deepest affected keys
|
|
90
|
+
longest_key = find_longest_keys(path_dict)
|
|
91
|
+
|
|
92
|
+
# 4.5 Recalculate composite values starting from deepest nodes
|
|
93
|
+
for key in longest_key:
|
|
94
|
+
instance = self._nodes_instance_dict[key]
|
|
95
|
+
reacalculate_owner_value(snapshot_dict, instance.owner)
|
|
96
|
+
|
|
97
|
+
# 4.6 Build clean snapshot tuple
|
|
98
|
+
new_snapshot = tuple(snapshot_dict.values())
|
|
99
|
+
|
|
100
|
+
# 5. Return new instance
|
|
101
|
+
return create_new_instance(self, new_snapshot)
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
_DESIGN_NOTES = """
|
|
105
|
+
# with_constants
|
|
106
|
+
|
|
107
|
+
## Purpose
|
|
108
|
+
Applies multiple constant updates in a single immutable-safe operation.
|
|
109
|
+
This function is the batch version of [with_constant](ca://s?q=Explain_with_constant) and is used whenever several atomic values must be updated at once while ensuring composite nodes remain consistent.
|
|
110
|
+
|
|
111
|
+
## Architectural role
|
|
112
|
+
This function is used by:
|
|
113
|
+
|
|
114
|
+
- [with_any](ca://s?q=Explain_with_any) — mixed updates
|
|
115
|
+
- [with_composite](ca://s?q=Explain_with_composite) — composite updates
|
|
116
|
+
- [Serialization update_constants](ca://s?q=Explain_update_constants) — partial dict updates
|
|
117
|
+
- [Snapshot restoration](ca://s?q=Explain_snapshot_restoration) — rebuilding state
|
|
118
|
+
|
|
119
|
+
It provides a deterministic, safe, and efficient batch update mechanism.
|
|
120
|
+
|
|
121
|
+
## How it works
|
|
122
|
+
The function performs five deterministic phases:
|
|
123
|
+
|
|
124
|
+
### 1. Build snapshot dictionary
|
|
125
|
+
Uses [create_snapshot_dict](ca://s?q=Explain_create_snapshot_dict) to create a flat dictionary of current values.
|
|
126
|
+
|
|
127
|
+
### 2. Prepare path dictionary
|
|
128
|
+
Stores structural paths of changed constants for later recalculation.
|
|
129
|
+
|
|
130
|
+
### 3. Normalize and validate changes
|
|
131
|
+
Each change must be a `(name, value)` tuple.
|
|
132
|
+
Validation ensures:
|
|
133
|
+
|
|
134
|
+
- correct tuple structure,
|
|
135
|
+
- constant name correctness,
|
|
136
|
+
- semantic correctness via `validate()`.
|
|
137
|
+
|
|
138
|
+
### 4. Apply changes and recalculate composites
|
|
139
|
+
After writing new constant values:
|
|
140
|
+
|
|
141
|
+
- affected paths are analyzed using
|
|
142
|
+
[find_longest_keys](ca://s?q=Explain_find_longest_keys)
|
|
143
|
+
- composite recalculation begins at deepest nodes using
|
|
144
|
+
[reacalculate_owner_value](ca://s?q=Explain_recalculate_owner_value)
|
|
145
|
+
|
|
146
|
+
This guarantees correct dependency ordering.
|
|
147
|
+
|
|
148
|
+
### 5. Build clean snapshot and create new instance
|
|
149
|
+
The updated dictionary is converted into a positional snapshot and passed to
|
|
150
|
+
[create_new_instance](ca://s?q=Explain_create_new_instance).
|
|
151
|
+
|
|
152
|
+
## Why batch updates matter
|
|
153
|
+
Batch updates allow:
|
|
154
|
+
|
|
155
|
+
- atomic multi-value changes,
|
|
156
|
+
- correct composite recalculation,
|
|
157
|
+
- minimal recomputation,
|
|
158
|
+
- deterministic immutability behavior,
|
|
159
|
+
- efficient pipelines for serialization and patch operations.
|
|
160
|
+
|
|
161
|
+
## Deterministic behavior
|
|
162
|
+
The update is deterministic because:
|
|
163
|
+
|
|
164
|
+
- `nodes_tuple` defines stable ordering,
|
|
165
|
+
- snapshot dictionaries use canonical `name_snake` keys,
|
|
166
|
+
- composite recalculation is pure,
|
|
167
|
+
- terminal nodes are computed structurally,
|
|
168
|
+
- instance creation is clean and side-effect-free.
|
|
169
|
+
|
|
170
|
+
## Integration requirements
|
|
171
|
+
The function assumes the instance implements:
|
|
172
|
+
|
|
173
|
+
- [Snapshot](ca://s?q=Explain_Snapshot_mixin) — provides `_restore_snapshot`
|
|
174
|
+
- [NodesDicts](ca://s?q=Explain_NodesDicts_mixin) — provides node metadata
|
|
175
|
+
|
|
176
|
+
Without these mixins, the pipeline cannot reconstruct the instance.
|
|
177
|
+
|
|
178
|
+
## Stability guarantee
|
|
179
|
+
Any change to this function would affect:
|
|
180
|
+
|
|
181
|
+
- immutability behavior,
|
|
182
|
+
- composite recalculation,
|
|
183
|
+
- serialization consistency,
|
|
184
|
+
- debugging tools,
|
|
185
|
+
- history tracking.
|
|
186
|
+
|
|
187
|
+
Therefore, `with_constants` is treated as a **core invariant** of the immutability subsystem.
|
|
188
|
+
|
|
189
|
+
## Notes
|
|
190
|
+
- This function is intentionally minimal and side-effect-free.
|
|
191
|
+
- It is not part of the public API; it is used internally by mixins.
|
|
192
|
+
- All structural logic is delegated to helper utilities.
|
|
193
|
+
"""
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
from simplibs.sentinels import UNSET
|
|
3
|
+
# Inners
|
|
4
|
+
from ._meta import SimpleMixinMeta
|
|
5
|
+
# Annotations
|
|
6
|
+
if TYPE_CHECKING:
|
|
7
|
+
from ..._core.protocols.mixins.base_class import SimpleMixinProtocol
|
|
8
|
+
from ..._core.protocols.alias_typings import ValidTypes
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class SimpleMixin(metaclass=SimpleMixinMeta):
|
|
12
|
+
"""Base class representing the structural interface for all mixins in the Simple system.
|
|
13
|
+
|
|
14
|
+
Mixins may extend instance behavior, participate in initialization, and declare
|
|
15
|
+
compatibility constraints that determine which instance types they may be applied to.
|
|
16
|
+
"""
|
|
17
|
+
|
|
18
|
+
# ----------------------------------------
|
|
19
|
+
# Declarative compatibility flags
|
|
20
|
+
# ----------------------------------------
|
|
21
|
+
|
|
22
|
+
_constant_only: bool = False
|
|
23
|
+
_composite_only: bool = False
|
|
24
|
+
_mutable_only: bool = False
|
|
25
|
+
_immutable_only: bool = False
|
|
26
|
+
_only_types: "ValidTypes" = UNSET
|
|
27
|
+
|
|
28
|
+
# ----------------------------------------
|
|
29
|
+
# Slot definition
|
|
30
|
+
# ----------------------------------------
|
|
31
|
+
|
|
32
|
+
__slots__ = ()
|
|
33
|
+
|
|
34
|
+
# ----------------------------------------
|
|
35
|
+
# Initialization hook
|
|
36
|
+
# ----------------------------------------
|
|
37
|
+
|
|
38
|
+
def init_mixins(
|
|
39
|
+
self: "SimpleMixinProtocol",
|
|
40
|
+
) -> None:
|
|
41
|
+
"""Default initialization hook for mixins.
|
|
42
|
+
|
|
43
|
+
Mixins overriding this method should only initialize their own internal
|
|
44
|
+
slots and state. Do NOT call super().init_mixins() as mixin hook chaining
|
|
45
|
+
is orchestrated by the instance compilation engine.
|
|
46
|
+
"""
|
|
47
|
+
pass
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
_DESIGN_NOTES = """
|
|
51
|
+
# SimpleMixin
|
|
52
|
+
|
|
53
|
+
## Purpose
|
|
54
|
+
`SimpleMixin` defines the foundational interface for all mixins in the Simple
|
|
55
|
+
system. Mixins extend instance behavior, participate in initialization, and
|
|
56
|
+
declare compatibility constraints that determine which instance types they may
|
|
57
|
+
be applied to.
|
|
58
|
+
|
|
59
|
+
This base class ensures that every mixin:
|
|
60
|
+
|
|
61
|
+
- defines its own memory layout (`__slots__`),
|
|
62
|
+
- declares an isolated initialization hook (`init_mixins`),
|
|
63
|
+
- declares compatibility flags in a consistent manner,
|
|
64
|
+
- passes structural validation during class definition via `SimpleMixinMeta`.
|
|
65
|
+
|
|
66
|
+
## Architectural reasoning
|
|
67
|
+
Mixins in the Simple system are dynamically merged into runtime-generated
|
|
68
|
+
instance classes via dictionary synthesis rather than Python's MRO. Because
|
|
69
|
+
they directly modify instance behavior and memory layout, they must follow
|
|
70
|
+
strict structural rules.
|
|
71
|
+
|
|
72
|
+
`SimpleMixin` provides:
|
|
73
|
+
|
|
74
|
+
### 1. Declarative compatibility flags
|
|
75
|
+
These flags restrict mixin applicability based on instance type:
|
|
76
|
+
|
|
77
|
+
- `_constant_only`
|
|
78
|
+
- `_composite_only`
|
|
79
|
+
- `_mutable_only`
|
|
80
|
+
- `_immutable_only`
|
|
81
|
+
- `_only_types`
|
|
82
|
+
|
|
83
|
+
They allow mixins to express structural constraints without embedding logic
|
|
84
|
+
inside the instance builder.
|
|
85
|
+
|
|
86
|
+
### 2. Explicit slot definition
|
|
87
|
+
Mixins must define their own `__slots__` to ensure:
|
|
88
|
+
|
|
89
|
+
- predictable memory layout,
|
|
90
|
+
- safe merging with other mixins,
|
|
91
|
+
- prevention of accidental attribute creation.
|
|
92
|
+
|
|
93
|
+
### 3. Isolated initialization hook
|
|
94
|
+
`init_mixins` allows mixins to initialize their own internal slots and state.
|
|
95
|
+
Because the instance builder orchestrates and composes all mixin hooks iteratively,
|
|
96
|
+
overriding mixins MUST NOT call `super().init_mixins()`.
|
|
97
|
+
|
|
98
|
+
### 4. Metaclass structural validation
|
|
99
|
+
`SimpleMixinMeta` triggers `verify_mixin_definition` upon mixin class creation.
|
|
100
|
+
This guarantees fail-fast validation and prevents structurally invalid mixins
|
|
101
|
+
from entering the runtime engine.
|
|
102
|
+
|
|
103
|
+
## Diagnostic value
|
|
104
|
+
Any structural mistake results in a structured `SimpleRuntimeError` with:
|
|
105
|
+
|
|
106
|
+
- clear explanation,
|
|
107
|
+
- actionable guidance,
|
|
108
|
+
- examples,
|
|
109
|
+
- contextual metadata.
|
|
110
|
+
|
|
111
|
+
This makes debugging mixin definitions fast and predictable.
|
|
112
|
+
|
|
113
|
+
## Notes
|
|
114
|
+
- `SimpleMixin` is not intended to be instantiated directly.
|
|
115
|
+
- All mixins in the Simple system must inherit from this class.
|
|
116
|
+
- The class is intentionally minimal; all heavy logic is delegated to the
|
|
117
|
+
validator and mixin-specific implementations.
|
|
118
|
+
"""
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
from .SimpleMixin import SimpleMixin
|
|
2
|
+
|
|
3
|
+
_DESIGN_NOTES = """
|
|
4
|
+
# Simple Mixin Base Package
|
|
5
|
+
|
|
6
|
+
## Purpose
|
|
7
|
+
Provides the foundational interface for all mixins in the Simple system.
|
|
8
|
+
This package defines the `SimpleMixin` class, which establishes the structural
|
|
9
|
+
contract, declarative compatibility flags, initialization hook, and automatic
|
|
10
|
+
validation pipeline for mixin subclasses.
|
|
11
|
+
|
|
12
|
+
## Internal Components Registry
|
|
13
|
+
|
|
14
|
+
| Component | Type | Description |
|
|
15
|
+
| :------------ | :----- | :---------------------------------------------------------------------- |
|
|
16
|
+
| `SimpleMixin` | Class | Base class for all mixins; enforces structural rules via subclass init. |
|
|
17
|
+
"""
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# Inners
|
|
2
|
+
from ._verify_mixin_definition import _verify_mixin_definition
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
class SimpleMixinMeta(type):
|
|
6
|
+
"""Metaclass for all mixins in the Simple system.
|
|
7
|
+
|
|
8
|
+
Provides runtime type resolution via `isinstance` checks against flattened
|
|
9
|
+
`__mixins__` tuples and executes static definition validation upon class creation.
|
|
10
|
+
"""
|
|
11
|
+
|
|
12
|
+
def __init__(cls, name: str, bases: tuple[type, ...], dct: dict[str, object], **kwargs) -> None:
|
|
13
|
+
super().__init__(name, bases, dct, **kwargs)
|
|
14
|
+
|
|
15
|
+
# Run structural verification for all derived mixin classes (skip root SimpleMixin)
|
|
16
|
+
if bases:
|
|
17
|
+
_verify_mixin_definition(cls)
|
|
18
|
+
|
|
19
|
+
def __instancecheck__(cls, instance: object) -> bool:
|
|
20
|
+
"""Intercepts `isinstance(obj, MyMixin)` calls to inspect the internal
|
|
21
|
+
|
|
22
|
+
`__mixins__` tuple attached to compiled instance classes.
|
|
23
|
+
"""
|
|
24
|
+
# 1. Standard MRO instance check (covers direct mixin instances if any exist)
|
|
25
|
+
if super().__instancecheck__(instance):
|
|
26
|
+
return True
|
|
27
|
+
|
|
28
|
+
# 2. Inspect dynamically attached mixin registry on runtime instance classes
|
|
29
|
+
mixins = getattr(instance, "__mixins__", ())
|
|
30
|
+
|
|
31
|
+
# Returns True if this mixin class or any of its subclasses are registered
|
|
32
|
+
return any(issubclass(m, cls) for m in mixins)
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
_DESIGN_NOTES = """
|
|
36
|
+
# SimpleMixinMeta
|
|
37
|
+
|
|
38
|
+
## Purpose
|
|
39
|
+
`SimpleMixinMeta` serves as the foundational metaclass for all mixin definitions in the Simple framework.
|
|
40
|
+
It addresses two architectural requirements in dynamic mixin systems:
|
|
41
|
+
1. Enforces strict definition-time structural validation on all mixin subclasses.
|
|
42
|
+
2. Bridges runtime identity checks (`isinstance()`) for dynamic instances that do not include mixins in their MRO.
|
|
43
|
+
|
|
44
|
+
## Core Mechanisms
|
|
45
|
+
|
|
46
|
+
### 1. Definition-Time Validation (`__init__`)
|
|
47
|
+
When a mixin class is declared, `SimpleMixinMeta.__init__` triggers `verify_mixin_definition(cls)`.
|
|
48
|
+
- **Root Skipping (`if bases:`)**: The root `SimpleMixin` class has an empty `bases` tuple and is excluded
|
|
49
|
+
from validation, allowing clean base-level defaults without triggering self-validation errors.
|
|
50
|
+
- **Fail-Fast Subclassing**: Any derived mixin is immediately validated against slot declarations, forbidden
|
|
51
|
+
namespace identifiers, flag typings, and hook signatures before it can be used anywhere in the codebase.
|
|
52
|
+
|
|
53
|
+
### 2. Flat Mixin Registry Resolution (`__instancecheck__`)
|
|
54
|
+
Because runtime instance classes compile mixin methods directly into `class_dict` rather than placing
|
|
55
|
+
mixins into Python's MRO, standard Python `isinstance(instance, TargetMixin)` would normally return `False`.
|
|
56
|
+
- `__instancecheck__` intercepts the check and inspects `instance.__mixins__` (the flat registry tuple).
|
|
57
|
+
- Returns `True` if `TargetMixin` or any of its subclasses are present in `__mixins__`.
|
|
58
|
+
- Preserves standard polymorphic semantics and duck-typing without incurring MRO multi-inheritance layout overhead.
|
|
59
|
+
"""
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
from .SimpleMixinMeta import SimpleMixinMeta
|
|
2
|
+
|
|
3
|
+
__all__ = ["SimpleMixinMeta"]
|
|
4
|
+
|
|
5
|
+
_DESIGN_NOTES = """
|
|
6
|
+
# Mixin Metaclass & Definition Validation Package
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
Provides the foundational metaclass (`SimpleMixinMeta`) and structural validation
|
|
10
|
+
pipeline responsible for verifying the correctness of mixin definitions in the Simple system.
|
|
11
|
+
Ensures that all mixins adhere to memory layout rules, declare proper compatibility flags,
|
|
12
|
+
isolate initialization hooks, and support runtime `isinstance` checks across flat-synthesized
|
|
13
|
+
instance classes.
|
|
14
|
+
|
|
15
|
+
## Internal Components Registry
|
|
16
|
+
|
|
17
|
+
| Component | Type | Scope | Description |
|
|
18
|
+
| :-------------------------- | :--------- | :------- | :----------------------------------------------------------------------- |
|
|
19
|
+
| `SimpleMixinMeta` | Metaclass | Public | Base metaclass managing class-creation validation and `isinstance` checks.|
|
|
20
|
+
| `_verify_mixin_definition` | Function | Internal | Main validation pipeline executed during mixin subclass creation. |
|
|
21
|
+
"""
|