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
simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/process_step_value.py
ADDED
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
from typing import Any, TYPE_CHECKING
|
|
2
|
+
from simplibs.sentinels import UNSET
|
|
3
|
+
# Outers
|
|
4
|
+
from ...processors import process_value
|
|
5
|
+
# Annotations
|
|
6
|
+
if TYPE_CHECKING:
|
|
7
|
+
from ......._core.protocols.mixins.numerical.stepper import StepperProtocol
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
def process_step_value(
|
|
11
|
+
self: "StepperProtocol",
|
|
12
|
+
value: Any = UNSET,
|
|
13
|
+
*,
|
|
14
|
+
validate: bool = True
|
|
15
|
+
) -> Any:
|
|
16
|
+
"""
|
|
17
|
+
Prepares and normalizes the step value for use in step_up and step_down.
|
|
18
|
+
|
|
19
|
+
If the value is UNSET, returns the default step of the stepper.
|
|
20
|
+
If the value is provided, it undergoes standard normalization and optional validation.
|
|
21
|
+
"""
|
|
22
|
+
return (
|
|
23
|
+
self._step if value is UNSET
|
|
24
|
+
else process_value(self, value, validate=validate)
|
|
25
|
+
)
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
_DESIGN_NOTES = """
|
|
29
|
+
# process_step_value
|
|
30
|
+
|
|
31
|
+
## Purpose
|
|
32
|
+
Normalizes and prepares the step value used by `step_up` and `step_down`.
|
|
33
|
+
This function ensures that both default step values and user‑provided step
|
|
34
|
+
values behave consistently and safely.
|
|
35
|
+
|
|
36
|
+
It acts as a lightweight wrapper around `process_value`, adding logic specific
|
|
37
|
+
to stepper semantics.
|
|
38
|
+
|
|
39
|
+
## Architectural role
|
|
40
|
+
`process_step_value` is used by:
|
|
41
|
+
|
|
42
|
+
- `step_up`
|
|
43
|
+
- `step_down`
|
|
44
|
+
|
|
45
|
+
It provides the canonical way to interpret the “step amount” before applying
|
|
46
|
+
it to the instance’s value.
|
|
47
|
+
|
|
48
|
+
## How it works
|
|
49
|
+
The function performs two deterministic operations:
|
|
50
|
+
|
|
51
|
+
### 1. Default step handling
|
|
52
|
+
If the caller does not provide a step value (`value is UNSET`), the function
|
|
53
|
+
returns the stepper’s configured default step (`self._step`).
|
|
54
|
+
|
|
55
|
+
This ensures that step operations always have a valid numeric increment.
|
|
56
|
+
|
|
57
|
+
### 2. Normalization of user‑provided step values
|
|
58
|
+
If the caller provides a step value, it is passed to `process_value`, which:
|
|
59
|
+
|
|
60
|
+
- converts the value to the correct numeric type,
|
|
61
|
+
- validates the value if requested,
|
|
62
|
+
- ensures type consistency with the instance’s value type.
|
|
63
|
+
|
|
64
|
+
This guarantees that user‑provided step values behave identically to default
|
|
65
|
+
step values.
|
|
66
|
+
|
|
67
|
+
## Integration requirements
|
|
68
|
+
The function assumes:
|
|
69
|
+
|
|
70
|
+
- **StepperProtocol**
|
|
71
|
+
Provides `_step` and metadata about the instance.
|
|
72
|
+
|
|
73
|
+
- **process_value**
|
|
74
|
+
Performs normalization and optional validation of numeric values.
|
|
75
|
+
|
|
76
|
+
Without these components, step value processing cannot operate correctly.
|
|
77
|
+
|
|
78
|
+
## Why this function exists
|
|
79
|
+
Stepper operations must support:
|
|
80
|
+
|
|
81
|
+
- default step values,
|
|
82
|
+
- user‑provided step values,
|
|
83
|
+
- type‑safe normalization,
|
|
84
|
+
- optional validation,
|
|
85
|
+
- consistent behavior across all numeric types.
|
|
86
|
+
|
|
87
|
+
This function encapsulates the minimal logic required to achieve that.
|
|
88
|
+
|
|
89
|
+
## Deterministic behavior
|
|
90
|
+
The function guarantees:
|
|
91
|
+
|
|
92
|
+
- stable fallback to default step,
|
|
93
|
+
- predictable normalization,
|
|
94
|
+
- consistent validation behavior,
|
|
95
|
+
- type‑safe numeric operations.
|
|
96
|
+
|
|
97
|
+
This determinism is essential for safe stepper behavior.
|
|
98
|
+
|
|
99
|
+
## Stability guarantee
|
|
100
|
+
Any change to this function would affect:
|
|
101
|
+
|
|
102
|
+
- step_up / step_down semantics,
|
|
103
|
+
- numeric consistency,
|
|
104
|
+
- validation behavior,
|
|
105
|
+
- user experience when stepping values.
|
|
106
|
+
|
|
107
|
+
Therefore, `process_step_value` is treated as a **core invariant** of the
|
|
108
|
+
Stepper subsystem.
|
|
109
|
+
|
|
110
|
+
## Notes
|
|
111
|
+
- This function is intentionally minimal and side‑effect‑free.
|
|
112
|
+
- It is not part of the public API; it is used internally by Stepper methods.
|
|
113
|
+
- All structural logic is delegated to `process_value`.
|
|
114
|
+
"""
|
simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/validations/__init__.py
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
from .raise_stepper_down_limit_reached import raise_stepper_down_limit_reached
|
|
2
|
+
from .raise_stepper_up_limit_reached import raise_stepper_up_limit_reached
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
_DESIGN_NOTES = """
|
|
6
|
+
# Stepper Limit-Reached Validations
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
Provides the specialized validation functions used when a stepper value
|
|
10
|
+
crosses its configured numeric boundaries. These functions raise structured,
|
|
11
|
+
diagnostic errors that describe the limit violation in detail and offer
|
|
12
|
+
actionable guidance.
|
|
13
|
+
|
|
14
|
+
They form the core of the stepper's runtime safety layer, ensuring that
|
|
15
|
+
invalid transitions are detected early and handled consistently.
|
|
16
|
+
|
|
17
|
+
## Components
|
|
18
|
+
|
|
19
|
+
| Component | Type | Description |
|
|
20
|
+
| :-------------------------------- | :--------| :-------------------------------------------------------- |
|
|
21
|
+
| `raise_stepper_down_limit_reached`| Function | Raises an error when the new value falls below the down limit. |
|
|
22
|
+
| `raise_stepper_up_limit_reached` | Function | Raises an error when the new value exceeds the up limit. |
|
|
23
|
+
|
|
24
|
+
## Notes
|
|
25
|
+
- These utilities are internal and not part of the public API.
|
|
26
|
+
- They are used exclusively by `verify_down_limit` and `verify_up_limit`.
|
|
27
|
+
- All structural logic is delegated to the stepper's validation subsystem.
|
|
28
|
+
- Errors raised here follow the SimpleRuntimeError diagnostic format.
|
|
29
|
+
"""
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING, NoReturn, Any
|
|
2
|
+
# Outers
|
|
3
|
+
from ........exceptions import SimpleRuntimeError
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ........_core.protocols.mixins.numerical.stepper import StepperProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def raise_stepper_down_limit_reached(
|
|
10
|
+
stepper: "StepperProtocol",
|
|
11
|
+
new_value: Any,
|
|
12
|
+
) -> NoReturn:
|
|
13
|
+
"""
|
|
14
|
+
Raises a structured error when a step operation attempts to go below
|
|
15
|
+
the configured down limit.
|
|
16
|
+
"""
|
|
17
|
+
|
|
18
|
+
raise SimpleRuntimeError(
|
|
19
|
+
error_name="STEPPER DOWN LIMIT ERROR",
|
|
20
|
+
label="new value",
|
|
21
|
+
value=new_value,
|
|
22
|
+
expected=f"Value >= {stepper.down_limit!r}",
|
|
23
|
+
problem=(
|
|
24
|
+
"The step operation attempted to decrease the value below the "
|
|
25
|
+
"configured down limit."
|
|
26
|
+
),
|
|
27
|
+
context=(
|
|
28
|
+
f"Instance type: {type(stepper._instance).__name__}.",
|
|
29
|
+
f"Current value: {stepper._instance.value!r}.",
|
|
30
|
+
f"Down limit: {stepper.down_limit!r}.",
|
|
31
|
+
"The stepper enforces numeric boundaries to prevent invalid state transitions."
|
|
32
|
+
),
|
|
33
|
+
how_to_fix=(
|
|
34
|
+
"Increase the down limit if lower values should be allowed.",
|
|
35
|
+
"Adjust the step value to avoid crossing the limit.",
|
|
36
|
+
"Disable limit enforcement if this behavior is intentional.",
|
|
37
|
+
),
|
|
38
|
+
exception=ValueError,
|
|
39
|
+
)
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
_DESIGN_NOTES = """
|
|
43
|
+
# raise_stepper_down_limit_reached
|
|
44
|
+
|
|
45
|
+
## Purpose
|
|
46
|
+
Provides a structured diagnostic error when a step operation attempts to move
|
|
47
|
+
the value below the configured down limit.
|
|
48
|
+
This replaces the generic `ValueError` with a rich, contextual, and actionable
|
|
49
|
+
error message consistent with the rest of the Simple ecosystem.
|
|
50
|
+
|
|
51
|
+
The function ensures that limit violations are always reported clearly and
|
|
52
|
+
predictably.
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## Architectural reasoning
|
|
57
|
+
Stepper is a numerical mixin subsystem responsible for:
|
|
58
|
+
|
|
59
|
+
- controlled value manipulation,
|
|
60
|
+
- enforcing numeric boundaries,
|
|
61
|
+
- triggering limit actions,
|
|
62
|
+
- maintaining safe state transitions.
|
|
63
|
+
|
|
64
|
+
Crossing the down limit is not a trivial numeric error — it is a **logical
|
|
65
|
+
violation of the stepper’s configuration**.
|
|
66
|
+
Therefore, it must be reported using a structured error that:
|
|
67
|
+
|
|
68
|
+
- explains what happened,
|
|
69
|
+
- shows the offending value,
|
|
70
|
+
- shows the configured limit,
|
|
71
|
+
- provides actionable steps to fix the issue,
|
|
72
|
+
- includes contextual information about the instance.
|
|
73
|
+
|
|
74
|
+
This mirrors the design of immutability, history, metadata, and composite
|
|
75
|
+
errors.
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## Pipeline position
|
|
80
|
+
This function is used inside `verify_down_limit`:
|
|
81
|
+
|
|
82
|
+
1. Check if `new_value < down_limit`.
|
|
83
|
+
2. Trigger `down_limit_action` if present.
|
|
84
|
+
3. If `raise_exception=True`, call this function.
|
|
85
|
+
4. Otherwise return `False`.
|
|
86
|
+
|
|
87
|
+
This ensures:
|
|
88
|
+
|
|
89
|
+
- consistent behavior across all step operations,
|
|
90
|
+
- predictable error handling,
|
|
91
|
+
- clear separation of validation and error raising.
|
|
92
|
+
|
|
93
|
+
---
|
|
94
|
+
|
|
95
|
+
## Diagnostic value
|
|
96
|
+
The error message includes:
|
|
97
|
+
|
|
98
|
+
- the invalid new value,
|
|
99
|
+
- the expected minimum value,
|
|
100
|
+
- the current instance value,
|
|
101
|
+
- the configured down limit,
|
|
102
|
+
- the instance type,
|
|
103
|
+
- actionable steps to resolve the issue.
|
|
104
|
+
|
|
105
|
+
This makes debugging significantly easier and aligns with the philosophy of
|
|
106
|
+
Simple’s structured error system.
|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
## Notes
|
|
111
|
+
- This is a pure `raise_...` function: it performs no branching logic.
|
|
112
|
+
- It is internal and not part of the public API.
|
|
113
|
+
- All stepper limit violations must use this function.
|
|
114
|
+
- The error type is `SimpleRuntimeError` with `ValueError` as the underlying exception.
|
|
115
|
+
"""
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING, NoReturn, Any
|
|
2
|
+
# Outers
|
|
3
|
+
from ........exceptions import SimpleRuntimeError
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ........_core.protocols.mixins.numerical.stepper import StepperProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def raise_stepper_up_limit_reached(
|
|
10
|
+
stepper: "StepperProtocol",
|
|
11
|
+
new_value: Any,
|
|
12
|
+
) -> NoReturn:
|
|
13
|
+
"""
|
|
14
|
+
Raises a structured error when a step operation attempts to exceed
|
|
15
|
+
the configured upper limit.
|
|
16
|
+
"""
|
|
17
|
+
|
|
18
|
+
raise SimpleRuntimeError(
|
|
19
|
+
error_name="STEPPER UP LIMIT ERROR",
|
|
20
|
+
label="new value",
|
|
21
|
+
value=new_value,
|
|
22
|
+
expected=f"Value <= {stepper.up_limit!r}",
|
|
23
|
+
problem=(
|
|
24
|
+
"The step operation attempted to increase the value above the "
|
|
25
|
+
"configured upper limit."
|
|
26
|
+
),
|
|
27
|
+
context=(
|
|
28
|
+
f"Instance type: {type(stepper._instance).__name__}.",
|
|
29
|
+
f"Current value: {stepper._instance.value!r}.",
|
|
30
|
+
f"Upper limit: {stepper.up_limit!r}.",
|
|
31
|
+
"The stepper enforces numeric boundaries to prevent invalid state transitions."
|
|
32
|
+
),
|
|
33
|
+
how_to_fix=(
|
|
34
|
+
"Increase the upper limit if higher values should be allowed.",
|
|
35
|
+
"Adjust the step value to avoid crossing the limit.",
|
|
36
|
+
"Disable limit enforcement if this behavior is intentional.",
|
|
37
|
+
),
|
|
38
|
+
exception=ValueError,
|
|
39
|
+
)
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
_DESIGN_NOTES = """
|
|
43
|
+
# raise_stepper_up_limit_reached
|
|
44
|
+
|
|
45
|
+
## Purpose
|
|
46
|
+
Provides a structured diagnostic error when a step operation attempts to move
|
|
47
|
+
the value above the configured upper limit.
|
|
48
|
+
This replaces the generic `ValueError("Dosaženo horního limitu")` with a rich,
|
|
49
|
+
contextual, and actionable error message consistent with the Simple ecosystem.
|
|
50
|
+
|
|
51
|
+
The function ensures that upper‑limit violations are always reported clearly
|
|
52
|
+
and predictably.
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## Architectural reasoning
|
|
57
|
+
Stepper is responsible for safe numeric manipulation.
|
|
58
|
+
Crossing the upper limit is a **logical violation** of the stepper’s
|
|
59
|
+
configuration, not just a numeric mismatch.
|
|
60
|
+
|
|
61
|
+
Therefore, the error must:
|
|
62
|
+
|
|
63
|
+
- explain what happened,
|
|
64
|
+
- show the offending value,
|
|
65
|
+
- show the configured limit,
|
|
66
|
+
- provide actionable steps,
|
|
67
|
+
- include contextual information about the instance.
|
|
68
|
+
|
|
69
|
+
This mirrors the design of immutability, history, metadata, and composite
|
|
70
|
+
errors.
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## Pipeline position
|
|
75
|
+
This function is used inside `verify_up_limit`:
|
|
76
|
+
|
|
77
|
+
1. Check if `new_value > up_limit`.
|
|
78
|
+
2. Trigger `up_limit_action` if present.
|
|
79
|
+
3. If `raise_exception=True`, call this function.
|
|
80
|
+
4. Otherwise return `False`.
|
|
81
|
+
|
|
82
|
+
This ensures:
|
|
83
|
+
|
|
84
|
+
- consistent behavior across all step operations,
|
|
85
|
+
- predictable error handling,
|
|
86
|
+
- clear separation of validation and error raising.
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## Diagnostic value
|
|
91
|
+
The error message includes:
|
|
92
|
+
|
|
93
|
+
- the invalid new value,
|
|
94
|
+
- the expected maximum value,
|
|
95
|
+
- the current instance value,
|
|
96
|
+
- the configured upper limit,
|
|
97
|
+
- the instance type,
|
|
98
|
+
- actionable steps to resolve the issue.
|
|
99
|
+
|
|
100
|
+
This makes debugging significantly easier and aligns with the philosophy of
|
|
101
|
+
Simple’s structured error system.
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
## Notes
|
|
106
|
+
- This is a pure `raise_...` function: it performs no branching logic.
|
|
107
|
+
- It is internal and not part of the public API.
|
|
108
|
+
- All stepper limit violations must use this function.
|
|
109
|
+
- The error type is `SimpleRuntimeError` with `ValueError` as the underlying exception.
|
|
110
|
+
"""
|
simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/verify_down_limit.py
ADDED
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
from typing import Any, TYPE_CHECKING
|
|
2
|
+
from simplibs.sentinels import UNSET
|
|
3
|
+
# Inners
|
|
4
|
+
from .validations import raise_stepper_down_limit_reached
|
|
5
|
+
# Annotations
|
|
6
|
+
if TYPE_CHECKING:
|
|
7
|
+
from ......._core.protocols.mixins.numerical.stepper import StepperProtocol
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
def verify_down_limit(
|
|
11
|
+
self: "StepperProtocol",
|
|
12
|
+
new_value: Any,
|
|
13
|
+
*,
|
|
14
|
+
raise_exception: bool = False
|
|
15
|
+
) -> bool:
|
|
16
|
+
"""
|
|
17
|
+
Verifies that the new value does not fall below the stepper's down limit.
|
|
18
|
+
|
|
19
|
+
If the down limit is set and the new value is below it,
|
|
20
|
+
triggers the optional limit action and optionally raises a structured error.
|
|
21
|
+
"""
|
|
22
|
+
|
|
23
|
+
# 1. Check whether the DOWN limit is set and violated
|
|
24
|
+
if self.down_limit is not UNSET and new_value < self.down_limit:
|
|
25
|
+
|
|
26
|
+
# 2. Trigger limit action if present
|
|
27
|
+
if self.down_limit_action:
|
|
28
|
+
self.down_limit_action()
|
|
29
|
+
|
|
30
|
+
# 3. Raise structured error if requested
|
|
31
|
+
if raise_exception:
|
|
32
|
+
raise_stepper_down_limit_reached(self, new_value)
|
|
33
|
+
|
|
34
|
+
return False
|
|
35
|
+
|
|
36
|
+
# 4. Successful validation
|
|
37
|
+
return True
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
_DESIGN_NOTES = """
|
|
41
|
+
# verify_down_limit
|
|
42
|
+
|
|
43
|
+
## Purpose
|
|
44
|
+
Checks whether a new value violates the configured down limit of the stepper.
|
|
45
|
+
If the limit is violated, the function:
|
|
46
|
+
|
|
47
|
+
1. triggers the optional `down_limit_action`,
|
|
48
|
+
2. optionally raises a structured diagnostic error,
|
|
49
|
+
3. returns `False` to indicate validation failure.
|
|
50
|
+
|
|
51
|
+
This function provides the core logic for lower-bound enforcement in stepper
|
|
52
|
+
operations.
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## Architectural role
|
|
57
|
+
`verify_down_limit` is used by:
|
|
58
|
+
|
|
59
|
+
- `step_down`
|
|
60
|
+
- `step_up`
|
|
61
|
+
- `set_value`
|
|
62
|
+
|
|
63
|
+
It acts as the canonical validation layer for lower-bound limit checks.
|
|
64
|
+
|
|
65
|
+
The function integrates with:
|
|
66
|
+
|
|
67
|
+
- structured error raising (`raise_stepper_down_limit_reached`),
|
|
68
|
+
- optional callback execution (`down_limit_action`),
|
|
69
|
+
- UNSET semantics for optional configuration.
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## How it works
|
|
74
|
+
|
|
75
|
+
### 1. Limit presence and violation check
|
|
76
|
+
The function first checks:
|
|
77
|
+
|
|
78
|
+
```
|
|
79
|
+
self.down_limit is not UNSET
|
|
80
|
+
and new_value < self.down_limit
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
This ensures that:
|
|
84
|
+
|
|
85
|
+
- limits are only enforced when explicitly configured,
|
|
86
|
+
- numeric comparison is performed only when meaningful.
|
|
87
|
+
|
|
88
|
+
### 2. Triggering limit actions
|
|
89
|
+
If a violation occurs and a `down_limit_action` is configured, it is executed
|
|
90
|
+
immediately.
|
|
91
|
+
This allows users to attach custom behavior such as logging, clamping, or
|
|
92
|
+
side-effect operations.
|
|
93
|
+
|
|
94
|
+
### 3. Structured error raising
|
|
95
|
+
If `raise_exception=True`, the function raises a structured diagnostic error
|
|
96
|
+
via `raise_stepper_down_limit_reached`.
|
|
97
|
+
|
|
98
|
+
This replaces generic exceptions with rich, contextual, and actionable error
|
|
99
|
+
messages consistent with the Simple ecosystem.
|
|
100
|
+
|
|
101
|
+
### 4. Returning validation status
|
|
102
|
+
If no exception is raised, the function returns `False` to indicate that the
|
|
103
|
+
limit was violated.
|
|
104
|
+
|
|
105
|
+
If the limit is not violated, the function returns `True`.
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
## Why this function exists
|
|
110
|
+
Stepper operations must enforce numeric boundaries to prevent invalid state
|
|
111
|
+
transitions.
|
|
112
|
+
This function encapsulates:
|
|
113
|
+
|
|
114
|
+
- limit checking,
|
|
115
|
+
- callback execution,
|
|
116
|
+
- structured error raising,
|
|
117
|
+
- UNSET semantics,
|
|
118
|
+
- consistent return values.
|
|
119
|
+
|
|
120
|
+
It ensures predictable behavior across all stepper operations.
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
## Deterministic behavior
|
|
125
|
+
The function guarantees:
|
|
126
|
+
|
|
127
|
+
- stable limit checking,
|
|
128
|
+
- consistent callback execution,
|
|
129
|
+
- predictable error raising,
|
|
130
|
+
- deterministic return values.
|
|
131
|
+
|
|
132
|
+
This determinism is essential for safe numeric stepping.
|
|
133
|
+
|
|
134
|
+
---
|
|
135
|
+
|
|
136
|
+
## Notes
|
|
137
|
+
- This function is internal and not part of the public API.
|
|
138
|
+
- All structural logic is delegated to limit configuration and validation utilities.
|
|
139
|
+
- The function is intentionally minimal and side-effect-free except for
|
|
140
|
+
optional callback execution.
|
|
141
|
+
"""
|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
from typing import Any, TYPE_CHECKING
|
|
2
|
+
from simplibs.sentinels import UNSET
|
|
3
|
+
# Inners
|
|
4
|
+
from .validations import raise_stepper_up_limit_reached
|
|
5
|
+
# Annotations
|
|
6
|
+
if TYPE_CHECKING:
|
|
7
|
+
from ......._core.protocols.mixins.numerical.stepper import StepperProtocol
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
def verify_up_limit(
|
|
11
|
+
self: "StepperProtocol",
|
|
12
|
+
new_value: Any,
|
|
13
|
+
*,
|
|
14
|
+
raise_exception: bool = False
|
|
15
|
+
) -> bool:
|
|
16
|
+
"""
|
|
17
|
+
Verifies that the new value does not exceed the stepper's upper limit.
|
|
18
|
+
|
|
19
|
+
If the upper limit is set and the new value exceeds it,
|
|
20
|
+
triggers the optional limit action and optionally raises a structured error.
|
|
21
|
+
"""
|
|
22
|
+
|
|
23
|
+
# 1. Check whether the UP limit is set and violated
|
|
24
|
+
if self.up_limit is not UNSET and new_value > self.up_limit:
|
|
25
|
+
|
|
26
|
+
# 2. Trigger limit action if present
|
|
27
|
+
if self.up_limit_action:
|
|
28
|
+
self.up_limit_action()
|
|
29
|
+
|
|
30
|
+
# 3. Raise structured error if requested
|
|
31
|
+
if raise_exception:
|
|
32
|
+
raise_stepper_up_limit_reached(self, new_value)
|
|
33
|
+
|
|
34
|
+
return False
|
|
35
|
+
|
|
36
|
+
# 4. Successful validation
|
|
37
|
+
return True
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
_DESIGN_NOTES = """
|
|
41
|
+
# verify_up_limit
|
|
42
|
+
|
|
43
|
+
## Purpose
|
|
44
|
+
Checks whether a new value violates the configured upper limit of the stepper.
|
|
45
|
+
If the limit is violated, the function:
|
|
46
|
+
|
|
47
|
+
1. triggers the optional `up_limit_action`,
|
|
48
|
+
2. optionally raises a structured diagnostic error,
|
|
49
|
+
3. returns `False` to indicate validation failure.
|
|
50
|
+
|
|
51
|
+
This function provides the core logic for upper-bound enforcement in stepper
|
|
52
|
+
operations.
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## Architectural role
|
|
57
|
+
`verify_up_limit` is used by:
|
|
58
|
+
|
|
59
|
+
- `step_up`
|
|
60
|
+
- `step_down`
|
|
61
|
+
- `set_value`
|
|
62
|
+
|
|
63
|
+
It acts as the canonical validation layer for upper-bound limit checks.
|
|
64
|
+
|
|
65
|
+
The function integrates with:
|
|
66
|
+
|
|
67
|
+
- structured error raising (`raise_stepper_up_limit_reached`),
|
|
68
|
+
- optional callback execution (`up_limit_action`),
|
|
69
|
+
- UNSET semantics for optional configuration.
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## How it works
|
|
74
|
+
|
|
75
|
+
### 1. Limit presence and violation check
|
|
76
|
+
The function first checks:
|
|
77
|
+
|
|
78
|
+
```
|
|
79
|
+
self.up_limit is not UNSET
|
|
80
|
+
and new_value > self.up_limit
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
This ensures that:
|
|
84
|
+
|
|
85
|
+
- limits are only enforced when explicitly configured,
|
|
86
|
+
- numeric comparison is performed only when meaningful.
|
|
87
|
+
|
|
88
|
+
### 2. Triggering limit actions
|
|
89
|
+
If a violation occurs and an `up_limit_action` is configured, it is executed
|
|
90
|
+
immediately.
|
|
91
|
+
This allows users to attach custom behavior such as logging, clamping, or
|
|
92
|
+
side-effect operations.
|
|
93
|
+
|
|
94
|
+
### 3. Structured error raising
|
|
95
|
+
If `raise_exception=True`, the function raises a structured diagnostic error
|
|
96
|
+
via `raise_stepper_up_limit_reached`.
|
|
97
|
+
|
|
98
|
+
This replaces generic exceptions with rich, contextual, and actionable error
|
|
99
|
+
messages consistent with the Simple ecosystem.
|
|
100
|
+
|
|
101
|
+
### 4. Returning validation status
|
|
102
|
+
If no exception is raised, the function returns `False` to indicate that the
|
|
103
|
+
limit was violated.
|
|
104
|
+
|
|
105
|
+
If the limit is not violated, the function returns `True`.
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
## Why this function exists
|
|
110
|
+
Stepper operations must enforce numeric boundaries to prevent invalid state
|
|
111
|
+
transitions.
|
|
112
|
+
This function encapsulates:
|
|
113
|
+
|
|
114
|
+
- limit checking,
|
|
115
|
+
- callback execution,
|
|
116
|
+
- structured error raising,
|
|
117
|
+
- UNSET semantics,
|
|
118
|
+
- consistent return values.
|
|
119
|
+
|
|
120
|
+
It ensures predictable behavior across all stepper operations.
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
## Deterministic behavior
|
|
125
|
+
The function guarantees:
|
|
126
|
+
|
|
127
|
+
- stable limit checking,
|
|
128
|
+
- consistent callback execution,
|
|
129
|
+
- predictable error raising,
|
|
130
|
+
- deterministic return values.
|
|
131
|
+
|
|
132
|
+
This determinism is essential for safe numeric stepping.
|
|
133
|
+
|
|
134
|
+
---
|
|
135
|
+
|
|
136
|
+
## Notes
|
|
137
|
+
- This function is internal and not part of the public API.
|
|
138
|
+
- All structural logic is delegated to limit configuration and validation utilities.
|
|
139
|
+
- The function is intentionally minimal and side-effect-free except for
|
|
140
|
+
optional callback execution.
|
|
141
|
+
"""
|