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,49 @@
|
|
|
1
|
+
from typing import Protocol, runtime_checkable, Any
|
|
2
|
+
# Outers
|
|
3
|
+
from ..base_class import SimpleMixinProtocol
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
@runtime_checkable
|
|
7
|
+
class MetaShortcutsProtocol(
|
|
8
|
+
SimpleMixinProtocol,
|
|
9
|
+
Protocol
|
|
10
|
+
):
|
|
11
|
+
"""
|
|
12
|
+
Protocol for the MetaShortcuts mixin.
|
|
13
|
+
|
|
14
|
+
Guarantees the presence of ergonomic shortcuts (properties) directly on the instance,
|
|
15
|
+
providing fast access to frequently queried class metadata.
|
|
16
|
+
"""
|
|
17
|
+
|
|
18
|
+
# --- OBJECT IDENTITY ---
|
|
19
|
+
@property
|
|
20
|
+
def name_snake(self) -> str:
|
|
21
|
+
"""Snake_case name of the object's class (e.g., 'my_data')."""
|
|
22
|
+
...
|
|
23
|
+
|
|
24
|
+
# --- TYPE INFORMATION ---
|
|
25
|
+
@property
|
|
26
|
+
def value_type(self) -> type:
|
|
27
|
+
"""Original Python type of the value represented by the object."""
|
|
28
|
+
...
|
|
29
|
+
|
|
30
|
+
@property
|
|
31
|
+
def default(self) -> Any:
|
|
32
|
+
"""Default value of the object defined in its metadata."""
|
|
33
|
+
...
|
|
34
|
+
|
|
35
|
+
# --- OBJECT STRUCTURE ---
|
|
36
|
+
@property
|
|
37
|
+
def is_atom(self) -> bool:
|
|
38
|
+
"""Returns True if the object represents an Atom (has no inner elements)."""
|
|
39
|
+
...
|
|
40
|
+
|
|
41
|
+
@property
|
|
42
|
+
def is_composite(self) -> bool:
|
|
43
|
+
"""Returns True if the object represents a Composite (consists of inner elements)."""
|
|
44
|
+
...
|
|
45
|
+
|
|
46
|
+
@property
|
|
47
|
+
def is_decomposeable(self) -> bool:
|
|
48
|
+
"""Returns True if the object supports decomposition logic for its main value."""
|
|
49
|
+
...
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
from .MetaShortcutsProtocol import MetaShortcutsProtocol
|
|
2
|
+
from .InnersPropertyProtocol import InnersPropertyProtocol
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
_DESIGN_NOTES = """
|
|
6
|
+
# Property Mixin Protocols Sub-Package
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
Provides protocols for dynamic inner element property access and ergonomic metadata shortcuts.
|
|
10
|
+
|
|
11
|
+
## Internal Components Registry
|
|
12
|
+
|
|
13
|
+
| Component | Type | Description |
|
|
14
|
+
| :------------------------ | :------- | :--------------------------------------------------------------------------- |
|
|
15
|
+
| `InnersPropertyProtocol` | Protocol | Dynamic access interface for sub-node properties generated from blueprints. |
|
|
16
|
+
| `MetaShortcutsProtocol` | Protocol | Ergonomic properties for fast querying of object identity and metadata. |
|
|
17
|
+
"""
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
from typing import Protocol, runtime_checkable, Self, TYPE_CHECKING
|
|
2
|
+
# Outers
|
|
3
|
+
from ..core_mixins.SnapshotProtocol import SnapshotProtocol
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ...alias_typings import SnapshotTuple
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
@runtime_checkable
|
|
10
|
+
class DefaultStateProtocol(
|
|
11
|
+
SnapshotProtocol,
|
|
12
|
+
Protocol
|
|
13
|
+
):
|
|
14
|
+
"""
|
|
15
|
+
Protocol for the DefaultState mixin.
|
|
16
|
+
|
|
17
|
+
Guarantees the instance's ability to maintain its default state, reset to it,
|
|
18
|
+
create fresh new default instances, or clone its current state.
|
|
19
|
+
"""
|
|
20
|
+
|
|
21
|
+
# --- TECHNICAL ATTRIBUTES (Initialized in init_mixins) ---
|
|
22
|
+
|
|
23
|
+
# Stores a state snapshot of values taken at the moment of instance creation
|
|
24
|
+
_default_state_snapshot: "SnapshotTuple"
|
|
25
|
+
|
|
26
|
+
# --- PUBLIC STATE MANAGEMENT API ---
|
|
27
|
+
|
|
28
|
+
def clone_instance(self) -> Self:
|
|
29
|
+
"""Creates and returns a new instance with the same current state as this instance."""
|
|
30
|
+
...
|
|
31
|
+
|
|
32
|
+
def reset_to_default_values(self) -> None:
|
|
33
|
+
"""Resets the internal state of the entire instance to its initial creation state."""
|
|
34
|
+
...
|
|
35
|
+
|
|
36
|
+
def create_new_default_instance(self) -> Self:
|
|
37
|
+
"""
|
|
38
|
+
Creates and returns a completely new, clean instance of the same type
|
|
39
|
+
with default values defined in the blueprint.
|
|
40
|
+
"""
|
|
41
|
+
...
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
from typing import Protocol, runtime_checkable, TYPE_CHECKING
|
|
2
|
+
# Outers
|
|
3
|
+
from ..core_mixins.SnapshotProtocol import SnapshotProtocol
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ...alias_typings import SnapshotTuple, SnapshotDiffTuple
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
@runtime_checkable
|
|
10
|
+
class DirtyTrackingProtocol(
|
|
11
|
+
SnapshotProtocol,
|
|
12
|
+
Protocol
|
|
13
|
+
):
|
|
14
|
+
"""
|
|
15
|
+
Protocol for the DirtyTracking mixin.
|
|
16
|
+
|
|
17
|
+
Guarantees the ability to track state changes (dirty tracking) across the object hierarchy
|
|
18
|
+
against a stored "clean" snapshot, retrieve modified paths, and reset state.
|
|
19
|
+
"""
|
|
20
|
+
|
|
21
|
+
# --- TECHNICAL ATTRIBUTES (Initialized in init_mixins) ---
|
|
22
|
+
|
|
23
|
+
# Stores a state snapshot considered as the default "clean" (unmodified) baseline
|
|
24
|
+
_clean_snapshot: "SnapshotTuple"
|
|
25
|
+
|
|
26
|
+
# --- ERGONOMIC PROPERTIES ---
|
|
27
|
+
|
|
28
|
+
@property
|
|
29
|
+
def is_dirty(self) -> bool:
|
|
30
|
+
"""Returns True if the current hierarchy state differs from the clean snapshot."""
|
|
31
|
+
...
|
|
32
|
+
|
|
33
|
+
@property
|
|
34
|
+
def dirty_paths(self) -> "SnapshotDiffTuple":
|
|
35
|
+
"""
|
|
36
|
+
Returns a tuple of modified atomic element paths.
|
|
37
|
+
Each element in the tuple consists of a triplet: (element_path, old_value, new_value).
|
|
38
|
+
"""
|
|
39
|
+
...
|
|
40
|
+
|
|
41
|
+
@property
|
|
42
|
+
def clean_snapshot(self) -> "SnapshotTuple":
|
|
43
|
+
"""Access to the currently stored clean snapshot."""
|
|
44
|
+
...
|
|
45
|
+
|
|
46
|
+
# --- PUBLIC CHANGE TRACKING API ---
|
|
47
|
+
|
|
48
|
+
def get_dirty_paths(self, *, constants_only: bool = True) -> "SnapshotDiffTuple":
|
|
49
|
+
"""
|
|
50
|
+
Returns a tuple of detected hierarchy changes.
|
|
51
|
+
Allows selecting whether to track only constants (atoms) or composite nodes as well.
|
|
52
|
+
"""
|
|
53
|
+
...
|
|
54
|
+
|
|
55
|
+
def reset_to_clean(self) -> None:
|
|
56
|
+
"""Restores the complete internal state of all elements from the clean snapshot (discards changes)."""
|
|
57
|
+
...
|
|
58
|
+
|
|
59
|
+
def mark_clean(self) -> None:
|
|
60
|
+
"""Marks the current state of the entire instance as the new baseline 'clean' state."""
|
|
61
|
+
...
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
from typing import Protocol, runtime_checkable, TYPE_CHECKING, Any
|
|
2
|
+
from datetime import datetime
|
|
3
|
+
# Outers
|
|
4
|
+
from ..core_mixins import SerializationProtocol
|
|
5
|
+
# Annotations
|
|
6
|
+
if TYPE_CHECKING:
|
|
7
|
+
from ...alias_typings import HistoryEntry, HistoryDict, SnapshotDiffTuple
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
@runtime_checkable
|
|
11
|
+
class HistoryProtocol(
|
|
12
|
+
SerializationProtocol,
|
|
13
|
+
Protocol
|
|
14
|
+
):
|
|
15
|
+
"""
|
|
16
|
+
Protocol for the History mixin.
|
|
17
|
+
|
|
18
|
+
Guarantees complete timeline management for the object (Undo/Redo cascades),
|
|
19
|
+
including navigation by index/timestamp, memory limit tracking,
|
|
20
|
+
historical snapshot diff analysis, and full history export/import.
|
|
21
|
+
"""
|
|
22
|
+
|
|
23
|
+
# --- TECHNICAL ATTRIBUTES (Initialized in init_mixins) ---
|
|
24
|
+
_history: list["HistoryEntry"] # Internal timeline records storage
|
|
25
|
+
_history_limit: int | None # Maximum allowed record capacity
|
|
26
|
+
_history_index: int # Pointer to the current timeline position
|
|
27
|
+
_history_count: int # Total count of actually stored records
|
|
28
|
+
|
|
29
|
+
# --- INITIALIZATION AND RECORDING LOGIC ---
|
|
30
|
+
|
|
31
|
+
def record_state(self) -> "HistoryEntry":
|
|
32
|
+
"""Creates a snapshot of the current state and appends it to the timeline."""
|
|
33
|
+
...
|
|
34
|
+
|
|
35
|
+
# --- PROPERTIES ---
|
|
36
|
+
|
|
37
|
+
@property
|
|
38
|
+
def history(self) -> tuple["HistoryEntry", ...]:
|
|
39
|
+
"""Returns the full timeline history as an immutable tuple of records."""
|
|
40
|
+
...
|
|
41
|
+
|
|
42
|
+
@property
|
|
43
|
+
def history_index(self) -> int | None:
|
|
44
|
+
"""Returns the index of the current position (record) within the timeline."""
|
|
45
|
+
...
|
|
46
|
+
|
|
47
|
+
@property
|
|
48
|
+
def history_limit(self) -> int | None:
|
|
49
|
+
"""Returns the current history capacity limit, or None if unlimited."""
|
|
50
|
+
...
|
|
51
|
+
|
|
52
|
+
@history_limit.setter
|
|
53
|
+
def history_limit(self, value: int) -> None:
|
|
54
|
+
"""Sets the maximum history capacity limit."""
|
|
55
|
+
...
|
|
56
|
+
|
|
57
|
+
# --- NAVIGATION API (Undo & Redo & GoTo) ---
|
|
58
|
+
|
|
59
|
+
def undo(self) -> bool:
|
|
60
|
+
"""
|
|
61
|
+
Moves the instance state one step back in time.
|
|
62
|
+
Returns True if successful, False otherwise.
|
|
63
|
+
"""
|
|
64
|
+
...
|
|
65
|
+
|
|
66
|
+
def redo(self) -> bool:
|
|
67
|
+
"""
|
|
68
|
+
Moves the instance state one step forward in time.
|
|
69
|
+
Returns True if successful, False otherwise.
|
|
70
|
+
"""
|
|
71
|
+
...
|
|
72
|
+
|
|
73
|
+
def go_to_last(self) -> None:
|
|
74
|
+
"""Navigates the instance state to the latest (most recent) recorded entry."""
|
|
75
|
+
...
|
|
76
|
+
|
|
77
|
+
def go_to_index(self, index: int) -> None:
|
|
78
|
+
"""Navigates the instance state to a record specified by a numerical index."""
|
|
79
|
+
...
|
|
80
|
+
|
|
81
|
+
def go_to_timestamp(self, timestamp: datetime) -> None:
|
|
82
|
+
"""Navigates the instance state to a record corresponding to a specific timestamp."""
|
|
83
|
+
...
|
|
84
|
+
|
|
85
|
+
# --- HISTORY EXPORT & IMPORT ---
|
|
86
|
+
|
|
87
|
+
def export_history_to_dict(self) -> "HistoryDict":
|
|
88
|
+
"""Exports the complete timeline structure and data into a dictionary."""
|
|
89
|
+
...
|
|
90
|
+
|
|
91
|
+
def import_history_from_dict(self, history_dict: "HistoryDict") -> None:
|
|
92
|
+
"""Imports and fully reconstructs the entire timeline from the provided dictionary."""
|
|
93
|
+
...
|
|
94
|
+
|
|
95
|
+
def remove_history_limit(self) -> None:
|
|
96
|
+
"""Removes the history capacity limit entirely (unlimited timeline)."""
|
|
97
|
+
...
|
|
98
|
+
|
|
99
|
+
# --- DIFF ANALYSIS ---
|
|
100
|
+
|
|
101
|
+
def diff(
|
|
102
|
+
self,
|
|
103
|
+
snap1: int | datetime,
|
|
104
|
+
snap2: int | datetime,
|
|
105
|
+
*,
|
|
106
|
+
constants_only: bool = False
|
|
107
|
+
) -> "SnapshotDiffTuple":
|
|
108
|
+
"""
|
|
109
|
+
Compares two arbitrary history points (specified by index or timestamp).
|
|
110
|
+
Returns a tuple of change triplets: (element_path, old_value, new_value).
|
|
111
|
+
"""
|
|
112
|
+
...
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
from typing import Protocol, runtime_checkable
|
|
2
|
+
# Outers
|
|
3
|
+
from ..base_class import SimpleMixinProtocol
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
@runtime_checkable
|
|
7
|
+
class PermissionProtocol(
|
|
8
|
+
SimpleMixinProtocol,
|
|
9
|
+
Protocol
|
|
10
|
+
):
|
|
11
|
+
"""
|
|
12
|
+
Protocol for the Permission mixin.
|
|
13
|
+
|
|
14
|
+
Works with the _lock attribute.
|
|
15
|
+
|
|
16
|
+
Guarantees the ability to lock an instance against changes (Read-only mode)
|
|
17
|
+
by activating an internal lock and validating via a pre-update hook.
|
|
18
|
+
"""
|
|
19
|
+
|
|
20
|
+
# --- ERGONOMIC PROPERTIES ---
|
|
21
|
+
|
|
22
|
+
@property
|
|
23
|
+
def is_locked(self) -> bool:
|
|
24
|
+
"""Returns True if the instance is currently locked for writing."""
|
|
25
|
+
...
|
|
26
|
+
|
|
27
|
+
# --- PUBLIC LOCK MANAGEMENT API ---
|
|
28
|
+
|
|
29
|
+
def lock(self) -> None:
|
|
30
|
+
"""Locks the instance. Any attempt to modify the value will raise a ValueError."""
|
|
31
|
+
...
|
|
32
|
+
|
|
33
|
+
def unlock(self) -> None:
|
|
34
|
+
"""Unlocks the instance, enabling value modification and updates once again."""
|
|
35
|
+
...
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
from .DefaultStateProtocol import DefaultStateProtocol
|
|
2
|
+
from .DirtyTrackingProtocol import DirtyTrackingProtocol
|
|
3
|
+
from .PermissionProtocol import PermissionProtocol
|
|
4
|
+
from .HistoryProtocol import HistoryProtocol
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
_DESIGN_NOTES = """
|
|
8
|
+
# State Mixin Protocols Sub-Package
|
|
9
|
+
|
|
10
|
+
## Purpose
|
|
11
|
+
Defines protocols for state lifecycle management, change tracking, timeline cascades (Undo/Redo),
|
|
12
|
+
and write-access locking.
|
|
13
|
+
|
|
14
|
+
## Internal Components Registry
|
|
15
|
+
|
|
16
|
+
| Component | Type | Description |
|
|
17
|
+
| :---------------------- | :------- | :--------------------------------------------------------------------------- |
|
|
18
|
+
| `DefaultStateProtocol` | Protocol | Manages initial baseline state, cloning, and instance resets. |
|
|
19
|
+
| `DirtyTrackingProtocol` | Protocol | Tracks modified paths against clean state baselines and handles rollbacks. |
|
|
20
|
+
| `HistoryProtocol` | Protocol | Full timeline management with Undo/Redo cascades, timestamps, and diffs. |
|
|
21
|
+
| `PermissionProtocol` | Protocol | Read-only mode locking and write-access authorization controls. |
|
|
22
|
+
"""
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Inners
|
|
2
|
+
from .base_exception import SimpleObjectError
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
class SimpleDefinitionError(SimpleObjectError):
|
|
6
|
+
"""
|
|
7
|
+
Exception raised when a declarative Simple class contains invalid metadata
|
|
8
|
+
or violates structural rules during class definition.
|
|
9
|
+
|
|
10
|
+
This error indicates that the class itself is incorrectly written during code
|
|
11
|
+
creation, even before any instance or runtime value is processed.
|
|
12
|
+
"""
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
_DESIGN_NOTES = """
|
|
16
|
+
# SimpleDefinitionError — Definition-Time Exception
|
|
17
|
+
|
|
18
|
+
## Purpose
|
|
19
|
+
`SimpleDefinitionError` is raised when the *declarative class definition* of a
|
|
20
|
+
`SimpleConstant` or `SimpleObject` is invalid. It signals that a developer
|
|
21
|
+
made a structural mistake in the class declaration, metadata configuration, or
|
|
22
|
+
blueprint definition.
|
|
23
|
+
|
|
24
|
+
The primary consumer of this exception is the **metadata engine and class builder
|
|
25
|
+
logic** executing at import or class-creation time.
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## When It Occurs
|
|
30
|
+
Typical situations include:
|
|
31
|
+
|
|
32
|
+
- forbidden attributes defined on a class (e.g., `_default` defined on a composite),
|
|
33
|
+
- malformed, missing, or incompatible `_inners` declarations,
|
|
34
|
+
- invalid type annotations or type declarations in metadata,
|
|
35
|
+
- structural inconsistencies detected while parsing declarative blueprints.
|
|
36
|
+
|
|
37
|
+
These errors occur **during code writing and class declaration**, not during runtime
|
|
38
|
+
usage or data processing.
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## Notes
|
|
43
|
+
- Inherits from `SimpleObjectError`, so it can be caught via `except SimpleObjectError`.
|
|
44
|
+
- Intended for developers defining Simple classes, surfacing errors at import/definition time.
|
|
45
|
+
"""
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Inners
|
|
2
|
+
from .base_exception import SimpleObjectError
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
class SimpleInitializationError(SimpleObjectError):
|
|
6
|
+
"""
|
|
7
|
+
Exception raised during the instantiation of a Simple instance or mixin.
|
|
8
|
+
|
|
9
|
+
This error indicates that the class metadata is valid, but the runtime
|
|
10
|
+
creation/initialization failed due to missing required parameters, mixin
|
|
11
|
+
incompatibilities, or structural setup failures.
|
|
12
|
+
"""
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
_DESIGN_NOTES = """
|
|
16
|
+
# SimpleInitializationError — Instantiation-Time Exception
|
|
17
|
+
|
|
18
|
+
## Purpose
|
|
19
|
+
`SimpleInitializationError` is raised exclusively during the initialization phase of a
|
|
20
|
+
`SimpleConstant`, `SimpleObject`, or associated mixin. It signals that:
|
|
21
|
+
|
|
22
|
+
- the class definition and metadata are fully valid,
|
|
23
|
+
- but the **runtime instantiation process** failed.
|
|
24
|
+
|
|
25
|
+
The primary consumer of this exception is the **instance initialization pipeline,
|
|
26
|
+
`__init__` builders, and mixin composition checks**.
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## When It Occurs
|
|
31
|
+
Typical situations include:
|
|
32
|
+
|
|
33
|
+
- missing or incompatible positional/keyword arguments passed during `__init__`,
|
|
34
|
+
- mixin dependency conflicts or failed mixin contract verifications,
|
|
35
|
+
- structural initialization failures when assembling composite inner instances,
|
|
36
|
+
- attempts to instantiate an abstract or improperly configured mixin structure.
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## Notes
|
|
41
|
+
- Inherits from `SimpleObjectError`, so it can be caught via `except SimpleObjectError`.
|
|
42
|
+
- Clearly separates instantiation/setup problems from definition errors and runtime data errors.
|
|
43
|
+
"""
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# Inners
|
|
2
|
+
from .base_exception import SimpleObjectError
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
class SimpleRuntimeError(SimpleObjectError):
|
|
6
|
+
"""
|
|
7
|
+
Exception raised when provided data or operations fail logic, validation,
|
|
8
|
+
or state rules during object execution.
|
|
9
|
+
|
|
10
|
+
This error indicates that the class definition and instance setup are valid,
|
|
11
|
+
but the runtime value or operation violates declared domain logic.
|
|
12
|
+
"""
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
_DESIGN_NOTES = """
|
|
16
|
+
# SimpleRuntimeError — Data & Operational Runtime Exception
|
|
17
|
+
|
|
18
|
+
## Purpose
|
|
19
|
+
`SimpleRuntimeError` represents errors caused by **runtime data or invalid user operations**.
|
|
20
|
+
It is raised when values passed to or operations performed on a `SimpleConstant` or
|
|
21
|
+
`SimpleObject` fail to satisfy domain rules.
|
|
22
|
+
|
|
23
|
+
This is the primary public-facing exception that end users will encounter when
|
|
24
|
+
interacting with instantiated Simple objects in application logic.
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## When It Occurs
|
|
29
|
+
Typical situations include:
|
|
30
|
+
|
|
31
|
+
- type mismatches during property assignment or setter calls,
|
|
32
|
+
- custom validation failures inside `_validate` methods,
|
|
33
|
+
- normalization or conversion errors during data assignment,
|
|
34
|
+
- illegal state modifications (e.g., writing to a locked/immutable instance),
|
|
35
|
+
- calculation or decomposition failures during value propagation.
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## Distinction from Other Exceptions
|
|
40
|
+
- `SimpleDefinitionError` → definition-time errors (invalid declarative blueprint)
|
|
41
|
+
- `SimpleInitializationError` → instantiation-time errors (failed instance/mixin setup)
|
|
42
|
+
- `SimpleRuntimeError` → **runtime data & logic errors** (invalid user input/state)
|
|
43
|
+
- `SimpleRuntimeError` → test utility failures (fuzzing/filler issues)
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## Notes
|
|
48
|
+
- Inherits from `SimpleObjectError`, so it can be caught via `except SimpleObjectError`.
|
|
49
|
+
- Main exception meant for application-level `try...except` blocks handling user data.
|
|
50
|
+
"""
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
from .base_exception import SimpleObjectError
|
|
2
|
+
from .SimpleInitializationError import SimpleInitializationError
|
|
3
|
+
from .SimpleDefinitionError import SimpleDefinitionError
|
|
4
|
+
from .SimpleRuntimeError import SimpleRuntimeError
|
|
5
|
+
|
|
6
|
+
__all__ = [
|
|
7
|
+
"SimpleObjectError",
|
|
8
|
+
"SimpleDefinitionError",
|
|
9
|
+
"SimpleInitializationError",
|
|
10
|
+
"SimpleRuntimeError",
|
|
11
|
+
]
|
|
12
|
+
|
|
13
|
+
_DESIGN_NOTES = """
|
|
14
|
+
# Simple Exceptions Sub-Package
|
|
15
|
+
|
|
16
|
+
## Purpose
|
|
17
|
+
Provides the complete set of public exception types used across the SimpleObject
|
|
18
|
+
library. These exceptions form a clear, symmetric 4-stage hierarchy built on top of
|
|
19
|
+
`SimpleObjectError`, allowing developers to precisely distinguish between errors occurring
|
|
20
|
+
during code definition, object instantiation, runtime execution, or test generation.
|
|
21
|
+
|
|
22
|
+
All exceptions exported by this package are part of the public API and may be safely
|
|
23
|
+
imported and caught by library users.
|
|
24
|
+
|
|
25
|
+
## Public Exception Registry
|
|
26
|
+
|
|
27
|
+
| Exception | Stage / Consumer | Description |
|
|
28
|
+
| :-------------------------- | :--------------------------------- | :-------------------------------------------------------------------------- |
|
|
29
|
+
| `SimpleObjectError` | Umbrella Base | Root exception for all Simple-related errors. Catch-all for the library. |
|
|
30
|
+
| `SimpleDefinitionError` | Definition-Time (Metadata) | Raised when declarative class metadata or structural blueprints are invalid.|
|
|
31
|
+
| `SimpleInitializationError` | Instantiation-Time (Init/Mixins) | Raised when instance setup, `__init__` arguments, or mixins fail. |
|
|
32
|
+
| `SimpleRuntimeError` | Execution-Time (User Data/State) | Raised when runtime values fail validation, normalization, or state rules. |
|
|
33
|
+
|
|
34
|
+
## Usage
|
|
35
|
+
Developers may catch all Simple-related errors using the umbrella exception:
|
|
36
|
+
|
|
37
|
+
```python
|
|
38
|
+
from simplibs.object.exceptions import SimpleObjectError
|
|
39
|
+
|
|
40
|
+
try:
|
|
41
|
+
...
|
|
42
|
+
except SimpleObjectError:
|
|
43
|
+
# Handles any error originating from the SimpleObject library
|
|
44
|
+
...
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Or target specific operational phases:
|
|
48
|
+
|
|
49
|
+
```python
|
|
50
|
+
from simplibs.object.exceptions import SimpleRuntimeError, SimpleDefinitionError
|
|
51
|
+
|
|
52
|
+
try:
|
|
53
|
+
user_instance.value = raw_input
|
|
54
|
+
except SimpleRuntimeError:
|
|
55
|
+
# Handles invalid runtime data or validation failures
|
|
56
|
+
...
|
|
57
|
+
except SimpleDefinitionError:
|
|
58
|
+
# Handles invalid class blueprints (definition time)
|
|
59
|
+
...
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
"""
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
from simplibs.exception import SimpleException
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
class SimpleObjectError(SimpleException):
|
|
5
|
+
"""
|
|
6
|
+
Base exception class for all errors originating from the SimpleObject library.
|
|
7
|
+
|
|
8
|
+
This class is not intended to be raised directly. Instead, it serves as the
|
|
9
|
+
common ancestor for all specific Simple-related exceptions, allowing users
|
|
10
|
+
to catch any library-level error using a single `except SimpleObjectError` block.
|
|
11
|
+
"""
|
|
12
|
+
|
|
13
|
+
# Skip internal library frames when generating error location metadata.
|
|
14
|
+
# This ensures that error messages point to user code rather than internal
|
|
15
|
+
# implementation details, unless no user-level frames remain.
|
|
16
|
+
_skip_locations = ("simplibs/object",)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
_DESIGN_NOTES = """
|
|
20
|
+
# SimpleObjectError — Root Exception for the Simple Library
|
|
21
|
+
|
|
22
|
+
## Purpose
|
|
23
|
+
`SimpleObjectError` is the umbrella exception for the entire SimpleObject ecosystem.
|
|
24
|
+
It provides a unified base class for all errors thrown by the library, allowing
|
|
25
|
+
users to catch any Simple-related issue using a single exception type.
|
|
26
|
+
|
|
27
|
+
This class is not meant to be raised directly. Instead, it acts as the root of
|
|
28
|
+
the exception hierarchy, ensuring consistent behavior, predictable grouping, and
|
|
29
|
+
clean error reporting.
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## 1. Error Location Filtering (`_skip_locations`)
|
|
34
|
+
The attribute:
|
|
35
|
+
|
|
36
|
+
```python
|
|
37
|
+
_skip_locations = ("simplibs/object",)
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
instructs the underlying `SimpleException` engine to skip internal frames
|
|
42
|
+
originating from the SimpleObject library when generating error location
|
|
43
|
+
metadata.
|
|
44
|
+
|
|
45
|
+
This ensures that:
|
|
46
|
+
|
|
47
|
+
* error messages point to **user code**, not internal implementation,
|
|
48
|
+
* internal frames are shown **only when necessary** (e.g., when no user frames
|
|
49
|
+
remain),
|
|
50
|
+
* developers receive clean, readable diagnostics.
|
|
51
|
+
|
|
52
|
+
This behavior is essential for library authors and is automatically inherited by
|
|
53
|
+
all Simple-related exceptions.
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## 2. Subclasses
|
|
58
|
+
|
|
59
|
+
### `SimpleDefinitionError`
|
|
60
|
+
|
|
61
|
+
Definition-time exception raised when processing metadata or class blueprints.
|
|
62
|
+
Signals structural errors made during code writing (e.g., malformed `_inners`,
|
|
63
|
+
forbidden `_default` on composites). Main consumer: Metadata logic.
|
|
64
|
+
|
|
65
|
+
### `SimpleInitializationError`
|
|
66
|
+
|
|
67
|
+
Instantiation-time exception raised during `__init__` or `__new__` pipeline.
|
|
68
|
+
Signals incompatible runtime creation parameters, missing requirements, or
|
|
69
|
+
mixin composition conflicts. Main consumer: Instance and mixin initialization logic.
|
|
70
|
+
|
|
71
|
+
### `SimpleRuntimeError`
|
|
72
|
+
|
|
73
|
+
Data-level exception raised during execution when values fail validation,
|
|
74
|
+
normalization, or state rules. This is the primary public exception that end
|
|
75
|
+
users encounter during normal application usage.
|
|
76
|
+
|
|
77
|
+
### `SimpleRuntimeError`
|
|
78
|
+
|
|
79
|
+
Utility exception raised exclusively by test-assistance functions (e.g., fuzz-filling
|
|
80
|
+
or randomized data generation). Signals exhausted retries or unsupported test setups.
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
## 3. Catch-All Grouping
|
|
85
|
+
|
|
86
|
+
Users can catch all Simple-related errors using:
|
|
87
|
+
|
|
88
|
+
```python
|
|
89
|
+
try:
|
|
90
|
+
# SimpleObject operations
|
|
91
|
+
...
|
|
92
|
+
except SimpleObjectError:
|
|
93
|
+
# Handle any error thrown by the SimpleObject library
|
|
94
|
+
...
|
|
95
|
+
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
This provides a clean and predictable error-handling strategy.
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## Notes
|
|
103
|
+
|
|
104
|
+
* All Simple exceptions inherit from `SimpleObjectError`.
|
|
105
|
+
* This class ensures consistent behavior across the entire library.
|
|
106
|
+
* Error location filtering is inherited automatically by all subclasses.
|
|
107
|
+
"""
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
from .SimpleObjectError import SimpleObjectError
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
_DESIGN_NOTES = """
|
|
5
|
+
# Base Exception Sub-Package
|
|
6
|
+
|
|
7
|
+
## Purpose
|
|
8
|
+
Contains the core root exception `SimpleObjectError` for the entire SimpleObject ecosystem.
|
|
9
|
+
Isolating the root exception in its own sub-package prevents circular import issues
|
|
10
|
+
when other exception modules or internal library components inherit from it.
|
|
11
|
+
|
|
12
|
+
## Exports
|
|
13
|
+
- `SimpleObjectError`: The common ancestor for all library-specific exceptions.
|
|
14
|
+
|
|
15
|
+
| Exception | Stage / Consumer | Description |
|
|
16
|
+
| :--------------------- | :--------------------------------- | :-------------------------------------------------------------------------- |
|
|
17
|
+
| `SimpleObjectError` | Umbrella Base | Root exception for all Simple-related errors. Catch-all for the library. |
|
|
18
|
+
|
|
19
|
+
"""
|