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,130 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
from datetime import datetime
|
|
3
|
+
# Annotations
|
|
4
|
+
if TYPE_CHECKING:
|
|
5
|
+
from ......_core.protocols.mixins.state import HistoryProtocol
|
|
6
|
+
from ......_core.protocols.alias_typings import HistoryEntry
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def record_state(
|
|
10
|
+
self: "HistoryProtocol"
|
|
11
|
+
) -> "HistoryEntry":
|
|
12
|
+
"""
|
|
13
|
+
Creates a snapshot of the current instance state and stores it in history.
|
|
14
|
+
"""
|
|
15
|
+
|
|
16
|
+
# 1. Create timestamp and snapshot
|
|
17
|
+
timestamp = datetime.now()
|
|
18
|
+
snapshot = self._build_snapshot()
|
|
19
|
+
|
|
20
|
+
# 2. Enforce history limit
|
|
21
|
+
if self._history_limit and self._history_count >= self._history_limit:
|
|
22
|
+
self._history.pop(0)
|
|
23
|
+
|
|
24
|
+
# 3. Store entry
|
|
25
|
+
history_entry = (timestamp, snapshot)
|
|
26
|
+
self._history.append(history_entry)
|
|
27
|
+
self._history_count = len(self._history)
|
|
28
|
+
self._history_index = self._history_count - 1
|
|
29
|
+
|
|
30
|
+
# 4. Return entry
|
|
31
|
+
return history_entry
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
_DESIGN_NOTES = """
|
|
35
|
+
# record_state
|
|
36
|
+
|
|
37
|
+
## Purpose
|
|
38
|
+
Creates a new history entry representing the current state of the instance.
|
|
39
|
+
Each entry consists of a timestamp and a snapshot (tuple of raw node values).
|
|
40
|
+
This function is the foundation of the history subsystem: every state change,
|
|
41
|
+
initialization, or navigation ultimately relies on `record_state` to capture
|
|
42
|
+
the instance’s evolution over time.
|
|
43
|
+
|
|
44
|
+
## Architectural role
|
|
45
|
+
`record_state` is used by:
|
|
46
|
+
|
|
47
|
+
- History mixin initialization (`init_mixins`)
|
|
48
|
+
- automatic state tracking during mutations
|
|
49
|
+
- undo/redo navigation
|
|
50
|
+
- timestamp/index-based navigation
|
|
51
|
+
- history export/import pipelines
|
|
52
|
+
- debugging and diffing tools
|
|
53
|
+
|
|
54
|
+
It ensures that every relevant state transition is captured in a stable,
|
|
55
|
+
deterministic format.
|
|
56
|
+
|
|
57
|
+
## How it works
|
|
58
|
+
The function performs four deterministic steps:
|
|
59
|
+
|
|
60
|
+
### 1. Create timestamp and snapshot
|
|
61
|
+
Captures the current moment using `datetime.now()` and builds a raw snapshot
|
|
62
|
+
via `_build_snapshot()`.
|
|
63
|
+
The snapshot is a tuple of values in the exact order of `_nodes_tuple`.
|
|
64
|
+
|
|
65
|
+
### 2. Enforce history limit
|
|
66
|
+
If a history limit is set and the history is full, the oldest entry is removed.
|
|
67
|
+
This ensures bounded memory usage and predictable history size.
|
|
68
|
+
|
|
69
|
+
### 3. Store entry
|
|
70
|
+
Creates a `(timestamp, snapshot)` tuple and appends it to the internal history
|
|
71
|
+
list. Updates:
|
|
72
|
+
|
|
73
|
+
- `_history_count` — total number of entries
|
|
74
|
+
- `_history_index` — index of the most recent entry
|
|
75
|
+
|
|
76
|
+
### 4. Return entry
|
|
77
|
+
Returns the newly created history entry for convenience and debugging.
|
|
78
|
+
|
|
79
|
+
## Integration requirements
|
|
80
|
+
The function assumes the instance implements:
|
|
81
|
+
|
|
82
|
+
- **SnapshotMixin**
|
|
83
|
+
Provides `_build_snapshot()`.
|
|
84
|
+
|
|
85
|
+
- **HistoryMixin internals**
|
|
86
|
+
Provides `_history`, `_history_limit`, `_history_index`, `_history_count`.
|
|
87
|
+
|
|
88
|
+
Without these components, the history subsystem cannot operate correctly.
|
|
89
|
+
|
|
90
|
+
## Why this function exists
|
|
91
|
+
History tracking must be:
|
|
92
|
+
|
|
93
|
+
- deterministic,
|
|
94
|
+
- lightweight,
|
|
95
|
+
- stable across mutations,
|
|
96
|
+
- independent of internal representation,
|
|
97
|
+
- safe for undo/redo navigation,
|
|
98
|
+
- compatible with serialization.
|
|
99
|
+
|
|
100
|
+
`record_state` encapsulates all of this in a single, minimal utility.
|
|
101
|
+
|
|
102
|
+
## Deterministic behavior
|
|
103
|
+
Each history entry is guaranteed to be:
|
|
104
|
+
|
|
105
|
+
- timestamped,
|
|
106
|
+
- structurally consistent,
|
|
107
|
+
- ordered,
|
|
108
|
+
- immutable,
|
|
109
|
+
- safe for navigation and diffing.
|
|
110
|
+
|
|
111
|
+
This determinism is essential for debugging, reproducibility, and state
|
|
112
|
+
management.
|
|
113
|
+
|
|
114
|
+
## Stability guarantee
|
|
115
|
+
Any change to this function would affect:
|
|
116
|
+
|
|
117
|
+
- undo/redo behavior,
|
|
118
|
+
- navigation correctness,
|
|
119
|
+
- history export/import,
|
|
120
|
+
- diffing tools,
|
|
121
|
+
- initialization behavior.
|
|
122
|
+
|
|
123
|
+
Therefore, `record_state` is treated as a **core invariant** of the history
|
|
124
|
+
subsystem.
|
|
125
|
+
|
|
126
|
+
## Notes
|
|
127
|
+
- This function is intentionally minimal and side‑effect‑free.
|
|
128
|
+
- It is not part of the public API; it is used internally by mixins.
|
|
129
|
+
- All structural logic is delegated to `_build_snapshot` and history internals.
|
|
130
|
+
"""
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
# Outers
|
|
3
|
+
from .validations import raise_history_limit_not_positive_integer
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ......_core.protocols.mixins.state import HistoryProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def set_history_limit(
|
|
10
|
+
self: "HistoryProtocol",
|
|
11
|
+
value: int
|
|
12
|
+
) -> None:
|
|
13
|
+
"""
|
|
14
|
+
Sets the maximum allowed size of the history list.
|
|
15
|
+
"""
|
|
16
|
+
|
|
17
|
+
# 1. Validate value
|
|
18
|
+
if not isinstance(value, int) or value < 1:
|
|
19
|
+
raise_history_limit_not_positive_integer(self, value)
|
|
20
|
+
|
|
21
|
+
# 2. Adjust history to the new limit
|
|
22
|
+
if self._history_count > value:
|
|
23
|
+
del self._history[:(self._history_count - value)]
|
|
24
|
+
self._history_count = len(self._history)
|
|
25
|
+
self._history_index = self._history_count - 1
|
|
26
|
+
|
|
27
|
+
# 3. Store limit
|
|
28
|
+
self._history_limit = value
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
_DESIGN_NOTES = """
|
|
32
|
+
# set_history_limit
|
|
33
|
+
|
|
34
|
+
## Purpose
|
|
35
|
+
Sets a maximum size for the history list and trims older entries if necessary.
|
|
36
|
+
This function ensures that history tracking remains memory‑efficient and
|
|
37
|
+
predictable, especially for long‑running or frequently mutated objects.
|
|
38
|
+
|
|
39
|
+
## Architectural role
|
|
40
|
+
`set_history_limit` is used by:
|
|
41
|
+
|
|
42
|
+
- the `History.history_limit` property setter,
|
|
43
|
+
- initialization routines,
|
|
44
|
+
- debugging tools,
|
|
45
|
+
- import/export pipelines (when restoring history limits).
|
|
46
|
+
|
|
47
|
+
It provides a deterministic mechanism for bounding the history size.
|
|
48
|
+
|
|
49
|
+
## How it works
|
|
50
|
+
The function performs three deterministic steps:
|
|
51
|
+
|
|
52
|
+
### 1. Validate value
|
|
53
|
+
Ensures the limit is a positive integer (`value >= 1`).
|
|
54
|
+
Invalid values trigger a structured validation error.
|
|
55
|
+
|
|
56
|
+
### 2. Trim history if needed
|
|
57
|
+
If the current history contains more entries than the new limit:
|
|
58
|
+
- the oldest entries are removed,
|
|
59
|
+
- `_history_count` is updated,
|
|
60
|
+
- `_history_index` is set to the last valid entry.
|
|
61
|
+
|
|
62
|
+
This guarantees that the history always respects the configured limit.
|
|
63
|
+
|
|
64
|
+
### 3. Store limit
|
|
65
|
+
Updates `_history_limit` with the validated value.
|
|
66
|
+
|
|
67
|
+
## Integration requirements
|
|
68
|
+
The function assumes the instance implements:
|
|
69
|
+
|
|
70
|
+
- **History internals**
|
|
71
|
+
`_history`, `_history_limit`, `_history_count`, `_history_index`
|
|
72
|
+
|
|
73
|
+
- **SnapshotMixin**
|
|
74
|
+
History entries contain snapshot tuples created by `_build_snapshot()`.
|
|
75
|
+
|
|
76
|
+
Without these components, the history subsystem cannot enforce limits correctly.
|
|
77
|
+
|
|
78
|
+
## Why this function exists
|
|
79
|
+
History tracking can grow indefinitely if not bounded.
|
|
80
|
+
A configurable limit allows:
|
|
81
|
+
|
|
82
|
+
- predictable memory usage,
|
|
83
|
+
- stable performance,
|
|
84
|
+
- safe long‑term operation,
|
|
85
|
+
- controlled undo/redo depth.
|
|
86
|
+
|
|
87
|
+
This function encapsulates the trimming logic in a single, stable utility.
|
|
88
|
+
|
|
89
|
+
## Deterministic behavior
|
|
90
|
+
History trimming is guaranteed to be:
|
|
91
|
+
|
|
92
|
+
- stable,
|
|
93
|
+
- predictable,
|
|
94
|
+
- index‑safe,
|
|
95
|
+
- consistent across all history operations.
|
|
96
|
+
|
|
97
|
+
This determinism is essential for undo/redo, navigation, and debugging.
|
|
98
|
+
|
|
99
|
+
## Stability guarantee
|
|
100
|
+
Any change to this function would affect:
|
|
101
|
+
|
|
102
|
+
- undo/redo behavior,
|
|
103
|
+
- navigation correctness,
|
|
104
|
+
- history import/export,
|
|
105
|
+
- initialization behavior.
|
|
106
|
+
|
|
107
|
+
Therefore, `set_history_limit` is treated as a **core invariant** of the
|
|
108
|
+
history subsystem.
|
|
109
|
+
|
|
110
|
+
## Notes
|
|
111
|
+
- This function is intentionally minimal and side‑effect‑free.
|
|
112
|
+
- It is not part of the public API; it is used internally by mixins.
|
|
113
|
+
- All structural logic is delegated to history internals.
|
|
114
|
+
"""
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
from .raise_history_limit_not_positive_integer import raise_history_limit_not_positive_integer
|
|
2
|
+
from .raise_unvalide_snapshot_index import raise_unvalide_snapshot_index
|
|
3
|
+
from .raise_unvalide_snopshot_reference import raise_unvalide_snopshot_reference
|
|
4
|
+
from .raise_unvalide_snopshot_timestamp import raise_unvalide_snopshot_timestamp
|
|
5
|
+
from .raise_unvalide_timestamp import raise_unvalide_timestamp
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
_DESIGN_NOTES = """
|
|
9
|
+
# Validations for History Core
|
|
10
|
+
|
|
11
|
+
## Purpose
|
|
12
|
+
Provides structured raise functions used by the core history utilities
|
|
13
|
+
(`find_snapshot`, `set_history_limit`, timestamp navigation).
|
|
14
|
+
These validations ensure that:
|
|
15
|
+
|
|
16
|
+
- snapshot indices are valid,
|
|
17
|
+
- timestamp inputs are correct,
|
|
18
|
+
- snapshot references are of supported types,
|
|
19
|
+
- timestamp lookups fail with clear diagnostics,
|
|
20
|
+
- history limits are positive integers.
|
|
21
|
+
|
|
22
|
+
## Components
|
|
23
|
+
|
|
24
|
+
| Component | Type | Description |
|
|
25
|
+
| :------------------------------------------- | :------- | :------------------------------------------------------- |
|
|
26
|
+
| `raise_history_limit_not_positive_integer` | Function | Ensures history limit is a positive integer. |
|
|
27
|
+
| `raise_unvalide_snapshot_index` | Function | Raised when snapshot index is out of range. |
|
|
28
|
+
| `raise_unvalide_snopshot_reference` | Function | Raised when snapshot reference is neither int nor datetime. |
|
|
29
|
+
| `raise_unvalide_snopshot_timestamp` | Function | Raised when timestamp lookup fails. |
|
|
30
|
+
| `raise_unvalide_timestamp` | Function | Raised when timestamp input is not a datetime. |
|
|
31
|
+
"""
|
|
@@ -0,0 +1,65 @@
|
|
|
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.state import HistoryProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def raise_history_limit_not_positive_integer(
|
|
10
|
+
instance: "HistoryProtocol",
|
|
11
|
+
value: object,
|
|
12
|
+
) -> NoReturn:
|
|
13
|
+
"""
|
|
14
|
+
Raises an error when the provided history limit is not a positive integer.
|
|
15
|
+
"""
|
|
16
|
+
|
|
17
|
+
raise SimpleRuntimeError(
|
|
18
|
+
error_name="HISTORY LIMIT ERROR",
|
|
19
|
+
label="history limit",
|
|
20
|
+
expected="A positive integer (value >= 1).",
|
|
21
|
+
value=value,
|
|
22
|
+
problem=(
|
|
23
|
+
"Invalid history limit provided.",
|
|
24
|
+
"History limit must be a positive integer greater than or equal to 1."
|
|
25
|
+
),
|
|
26
|
+
context=(
|
|
27
|
+
f"History limit assignment attempted on instance '{type(instance).__name__}'.",
|
|
28
|
+
f"Provided value type: {type(value).__name__}"
|
|
29
|
+
),
|
|
30
|
+
how_to_fix=(
|
|
31
|
+
"Ensure the limit is an integer.",
|
|
32
|
+
"Ensure the limit is at least 1.",
|
|
33
|
+
"Example valid values: 1, 5, 10, 100."
|
|
34
|
+
),
|
|
35
|
+
exception=ValueError,
|
|
36
|
+
)
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
_DESIGN_NOTES = """
|
|
40
|
+
# raise_history_limit_not_positive_integer
|
|
41
|
+
|
|
42
|
+
## Purpose
|
|
43
|
+
Raises a structured error when the user attempts to set a history limit that is
|
|
44
|
+
not a positive integer.
|
|
45
|
+
|
|
46
|
+
Valid values must satisfy:
|
|
47
|
+
`isinstance(value, int) and value >= 1`.
|
|
48
|
+
|
|
49
|
+
## Why this validation exists
|
|
50
|
+
History limit controls memory usage and navigation behavior.
|
|
51
|
+
Invalid values could break history truncation logic or produce inconsistent
|
|
52
|
+
state.
|
|
53
|
+
|
|
54
|
+
Failing early ensures:
|
|
55
|
+
- predictable history behavior,
|
|
56
|
+
- safe truncation,
|
|
57
|
+
- clear diagnostics.
|
|
58
|
+
|
|
59
|
+
## Execution context
|
|
60
|
+
Used inside `set_history_limit` before applying the new limit.
|
|
61
|
+
|
|
62
|
+
## Notes
|
|
63
|
+
- Pure raise function, no conditional logic.
|
|
64
|
+
- Used exclusively by the History mixin.
|
|
65
|
+
"""
|
simplibs/object/mixins/others/state/_history_utils/core/validations/raise_unvalide_snapshot_index.py
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
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.state import HistoryProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def raise_unvalide_snapshot_index(
|
|
10
|
+
instance: "HistoryProtocol",
|
|
11
|
+
ref: int,
|
|
12
|
+
) -> NoReturn:
|
|
13
|
+
"""
|
|
14
|
+
Raises an error when a snapshot index is outside the valid range.
|
|
15
|
+
"""
|
|
16
|
+
# noinspection PyProtectedMember
|
|
17
|
+
history_count = instance._history_count
|
|
18
|
+
|
|
19
|
+
raise SimpleRuntimeError(
|
|
20
|
+
error_name="HISTORY SNAPSHOT INDEX ERROR",
|
|
21
|
+
label="snapshot index",
|
|
22
|
+
expected=f"Integer in range 0 <= index < {history_count}",
|
|
23
|
+
value=ref,
|
|
24
|
+
problem=(
|
|
25
|
+
"Invalid snapshot index provided.",
|
|
26
|
+
f"Index {ref} is outside the valid range of recorded history."
|
|
27
|
+
),
|
|
28
|
+
context=(
|
|
29
|
+
f"History lookup attempted on instance '{type(instance).__name__}'.",
|
|
30
|
+
f"Total number of snapshots: {history_count}"
|
|
31
|
+
),
|
|
32
|
+
how_to_fix=(
|
|
33
|
+
"Ensure the index refers to an existing snapshot.",
|
|
34
|
+
"Use `history_index` or inspect `history` to determine valid indices.",
|
|
35
|
+
"Snapshot indices start at 0 and increase sequentially."
|
|
36
|
+
),
|
|
37
|
+
exception=IndexError,
|
|
38
|
+
)
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
_DESIGN_NOTES = """
|
|
42
|
+
# raise_unvalide_snapshot_index
|
|
43
|
+
|
|
44
|
+
## Purpose
|
|
45
|
+
Raises a structured error when the user provides a snapshot index that does not
|
|
46
|
+
exist in the history list.
|
|
47
|
+
|
|
48
|
+
Snapshot indices must satisfy:
|
|
49
|
+
`0 <= index < history_count`.
|
|
50
|
+
|
|
51
|
+
## Why this validation exists
|
|
52
|
+
History navigation relies on deterministic indexing.
|
|
53
|
+
Invalid indices would lead to undefined behavior or incorrect snapshot access.
|
|
54
|
+
|
|
55
|
+
Failing early ensures:
|
|
56
|
+
- predictable navigation,
|
|
57
|
+
- safe snapshot restoration,
|
|
58
|
+
- clear diagnostics for debugging.
|
|
59
|
+
|
|
60
|
+
## Execution context
|
|
61
|
+
Used inside `find_snapshot` when the reference is an integer.
|
|
62
|
+
It is the first validation step before returning the snapshot.
|
|
63
|
+
|
|
64
|
+
## Notes
|
|
65
|
+
- Pure raise function, no conditional logic.
|
|
66
|
+
- Used exclusively by the History mixin.
|
|
67
|
+
"""
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING, NoReturn
|
|
2
|
+
from datetime import datetime
|
|
3
|
+
# Outers
|
|
4
|
+
from .......exceptions import SimpleRuntimeError
|
|
5
|
+
# Annotations
|
|
6
|
+
if TYPE_CHECKING:
|
|
7
|
+
from ......._core.protocols.mixins.state import HistoryProtocol
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
def raise_unvalide_snopshot_reference(
|
|
11
|
+
instance: "HistoryProtocol",
|
|
12
|
+
ref: object,
|
|
13
|
+
) -> NoReturn:
|
|
14
|
+
"""
|
|
15
|
+
Raises an error when the provided snapshot reference is neither an integer
|
|
16
|
+
nor a datetime object.
|
|
17
|
+
"""
|
|
18
|
+
|
|
19
|
+
raise SimpleRuntimeError(
|
|
20
|
+
error_name="HISTORY SNAPSHOT REFERENCE ERROR",
|
|
21
|
+
label="snapshot reference",
|
|
22
|
+
expected="Either an integer index or a datetime timestamp.",
|
|
23
|
+
value=type(ref).__name__,
|
|
24
|
+
problem=(
|
|
25
|
+
"Invalid snapshot reference provided.",
|
|
26
|
+
"Snapshot lookup requires either an integer index or a datetime timestamp."
|
|
27
|
+
),
|
|
28
|
+
context=(
|
|
29
|
+
f"History lookup attempted on instance '{type(instance).__name__}'.",
|
|
30
|
+
f"Provided value type: {type(ref).__name__}"
|
|
31
|
+
),
|
|
32
|
+
how_to_fix=(
|
|
33
|
+
"Use an integer index to reference snapshots by position.",
|
|
34
|
+
"Use a datetime value to reference snapshots by timestamp.",
|
|
35
|
+
"Do not pass strings, floats, None, or other unsupported types."
|
|
36
|
+
),
|
|
37
|
+
exception=TypeError,
|
|
38
|
+
)
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
_DESIGN_NOTES = """
|
|
42
|
+
# raise_unvalide_snopshot_reference
|
|
43
|
+
|
|
44
|
+
## Purpose
|
|
45
|
+
Raises a structured error when the user provides a snapshot reference that is
|
|
46
|
+
neither an integer nor a datetime object.
|
|
47
|
+
|
|
48
|
+
## Why this validation exists
|
|
49
|
+
Snapshot lookup supports exactly two reference modes:
|
|
50
|
+
- index-based lookup (`int`),
|
|
51
|
+
- timestamp-based lookup (`datetime`).
|
|
52
|
+
|
|
53
|
+
Any other type would make the lookup ambiguous or meaningless.
|
|
54
|
+
|
|
55
|
+
Failing early ensures:
|
|
56
|
+
- predictable navigation,
|
|
57
|
+
- clear diagnostics,
|
|
58
|
+
- safe snapshot restoration.
|
|
59
|
+
|
|
60
|
+
## Execution context
|
|
61
|
+
Used inside `find_snapshot` when the reference does not match any supported
|
|
62
|
+
type. It is the final validation step before rejecting the input.
|
|
63
|
+
|
|
64
|
+
## Notes
|
|
65
|
+
- Pure raise function, no conditional logic.
|
|
66
|
+
- Used exclusively by the History mixin.
|
|
67
|
+
"""
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING, NoReturn, Any
|
|
2
|
+
# Outers
|
|
3
|
+
from .......exceptions import SimpleRuntimeError
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ......._core.protocols.mixins.state import HistoryProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def raise_unvalide_snopshot_timestamp(
|
|
10
|
+
instance: "HistoryProtocol",
|
|
11
|
+
ref: Any,
|
|
12
|
+
) -> NoReturn:
|
|
13
|
+
"""
|
|
14
|
+
Raises an error when a timestamp reference does not match any snapshot
|
|
15
|
+
recorded in history.
|
|
16
|
+
"""
|
|
17
|
+
# noinspection PyProtectedMember
|
|
18
|
+
history_timestamps = tuple(ts for ts, _ in instance._history)
|
|
19
|
+
|
|
20
|
+
raise SimpleRuntimeError(
|
|
21
|
+
error_name="HISTORY SNAPSHOT TIMESTAMP ERROR",
|
|
22
|
+
label="snapshot timestamp",
|
|
23
|
+
expected="A timestamp that exists in recorded history.",
|
|
24
|
+
value=ref,
|
|
25
|
+
problem=(
|
|
26
|
+
"Snapshot with the provided timestamp was not found.",
|
|
27
|
+
f"Timestamp {ref!r} does not match any recorded snapshot."
|
|
28
|
+
),
|
|
29
|
+
context=(
|
|
30
|
+
f"History lookup attempted on instance '{type(instance).__name__}'.",
|
|
31
|
+
f"Available timestamps: {history_timestamps}"
|
|
32
|
+
),
|
|
33
|
+
how_to_fix=(
|
|
34
|
+
"Ensure the timestamp refers to an existing snapshot.",
|
|
35
|
+
"Use `history` or `export_history_to_dict` to inspect available timestamps.",
|
|
36
|
+
"Snapshot timestamps are stored exactly as datetime values."
|
|
37
|
+
),
|
|
38
|
+
exception=KeyError,
|
|
39
|
+
)
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
_DESIGN_NOTES = """
|
|
43
|
+
# raise_unvalide_snopshot_timestamp
|
|
44
|
+
|
|
45
|
+
## Purpose
|
|
46
|
+
Raises a structured error when the user provides a valid datetime timestamp
|
|
47
|
+
that does not exist in the history list.
|
|
48
|
+
|
|
49
|
+
## Why this validation exists
|
|
50
|
+
History navigation by timestamp requires an exact match.
|
|
51
|
+
If the timestamp is not present, the lookup cannot proceed and must fail
|
|
52
|
+
deterministically.
|
|
53
|
+
|
|
54
|
+
Failing early ensures:
|
|
55
|
+
- predictable navigation,
|
|
56
|
+
- clear diagnostics,
|
|
57
|
+
- safe snapshot restoration.
|
|
58
|
+
|
|
59
|
+
## Execution context
|
|
60
|
+
Used inside `find_snapshot` after scanning all recorded timestamps.
|
|
61
|
+
It is triggered only when the timestamp is valid but not found.
|
|
62
|
+
|
|
63
|
+
## Notes
|
|
64
|
+
- Pure raise function, no conditional logic.
|
|
65
|
+
- Used exclusively by the History mixin.
|
|
66
|
+
"""
|
simplibs/object/mixins/others/state/_history_utils/core/validations/raise_unvalide_timestamp.py
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
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.state import HistoryProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def raise_unvalide_timestamp(
|
|
10
|
+
instance: "HistoryProtocol",
|
|
11
|
+
ref: object,
|
|
12
|
+
) -> NoReturn:
|
|
13
|
+
"""
|
|
14
|
+
Raises an error when the provided timestamp reference is not a valid datetime.
|
|
15
|
+
"""
|
|
16
|
+
|
|
17
|
+
raise SimpleRuntimeError(
|
|
18
|
+
error_name="HISTORY TIMESTAMP ERROR",
|
|
19
|
+
label="timestamp",
|
|
20
|
+
expected="A valid datetime object.",
|
|
21
|
+
value=type(ref).__name__,
|
|
22
|
+
problem=(
|
|
23
|
+
"Invalid timestamp reference provided.",
|
|
24
|
+
"History lookup requires a datetime value."
|
|
25
|
+
),
|
|
26
|
+
context=(
|
|
27
|
+
f"History lookup attempted on instance '{type(instance).__name__}'.",
|
|
28
|
+
f"Provided value type: {type(ref).__name__}"
|
|
29
|
+
),
|
|
30
|
+
how_to_fix=(
|
|
31
|
+
"Ensure the reference is a datetime object.",
|
|
32
|
+
"Use `go_to_timestamp` or `find_snapshot` with a valid datetime.",
|
|
33
|
+
"Do not pass integers, strings, or other types."
|
|
34
|
+
),
|
|
35
|
+
exception=TypeError,
|
|
36
|
+
)
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
_DESIGN_NOTES = """
|
|
40
|
+
# raise_unvalide_timestamp
|
|
41
|
+
|
|
42
|
+
## Purpose
|
|
43
|
+
Raises a structured error when the user provides a timestamp reference that is
|
|
44
|
+
not a valid `datetime` object.
|
|
45
|
+
|
|
46
|
+
## Why this validation exists
|
|
47
|
+
History navigation by timestamp requires an exact datetime match.
|
|
48
|
+
Passing any other type (string, int, float, None, etc.) would make the lookup
|
|
49
|
+
ambiguous or meaningless.
|
|
50
|
+
|
|
51
|
+
Failing early ensures:
|
|
52
|
+
- predictable timestamp navigation,
|
|
53
|
+
- clear diagnostics,
|
|
54
|
+
- safe snapshot restoration.
|
|
55
|
+
|
|
56
|
+
## Execution context
|
|
57
|
+
Used inside `find_snapshot` when the reference is expected to be a datetime.
|
|
58
|
+
It is the first validation step before searching for a matching timestamp.
|
|
59
|
+
|
|
60
|
+
## Notes
|
|
61
|
+
- Pure raise function, no conditional logic.
|
|
62
|
+
- Used exclusively by the History mixin.
|
|
63
|
+
"""
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
from .go_to_history_on_index import go_to_history_on_index
|
|
2
|
+
from .go_to_history_on_timestamp import go_to_history_on_timestamp
|
|
3
|
+
from .go_to_last_history import go_to_last_history
|
|
4
|
+
from .history_redo import history_redo
|
|
5
|
+
from .history_undo import history_undo
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
_DESIGN_NOTES = """
|
|
9
|
+
# History Navigation Utilities
|
|
10
|
+
|
|
11
|
+
## Purpose
|
|
12
|
+
Provides navigation helpers used by the History mixin to move between
|
|
13
|
+
historical snapshots. These utilities implement the core mechanics of:
|
|
14
|
+
|
|
15
|
+
- index-based navigation,
|
|
16
|
+
- timestamp-based navigation,
|
|
17
|
+
- undo/redo traversal,
|
|
18
|
+
- jumping to the latest state.
|
|
19
|
+
|
|
20
|
+
They form the operational layer of the history subsystem and are used by
|
|
21
|
+
debugging tools, diffing utilities, import/export pipelines, and interactive
|
|
22
|
+
editing workflows.
|
|
23
|
+
|
|
24
|
+
## Components
|
|
25
|
+
|
|
26
|
+
| Component | Type | Description |
|
|
27
|
+
| :--------------------------- | :--------| :------------------------------------------------------- |
|
|
28
|
+
| `go_to_history_on_index` | Function | Navigates to a specific history entry by index. |
|
|
29
|
+
| `go_to_history_on_timestamp` | Function | Navigates to a specific history entry by timestamp. |
|
|
30
|
+
| `go_to_last_history` | Function | Jumps to the most recent history entry. |
|
|
31
|
+
| `history_redo` | Function | Moves forward to the next history entry. |
|
|
32
|
+
| `history_undo` | Function | Moves backward to the previous history entry. |
|
|
33
|
+
|
|
34
|
+
## Notes
|
|
35
|
+
- These utilities are internal and not part of the public API.
|
|
36
|
+
- They rely on History internals and SnapshotMixin for state restoration.
|
|
37
|
+
- They are treated as core invariants of the history subsystem.
|
|
38
|
+
"""
|