simplibs-object 0.1.1__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.1.dist-info/METADATA +590 -0
- simplibs_object-0.1.1.dist-info/RECORD +580 -0
- simplibs_object-0.1.1.dist-info/WHEEL +5 -0
- simplibs_object-0.1.1.dist-info/licenses/LICENSE +21 -0
- simplibs_object-0.1.1.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
from typing import Any, NoReturn, TYPE_CHECKING
|
|
2
|
+
# Outers
|
|
3
|
+
from .....exceptions import SimpleRuntimeError
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ....protocols.classes import SimpleConstantProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def raise_unexpected_validation_error(
|
|
10
|
+
cls: "SimpleConstantProtocol",
|
|
11
|
+
value: Any,
|
|
12
|
+
original_exception: Exception,
|
|
13
|
+
) -> NoReturn:
|
|
14
|
+
"""Raises a standardized error when user-defined validation fails unexpectedly."""
|
|
15
|
+
|
|
16
|
+
class_name = cls.__name__
|
|
17
|
+
|
|
18
|
+
raise SimpleRuntimeError(
|
|
19
|
+
error_name="VALIDATION ERROR",
|
|
20
|
+
label="value",
|
|
21
|
+
value=value,
|
|
22
|
+
expected="A value that satisfies the user-defined validation logic.",
|
|
23
|
+
problem=(
|
|
24
|
+
f"The value could not be validated successfully.",
|
|
25
|
+
f"An unexpected exception occurred during validation in '{class_name}'. "
|
|
26
|
+
),
|
|
27
|
+
context=(
|
|
28
|
+
f"The validation pipeline for '{class_name}' intercepted an exception "
|
|
29
|
+
f"raised inside the user-defined '_validate' method. ",
|
|
30
|
+
f"This may indicate either an invalid value or an internal error in the validation logic."
|
|
31
|
+
),
|
|
32
|
+
how_to_fix=(
|
|
33
|
+
"Review the intercepted exception shown at the end of this error message "
|
|
34
|
+
"to determine whether the issue is caused by invalid input or a bug in "
|
|
35
|
+
"the '_validate' method.",
|
|
36
|
+
"If you intend to raise custom validation errors, ensure they inherit "
|
|
37
|
+
"from 'SimpleObjectError' so they are handled as expected.",
|
|
38
|
+
"If the error is unintended, verify that the validation logic does not "
|
|
39
|
+
"perform unsafe operations or rely on assumptions that may not hold."
|
|
40
|
+
),
|
|
41
|
+
exception=original_exception,
|
|
42
|
+
)
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
_DESIGN_NOTES = """
|
|
46
|
+
# raise_unexpected_validation_error
|
|
47
|
+
|
|
48
|
+
## Purpose
|
|
49
|
+
Handles any unexpected exception raised during user-defined validation (`_validate`).
|
|
50
|
+
This error is user-facing and explains that validation failed due to an internal
|
|
51
|
+
exception rather than a structured validation error.
|
|
52
|
+
|
|
53
|
+
## Behavior
|
|
54
|
+
- Triggered when `_validate` raises an exception that is **not** a `SimpleObjectError`.
|
|
55
|
+
- Wraps the original exception into a structured `SimpleRuntimeError`.
|
|
56
|
+
- Provides clear guidance for both possible scenarios:
|
|
57
|
+
1. The value is invalid and caused the user’s validation logic to fail.
|
|
58
|
+
2. The validation logic itself contains an error.
|
|
59
|
+
|
|
60
|
+
## Notes
|
|
61
|
+
- The original exception is preserved and displayed under “Intercepted exception”
|
|
62
|
+
in the formatted error output.
|
|
63
|
+
- If the user intends to raise custom validation errors, they should inherit from
|
|
64
|
+
`SimpleObjectError` so they are treated as expected validation failures.
|
|
65
|
+
- This function ensures consistent error formatting across all validation paths.
|
|
66
|
+
"""
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
from typing import Any, NoReturn, TYPE_CHECKING
|
|
2
|
+
# Outers
|
|
3
|
+
from .....exceptions import SimpleRuntimeError
|
|
4
|
+
# Inners
|
|
5
|
+
from ._extract_clean_code_lines import _extract_clean_code_lines
|
|
6
|
+
# Annotations
|
|
7
|
+
if TYPE_CHECKING:
|
|
8
|
+
from ....protocols.classes import SimpleConstantProtocol
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
def raise_validation_error(
|
|
12
|
+
cls: "SimpleConstantProtocol",
|
|
13
|
+
value: Any,
|
|
14
|
+
) -> NoReturn:
|
|
15
|
+
"""Raises a standardized error when user-defined validation returns False."""
|
|
16
|
+
|
|
17
|
+
# 1. Extract user-defined validation logic
|
|
18
|
+
# noinspection PyBroadException
|
|
19
|
+
try:
|
|
20
|
+
validate_method = cls.meta.validate
|
|
21
|
+
validate_func = getattr(validate_method, "__func__", validate_method)
|
|
22
|
+
validate_source_list = _extract_clean_code_lines(validate_func)
|
|
23
|
+
except Exception:
|
|
24
|
+
validate_source_list = [" <source code not available>"]
|
|
25
|
+
|
|
26
|
+
# 2. Raise structured validation failure error
|
|
27
|
+
raise SimpleRuntimeError(
|
|
28
|
+
error_name="VALIDATION ERROR",
|
|
29
|
+
label="value",
|
|
30
|
+
value=value,
|
|
31
|
+
expected="A value that satisfies the user-defined validation logic.",
|
|
32
|
+
problem="The provided value did not pass the user-defined validation rules.",
|
|
33
|
+
context=(
|
|
34
|
+
f"The '_validate' method of '{cls.__name__}' returned False, indicating "
|
|
35
|
+
f"that the value does not meet the required validation criteria."
|
|
36
|
+
),
|
|
37
|
+
how_to_fix=(
|
|
38
|
+
"Review the validation logic shown below to understand why the value "
|
|
39
|
+
"was rejected:",
|
|
40
|
+
*validate_source_list,
|
|
41
|
+
"Ensure that the input value matches the assumptions and constraints "
|
|
42
|
+
"defined in your validation method.",
|
|
43
|
+
"If you intend to raise custom validation errors instead of returning "
|
|
44
|
+
"False, use 'SimpleObjectError' or 'cls.bool_or_raise_validate_error()'.",
|
|
45
|
+
),
|
|
46
|
+
exception=ValueError,
|
|
47
|
+
)
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
_DESIGN_NOTES = """
|
|
51
|
+
# raise_validation_error
|
|
52
|
+
|
|
53
|
+
## Purpose
|
|
54
|
+
Handles the case where user-defined validation (`_validate`) returns `False`
|
|
55
|
+
instead of raising an exception. This error is user-facing and explains that the
|
|
56
|
+
value failed the validation rules defined by the developer.
|
|
57
|
+
|
|
58
|
+
## Behavior
|
|
59
|
+
- Extracts the body of the `_validate` method using `extract_clean_code_lines`.
|
|
60
|
+
- Displays the validation logic directly in the error message.
|
|
61
|
+
- Raises a structured `SimpleRuntimeError` indicating that the value did not meet
|
|
62
|
+
the validation criteria.
|
|
63
|
+
|
|
64
|
+
## Why this exists
|
|
65
|
+
Users may implement `_validate` in two ways:
|
|
66
|
+
1. **Boolean style** — return `True` or `False`.
|
|
67
|
+
2. **Exception style** — raise `SimpleObjectError` or a subclass.
|
|
68
|
+
|
|
69
|
+
This function handles the first case, providing a clear and helpful error message
|
|
70
|
+
when `_validate` returns `False`.
|
|
71
|
+
|
|
72
|
+
## Notes
|
|
73
|
+
- The extracted code helps users understand exactly which part of their logic
|
|
74
|
+
rejected the value.
|
|
75
|
+
- If the source code cannot be retrieved, a placeholder is shown.
|
|
76
|
+
- This function is part of the main validation pipeline:
|
|
77
|
+
`validate_type` → `validate` → `raise_validation_error`.
|
|
78
|
+
"""
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
from .calculate_value import calculate_value
|
|
2
|
+
from .decompose_value import decompose_value
|
|
3
|
+
|
|
4
|
+
_DESIGN_NOTES = """
|
|
5
|
+
# Object Methods Sub-Package
|
|
6
|
+
|
|
7
|
+
## Purpose
|
|
8
|
+
Provides the core functional building blocks used by `SimpleObject` classes to
|
|
9
|
+
perform composite value calculation, decomposition, and structured parameter
|
|
10
|
+
processing.
|
|
11
|
+
|
|
12
|
+
## Internal Components Registry
|
|
13
|
+
|
|
14
|
+
| Component | Type | Description |
|
|
15
|
+
| :--------------------------------- | :------- | :------------------------------------------------------------------------- |
|
|
16
|
+
| `calculate_value` | Function | Computes composite values using the user-defined `_logic` method. |
|
|
17
|
+
| `decompose_value` | Function | Decomposes composite values using the user-defined `_decompose` method. |
|
|
18
|
+
"""
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
from typing import Any, TYPE_CHECKING
|
|
2
|
+
# Inners
|
|
3
|
+
from .validations import (
|
|
4
|
+
raise_too_many_positional_args_error,
|
|
5
|
+
raise_duplicate_argument_error,
|
|
6
|
+
raise_unknown_parameter_error,
|
|
7
|
+
)
|
|
8
|
+
# Annotations
|
|
9
|
+
if TYPE_CHECKING:
|
|
10
|
+
from ...protocols.classes import SimpleObjectProtocol
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
def _process_calculate_value_params(
|
|
14
|
+
cls: "SimpleObjectProtocol",
|
|
15
|
+
*args,
|
|
16
|
+
**kwargs,
|
|
17
|
+
) -> dict[str, Any]:
|
|
18
|
+
"""Processes positional and keyword parameters for composite value calculation."""
|
|
19
|
+
|
|
20
|
+
# 1. Load inner element mapping
|
|
21
|
+
inners_map = cls.meta.inners_map
|
|
22
|
+
|
|
23
|
+
# 2. Guard clause — too many positional arguments
|
|
24
|
+
if len(args) > len(inners_map):
|
|
25
|
+
raise_too_many_positional_args_error(
|
|
26
|
+
cls,
|
|
27
|
+
given_count=len(args),
|
|
28
|
+
allowed_count=len(inners_map),
|
|
29
|
+
)
|
|
30
|
+
|
|
31
|
+
# 3. Prepare data structures
|
|
32
|
+
clean_kwargs: dict[str, Any] = {}
|
|
33
|
+
args_iter = iter(args)
|
|
34
|
+
|
|
35
|
+
# 4. Iterate through inner elements in order
|
|
36
|
+
for param_name, inner_cls in inners_map.items():
|
|
37
|
+
|
|
38
|
+
# 4.1 Try to consume positional argument
|
|
39
|
+
try:
|
|
40
|
+
value = next(args_iter)
|
|
41
|
+
|
|
42
|
+
# If the same parameter also appears in kwargs → error
|
|
43
|
+
if param_name in kwargs:
|
|
44
|
+
raise_duplicate_argument_error(cls, param_name)
|
|
45
|
+
|
|
46
|
+
# 4.2 No positional argument → fall back to kwargs
|
|
47
|
+
except StopIteration:
|
|
48
|
+
value = kwargs.pop(param_name, None)
|
|
49
|
+
|
|
50
|
+
# 4.3 Load default if no value provided
|
|
51
|
+
if value is None:
|
|
52
|
+
value = inner_cls.meta.default
|
|
53
|
+
|
|
54
|
+
# 4.4 Validate provided value
|
|
55
|
+
else:
|
|
56
|
+
inner_cls.validate(value)
|
|
57
|
+
|
|
58
|
+
# 4.5 Store validated value
|
|
59
|
+
clean_kwargs[param_name] = value
|
|
60
|
+
|
|
61
|
+
# 5. Detect unknown keyword parameters
|
|
62
|
+
if kwargs:
|
|
63
|
+
raise_unknown_parameter_error(cls, list(kwargs.keys()))
|
|
64
|
+
|
|
65
|
+
# 6. Return processed parameter dictionary
|
|
66
|
+
return clean_kwargs
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
_DESIGN_NOTES = """
|
|
70
|
+
# _process_calculate_value_params
|
|
71
|
+
|
|
72
|
+
## Purpose
|
|
73
|
+
Processes positional and keyword arguments passed to `calculate_value` and maps
|
|
74
|
+
them to the inner elements of a composite object. Ensures strict, predictable
|
|
75
|
+
parameter handling and provides structured error reporting for all invalid cases.
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## Behavior
|
|
80
|
+
|
|
81
|
+
### 1. Positional Argument Count
|
|
82
|
+
- Ensures that the number of positional arguments does not exceed the number of
|
|
83
|
+
inner elements.
|
|
84
|
+
- Violations trigger `raise_too_many_positional_args_error`.
|
|
85
|
+
|
|
86
|
+
### 2. Duplicate Parameter Detection
|
|
87
|
+
- Detects when a parameter is supplied both positionally and as a keyword.
|
|
88
|
+
- Violations trigger `raise_duplicate_argument_error`.
|
|
89
|
+
|
|
90
|
+
### 3. Unknown Keyword Arguments
|
|
91
|
+
- After processing all known parameters, any remaining keyword arguments are
|
|
92
|
+
considered invalid.
|
|
93
|
+
- Violations trigger `raise_unknown_parameter_error`.
|
|
94
|
+
|
|
95
|
+
### 4. Default Handling
|
|
96
|
+
- If a parameter is not provided, its default value is loaded from metadata.
|
|
97
|
+
|
|
98
|
+
### 5. Validation
|
|
99
|
+
- All provided values are validated using the inner element’s validation pipeline.
|
|
100
|
+
|
|
101
|
+
---
|
|
102
|
+
|
|
103
|
+
## Notes
|
|
104
|
+
- This function is used internally by `calculate_value`.
|
|
105
|
+
- It ensures that composite objects behave predictably and consistently.
|
|
106
|
+
- All diagnostics are delegated to structured `SimpleRuntimeError` helpers.
|
|
107
|
+
- The public-facing documentation belongs to `SimpleObject.calculate_value`.
|
|
108
|
+
"""
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING, Any
|
|
2
|
+
# Inners
|
|
3
|
+
from ._process_calculate_value_params import _process_calculate_value_params
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ...protocols.classes import SimpleObjectProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def calculate_value(
|
|
10
|
+
cls: "SimpleObjectProtocol",
|
|
11
|
+
*args,
|
|
12
|
+
**kwargs,
|
|
13
|
+
) -> Any:
|
|
14
|
+
"""Computes the composite value by invoking the user-defined `_logic` method."""
|
|
15
|
+
|
|
16
|
+
# 1. Process incoming parameters
|
|
17
|
+
params_dict = _process_calculate_value_params(cls, *args, **kwargs)
|
|
18
|
+
|
|
19
|
+
# 2. Compute the value using the class's logic function
|
|
20
|
+
outcome = cls.meta.logic(**params_dict)
|
|
21
|
+
|
|
22
|
+
# 3. Return the computed value
|
|
23
|
+
return outcome
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
_DESIGN_NOTES = """
|
|
27
|
+
# calculate_value
|
|
28
|
+
|
|
29
|
+
## Purpose
|
|
30
|
+
Serves as the public-facing entry point for computing the value of a composite
|
|
31
|
+
object. It connects user-provided parameters with the class’s `_logic` method,
|
|
32
|
+
ensuring correct parameter mapping, validation, and execution.
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## Pipeline Overview
|
|
37
|
+
|
|
38
|
+
### 1. Parameter Processing
|
|
39
|
+
All positional and keyword arguments are normalized and validated through
|
|
40
|
+
`_process_calculate_value_params`. This step ensures:
|
|
41
|
+
|
|
42
|
+
- correct mapping to inner elements,
|
|
43
|
+
- default value substitution,
|
|
44
|
+
- validation of each inner value,
|
|
45
|
+
- structured error reporting for invalid parameters.
|
|
46
|
+
|
|
47
|
+
### 2. Logic Execution
|
|
48
|
+
After parameters are processed, the function invokes:
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
cls.meta.logic(cls, **params_dict)
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
This calls the user-defined `_logic` method with:
|
|
55
|
+
|
|
56
|
+
- the class itself (`cls`) as the first argument,
|
|
57
|
+
- validated parameters as keyword arguments.
|
|
58
|
+
|
|
59
|
+
### 3. Result Delivery
|
|
60
|
+
The return value of `_logic` becomes the composite’s computed value.
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
## Why this function exists
|
|
65
|
+
Composite objects must compute their value dynamically based on inner elements.
|
|
66
|
+
This function provides:
|
|
67
|
+
|
|
68
|
+
- a stable API for users,
|
|
69
|
+
- full type inference via `ParamSpec`,
|
|
70
|
+
- predictable behavior,
|
|
71
|
+
- separation of concerns (parameter processing vs. logic execution).
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
## Notes
|
|
76
|
+
- This function is attached to `SimpleObject` as a class method.
|
|
77
|
+
- The public-facing documentation belongs to `SimpleObject.calculate_value`.
|
|
78
|
+
- All diagnostics are delegated to `_process_calculate_value_params` and the
|
|
79
|
+
validation pipeline.
|
|
80
|
+
```
|
|
81
|
+
"""
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING, Any
|
|
2
|
+
# Inners
|
|
3
|
+
from .validations import raise_class_not_decomposeable
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ...protocols.classes import SimpleObjectProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def decompose_value(
|
|
10
|
+
cls: "SimpleObjectProtocol",
|
|
11
|
+
value: Any,
|
|
12
|
+
) -> Any:
|
|
13
|
+
"""Decomposes a composite value into its inner components."""
|
|
14
|
+
|
|
15
|
+
# 1. Ensure the composite supports decomposition
|
|
16
|
+
if not cls.meta.is_decomposeable:
|
|
17
|
+
raise_class_not_decomposeable(cls.meta)
|
|
18
|
+
|
|
19
|
+
# 2. Validate the provided value
|
|
20
|
+
cls.validate(value)
|
|
21
|
+
|
|
22
|
+
# 3. Perform decomposition using the class's decompose function
|
|
23
|
+
outcome = cls.meta.decompose(value)
|
|
24
|
+
|
|
25
|
+
# 4. Return the decomposed result
|
|
26
|
+
return outcome
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
_DESIGN_NOTES = """
|
|
31
|
+
# decompose_value
|
|
32
|
+
|
|
33
|
+
## Purpose
|
|
34
|
+
Provides the public-facing entry point for decomposing a composite value into its
|
|
35
|
+
inner components. This function ensures that decomposition is supported by the
|
|
36
|
+
class and that the provided value is valid before invoking the user-defined
|
|
37
|
+
`_decompose` method.
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## Pipeline Overview
|
|
42
|
+
|
|
43
|
+
### 1. Decomposability Check
|
|
44
|
+
Before any decomposition occurs, the system verifies that the composite class
|
|
45
|
+
supports decomposition. If the class is not marked as `is_decomposeable`, a
|
|
46
|
+
structured error is raised via `raise_class_not_decomposeable`.
|
|
47
|
+
|
|
48
|
+
### 2. Validation
|
|
49
|
+
The provided value is validated using the full validation pipeline:
|
|
50
|
+
|
|
51
|
+
- type validation,
|
|
52
|
+
- user-defined validation,
|
|
53
|
+
- normalization rules (if applicable).
|
|
54
|
+
|
|
55
|
+
This ensures that decomposition is performed only on valid, well-formed values.
|
|
56
|
+
|
|
57
|
+
### 3. Decomposition
|
|
58
|
+
After validation, the function calls:
|
|
59
|
+
|
|
60
|
+
```
|
|
61
|
+
cls.meta.decompose(cls, value)
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
This delegates the actual decomposition logic to the user-defined `_decompose`
|
|
65
|
+
method, if provided. If `_decompose` is not implemented, metadata ensures that
|
|
66
|
+
the class is marked as non-decomposable.
|
|
67
|
+
|
|
68
|
+
### 4. Result Delivery
|
|
69
|
+
The return value of `_decompose` becomes the decomposed representation of the
|
|
70
|
+
composite value.
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## Why this function exists
|
|
75
|
+
Composite objects may optionally support decomposition. This function provides:
|
|
76
|
+
|
|
77
|
+
- a stable API for users,
|
|
78
|
+
- consistent validation before decomposition,
|
|
79
|
+
- predictable behavior across all composite classes,
|
|
80
|
+
- separation of concerns (validation vs. decomposition),
|
|
81
|
+
- safety guarantees through decomposability checks.
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
## Notes
|
|
86
|
+
- This function is attached to `SimpleObject` as a class method.
|
|
87
|
+
- The public-facing documentation belongs to `SimpleObject.decompose_value`.
|
|
88
|
+
- All diagnostics are delegated to the validation pipeline and
|
|
89
|
+
`raise_class_not_decomposeable`.
|
|
90
|
+
```
|
|
91
|
+
"""
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
from .raise_class_not_decomposeable import raise_class_not_decomposeable
|
|
2
|
+
from .raise_duplicate_argument_error import raise_duplicate_argument_error
|
|
3
|
+
from .raise_too_many_positional_args_error import raise_too_many_positional_args_error
|
|
4
|
+
from .raise_unknown_parameter_error import raise_unknown_parameter_error
|
|
5
|
+
|
|
6
|
+
_DESIGN_NOTES = """
|
|
7
|
+
# Object Method Validation Errors Sub-Package
|
|
8
|
+
|
|
9
|
+
## Purpose
|
|
10
|
+
Contains all structured error generators used during composite value calculation
|
|
11
|
+
and decomposition. These functions ensure consistent, user-facing diagnostics
|
|
12
|
+
across the entire object-method pipeline.
|
|
13
|
+
|
|
14
|
+
## Internal Components Registry
|
|
15
|
+
|
|
16
|
+
| Component | Type | Description |
|
|
17
|
+
| :-------------------------------------- | :------- | :------------------------------------------------------------------------- |
|
|
18
|
+
| `raise_class_not_decomposeable` | Function | Raised when a composite does not support decomposition. |
|
|
19
|
+
| `raise_duplicate_argument_error` | Function | Raised when a parameter is passed both positionally and by keyword. |
|
|
20
|
+
| `raise_too_many_positional_args_error` | Function | Raised when too many positional arguments are supplied. |
|
|
21
|
+
| `raise_unknown_parameter_error` | Function | Raised when unknown keyword arguments are supplied. |
|
|
22
|
+
"""
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
from simplibs.sentinels import UNSET
|
|
3
|
+
# Outers
|
|
4
|
+
from .....exceptions import SimpleRuntimeError
|
|
5
|
+
# Annotations
|
|
6
|
+
if TYPE_CHECKING:
|
|
7
|
+
from ....protocols.metadata import SimpleMetadataLike
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
def raise_class_not_decomposeable(
|
|
11
|
+
meta: "SimpleMetadataLike",
|
|
12
|
+
) -> None:
|
|
13
|
+
"""Raises an error when a composite value cannot be assigned directly."""
|
|
14
|
+
|
|
15
|
+
class_name = meta.class_name
|
|
16
|
+
|
|
17
|
+
# 1. Determine whether the class itself lacks a decompose method
|
|
18
|
+
has_decompose = meta.decompose is not None and meta.decompose is not UNSET
|
|
19
|
+
|
|
20
|
+
# 2. Identify inner composite nodes that break decomposability
|
|
21
|
+
offenders = [
|
|
22
|
+
inner for inner in meta.inners
|
|
23
|
+
if not inner.meta.is_constant and not inner.meta.is_decomposeable
|
|
24
|
+
]
|
|
25
|
+
offender_names = ", ".join(o.meta.class_name for o in offenders) or "None"
|
|
26
|
+
|
|
27
|
+
# 3. Build human-facing explanation
|
|
28
|
+
if not has_decompose:
|
|
29
|
+
reason = (
|
|
30
|
+
f"Composite '{class_name}' does not define a method for decomposing values."
|
|
31
|
+
)
|
|
32
|
+
else:
|
|
33
|
+
reason = (
|
|
34
|
+
f"Composite '{class_name}' defines a decomposition method, "
|
|
35
|
+
f"but some of its inner composite elements cannot be decomposed."
|
|
36
|
+
)
|
|
37
|
+
|
|
38
|
+
raise SimpleRuntimeError(
|
|
39
|
+
error_name="COMPOSITE VALUE ASSIGNMENT ERROR",
|
|
40
|
+
label="composite_not_decomposeable",
|
|
41
|
+
expected="A composite that supports direct value assignment",
|
|
42
|
+
value=class_name,
|
|
43
|
+
problem=f"Direct assignment of a value to composite '{class_name}' is not possible. ",
|
|
44
|
+
context=(
|
|
45
|
+
f"{reason}",
|
|
46
|
+
f"Inner non-decomposable elements: {offender_names}."
|
|
47
|
+
),
|
|
48
|
+
how_to_fix=(
|
|
49
|
+
"This composite cannot accept a value directly because it cannot decompose "
|
|
50
|
+
"the provided value into its inner elements.",
|
|
51
|
+
"You can still modify the composite by changing its constant inner values, "
|
|
52
|
+
"which will update the composite from the bottom up.",
|
|
53
|
+
"If the composite is intentionally non-decomposable, this behavior is expected."
|
|
54
|
+
),
|
|
55
|
+
exception=TypeError,
|
|
56
|
+
)
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
_DESIGN_NOTES = """
|
|
60
|
+
# raise_class_not_decomposeable
|
|
61
|
+
|
|
62
|
+
## Purpose
|
|
63
|
+
This exception is user-facing. It informs the user that a composite value cannot
|
|
64
|
+
be assigned directly because the composite structure cannot decompose the
|
|
65
|
+
incoming value into its inner elements.
|
|
66
|
+
|
|
67
|
+
## Behavior
|
|
68
|
+
- If the composite class itself lacks a `decompose_value` method, the error
|
|
69
|
+
explains that direct assignment is impossible.
|
|
70
|
+
- If the composite class *does* define a decomposition method but one or more
|
|
71
|
+
inner composite nodes are non-decomposable, the error identifies those nodes.
|
|
72
|
+
- Constant inners are ignored, because they do not require decomposition.
|
|
73
|
+
|
|
74
|
+
## Notes
|
|
75
|
+
- This is not a developer guidance error. It does not instruct the programmer to
|
|
76
|
+
implement `decompose_value`. Instead, it explains to the *user* why the value
|
|
77
|
+
cannot be set directly.
|
|
78
|
+
- The error clarifies that the composite can still be modified indirectly by
|
|
79
|
+
changing constant inner values, which propagate upward.
|
|
80
|
+
- A composite may intentionally be non-decomposable; this exception respects
|
|
81
|
+
that design and communicates it clearly.
|
|
82
|
+
"""
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
from typing import NoReturn, TYPE_CHECKING
|
|
2
|
+
# Outers
|
|
3
|
+
from .....exceptions import SimpleRuntimeError
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ....protocols.classes import SimpleObjectProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def raise_duplicate_argument_error(
|
|
10
|
+
cls: "SimpleObjectProtocol",
|
|
11
|
+
param_name: str,
|
|
12
|
+
) -> NoReturn:
|
|
13
|
+
"""Raises an error when an argument is provided both positionally and by keyword."""
|
|
14
|
+
|
|
15
|
+
class_name = cls.__name__
|
|
16
|
+
|
|
17
|
+
raise SimpleRuntimeError(
|
|
18
|
+
error_name="INVALID PARAMETERS",
|
|
19
|
+
label=param_name,
|
|
20
|
+
value=f"Positional and keyword argument for '{param_name}'",
|
|
21
|
+
expected=f"Parameter '{param_name}' provided either positionally OR as a keyword",
|
|
22
|
+
problem=(
|
|
23
|
+
f"The parameter '{param_name}' was supplied twice when calling "
|
|
24
|
+
f"'{class_name}.calculate_value': once as a positional argument and "
|
|
25
|
+
f"once as a keyword argument."
|
|
26
|
+
),
|
|
27
|
+
context=(
|
|
28
|
+
f"During parameter processing for '{class_name}.calculate_value', "
|
|
29
|
+
f"the system detected a duplicate argument definition."
|
|
30
|
+
),
|
|
31
|
+
how_to_fix=(
|
|
32
|
+
"Provide the parameter only once.",
|
|
33
|
+
"If you prefer positional arguments, remove the keyword version.",
|
|
34
|
+
"If you prefer keyword arguments, remove the positional version.",
|
|
35
|
+
"Ensure that each inner element is mapped to exactly one argument.",
|
|
36
|
+
),
|
|
37
|
+
exception=ValueError,
|
|
38
|
+
)
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
_DESIGN_NOTES = """
|
|
42
|
+
# raise_duplicate_argument_error
|
|
43
|
+
|
|
44
|
+
## Purpose
|
|
45
|
+
Signals that a parameter was supplied both positionally and as a keyword when
|
|
46
|
+
calling `calculate_value`. This is a user-facing error that prevents ambiguous
|
|
47
|
+
argument mapping in composite objects.
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
## Behavior
|
|
52
|
+
- Detects when the same parameter name appears in both `args` and `kwargs`.
|
|
53
|
+
- Raises a structured `SimpleRuntimeError` explaining the conflict.
|
|
54
|
+
- Provides actionable guidance on how to correct the call.
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## Why this error exists
|
|
59
|
+
Composite objects map positional arguments to inner elements **by order**.
|
|
60
|
+
Keyword arguments map them **by name**.
|
|
61
|
+
|
|
62
|
+
If a parameter is supplied twice:
|
|
63
|
+
|
|
64
|
+
- the system cannot determine which value should be used,
|
|
65
|
+
- the mapping becomes ambiguous,
|
|
66
|
+
- the resulting composite value could be incorrect.
|
|
67
|
+
|
|
68
|
+
This error ensures predictable behavior and prevents silent overwrites.
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## Notes
|
|
73
|
+
- Used inside `process_calculate_value_params`.
|
|
74
|
+
- The public-facing documentation belongs to `SimpleObject.calculate_value`.
|
|
75
|
+
- Uses `ValueError` as the underlying exception type for consistency with Python’s
|
|
76
|
+
argument handling semantics.
|
|
77
|
+
"""
|