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,248 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING, Any
|
|
2
|
+
from datetime import datetime
|
|
3
|
+
# Outers
|
|
4
|
+
from ...core_mixins import Serialization
|
|
5
|
+
# Inners
|
|
6
|
+
from ._history_utils.core import set_history_limit, record_state, find_snapshot
|
|
7
|
+
from ._history_utils.transfer import export_history_to_dict, import_history_from_dict
|
|
8
|
+
from ._history_utils.navigations import (
|
|
9
|
+
history_undo,
|
|
10
|
+
history_redo,
|
|
11
|
+
go_to_last_history,
|
|
12
|
+
go_to_history_on_timestamp,
|
|
13
|
+
go_to_history_on_index
|
|
14
|
+
)
|
|
15
|
+
# Annotations
|
|
16
|
+
if TYPE_CHECKING:
|
|
17
|
+
from ...._core.protocols.mixins.state import HistoryProtocol
|
|
18
|
+
from ...._core.protocols.alias_typings import HistoryEntry, HistoryDict, SnapshotDiffTuple
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
class History(Serialization):
|
|
22
|
+
"""
|
|
23
|
+
Provides a full undo/redo history for a mutable instance.
|
|
24
|
+
|
|
25
|
+
Every state-changing action can be recorded as a timestamped snapshot.
|
|
26
|
+
The history can be navigated step by step (undo/redo), jumped to by
|
|
27
|
+
index or timestamp, diffed between any two recorded points, and
|
|
28
|
+
exported to / imported from a dict for persistence.
|
|
29
|
+
"""
|
|
30
|
+
|
|
31
|
+
# ----------------------------------------
|
|
32
|
+
# Basic interface
|
|
33
|
+
# ----------------------------------------
|
|
34
|
+
|
|
35
|
+
# Compatibility declaration
|
|
36
|
+
_mutable_only = True
|
|
37
|
+
|
|
38
|
+
# Slot definition
|
|
39
|
+
__slots__ = (
|
|
40
|
+
"_history",
|
|
41
|
+
"_history_index",
|
|
42
|
+
"_history_limit",
|
|
43
|
+
"_history_count"
|
|
44
|
+
)
|
|
45
|
+
|
|
46
|
+
# ----------------------------------------
|
|
47
|
+
# Initialization hook
|
|
48
|
+
# ----------------------------------------
|
|
49
|
+
|
|
50
|
+
# noinspection PyAttributeOutsideInit
|
|
51
|
+
def init_mixins(
|
|
52
|
+
self: "HistoryProtocol"
|
|
53
|
+
) -> None:
|
|
54
|
+
"""
|
|
55
|
+
Method forwarding its logic into the instance's initialization
|
|
56
|
+
process.
|
|
57
|
+
"""
|
|
58
|
+
|
|
59
|
+
# 1. Create internal elements
|
|
60
|
+
self._history: list["HistoryEntry"] = []
|
|
61
|
+
self._history_limit: int | None = None
|
|
62
|
+
self._history_index: int = 0
|
|
63
|
+
self._history_count: int = 0
|
|
64
|
+
|
|
65
|
+
# 2. Create the first entry
|
|
66
|
+
self.record_state()
|
|
67
|
+
|
|
68
|
+
# ----------------------------------------
|
|
69
|
+
# Initialization-related method
|
|
70
|
+
# ----------------------------------------
|
|
71
|
+
|
|
72
|
+
def record_state(
|
|
73
|
+
self: "HistoryProtocol"
|
|
74
|
+
) -> "HistoryEntry":
|
|
75
|
+
"""Creates a snapshot of the current state and saves it to history."""
|
|
76
|
+
return record_state(self)
|
|
77
|
+
|
|
78
|
+
# ----------------------------------------
|
|
79
|
+
# Property - getters
|
|
80
|
+
# ----------------------------------------
|
|
81
|
+
|
|
82
|
+
@property
|
|
83
|
+
def history(
|
|
84
|
+
self: "HistoryProtocol"
|
|
85
|
+
) -> tuple["HistoryEntry", ...]:
|
|
86
|
+
"""Returns the history as a tuple."""
|
|
87
|
+
return tuple(self._history)
|
|
88
|
+
|
|
89
|
+
@property
|
|
90
|
+
def history_index(
|
|
91
|
+
self: "HistoryProtocol"
|
|
92
|
+
) -> int | None:
|
|
93
|
+
"""Returns the index of the latest history entry."""
|
|
94
|
+
return self._history_index
|
|
95
|
+
|
|
96
|
+
@property
|
|
97
|
+
def history_limit(
|
|
98
|
+
self: "HistoryProtocol"
|
|
99
|
+
) -> int | None:
|
|
100
|
+
"""Returns the history size limit."""
|
|
101
|
+
return self._history_limit
|
|
102
|
+
|
|
103
|
+
# ----------------------------------------
|
|
104
|
+
# Property - setters
|
|
105
|
+
# ----------------------------------------
|
|
106
|
+
|
|
107
|
+
@history_limit.setter
|
|
108
|
+
def history_limit(
|
|
109
|
+
self: "HistoryProtocol",
|
|
110
|
+
value: int
|
|
111
|
+
) -> None:
|
|
112
|
+
"""Sets the history size limit."""
|
|
113
|
+
set_history_limit(self, value)
|
|
114
|
+
|
|
115
|
+
# ----------------------------------------
|
|
116
|
+
# Methods - UNDO / REDO
|
|
117
|
+
# ----------------------------------------
|
|
118
|
+
|
|
119
|
+
def undo(
|
|
120
|
+
self: "HistoryProtocol"
|
|
121
|
+
) -> bool:
|
|
122
|
+
"""Method for moving to the previous entry (if it exists)."""
|
|
123
|
+
return history_undo(self)
|
|
124
|
+
|
|
125
|
+
def redo(
|
|
126
|
+
self: "HistoryProtocol"
|
|
127
|
+
) -> bool:
|
|
128
|
+
"""Method for moving to the next entry (if it exists)."""
|
|
129
|
+
return history_redo(self)
|
|
130
|
+
|
|
131
|
+
# ----------------------------------------
|
|
132
|
+
# Methods - GOTO
|
|
133
|
+
# ----------------------------------------
|
|
134
|
+
|
|
135
|
+
def go_to_last(
|
|
136
|
+
self: "HistoryProtocol"
|
|
137
|
+
) -> None:
|
|
138
|
+
"""Method for moving to the last history entry."""
|
|
139
|
+
go_to_last_history(self)
|
|
140
|
+
|
|
141
|
+
def go_to_index(
|
|
142
|
+
self: "HistoryProtocol",
|
|
143
|
+
index: int
|
|
144
|
+
) -> None:
|
|
145
|
+
"""Method for moving to a specific index."""
|
|
146
|
+
go_to_history_on_index(self, index)
|
|
147
|
+
|
|
148
|
+
def go_to_timestamp(
|
|
149
|
+
self: "HistoryProtocol",
|
|
150
|
+
timestamp: datetime
|
|
151
|
+
) -> None:
|
|
152
|
+
"""Method for moving to a specific timestamp."""
|
|
153
|
+
go_to_history_on_timestamp(self, timestamp)
|
|
154
|
+
|
|
155
|
+
# ----------------------------------------
|
|
156
|
+
# Methods - EXPORT / IMPORT
|
|
157
|
+
# ----------------------------------------
|
|
158
|
+
|
|
159
|
+
def export_history_to_dict(
|
|
160
|
+
self: "HistoryProtocol"
|
|
161
|
+
) -> "HistoryDict":
|
|
162
|
+
"""Exports the history to a dict."""
|
|
163
|
+
return export_history_to_dict(self)
|
|
164
|
+
|
|
165
|
+
def import_history_from_dict(
|
|
166
|
+
self: "HistoryProtocol",
|
|
167
|
+
history_dict: "HistoryDict"
|
|
168
|
+
) -> None:
|
|
169
|
+
"""Imports the history from a dict."""
|
|
170
|
+
import_history_from_dict(self, history_dict)
|
|
171
|
+
|
|
172
|
+
# ----------------------------------------
|
|
173
|
+
# Methods - REMOVE / DIFF
|
|
174
|
+
# ----------------------------------------
|
|
175
|
+
|
|
176
|
+
def remove_history_limit(
|
|
177
|
+
self: "HistoryProtocol"
|
|
178
|
+
) -> None:
|
|
179
|
+
"""Removes the history size limit."""
|
|
180
|
+
# noinspection PyAttributeOutsideInit
|
|
181
|
+
self._history_limit = None
|
|
182
|
+
|
|
183
|
+
def diff(
|
|
184
|
+
self: "HistoryProtocol",
|
|
185
|
+
snap1: int | datetime,
|
|
186
|
+
snap2: int | datetime,
|
|
187
|
+
*,
|
|
188
|
+
constants_only: bool = False
|
|
189
|
+
) -> "SnapshotDiffTuple":
|
|
190
|
+
"""Compares two snapshots — returns a tuple of changed (path, old_value, new_value)."""
|
|
191
|
+
return self._compare_snapshots(
|
|
192
|
+
find_snapshot(self, snap1),
|
|
193
|
+
find_snapshot(self, snap2),
|
|
194
|
+
constants_only=constants_only
|
|
195
|
+
)
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
_DESIGN_NOTES = """
|
|
199
|
+
# History
|
|
200
|
+
|
|
201
|
+
## Purpose
|
|
202
|
+
Full undo/redo history for a mutable instance — records snapshots over
|
|
203
|
+
time, lets you step backward/forward, jump to a specific index or
|
|
204
|
+
timestamp, diff any two recorded states, and export/import the whole
|
|
205
|
+
history as a dict.
|
|
206
|
+
|
|
207
|
+
## Compatibility
|
|
208
|
+
- `_mutable_only = True` — history tracks in-place mutations over time;
|
|
209
|
+
an immutable instance has no in-place timeline to record.
|
|
210
|
+
|
|
211
|
+
## Logic
|
|
212
|
+
`History` is mostly a thin coordinating layer over the
|
|
213
|
+
`_history_utils` package, which does the heavy lifting:
|
|
214
|
+
|
|
215
|
+
- **Recording**: `init_mixins` sets up empty `_history`/`_history_index`/
|
|
216
|
+
`_history_limit`/`_history_count`, then immediately calls
|
|
217
|
+
`record_state()` once, so a freshly created instance already has one
|
|
218
|
+
entry — its own starting state — rather than an empty history.
|
|
219
|
+
`record_state()` itself delegates to the `record_state` utility.
|
|
220
|
+
- **Limit management**: `history_limit` is a property with both a
|
|
221
|
+
getter (plain attribute read) and a setter that delegates to
|
|
222
|
+
`set_history_limit` (presumably handling trimming older entries when
|
|
223
|
+
the limit shrinks). `remove_history_limit()` bypasses that utility and
|
|
224
|
+
sets `_history_limit = None` directly, since removing a limit needs no
|
|
225
|
+
trimming logic.
|
|
226
|
+
- **Navigation**: `undo()`/`redo()` delegate to `history_undo`/
|
|
227
|
+
`history_redo` and return a `bool` (presumably whether the move
|
|
228
|
+
succeeded, e.g. `False` at the start/end of history). `go_to_last()`,
|
|
229
|
+
`go_to_index()`, `go_to_timestamp()` delegate to their matching
|
|
230
|
+
`_history_utils.navigations` functions.
|
|
231
|
+
- **Export/import**: `export_history_to_dict()`/
|
|
232
|
+
`import_history_from_dict()` delegate straight to the `transfer`
|
|
233
|
+
utilities — this is what makes history itself serializable, separate
|
|
234
|
+
from the instance's own `to_dict()`/`from_dict()` in `Serialization`.
|
|
235
|
+
- **Diffing**: `diff(snap1, snap2, constants_only=...)` accepts either an
|
|
236
|
+
index or a `datetime` for each side, resolves each via
|
|
237
|
+
`find_snapshot`, then reuses `_compare_snapshots` (inherited via
|
|
238
|
+
`Serialization` → `Infrastructure` → `Snapshot`) to produce the actual
|
|
239
|
+
diff.
|
|
240
|
+
|
|
241
|
+
## Notes
|
|
242
|
+
- Builds on `Serialization` (not directly on `Snapshot`), since history
|
|
243
|
+
export/import needs the same dict/JSON foundation the instance's own
|
|
244
|
+
state serialization uses.
|
|
245
|
+
- `diff()`'s dual `int | datetime` snapshot selectors mean a caller never
|
|
246
|
+
has to manually look up an entry first — `find_snapshot` handles both
|
|
247
|
+
identification schemes.
|
|
248
|
+
"""
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
# Outers
|
|
3
|
+
from ...base_class import SimpleMixin
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ...._core.protocols.mixins.state import PermissionProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
class Permission(SimpleMixin):
|
|
10
|
+
"""
|
|
11
|
+
Read-only mode — locking against changes.
|
|
12
|
+
|
|
13
|
+
Example:
|
|
14
|
+
obj.lock()
|
|
15
|
+
obj.value = 10 # → ValueError
|
|
16
|
+
"""
|
|
17
|
+
|
|
18
|
+
# ----------------------------------------
|
|
19
|
+
# Basic interface
|
|
20
|
+
# ----------------------------------------
|
|
21
|
+
|
|
22
|
+
# Compatibility declaration
|
|
23
|
+
_mutable_only = True
|
|
24
|
+
|
|
25
|
+
# Slot definition
|
|
26
|
+
__slots__ = ()
|
|
27
|
+
|
|
28
|
+
# ----------------------------------------
|
|
29
|
+
# Property - getters
|
|
30
|
+
# ----------------------------------------
|
|
31
|
+
|
|
32
|
+
@property
|
|
33
|
+
def is_locked(
|
|
34
|
+
self: "PermissionProtocol"
|
|
35
|
+
) -> bool:
|
|
36
|
+
"""Returns a bool indicating whether the lock is active."""
|
|
37
|
+
return self._locked
|
|
38
|
+
|
|
39
|
+
# ----------------------------------------
|
|
40
|
+
# Methods - LOCK / UNLOCK
|
|
41
|
+
# ----------------------------------------
|
|
42
|
+
|
|
43
|
+
def lock(
|
|
44
|
+
self: "PermissionProtocol"
|
|
45
|
+
) -> None:
|
|
46
|
+
"""Engages the lock."""
|
|
47
|
+
object.__setattr__(self, "_locked", True)
|
|
48
|
+
|
|
49
|
+
def unlock(
|
|
50
|
+
self: "PermissionProtocol"
|
|
51
|
+
) -> None:
|
|
52
|
+
"""Releases the lock."""
|
|
53
|
+
object.__setattr__(self, "_locked", False)
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
_DESIGN_NOTES = """
|
|
57
|
+
# Permission
|
|
58
|
+
|
|
59
|
+
## Purpose
|
|
60
|
+
Gives a mutable instance a runtime read-only switch — `obj.lock()` turns
|
|
61
|
+
further writes into errors, `obj.unlock()` turns them back on. Useful for
|
|
62
|
+
temporarily protecting a mutable instance without converting it to an
|
|
63
|
+
actual immutable class.
|
|
64
|
+
|
|
65
|
+
> For newcomers: this is different from immutability by design (the
|
|
66
|
+
> `_immutable_only` mixins) — that's a permanent, structural property of
|
|
67
|
+
> the class. `Permission` is a *runtime* toggle on an otherwise mutable
|
|
68
|
+
> instance, checked at write time rather than baked into the class.
|
|
69
|
+
|
|
70
|
+
## Compatibility
|
|
71
|
+
- `_mutable_only = True` — locking only makes sense where writes are
|
|
72
|
+
otherwise allowed; an immutable instance already rejects all writes
|
|
73
|
+
unconditionally, so this mixin would be redundant there.
|
|
74
|
+
|
|
75
|
+
## Logic
|
|
76
|
+
- `is_locked` simply exposes the internal `_locked` flag.
|
|
77
|
+
- `lock()` / `unlock()` set `_locked` via `object.__setattr__` rather
|
|
78
|
+
than plain attribute assignment — bypassing any custom `__setattr__`
|
|
79
|
+
the instance class might define, since the lock flag itself must
|
|
80
|
+
always be settable even while the instance is otherwise locked.
|
|
81
|
+
|
|
82
|
+
## Notes
|
|
83
|
+
- `_locked` is not initialized by this mixin's `init_mixins` — in fact
|
|
84
|
+
this mixin doesn't override `init_mixins` at all. The attribute is
|
|
85
|
+
defined directly on every atomic instance by `create_atom_init`
|
|
86
|
+
(`self._locked = False`), and the check for it lives directly inside
|
|
87
|
+
`create_value_setter` (`if self._locked: raise_locked_value_error(...)`).
|
|
88
|
+
In other words: every instance already carries `_locked` and already
|
|
89
|
+
enforces it, purely as part of how atomic instances and their value
|
|
90
|
+
setters are built — not as something this mixin sets up.
|
|
91
|
+
- `Permission` therefore adds **no new mechanism** — it only exposes a
|
|
92
|
+
friendly public API (`lock()`, `unlock()`, `is_locked`) over
|
|
93
|
+
infrastructure that already exists on every instance regardless of
|
|
94
|
+
whether this mixin is used. This was a deliberate choice: building a
|
|
95
|
+
separate access path into the value setter just for this one mixin
|
|
96
|
+
would have added complexity for a single consumer, so `_locked` was
|
|
97
|
+
folded directly into the shared atomic-instance construction instead.
|
|
98
|
+
- A practical consequence: even instances that don't use `Permission`
|
|
99
|
+
still carry a (permanently `False`) `_locked` attribute and pay the
|
|
100
|
+
cost of the `if self._locked:` check on every value write. This mixin
|
|
101
|
+
is what turns that otherwise-dormant flag into a usable feature.
|
|
102
|
+
"""
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
from .DefaultState import DefaultState
|
|
2
|
+
from .DirtyTracking import DirtyTracking
|
|
3
|
+
from .History import History
|
|
4
|
+
from .Permission import Permission
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
_DESIGN_NOTES = """
|
|
8
|
+
# State Mixins
|
|
9
|
+
|
|
10
|
+
## Purpose
|
|
11
|
+
State-management mixins for mutable instances — remembering an initial
|
|
12
|
+
state, tracking unsaved changes, recording a full undo/redo history, and
|
|
13
|
+
runtime read-only locking.
|
|
14
|
+
|
|
15
|
+
## Components
|
|
16
|
+
|
|
17
|
+
| Component | Type | Description |
|
|
18
|
+
| :----------------- | :---- | :--------------------------------------------------------------------- |
|
|
19
|
+
| `DefaultState` | Mixin | Remembers construction-time state; reset/clone/new-default. |
|
|
20
|
+
| `DirtyTracking` | Mixin | `is_dirty`, `dirty_paths`, `mark_clean()`, `reset_to_clean()`. |
|
|
21
|
+
| `History` | Mixin | Full undo/redo history — record, navigate, diff, export/import. |
|
|
22
|
+
| `Permission` | Mixin | Runtime `lock()` / `unlock()` read-only toggle. |
|
|
23
|
+
|
|
24
|
+
## Notes
|
|
25
|
+
- All four are `_mutable_only` — every one of them concerns in-place
|
|
26
|
+
state that has no meaning on an immutable instance.
|
|
27
|
+
- `Permission`'s `_locked` attribute and its enforcement are not set up
|
|
28
|
+
by this mixin — they are built directly into every atomic instance via
|
|
29
|
+
`create_atom_init` and `create_value_setter`; `Permission` only exposes
|
|
30
|
+
a friendly API over that existing infrastructure.
|
|
31
|
+
"""
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
_DESIGN_NOTES = """
|
|
2
|
+
# _history_utils Package Overview
|
|
3
|
+
|
|
4
|
+
The `_history_utils` package contains the internal helper subsystems used by
|
|
5
|
+
the History mixin. Each sub‑package focuses on a specific operational domain:
|
|
6
|
+
core history mechanics, navigation utilities, and import/export pipelines.
|
|
7
|
+
|
|
8
|
+
This package does not re‑export any components. All functionality is accessed
|
|
9
|
+
directly through the corresponding sub‑packages.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Sub‑Packages
|
|
14
|
+
|
|
15
|
+
### 1. core
|
|
16
|
+
Provides the foundational history operations:
|
|
17
|
+
- snapshot creation and recording,
|
|
18
|
+
- snapshot lookup by index or timestamp,
|
|
19
|
+
- history limit enforcement.
|
|
20
|
+
|
|
21
|
+
These utilities form the backbone of the History mixin’s state‑management logic.
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
### 2. navigations
|
|
26
|
+
Implements navigation helpers:
|
|
27
|
+
- undo and redo traversal,
|
|
28
|
+
- jumping to specific history entries,
|
|
29
|
+
- restoring the latest snapshot.
|
|
30
|
+
|
|
31
|
+
These functions provide the operational navigation API of the History mixin.
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
### 3. transfer
|
|
36
|
+
Implements import/export utilities:
|
|
37
|
+
- exporting history into dictionary structures,
|
|
38
|
+
- importing history with owner‑class validation,
|
|
39
|
+
- safe and atomic restoration of historical state.
|
|
40
|
+
|
|
41
|
+
These utilities support persistence, debugging, external tooling, and
|
|
42
|
+
cross‑process state transfer.
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## Notes
|
|
47
|
+
- This package is internal and not intended for direct user interaction.
|
|
48
|
+
- Each sub‑package is self‑contained and exposes its own public API.
|
|
49
|
+
- The structure is designed for clarity, modularity, and predictable behavior.
|
|
50
|
+
"""
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
from .find_snapshot import find_snapshot
|
|
2
|
+
from .record_state import record_state
|
|
3
|
+
from .set_history_limit import set_history_limit
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
_DESIGN_NOTES = """
|
|
7
|
+
# Core History Utilities
|
|
8
|
+
|
|
9
|
+
## Purpose
|
|
10
|
+
Provides the foundational helper functions used by the History mixin.
|
|
11
|
+
These utilities implement the core mechanics of:
|
|
12
|
+
|
|
13
|
+
- snapshot lookup,
|
|
14
|
+
- snapshot recording,
|
|
15
|
+
- history limit enforcement.
|
|
16
|
+
|
|
17
|
+
They form the backbone of the history subsystem and are used by navigation,
|
|
18
|
+
diffing, import/export, and debugging tools.
|
|
19
|
+
|
|
20
|
+
## Components
|
|
21
|
+
|
|
22
|
+
| Component | Type | Description |
|
|
23
|
+
| :--------------------| :--------| :-------------------------------------------------------- |
|
|
24
|
+
| `find_snapshot` | Function | Resolves index or timestamp into a snapshot tuple. |
|
|
25
|
+
| `record_state` | Function | Creates and stores a new history entry. |
|
|
26
|
+
| `set_history_limit` | Function | Enforces and applies the maximum history size. |
|
|
27
|
+
|
|
28
|
+
## Notes
|
|
29
|
+
- These utilities are internal and not part of the public API.
|
|
30
|
+
- They are treated as core invariants of the history subsystem.
|
|
31
|
+
- All structural logic is delegated to History internals and SnapshotMixin.
|
|
32
|
+
"""
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
from datetime import datetime
|
|
3
|
+
# Outers
|
|
4
|
+
from .validations import (
|
|
5
|
+
raise_unvalide_snapshot_index,
|
|
6
|
+
raise_unvalide_timestamp,
|
|
7
|
+
raise_unvalide_snopshot_timestamp,
|
|
8
|
+
raise_unvalide_snopshot_reference,
|
|
9
|
+
)
|
|
10
|
+
# Annotations
|
|
11
|
+
if TYPE_CHECKING:
|
|
12
|
+
from ......_core.protocols.mixins.state import HistoryProtocol
|
|
13
|
+
from ......_core.protocols.alias_typings import SnapshotTuple
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
def find_snapshot(
|
|
17
|
+
self: "HistoryProtocol",
|
|
18
|
+
ref: int | datetime
|
|
19
|
+
) -> "SnapshotTuple":
|
|
20
|
+
"""
|
|
21
|
+
Resolves an index or timestamp reference into a snapshot tuple.
|
|
22
|
+
"""
|
|
23
|
+
|
|
24
|
+
# 1. Handle integer reference
|
|
25
|
+
if isinstance(ref, int):
|
|
26
|
+
|
|
27
|
+
# 1.1 Validate index
|
|
28
|
+
if not (0 <= ref < self._history_count):
|
|
29
|
+
raise_unvalide_snapshot_index(self, ref)
|
|
30
|
+
|
|
31
|
+
# 1.2 Return snapshot
|
|
32
|
+
return self._history[ref][1]
|
|
33
|
+
|
|
34
|
+
# 2. Handle datetime reference
|
|
35
|
+
if isinstance(ref, datetime):
|
|
36
|
+
|
|
37
|
+
# 2.1 Validate timestamp type
|
|
38
|
+
if not isinstance(ref, datetime):
|
|
39
|
+
raise_unvalide_timestamp(self, ref)
|
|
40
|
+
|
|
41
|
+
# 2.2 Search for matching timestamp
|
|
42
|
+
for ts, snapshot in self._history:
|
|
43
|
+
if ts == ref:
|
|
44
|
+
return snapshot
|
|
45
|
+
|
|
46
|
+
# 2.3 Timestamp not found
|
|
47
|
+
raise_unvalide_snopshot_timestamp(self, ref)
|
|
48
|
+
|
|
49
|
+
# 3. Invalid reference type
|
|
50
|
+
raise_unvalide_snopshot_reference(self, ref)
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
_DESIGN_NOTES = """
|
|
54
|
+
# find_snapshot
|
|
55
|
+
|
|
56
|
+
## Purpose
|
|
57
|
+
Resolves a snapshot reference — either an integer index or a datetime
|
|
58
|
+
timestamp — into the corresponding snapshot tuple stored in history.
|
|
59
|
+
This function is the central lookup mechanism of the history subsystem.
|
|
60
|
+
|
|
61
|
+
## Architectural role
|
|
62
|
+
`find_snapshot` is used by:
|
|
63
|
+
|
|
64
|
+
- `History.diff` (snapshot comparison)
|
|
65
|
+
- navigation utilities (`go_to_index`, `go_to_timestamp`)
|
|
66
|
+
- undo/redo logic
|
|
67
|
+
- debugging tools
|
|
68
|
+
- history export/import validation
|
|
69
|
+
|
|
70
|
+
It provides a deterministic way to retrieve historical state regardless of
|
|
71
|
+
whether the user references it by index or timestamp.
|
|
72
|
+
|
|
73
|
+
## How it works
|
|
74
|
+
The function performs three deterministic steps:
|
|
75
|
+
|
|
76
|
+
### 1. Integer reference
|
|
77
|
+
If `ref` is an integer:
|
|
78
|
+
- validates that the index is within bounds,
|
|
79
|
+
- returns the snapshot at that index.
|
|
80
|
+
|
|
81
|
+
This is the fastest lookup path and is used by most navigation operations.
|
|
82
|
+
|
|
83
|
+
### 2. Timestamp reference
|
|
84
|
+
If `ref` is a datetime:
|
|
85
|
+
- validates the type,
|
|
86
|
+
- scans the history for a matching timestamp,
|
|
87
|
+
- returns the associated snapshot.
|
|
88
|
+
|
|
89
|
+
If no timestamp matches, a structured validation error is raised.
|
|
90
|
+
|
|
91
|
+
### 3. Invalid reference type
|
|
92
|
+
If `ref` is neither an integer nor a datetime, the function raises a dedicated
|
|
93
|
+
validation error describing the expected types.
|
|
94
|
+
|
|
95
|
+
## Integration requirements
|
|
96
|
+
The function assumes the instance implements:
|
|
97
|
+
|
|
98
|
+
- **History internals**
|
|
99
|
+
`_history`, `_history_count`, `_history_index`
|
|
100
|
+
|
|
101
|
+
- **SnapshotMixin**
|
|
102
|
+
Snapshot tuples are produced by `_build_snapshot()` and stored in history.
|
|
103
|
+
|
|
104
|
+
Without these components, the lookup mechanism cannot operate correctly.
|
|
105
|
+
|
|
106
|
+
## Why this function exists
|
|
107
|
+
History navigation must support two reference modes:
|
|
108
|
+
|
|
109
|
+
- **index-based** (fast, positional, stable)
|
|
110
|
+
- **timestamp-based** (semantic, human-readable)
|
|
111
|
+
|
|
112
|
+
Supporting both makes the history subsystem flexible and intuitive while
|
|
113
|
+
remaining deterministic.
|
|
114
|
+
|
|
115
|
+
## Deterministic behavior
|
|
116
|
+
Snapshot lookup is guaranteed to be:
|
|
117
|
+
|
|
118
|
+
- stable,
|
|
119
|
+
- predictable,
|
|
120
|
+
- type-safe,
|
|
121
|
+
- consistent across all history operations.
|
|
122
|
+
|
|
123
|
+
This determinism is essential for undo/redo, diffing, debugging, and
|
|
124
|
+
serialization.
|
|
125
|
+
|
|
126
|
+
## Stability guarantee
|
|
127
|
+
Any change to this function would affect:
|
|
128
|
+
|
|
129
|
+
- navigation correctness,
|
|
130
|
+
- diffing behavior,
|
|
131
|
+
- history import/export,
|
|
132
|
+
- undo/redo logic,
|
|
133
|
+
- debugging tools.
|
|
134
|
+
|
|
135
|
+
Therefore, `find_snapshot` is treated as a **core invariant** of the history
|
|
136
|
+
subsystem.
|
|
137
|
+
|
|
138
|
+
## Notes
|
|
139
|
+
- This function is intentionally minimal and side‑effect‑free.
|
|
140
|
+
- It is not part of the public API; it is used internally by mixins.
|
|
141
|
+
- All structural logic is delegated to history internals.
|
|
142
|
+
"""
|