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,24 @@
|
|
|
1
|
+
from .InnersProperty import InnersProperty
|
|
2
|
+
from .MetaShortcuts import MetaShortcuts
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
_DESIGN_NOTES = """
|
|
6
|
+
# Properties Mixins
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
Ergonomic property-based access — direct attribute access to a
|
|
10
|
+
composite's inners, and shortcut properties over frequently used
|
|
11
|
+
metadata fields.
|
|
12
|
+
|
|
13
|
+
## Components
|
|
14
|
+
|
|
15
|
+
| Component | Type | Description |
|
|
16
|
+
| :------------------ | :---- | :------------------------------------------------------------------ |
|
|
17
|
+
| `InnersProperty` | Mixin | Generates direct-access properties for a composite's inners. |
|
|
18
|
+
| `MetaShortcuts` | Mixin | Exposes `is_atom`, `is_composite`, `name_snake`, etc. from `meta`. |
|
|
19
|
+
|
|
20
|
+
## Notes
|
|
21
|
+
- `InnersProperty` is `_composite_only` and uses
|
|
22
|
+
`__extend_instance_class__`; `MetaShortcuts` has no compatibility
|
|
23
|
+
restrictions and adds no new behavior beyond passthrough properties.
|
|
24
|
+
"""
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
from .collect_all_nested_properties import collect_all_nested_properties
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
_DESIGN_NOTES = """
|
|
5
|
+
# Inners Property Utilities
|
|
6
|
+
|
|
7
|
+
## Purpose
|
|
8
|
+
Provides helper utilities used by the property subsystem to generate nested
|
|
9
|
+
properties for composite Simple objects. These utilities traverse metadata
|
|
10
|
+
structures and create fully qualified Python properties for deeply nested
|
|
11
|
+
inner elements.
|
|
12
|
+
|
|
13
|
+
## Components
|
|
14
|
+
|
|
15
|
+
| Component | Type | Description |
|
|
16
|
+
| :------------------------------ | :--------| :------------------------------------------------------------------ |
|
|
17
|
+
| `collect_all_nested_properties` | Function | Entry point that collects properties for all nested inner elements. |
|
|
18
|
+
|
|
19
|
+
## Notes
|
|
20
|
+
- This package is internal and not part of the public API.
|
|
21
|
+
- Recursive traversal is delegated to `_collect_nested_inner_properties`.
|
|
22
|
+
- The design emphasizes clarity, modularity, and deterministic behavior.
|
|
23
|
+
"""
|
simplibs/object/mixins/others/properties/_inners_property_utils/_collect_nested_inner_properties.py
ADDED
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
# Inners
|
|
3
|
+
from ....._core.logic.property_builders import create_properties_for_inner
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ....._core.protocols.metadata import SimpleMetadataLike
|
|
7
|
+
from ....._core.protocols.alias_typings import PathTuple
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
def _collect_nested_inner_properties(
|
|
11
|
+
meta: "SimpleMetadataLike",
|
|
12
|
+
path: "PathTuple",
|
|
13
|
+
result: dict[str, property]
|
|
14
|
+
) -> None:
|
|
15
|
+
"""
|
|
16
|
+
Recursively traverses all nested inners and adds their properties
|
|
17
|
+
into the `result` dictionary.
|
|
18
|
+
"""
|
|
19
|
+
|
|
20
|
+
# 1. Iterate through inner elements
|
|
21
|
+
for inner in meta.inners:
|
|
22
|
+
|
|
23
|
+
# 1.1 Extract metadata and extend path
|
|
24
|
+
inner_meta = inner.meta
|
|
25
|
+
new_path = path + (inner_meta.name_private,)
|
|
26
|
+
|
|
27
|
+
# 1.2 Create properties (for constants and composites)
|
|
28
|
+
props = create_properties_for_inner(inner_meta, new_path)
|
|
29
|
+
result.update(props)
|
|
30
|
+
|
|
31
|
+
# 1.3 Recursively process composite inners
|
|
32
|
+
if not inner_meta.is_constant:
|
|
33
|
+
_collect_nested_inner_properties(inner_meta, new_path, result)
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
_DESIGN_NOTES = """
|
|
37
|
+
# _collect_nested_inner_properties
|
|
38
|
+
|
|
39
|
+
## Purpose
|
|
40
|
+
Recursively collects properties for all nested inner elements and stores them
|
|
41
|
+
in the provided `result` dictionary. This function is the low‑level engine
|
|
42
|
+
behind nested property generation for composite structures.
|
|
43
|
+
|
|
44
|
+
It ensures that every inner element — regardless of depth — receives a
|
|
45
|
+
properly constructed property with a correct access path.
|
|
46
|
+
|
|
47
|
+
## Architectural role
|
|
48
|
+
`_collect_nested_inner_properties` is used by:
|
|
49
|
+
|
|
50
|
+
- `collect_all_nested_properties`
|
|
51
|
+
- property generation during class initialization
|
|
52
|
+
- composite structure expansion
|
|
53
|
+
- metadata‑driven property builders
|
|
54
|
+
- debugging and introspection tools
|
|
55
|
+
|
|
56
|
+
It forms the recursive backbone of nested property discovery.
|
|
57
|
+
|
|
58
|
+
## How it works
|
|
59
|
+
The function performs three deterministic steps:
|
|
60
|
+
|
|
61
|
+
### 1. Iterate through inner elements
|
|
62
|
+
For each inner element in `meta.inners`, the function extracts its metadata and
|
|
63
|
+
extends the current path tuple.
|
|
64
|
+
The path represents the hierarchical location of the inner element inside the
|
|
65
|
+
composite structure.
|
|
66
|
+
|
|
67
|
+
### 2. Create properties
|
|
68
|
+
Calls `create_properties_for_inner(inner_meta, new_path)` which generates:
|
|
69
|
+
|
|
70
|
+
- getter/setter properties,
|
|
71
|
+
- composite accessors,
|
|
72
|
+
- constant accessors,
|
|
73
|
+
- metadata‑aware property wrappers.
|
|
74
|
+
|
|
75
|
+
These properties are inserted into the shared `result` dictionary.
|
|
76
|
+
|
|
77
|
+
### 3. Recursively process composite inners
|
|
78
|
+
If the inner element is a composite (`not inner_meta.is_constant`), the
|
|
79
|
+
function calls itself recursively, passing the extended path.
|
|
80
|
+
|
|
81
|
+
This ensures that nested composite structures are fully traversed and all
|
|
82
|
+
properties are generated.
|
|
83
|
+
|
|
84
|
+
## Integration requirements
|
|
85
|
+
The function assumes:
|
|
86
|
+
|
|
87
|
+
- **SimpleMetadataLike**
|
|
88
|
+
Provides `.inners`, `.name_private`, `.is_constant`.
|
|
89
|
+
|
|
90
|
+
- **property_builders.create_properties_for_inner**
|
|
91
|
+
Generates the actual property objects.
|
|
92
|
+
|
|
93
|
+
Without these components, nested property generation cannot operate correctly.
|
|
94
|
+
|
|
95
|
+
## Why this function exists
|
|
96
|
+
Nested composite structures require:
|
|
97
|
+
|
|
98
|
+
- deterministic property generation,
|
|
99
|
+
- stable hierarchical paths,
|
|
100
|
+
- metadata‑driven behavior,
|
|
101
|
+
- recursive traversal,
|
|
102
|
+
- consistent naming conventions.
|
|
103
|
+
|
|
104
|
+
This function encapsulates all of that in a minimal, stable utility.
|
|
105
|
+
|
|
106
|
+
## Deterministic behavior
|
|
107
|
+
The function guarantees:
|
|
108
|
+
|
|
109
|
+
- stable path construction,
|
|
110
|
+
- consistent property naming,
|
|
111
|
+
- predictable recursion,
|
|
112
|
+
- correct handling of constants and composites,
|
|
113
|
+
- deterministic ordering based on metadata.
|
|
114
|
+
|
|
115
|
+
This determinism is essential for introspection, debugging, and composite
|
|
116
|
+
behavior.
|
|
117
|
+
|
|
118
|
+
## Stability guarantee
|
|
119
|
+
Any change to this function would affect:
|
|
120
|
+
|
|
121
|
+
- property generation,
|
|
122
|
+
- composite access behavior,
|
|
123
|
+
- metadata consistency,
|
|
124
|
+
- debugging tools,
|
|
125
|
+
- class initialization.
|
|
126
|
+
|
|
127
|
+
Therefore, `_collect_nested_inner_properties` is treated as a **core invariant**
|
|
128
|
+
of the property subsystem.
|
|
129
|
+
|
|
130
|
+
## Notes
|
|
131
|
+
- This function is intentionally minimal and side‑effect‑free.
|
|
132
|
+
- It is not part of the public API; it is used internally by mixins.
|
|
133
|
+
- All structural logic is delegated to metadata and property builders.
|
|
134
|
+
"""
|
simplibs/object/mixins/others/properties/_inners_property_utils/collect_all_nested_properties.py
ADDED
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
# Inners
|
|
3
|
+
from ._collect_nested_inner_properties import _collect_nested_inner_properties
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ....._core.protocols.metadata import SimpleMetadataLike
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def collect_all_nested_properties(
|
|
10
|
+
meta: "SimpleMetadataLike"
|
|
11
|
+
) -> dict[str, property]:
|
|
12
|
+
"""
|
|
13
|
+
Returns a dictionary of properties for all nested inner elements.
|
|
14
|
+
Direct inners are ignored (they already have their own properties).
|
|
15
|
+
"""
|
|
16
|
+
|
|
17
|
+
# 1. Initialize result container
|
|
18
|
+
result = {}
|
|
19
|
+
|
|
20
|
+
# 2. Iterate through direct inners
|
|
21
|
+
for inner in meta.inners:
|
|
22
|
+
|
|
23
|
+
# 2.1 Extract metadata
|
|
24
|
+
inner_meta = inner.meta
|
|
25
|
+
inner_meta: "SimpleMetadataLike"
|
|
26
|
+
|
|
27
|
+
# 2.2 Process only composite inners
|
|
28
|
+
if not inner_meta.is_constant:
|
|
29
|
+
|
|
30
|
+
# 2.2.1 Build initial path tuple
|
|
31
|
+
path = (inner_meta.name_private,)
|
|
32
|
+
|
|
33
|
+
# 2.2.2 Recursively collect nested properties
|
|
34
|
+
_collect_nested_inner_properties(inner_meta, path, result)
|
|
35
|
+
|
|
36
|
+
# 3. Return collected properties
|
|
37
|
+
return result
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
_DESIGN_NOTES = """
|
|
41
|
+
# collect_all_nested_properties
|
|
42
|
+
|
|
43
|
+
## Purpose
|
|
44
|
+
Collects properties for all *nested* inner elements of a composite structure.
|
|
45
|
+
Direct inners are intentionally skipped because they already have their own
|
|
46
|
+
properties generated during class initialization.
|
|
47
|
+
|
|
48
|
+
This function acts as the entry point for nested property discovery.
|
|
49
|
+
|
|
50
|
+
## Architectural role
|
|
51
|
+
`collect_all_nested_properties` is used by:
|
|
52
|
+
|
|
53
|
+
- `InnersPropertyMixin.__extend_instance_class__`
|
|
54
|
+
- metadata-driven property generation
|
|
55
|
+
- composite structure expansion
|
|
56
|
+
- debugging and introspection tools
|
|
57
|
+
|
|
58
|
+
It orchestrates the recursive property collection process by delegating the
|
|
59
|
+
actual traversal to `_collect_nested_inner_properties`.
|
|
60
|
+
|
|
61
|
+
## How it works
|
|
62
|
+
The function performs three deterministic steps:
|
|
63
|
+
|
|
64
|
+
### 1. Initialize result container
|
|
65
|
+
Creates an empty dictionary that will be filled with generated properties.
|
|
66
|
+
|
|
67
|
+
### 2. Iterate through direct inners
|
|
68
|
+
For each inner element in `meta.inners`:
|
|
69
|
+
|
|
70
|
+
- extracts its metadata,
|
|
71
|
+
- checks whether it is a composite (`not is_constant`),
|
|
72
|
+
- builds the initial path tuple,
|
|
73
|
+
- invokes the recursive collector.
|
|
74
|
+
|
|
75
|
+
Direct constants are skipped because they already have properties generated
|
|
76
|
+
by the core property builders.
|
|
77
|
+
|
|
78
|
+
### 3. Return collected properties
|
|
79
|
+
The final dictionary contains properties for all nested inner elements,
|
|
80
|
+
organized by their fully qualified names.
|
|
81
|
+
|
|
82
|
+
## Integration requirements
|
|
83
|
+
The function assumes:
|
|
84
|
+
|
|
85
|
+
- **SimpleMetadataLike**
|
|
86
|
+
Provides `.inners`, `.name_private`, `.is_constant`.
|
|
87
|
+
|
|
88
|
+
- **_collect_nested_inner_properties**
|
|
89
|
+
Performs the recursive traversal and property generation.
|
|
90
|
+
|
|
91
|
+
Without these components, nested property generation cannot operate correctly.
|
|
92
|
+
|
|
93
|
+
## Why this function exists
|
|
94
|
+
Composite structures can contain deeply nested inner elements.
|
|
95
|
+
To expose them as Python properties, the system must:
|
|
96
|
+
|
|
97
|
+
- traverse metadata hierarchies,
|
|
98
|
+
- build stable access paths,
|
|
99
|
+
- generate properties deterministically,
|
|
100
|
+
- skip direct inners (already handled elsewhere),
|
|
101
|
+
- delegate recursion to a dedicated utility.
|
|
102
|
+
|
|
103
|
+
This function encapsulates the orchestration logic for that process.
|
|
104
|
+
|
|
105
|
+
## Deterministic behavior
|
|
106
|
+
The function guarantees:
|
|
107
|
+
|
|
108
|
+
- stable ordering based on metadata,
|
|
109
|
+
- predictable path construction,
|
|
110
|
+
- consistent skipping of direct inners,
|
|
111
|
+
- deterministic recursion entry points.
|
|
112
|
+
|
|
113
|
+
This determinism is essential for introspection, debugging, and composite
|
|
114
|
+
behavior.
|
|
115
|
+
|
|
116
|
+
## Stability guarantee
|
|
117
|
+
Any change to this function would affect:
|
|
118
|
+
|
|
119
|
+
- property generation,
|
|
120
|
+
- composite access behavior,
|
|
121
|
+
- metadata consistency,
|
|
122
|
+
- debugging tools,
|
|
123
|
+
- class initialization.
|
|
124
|
+
|
|
125
|
+
Therefore, `collect_all_nested_properties` is treated as a **core invariant**
|
|
126
|
+
of the property subsystem.
|
|
127
|
+
|
|
128
|
+
## Notes
|
|
129
|
+
- This function is intentionally minimal and side‑effect‑free.
|
|
130
|
+
- It is not part of the public API; it is used internally by mixins.
|
|
131
|
+
- All structural logic is delegated to metadata and recursive collectors.
|
|
132
|
+
"""
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
# Outers
|
|
3
|
+
from ...core_mixins import Snapshot
|
|
4
|
+
from ..._common_logic.immutability import create_new_instance
|
|
5
|
+
# Annotations
|
|
6
|
+
if TYPE_CHECKING:
|
|
7
|
+
from ...._core.protocols.mixins.state import DefaultStateProtocol
|
|
8
|
+
from ...._core.protocols.alias_typings import SnapshotTuple
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
# noinspection PyProtectedMember
|
|
12
|
+
class DefaultState(Snapshot):
|
|
13
|
+
"""
|
|
14
|
+
Mixin providing the instance with:
|
|
15
|
+
- a stored default state (_default_state)
|
|
16
|
+
- the methods clone_instance(), reset_to_default_values(),
|
|
17
|
+
create_new_default_instance()
|
|
18
|
+
"""
|
|
19
|
+
|
|
20
|
+
# ----------------------------------------
|
|
21
|
+
# Basic interface
|
|
22
|
+
# ----------------------------------------
|
|
23
|
+
|
|
24
|
+
# Compatibility declaration
|
|
25
|
+
_mutable_only = True
|
|
26
|
+
|
|
27
|
+
# Slot definition
|
|
28
|
+
__slots__ = ("_default_state_snapshot",)
|
|
29
|
+
|
|
30
|
+
# ----------------------------------------
|
|
31
|
+
# Initialization hook
|
|
32
|
+
# ----------------------------------------
|
|
33
|
+
|
|
34
|
+
# noinspection PyAttributeOutsideInit
|
|
35
|
+
def init_mixins(
|
|
36
|
+
self: "DefaultStateProtocol"
|
|
37
|
+
) -> None:
|
|
38
|
+
"""
|
|
39
|
+
Method forwarding its logic into the instance's initialization
|
|
40
|
+
process.
|
|
41
|
+
"""
|
|
42
|
+
|
|
43
|
+
# 1. Build a snapshot of the default state
|
|
44
|
+
self._default_state_snapshot: "SnapshotTuple" = self._build_snapshot()
|
|
45
|
+
|
|
46
|
+
# ----------------------------------------
|
|
47
|
+
# Methods - CLONE / RESET / NEW
|
|
48
|
+
# ----------------------------------------
|
|
49
|
+
|
|
50
|
+
def clone_instance(
|
|
51
|
+
self: "DefaultStateProtocol"
|
|
52
|
+
) -> "DefaultStateProtocol":
|
|
53
|
+
"""Creates a new instance with the same state as this instance."""
|
|
54
|
+
new_instance = self.create_new_default_instance()
|
|
55
|
+
new_instance._restore_snapshot(self._build_snapshot())
|
|
56
|
+
return new_instance
|
|
57
|
+
|
|
58
|
+
def reset_to_default_values(
|
|
59
|
+
self: "DefaultStateProtocol"
|
|
60
|
+
) -> None:
|
|
61
|
+
"""Resets the instance to its default state (_default_state)."""
|
|
62
|
+
self._restore_snapshot(self._default_state_snapshot)
|
|
63
|
+
|
|
64
|
+
# noinspection PyTypeChecker
|
|
65
|
+
def create_new_default_instance(
|
|
66
|
+
self: "DefaultStateProtocol"
|
|
67
|
+
) -> "DefaultStateProtocol":
|
|
68
|
+
"""
|
|
69
|
+
Returns a new instance of the same type, with the same default
|
|
70
|
+
state this instance had when it was created.
|
|
71
|
+
"""
|
|
72
|
+
return create_new_instance(self, self._default_state_snapshot)
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
_DESIGN_NOTES = """
|
|
76
|
+
# DefaultState
|
|
77
|
+
|
|
78
|
+
## Purpose
|
|
79
|
+
Remembers the state a mutable instance was created with, and provides
|
|
80
|
+
three ways to use that memory: `reset_to_default_values()` (go back to
|
|
81
|
+
it), `create_new_default_instance()` (build a fresh instance starting
|
|
82
|
+
from it), and `clone_instance()` (build a new instance matching the
|
|
83
|
+
*current* state).
|
|
84
|
+
|
|
85
|
+
> For newcomers: "default state" here means "what this specific instance
|
|
86
|
+
> looked like at construction time" — not the blueprint's class-level
|
|
87
|
+
> defaults. Two instances of the same class, created with different
|
|
88
|
+
> initial values, will each remember their own default state.
|
|
89
|
+
|
|
90
|
+
## Compatibility
|
|
91
|
+
- `_mutable_only = True` — resetting/restoring in place only makes sense
|
|
92
|
+
for mutable instances; an immutable instance can't have its state
|
|
93
|
+
overwritten regardless.
|
|
94
|
+
|
|
95
|
+
## Logic
|
|
96
|
+
- On `init_mixins`, `_default_state_snapshot` is captured once, right
|
|
97
|
+
after construction — this becomes the fixed reference point for the
|
|
98
|
+
rest of the instance's life.
|
|
99
|
+
- `reset_to_default_values()` simply restores that snapshot via
|
|
100
|
+
`_restore_snapshot`, discarding any changes made since creation.
|
|
101
|
+
- `create_new_default_instance()` builds a brand-new instance using
|
|
102
|
+
`create_new_instance` seeded with `_default_state_snapshot` — the
|
|
103
|
+
result reflects where *this* instance started, not where it is now.
|
|
104
|
+
- `clone_instance()` combines both ideas: it first creates a fresh
|
|
105
|
+
default instance via `create_new_default_instance()`, then immediately
|
|
106
|
+
overwrites it with a snapshot of the *current* state via
|
|
107
|
+
`_restore_snapshot`. The two-step approach (build clean, then restore
|
|
108
|
+
current) reuses the default-instance construction path rather than
|
|
109
|
+
duplicating instance-creation logic for the "clone" case.
|
|
110
|
+
|
|
111
|
+
## Notes
|
|
112
|
+
- Compare with `DirtyTracking`, which answers "has this changed since a
|
|
113
|
+
reference point" — `DefaultState` instead answers "let me get back to
|
|
114
|
+
or start fresh from that reference point." The two mixins share the
|
|
115
|
+
same snapshot foundation but serve different questions.
|
|
116
|
+
- `clone_instance()`'s two-step build is worth noting for anyone
|
|
117
|
+
debugging performance — it constructs a full default instance as an
|
|
118
|
+
intermediate step, even though only the final restored state is kept.
|
|
119
|
+
"""
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
# Outers
|
|
3
|
+
from ...core_mixins import Snapshot
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ...._core.protocols.mixins.state import DirtyTrackingProtocol
|
|
7
|
+
from ...._core.protocols.alias_typings import SnapshotDiffTuple, SnapshotTuple
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class DirtyTracking(Snapshot):
|
|
11
|
+
"""
|
|
12
|
+
Modern snapshot-based dirty tracking.
|
|
13
|
+
Works for atoms, composites, and nested structures.
|
|
14
|
+
"""
|
|
15
|
+
|
|
16
|
+
# ----------------------------------------
|
|
17
|
+
# Basic interface
|
|
18
|
+
# ----------------------------------------
|
|
19
|
+
|
|
20
|
+
# Compatibility declaration
|
|
21
|
+
_mutable_only = True
|
|
22
|
+
|
|
23
|
+
# Slot definition
|
|
24
|
+
__slots__ = ("_clean_snapshot",)
|
|
25
|
+
|
|
26
|
+
# ----------------------------------------
|
|
27
|
+
# Initialization hook
|
|
28
|
+
# ----------------------------------------
|
|
29
|
+
|
|
30
|
+
# noinspection PyAttributeOutsideInit
|
|
31
|
+
def init_mixins(
|
|
32
|
+
self: "DirtyTrackingProtocol"
|
|
33
|
+
) -> None:
|
|
34
|
+
"""
|
|
35
|
+
Method forwarding its logic into the instance's initialization
|
|
36
|
+
process.
|
|
37
|
+
"""
|
|
38
|
+
|
|
39
|
+
# 1. Build a snapshot of the default state
|
|
40
|
+
self._clean_snapshot = self._build_snapshot()
|
|
41
|
+
|
|
42
|
+
# ----------------------------------------
|
|
43
|
+
# Property - getters
|
|
44
|
+
# ----------------------------------------
|
|
45
|
+
|
|
46
|
+
@property
|
|
47
|
+
def is_dirty(
|
|
48
|
+
self: "DirtyTrackingProtocol"
|
|
49
|
+
) -> bool:
|
|
50
|
+
"""True if the current state differs from the clean snapshot."""
|
|
51
|
+
current_snapshot = self._build_snapshot()
|
|
52
|
+
return current_snapshot != self._clean_snapshot
|
|
53
|
+
|
|
54
|
+
@property
|
|
55
|
+
def dirty_paths(
|
|
56
|
+
self: "DirtyTrackingProtocol"
|
|
57
|
+
) -> "SnapshotDiffTuple":
|
|
58
|
+
"""Returns a tuple of changed paths (path, old_value, new_value)."""
|
|
59
|
+
current_snapshot = self._build_snapshot()
|
|
60
|
+
return self._compare_snapshots(
|
|
61
|
+
self._clean_snapshot,
|
|
62
|
+
current_snapshot,
|
|
63
|
+
constants_only=True
|
|
64
|
+
)
|
|
65
|
+
|
|
66
|
+
@property
|
|
67
|
+
def clean_snapshot(
|
|
68
|
+
self: "DirtyTrackingProtocol"
|
|
69
|
+
) -> "SnapshotTuple":
|
|
70
|
+
return self._clean_snapshot
|
|
71
|
+
|
|
72
|
+
# ----------------------------------------
|
|
73
|
+
# Methods - GET DIRTY / RESET / MARK CLEAN
|
|
74
|
+
# ----------------------------------------
|
|
75
|
+
|
|
76
|
+
def get_dirty_paths(
|
|
77
|
+
self: "DirtyTrackingProtocol",
|
|
78
|
+
*,
|
|
79
|
+
constants_only: bool = True
|
|
80
|
+
) -> "SnapshotDiffTuple":
|
|
81
|
+
"""Returns changed paths, with the option to include only constants or everything."""
|
|
82
|
+
return self._compare_snapshots(
|
|
83
|
+
self._clean_snapshot,
|
|
84
|
+
self._build_snapshot(),
|
|
85
|
+
constants_only=constants_only
|
|
86
|
+
)
|
|
87
|
+
|
|
88
|
+
def reset_to_clean(
|
|
89
|
+
self: "DirtyTrackingProtocol"
|
|
90
|
+
) -> None:
|
|
91
|
+
"""Restores the object to its clean snapshot."""
|
|
92
|
+
self._restore_snapshot(self._clean_snapshot)
|
|
93
|
+
|
|
94
|
+
def mark_clean(
|
|
95
|
+
self: "DirtyTrackingProtocol"
|
|
96
|
+
) -> None:
|
|
97
|
+
"""Marks the current state as the new clean snapshot."""
|
|
98
|
+
# noinspection PyAttributeOutsideInit
|
|
99
|
+
self._clean_snapshot = self._build_snapshot()
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
_DESIGN_NOTES = """
|
|
103
|
+
# DirtyTracking
|
|
104
|
+
|
|
105
|
+
## Purpose
|
|
106
|
+
Tracks whether a mutable instance has changed since a reference point —
|
|
107
|
+
`is_dirty`, `dirty_paths`, `reset_to_clean()`, `mark_clean()` — the same
|
|
108
|
+
concept as "unsaved changes" indicators in editors, but generalized to
|
|
109
|
+
any Simple instance, including nested composites.
|
|
110
|
+
|
|
111
|
+
## Compatibility
|
|
112
|
+
- `_mutable_only = True` — "dirty" only means something relative to
|
|
113
|
+
in-place changes; an immutable instance never mutates, so it can never
|
|
114
|
+
become dirty in this sense.
|
|
115
|
+
|
|
116
|
+
## Logic
|
|
117
|
+
- On `init_mixins`, a `_clean_snapshot` is captured immediately — the
|
|
118
|
+
instance starts out "clean" by definition, relative to its own initial
|
|
119
|
+
state.
|
|
120
|
+
- `is_dirty` rebuilds a fresh snapshot and compares it against
|
|
121
|
+
`_clean_snapshot` for inequality — a full snapshot comparison on every
|
|
122
|
+
access, not a cached flag that's incrementally updated on each write.
|
|
123
|
+
- `dirty_paths` and `get_dirty_paths(constants_only=...)` both delegate
|
|
124
|
+
to `_compare_snapshots` (from `Snapshot`), turning positional
|
|
125
|
+
differences into meaningful `(path, old, new)` triples.
|
|
126
|
+
`dirty_paths` is a fixed `constants_only=True` property; `get_dirty_paths`
|
|
127
|
+
is the more flexible method form, letting a caller include
|
|
128
|
+
composite-level changes too.
|
|
129
|
+
- `reset_to_clean()` restores the instance back to `_clean_snapshot`,
|
|
130
|
+
discarding all changes since the last clean mark.
|
|
131
|
+
- `mark_clean()` re-captures the current state as the new baseline —
|
|
132
|
+
useful after a "save" operation, where the current dirty state should
|
|
133
|
+
become the new clean reference point.
|
|
134
|
+
|
|
135
|
+
## Notes
|
|
136
|
+
- "Modern" in the class docstring implies a prior, presumably
|
|
137
|
+
attribute-flag-based dirty-tracking approach existed before this
|
|
138
|
+
snapshot-based one — worth knowing if older code or docs reference a
|
|
139
|
+
different mechanism.
|
|
140
|
+
- Every dirty check does a full snapshot rebuild and comparison rather
|
|
141
|
+
than tracking writes incrementally — simple and correct, but worth
|
|
142
|
+
keeping in mind for very large composites where this could become a
|
|
143
|
+
noticeable cost if checked frequently.
|
|
144
|
+
"""
|