simplibs-object 0.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- simplibs/object/SimpleBase.py +115 -0
- simplibs/object/SimpleConstant.py +271 -0
- simplibs/object/SimpleObject.py +293 -0
- simplibs/object/__init__.py +7 -0
- simplibs/object/_core/__init__.py +66 -0
- simplibs/object/_core/logic/__init__.py +0 -0
- simplibs/object/_core/logic/constant_methods/__init__.py +22 -0
- simplibs/object/_core/logic/constant_methods/bool_or_raise_validate_error.py +76 -0
- simplibs/object/_core/logic/constant_methods/normalize.py +92 -0
- simplibs/object/_core/logic/constant_methods/validate.py +99 -0
- simplibs/object/_core/logic/constant_methods/validate_type.py +48 -0
- simplibs/object/_core/logic/constant_methods/validations/__init__.py +22 -0
- simplibs/object/_core/logic/constant_methods/validations/_extract_clean_code_lines.py +86 -0
- simplibs/object/_core/logic/constant_methods/validations/raise_missing_value_error.py +71 -0
- simplibs/object/_core/logic/constant_methods/validations/raise_type_error.py +59 -0
- simplibs/object/_core/logic/constant_methods/validations/raise_unexpected_validation_error.py +66 -0
- simplibs/object/_core/logic/constant_methods/validations/raise_validation_error.py +78 -0
- simplibs/object/_core/logic/object_methods/__init__.py +18 -0
- simplibs/object/_core/logic/object_methods/_process_calculate_value_params.py +108 -0
- simplibs/object/_core/logic/object_methods/calculate_value.py +81 -0
- simplibs/object/_core/logic/object_methods/decompose_value.py +91 -0
- simplibs/object/_core/logic/object_methods/validations/__init__.py +22 -0
- simplibs/object/_core/logic/object_methods/validations/raise_class_not_decomposeable.py +82 -0
- simplibs/object/_core/logic/object_methods/validations/raise_duplicate_argument_error.py +77 -0
- simplibs/object/_core/logic/object_methods/validations/raise_too_many_positional_args_error.py +81 -0
- simplibs/object/_core/logic/object_methods/validations/raise_unknown_parameter_error.py +77 -0
- simplibs/object/_core/logic/property_builders/__init__.py +20 -0
- simplibs/object/_core/logic/property_builders/create_instance_property.py +66 -0
- simplibs/object/_core/logic/property_builders/create_properties_for_inner.py +97 -0
- simplibs/object/_core/logic/property_builders/create_value_property.py +98 -0
- simplibs/object/_core/logic/property_builders/value_helpers/__init__.py +18 -0
- simplibs/object/_core/logic/property_builders/value_helpers/create_value_getter.py +52 -0
- simplibs/object/_core/logic/property_builders/value_helpers/create_value_setter.py +95 -0
- simplibs/object/_core/logic/property_builders/value_helpers/validations/__init__.py +16 -0
- simplibs/object/_core/logic/property_builders/value_helpers/validations/raise_locked_value_error.py +103 -0
- simplibs/object/_core/metadata/SimpleBaseMetadata.py +139 -0
- simplibs/object/_core/metadata/SimpleConstantMetadata.py +108 -0
- simplibs/object/_core/metadata/SimpleMeta.py +214 -0
- simplibs/object/_core/metadata/SimpleObjectMetadata.py +165 -0
- simplibs/object/_core/metadata/__init__.py +16 -0
- simplibs/object/_core/metadata/constants/BASE_CLASS_NAMES.py +23 -0
- simplibs/object/_core/metadata/constants/__init__.py +16 -0
- simplibs/object/_core/metadata/init_processors/__init__.py +47 -0
- simplibs/object/_core/metadata/init_processors/blueprint_path/__init__.py +15 -0
- simplibs/object/_core/metadata/init_processors/blueprint_path/calculate_blueprint_path.py +81 -0
- simplibs/object/_core/metadata/init_processors/default/__init__.py +17 -0
- simplibs/object/_core/metadata/init_processors/default/process_default_for_constant.py +71 -0
- simplibs/object/_core/metadata/init_processors/default/validations/__init__.py +19 -0
- simplibs/object/_core/metadata/init_processors/default/validations/_exception_info_for_default.py +66 -0
- simplibs/object/_core/metadata/init_processors/default/validations/raise_default_is_defined_in_composition.py +78 -0
- simplibs/object/_core/metadata/init_processors/default/validations/validate_default_is_defined.py +77 -0
- simplibs/object/_core/metadata/init_processors/default/validations/validate_default_matches_annotation.py +93 -0
- simplibs/object/_core/metadata/init_processors/inners/__init__.py +15 -0
- simplibs/object/_core/metadata/init_processors/inners/process_inners.py +143 -0
- simplibs/object/_core/metadata/init_processors/inners/validations/__init__.py +33 -0
- simplibs/object/_core/metadata/init_processors/inners/validations/_exception_info_for_inners.py +43 -0
- simplibs/object/_core/metadata/init_processors/inners/validations/_get_collision_path.py +45 -0
- simplibs/object/_core/metadata/init_processors/inners/validations/validate_collision_within_inners.py +78 -0
- simplibs/object/_core/metadata/init_processors/inners/validations/validate_if_collision_with_owner_class.py +66 -0
- simplibs/object/_core/metadata/init_processors/inners/validations/validate_inner_is_class.py +58 -0
- simplibs/object/_core/metadata/init_processors/inners/validations/validate_inner_is_not_simple_class.py +60 -0
- simplibs/object/_core/metadata/init_processors/inners/validations/validate_inner_is_simple_subclass.py +61 -0
- simplibs/object/_core/metadata/init_processors/inners/validations/validate_inners_is_defined.py +56 -0
- simplibs/object/_core/metadata/init_processors/inners/validations/validate_inners_is_not_empty.py +57 -0
- simplibs/object/_core/metadata/init_processors/inners/validations/validate_inners_is_tuple.py +57 -0
- simplibs/object/_core/metadata/init_processors/methods/__init__.py +15 -0
- simplibs/object/_core/metadata/init_processors/methods/process_classmethod.py +130 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/__init__.py +16 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/_exceptions_helpers/__init__.py +17 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/_exceptions_helpers/exception_info_for_classmethod.py +52 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/_exceptions_helpers/expected_structure_for_classmethod.py +80 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/annotations_and_defaults/__init__.py +15 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/annotations_and_defaults/validations/__init__.py +19 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/annotations_and_defaults/validations/_convert_annotation_to_type_set.py +38 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/annotations_and_defaults/validations/validate_annotations.py +84 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/annotations_and_defaults/validations/validate_args_defaults.py +76 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/annotations_and_defaults/validations/validate_kwargs_defaults.py +74 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/annotations_and_defaults/verify_annotations_and_defaults.py +100 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/__init__.py +15 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/decompose_method/__init__.py +15 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/decompose_method/validations/__init__.py +19 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/decompose_method/validations/raise_decompose_unvalide_outcome_length.py +64 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/decompose_method/validations/validate_decompose_unvalide_item_type.py +77 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/decompose_method/validations/validate_decompose_unvalide_item_value.py +72 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/decompose_method/verify_decompose_outcome.py +87 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/validations/__init__.py +17 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/validations/raise_method_raised_exceptions.py +56 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/validations/raise_method_return_unvalide_outcome_type.py +80 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/calculation/verify_calculation.py +89 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/classmethod/__init__.py +15 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/classmethod/_clone_classmethod.py +81 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/classmethod/validations/__init__.py +19 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/classmethod/validations/validate_method_is_callable.py +60 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/classmethod/validations/validate_method_is_classmethod.py +60 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/classmethod/validations/validate_method_is_defined.py +67 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/classmethod/verify_classmethod.py +117 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/params/__init__.py +15 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/params/validations/__init__.py +19 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/params/validations/validate_method_has_exact_args_count.py +59 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/params/validations/validate_method_not_use_param_placeholders.py +66 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/params/validations/validate_method_param_match_expected.py +61 -0
- simplibs/object/_core/metadata/init_processors/methods/verifiers/params/verify_params.py +123 -0
- simplibs/object/_core/metadata/init_processors/names/__init__.py +15 -0
- simplibs/object/_core/metadata/init_processors/names/_class_name_splitter.py +242 -0
- simplibs/object/_core/metadata/init_processors/names/create_names.py +119 -0
- simplibs/object/_core/metadata/init_processors/names/validations/__init__.py +19 -0
- simplibs/object/_core/metadata/init_processors/names/validations/validate_class_name_has_no_underscores.py +94 -0
- simplibs/object/_core/metadata/init_processors/names/validations/validate_class_name_is_ascii.py +95 -0
- simplibs/object/_core/metadata/init_processors/names/validations/validate_class_name_is_identifier.py +83 -0
- simplibs/object/_core/metadata/init_processors/type/__init__.py +15 -0
- simplibs/object/_core/metadata/init_processors/type/process_type.py +117 -0
- simplibs/object/_core/metadata/init_processors/type/validations/__init__.py +29 -0
- simplibs/object/_core/metadata/init_processors/type/validations/_exception_info_for_type.py +88 -0
- simplibs/object/_core/metadata/init_processors/type/validations/raise_union_type_contain_none.py +70 -0
- simplibs/object/_core/metadata/init_processors/type/validations/raise_validate_type_is_not_valid.py +92 -0
- simplibs/object/_core/metadata/init_processors/type/validations/validate_type_from_tuple_is_not_none.py +94 -0
- simplibs/object/_core/metadata/init_processors/type/validations/validate_type_is_defined.py +85 -0
- simplibs/object/_core/metadata/init_processors/type/validations/validate_type_is_not_empty.py +93 -0
- simplibs/object/_core/metadata/init_processors/type/validations/validate_type_is_not_none.py +87 -0
- simplibs/object/_core/metadata/init_processors/type/validations/validate_type_tuple_is_not_nested.py +92 -0
- simplibs/object/_core/metadata/instance_builders/__init__.py +55 -0
- simplibs/object/_core/metadata/instance_builders/atom_class/InstanceBase.py +77 -0
- simplibs/object/_core/metadata/instance_builders/atom_class/__init__.py +16 -0
- simplibs/object/_core/metadata/instance_builders/atom_class/helpers/__init__.py +16 -0
- simplibs/object/_core/metadata/instance_builders/atom_class/helpers/create_atom_init.py +51 -0
- simplibs/object/_core/metadata/instance_builders/atom_class/helpers/create_root_value_setter.py +67 -0
- simplibs/object/_core/metadata/instance_builders/atom_class/make_atom_class.py +101 -0
- simplibs/object/_core/metadata/instance_builders/composite_class/__init__.py +14 -0
- simplibs/object/_core/metadata/instance_builders/composite_class/helpers/__init__.py +20 -0
- simplibs/object/_core/metadata/instance_builders/composite_class/helpers/_get_inner_instance_class.py +51 -0
- simplibs/object/_core/metadata/instance_builders/composite_class/helpers/create_composite_init.py +74 -0
- simplibs/object/_core/metadata/instance_builders/composite_class/helpers/create_properties_for_inners.py +50 -0
- simplibs/object/_core/metadata/instance_builders/composite_class/helpers/create_recalculate_inners.py +57 -0
- simplibs/object/_core/metadata/instance_builders/composite_class/helpers/create_recalculate_self.py +69 -0
- simplibs/object/_core/metadata/instance_builders/composite_class/make_composite_class.py +93 -0
- simplibs/object/_core/metadata/instance_builders/instance/__init__.py +17 -0
- simplibs/object/_core/metadata/instance_builders/instance/create_instance.py +107 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/__init__.py +25 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/_build_combined_init_mixins.py +40 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/_build_instance_class_dict.py +127 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/_extend_instance_class.py +59 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/_resolve_flat_mixins.py +74 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/_verify_mixin_compatibility.py +83 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/create_instance_class.py +76 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/get_base_class.py +53 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/__init__.py +20 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/__init__.py +29 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/raise_mixin_not_allowed_for_composite.py +61 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/raise_mixin_not_allowed_for_constant.py +61 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/raise_mixin_not_allowed_for_immutable.py +61 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/raise_mixin_not_allowed_for_mutable.py +60 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/raise_mixin_not_support_default_value_type.py +66 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/validate_mixin_is_class.py +56 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/mixins_validations/validate_mixin_is_simple_base_subclass.py +60 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/raise_invalide_extend_instance_class_definition.py +62 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/raise_mixin_slot_collision.py +56 -0
- simplibs/object/_core/metadata/instance_builders/instance/helpers/validations/raise_mixin_slot_collision_with_base_class.py +56 -0
- simplibs/object/_core/metadata/instance_builders/instance/validations/__init__.py +21 -0
- simplibs/object/_core/metadata/instance_builders/instance/validations/validate_class_is_not_base_class.py +54 -0
- simplibs/object/_core/metadata/instance_builders/instance/validations/validate_hashing_for_immutable_value.py +66 -0
- simplibs/object/_core/metadata/instance_builders/instance/validations/validate_param_is_bool.py +47 -0
- simplibs/object/_core/metadata/validations/__init__.py +18 -0
- simplibs/object/_core/metadata/validations/raise_attribut_allready_set.py +57 -0
- simplibs/object/_core/metadata/validations/raise_metadata_is_immutable.py +73 -0
- simplibs/object/_core/protocols/__init__.py +118 -0
- simplibs/object/_core/protocols/alias_typings/__init__.py +137 -0
- simplibs/object/_core/protocols/alias_typings/changes/ChangeTuple.py +5 -0
- simplibs/object/_core/protocols/alias_typings/changes/ChangesDict.py +5 -0
- simplibs/object/_core/protocols/alias_typings/changes/ChangesTuple.py +8 -0
- simplibs/object/_core/protocols/alias_typings/changes/__init__.py +18 -0
- simplibs/object/_core/protocols/alias_typings/history/HistoryDict.py +5 -0
- simplibs/object/_core/protocols/alias_typings/history/HistoryEntry.py +10 -0
- simplibs/object/_core/protocols/alias_typings/history/__init__.py +16 -0
- simplibs/object/_core/protocols/alias_typings/inners/InnersMap.py +8 -0
- simplibs/object/_core/protocols/alias_typings/inners/InnersTuple.py +8 -0
- simplibs/object/_core/protocols/alias_typings/inners/__init__.py +16 -0
- simplibs/object/_core/protocols/alias_typings/mixins/MixinsTuple.py +8 -0
- simplibs/object/_core/protocols/alias_typings/mixins/__init__.py +14 -0
- simplibs/object/_core/protocols/alias_typings/names/NamesSet.py +5 -0
- simplibs/object/_core/protocols/alias_typings/names/NamesTuple.py +5 -0
- simplibs/object/_core/protocols/alias_typings/names/__init__.py +16 -0
- simplibs/object/_core/protocols/alias_typings/nodes/NodeItem.py +9 -0
- simplibs/object/_core/protocols/alias_typings/nodes/NodesDict.py +9 -0
- simplibs/object/_core/protocols/alias_typings/nodes/NodesIndexMap.py +6 -0
- simplibs/object/_core/protocols/alias_typings/nodes/NodesInstanceDict.py +9 -0
- simplibs/object/_core/protocols/alias_typings/nodes/NodesPathDict.py +9 -0
- simplibs/object/_core/protocols/alias_typings/nodes/NodesTuple.py +8 -0
- simplibs/object/_core/protocols/alias_typings/nodes/__init__.py +24 -0
- simplibs/object/_core/protocols/alias_typings/paths/PathDict.py +8 -0
- simplibs/object/_core/protocols/alias_typings/paths/PathTuple.py +5 -0
- simplibs/object/_core/protocols/alias_typings/paths/__init__.py +16 -0
- simplibs/object/_core/protocols/alias_typings/snapshots/SnapshotDict.py +5 -0
- simplibs/object/_core/protocols/alias_typings/snapshots/SnapshotDiffItem.py +5 -0
- simplibs/object/_core/protocols/alias_typings/snapshots/SnapshotDiffTuple.py +8 -0
- simplibs/object/_core/protocols/alias_typings/snapshots/SnapshotTuple.py +5 -0
- simplibs/object/_core/protocols/alias_typings/snapshots/__init__.py +20 -0
- simplibs/object/_core/protocols/alias_typings/state/StateDict.py +5 -0
- simplibs/object/_core/protocols/alias_typings/state/__init__.py +14 -0
- simplibs/object/_core/protocols/alias_typings/types/ValidTypes.py +6 -0
- simplibs/object/_core/protocols/alias_typings/types/__init__.py +14 -0
- simplibs/object/_core/protocols/classes/SimpleBaseProtocol.py +25 -0
- simplibs/object/_core/protocols/classes/SimpleConstantProtocol.py +54 -0
- simplibs/object/_core/protocols/classes/SimpleObjectProtocol.py +50 -0
- simplibs/object/_core/protocols/classes/__init__.py +26 -0
- simplibs/object/_core/protocols/instance/SimpleConstantInstanceProtocol.py +13 -0
- simplibs/object/_core/protocols/instance/SimpleInstanceBaseProtocol.py +24 -0
- simplibs/object/_core/protocols/instance/SimpleObjectInstanceProtocol.py +13 -0
- simplibs/object/_core/protocols/instance/__init__.py +29 -0
- simplibs/object/_core/protocols/instance/core_classes/AtomInstanceProtocol.py +46 -0
- simplibs/object/_core/protocols/instance/core_classes/CompositeInstanceProtocol.py +37 -0
- simplibs/object/_core/protocols/instance/core_classes/InstanceBaseProtocol.py +28 -0
- simplibs/object/_core/protocols/instance/core_classes/__init__.py +19 -0
- simplibs/object/_core/protocols/metadata/SimpleBaseMetadataProtocol.py +37 -0
- simplibs/object/_core/protocols/metadata/SimpleConstantMetadataProtocol.py +45 -0
- simplibs/object/_core/protocols/metadata/SimpleMetaProtocol.py +39 -0
- simplibs/object/_core/protocols/metadata/SimpleObjectMetadataProtocol.py +49 -0
- simplibs/object/_core/protocols/metadata/__init__.py +28 -0
- simplibs/object/_core/protocols/methods/ClassMethodProtocol.py +29 -0
- simplibs/object/_core/protocols/methods/LogicSignature.py +20 -0
- simplibs/object/_core/protocols/methods/__init__.py +18 -0
- simplibs/object/_core/protocols/mixins/__init__.py +120 -0
- simplibs/object/_core/protocols/mixins/base_class/SimpleMixinProtocol.py +46 -0
- simplibs/object/_core/protocols/mixins/base_class/__init__.py +18 -0
- simplibs/object/_core/protocols/mixins/core_mixins/InfrastructureProtocol.py +16 -0
- simplibs/object/_core/protocols/mixins/core_mixins/NodesDictsProtocol.py +38 -0
- simplibs/object/_core/protocols/mixins/core_mixins/NodesTupleProtocol.py +30 -0
- simplibs/object/_core/protocols/mixins/core_mixins/SerializationProtocol.py +55 -0
- simplibs/object/_core/protocols/mixins/core_mixins/SnapshotProtocol.py +42 -0
- simplibs/object/_core/protocols/mixins/core_mixins/__init__.py +27 -0
- simplibs/object/_core/protocols/mixins/dunders/__init__.py +123 -0
- simplibs/object/_core/protocols/mixins/dunders/collections/CollectionBaseProtocol.py +37 -0
- simplibs/object/_core/protocols/mixins/dunders/collections/CollectionProtocol.py +20 -0
- simplibs/object/_core/protocols/mixins/dunders/collections/IterableProtocol.py +37 -0
- simplibs/object/_core/protocols/mixins/dunders/collections/MappingProtocol.py +52 -0
- simplibs/object/_core/protocols/mixins/dunders/collections/__init__.py +21 -0
- simplibs/object/_core/protocols/mixins/dunders/comparison/EqualityProtocol.py +31 -0
- simplibs/object/_core/protocols/mixins/dunders/comparison/OrderingProtocol.py +32 -0
- simplibs/object/_core/protocols/mixins/dunders/comparison/__init__.py +16 -0
- simplibs/object/_core/protocols/mixins/dunders/generics/ClassGetItemProtocol.py +23 -0
- simplibs/object/_core/protocols/mixins/dunders/generics/__init__.py +14 -0
- simplibs/object/_core/protocols/mixins/dunders/interfaces/CallProtocol.py +26 -0
- simplibs/object/_core/protocols/mixins/dunders/interfaces/ContextProtocol.py +38 -0
- simplibs/object/_core/protocols/mixins/dunders/interfaces/__init__.py +16 -0
- simplibs/object/_core/protocols/mixins/dunders/lifecycles/CopyableProtocol.py +33 -0
- simplibs/object/_core/protocols/mixins/dunders/lifecycles/LifecycleProtocol.py +21 -0
- simplibs/object/_core/protocols/mixins/dunders/lifecycles/PickleReduceProtocol.py +30 -0
- simplibs/object/_core/protocols/mixins/dunders/lifecycles/PickleStateProtocol.py +42 -0
- simplibs/object/_core/protocols/mixins/dunders/lifecycles/__init__.py +20 -0
- simplibs/object/_core/protocols/mixins/dunders/lifecycles/internal_types/PicklePlan.py +5 -0
- simplibs/object/_core/protocols/mixins/dunders/lifecycles/internal_types/__init__.py +14 -0
- simplibs/object/_core/protocols/mixins/dunders/numeric/ArithmeticProtocol.py +95 -0
- simplibs/object/_core/protocols/mixins/dunders/numeric/BitwiseProtocol.py +79 -0
- simplibs/object/_core/protocols/mixins/dunders/numeric/ConversionProtocol.py +57 -0
- simplibs/object/_core/protocols/mixins/dunders/numeric/InplaceProtocol.py +66 -0
- simplibs/object/_core/protocols/mixins/dunders/numeric/UnaryProtocol.py +35 -0
- simplibs/object/_core/protocols/mixins/dunders/numeric/__init__.py +22 -0
- simplibs/object/_core/protocols/mixins/dunders/numeric/internal_types/Operator.py +5 -0
- simplibs/object/_core/protocols/mixins/dunders/numeric/internal_types/UnaryOperator.py +5 -0
- simplibs/object/_core/protocols/mixins/dunders/numeric/internal_types/__init__.py +16 -0
- simplibs/object/_core/protocols/mixins/dunders/representation/ValueDisplayProtocol.py +30 -0
- simplibs/object/_core/protocols/mixins/dunders/representation/ValueFormattingProtocol.py +42 -0
- simplibs/object/_core/protocols/mixins/dunders/representation/__init__.py +16 -0
- simplibs/object/_core/protocols/mixins/immutable/ImmutableMethodsProtocol.py +69 -0
- simplibs/object/_core/protocols/mixins/immutable/ImmutableMethodsWithInnersProtocol.py +27 -0
- simplibs/object/_core/protocols/mixins/immutable/__init__.py +18 -0
- simplibs/object/_core/protocols/mixins/numerical/EqualizerProtocol.py +37 -0
- simplibs/object/_core/protocols/mixins/numerical/VolumeProtocol.py +32 -0
- simplibs/object/_core/protocols/mixins/numerical/__init__.py +17 -0
- simplibs/object/_core/protocols/mixins/numerical/internal_types/SteppersMap.py +8 -0
- simplibs/object/_core/protocols/mixins/numerical/internal_types/__init__.py +14 -0
- simplibs/object/_core/protocols/mixins/numerical/stepper/StepperProtocol.py +95 -0
- simplibs/object/_core/protocols/mixins/numerical/stepper/__init__.py +14 -0
- simplibs/object/_core/protocols/mixins/numerical/stepper/internal_types/LimitAction.py +5 -0
- simplibs/object/_core/protocols/mixins/numerical/stepper/internal_types/StepValue.py +6 -0
- simplibs/object/_core/protocols/mixins/numerical/stepper/internal_types/__init__.py +16 -0
- simplibs/object/_core/protocols/mixins/properties/InnersPropertyProtocol.py +31 -0
- simplibs/object/_core/protocols/mixins/properties/MetaShortcutsProtocol.py +49 -0
- simplibs/object/_core/protocols/mixins/properties/__init__.py +17 -0
- simplibs/object/_core/protocols/mixins/state/DefaultStateProtocol.py +41 -0
- simplibs/object/_core/protocols/mixins/state/DirtyTrackingProtocol.py +61 -0
- simplibs/object/_core/protocols/mixins/state/HistoryProtocol.py +112 -0
- simplibs/object/_core/protocols/mixins/state/PermissionProtocol.py +35 -0
- simplibs/object/_core/protocols/mixins/state/__init__.py +22 -0
- simplibs/object/exceptions/SimpleDefinitionError.py +45 -0
- simplibs/object/exceptions/SimpleInitializationError.py +43 -0
- simplibs/object/exceptions/SimpleRuntimeError.py +50 -0
- simplibs/object/exceptions/__init__.py +62 -0
- simplibs/object/exceptions/base_exception/SimpleObjectError.py +107 -0
- simplibs/object/exceptions/base_exception/__init__.py +19 -0
- simplibs/object/mixins/__init__.py +99 -0
- simplibs/object/mixins/_common_logic/__init__.py +41 -0
- simplibs/object/mixins/_common_logic/constants/__init__.py +27 -0
- simplibs/object/mixins/_common_logic/constants/names/HISTORY.py +14 -0
- simplibs/object/mixins/_common_logic/constants/names/OWNER_CLASS.py +14 -0
- simplibs/object/mixins/_common_logic/constants/names/STEPPER.py +14 -0
- simplibs/object/mixins/_common_logic/constants/names/VALUE.py +14 -0
- simplibs/object/mixins/_common_logic/constants/names/__init__.py +28 -0
- simplibs/object/mixins/_common_logic/constants/sets/FORBIDDEN_NAMES.py +27 -0
- simplibs/object/mixins/_common_logic/constants/sets/RESTRICTION_FLAGS.py +18 -0
- simplibs/object/mixins/_common_logic/constants/sets/__init__.py +22 -0
- simplibs/object/mixins/_common_logic/immutability/__init__.py +28 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/__init__.py +17 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/utils/__init__.py +22 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/utils/get_top_composite_paths.py +142 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/utils/process_single_change.py +143 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/utils/split_changes.py +142 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/utils/split_constants_paths.py +147 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/utils/split_constants_paths2.py +142 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/utils/validations/__init__.py +23 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/utils/validations/raise_split_changes_unknown_name.py +107 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/utils/validations/raise_with_any_unknown_name.py +71 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/vaidations/__init__.py +24 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/vaidations/raise_with_any_changes_is_not_tuple.py +65 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/vaidations/raise_with_any_child_composite_mismatch.py +68 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/vaidations/raise_with_any_contained_constant_mismatch.py +67 -0
- simplibs/object/mixins/_common_logic/immutability/with_any/with_any.py +238 -0
- simplibs/object/mixins/_common_logic/immutability/with_composite/__init__.py +17 -0
- simplibs/object/mixins/_common_logic/immutability/with_composite/utils/__init__.py +15 -0
- simplibs/object/mixins/_common_logic/immutability/with_composite/utils/reacalculate_inners.py +112 -0
- simplibs/object/mixins/_common_logic/immutability/with_composite/vaidations/__init__.py +21 -0
- simplibs/object/mixins/_common_logic/immutability/with_composite/vaidations/validate_composite_is_decomposeable.py +71 -0
- simplibs/object/mixins/_common_logic/immutability/with_composite/vaidations/validate_composite_name_exists.py +71 -0
- simplibs/object/mixins/_common_logic/immutability/with_composite/with_composite.py +176 -0
- simplibs/object/mixins/_common_logic/immutability/with_constant/__init__.py +17 -0
- simplibs/object/mixins/_common_logic/immutability/with_constant/utils/__init__.py +20 -0
- simplibs/object/mixins/_common_logic/immutability/with_constant/utils/create_new_instance.py +130 -0
- simplibs/object/mixins/_common_logic/immutability/with_constant/utils/create_snapshot_dict.py +83 -0
- simplibs/object/mixins/_common_logic/immutability/with_constant/utils/reacalculate_owner_value.py +131 -0
- simplibs/object/mixins/_common_logic/immutability/with_constant/vaidations/__init__.py +16 -0
- simplibs/object/mixins/_common_logic/immutability/with_constant/vaidations/raise_immutability_constant_not_found.py +93 -0
- simplibs/object/mixins/_common_logic/immutability/with_constant/with_constant.py +147 -0
- simplibs/object/mixins/_common_logic/immutability/with_constants/__init__.py +17 -0
- simplibs/object/mixins/_common_logic/immutability/with_constants/utils/__init__.py +15 -0
- simplibs/object/mixins/_common_logic/immutability/with_constants/utils/find_longest_keys.py +112 -0
- simplibs/object/mixins/_common_logic/immutability/with_constants/vaidations/__init__.py +25 -0
- simplibs/object/mixins/_common_logic/immutability/with_constants/vaidations/raise_immutability_batch_constant_not_found.py +94 -0
- simplibs/object/mixins/_common_logic/immutability/with_constants/vaidations/raise_immutability_constants_changes_not_tuple.py +94 -0
- simplibs/object/mixins/_common_logic/immutability/with_constants/vaidations/validate_inner_tuple_has_length_two.py +91 -0
- simplibs/object/mixins/_common_logic/immutability/with_constants/vaidations/validate_inner_tuple_is_tuple.py +99 -0
- simplibs/object/mixins/_common_logic/immutability/with_constants/vaidations/validate_inner_tuple_name_is_str.py +90 -0
- simplibs/object/mixins/_common_logic/immutability/with_constants/with_constants.py +193 -0
- simplibs/object/mixins/base_class/SimpleMixin.py +118 -0
- simplibs/object/mixins/base_class/__init__.py +17 -0
- simplibs/object/mixins/base_class/_meta/SimpleMixinMeta.py +59 -0
- simplibs/object/mixins/base_class/_meta/__init__.py +21 -0
- simplibs/object/mixins/base_class/_meta/_verify_mixin_definition.py +161 -0
- simplibs/object/mixins/base_class/_meta/validations/__init__.py +34 -0
- simplibs/object/mixins/base_class/_meta/validations/raise_mixin_dict_contains_forbidden_attributes.py +101 -0
- simplibs/object/mixins/base_class/_meta/validations/raise_mixin_flag_is_not_bool.py +122 -0
- simplibs/object/mixins/base_class/_meta/validations/raise_mixin_init_mixins_contains_super_call.py +75 -0
- simplibs/object/mixins/base_class/_meta/validations/raise_mixin_only_types_invalid.py +107 -0
- simplibs/object/mixins/base_class/_meta/validations/raise_mixin_slots_contain_unvalid_type.py +85 -0
- simplibs/object/mixins/base_class/_meta/validations/raise_mixin_slots_contains_forbidden_slot_names.py +102 -0
- simplibs/object/mixins/base_class/_meta/validations/raise_mixin_slots_is_not_defined.py +79 -0
- simplibs/object/mixins/base_class/_meta/validations/raise_mixin_slots_unsuport_type.py +88 -0
- simplibs/object/mixins/core_mixins/Infrastructure.py +49 -0
- simplibs/object/mixins/core_mixins/NodesDicts.py +104 -0
- simplibs/object/mixins/core_mixins/NodesTuple.py +86 -0
- simplibs/object/mixins/core_mixins/Serialization.py +120 -0
- simplibs/object/mixins/core_mixins/Snapshot.py +104 -0
- simplibs/object/mixins/core_mixins/__init__.py +32 -0
- simplibs/object/mixins/core_mixins/_utils/__init__.py +49 -0
- simplibs/object/mixins/core_mixins/_utils/nodes_tuple/__init__.py +17 -0
- simplibs/object/mixins/core_mixins/_utils/nodes_tuple/_collect_nodes_data.py +131 -0
- simplibs/object/mixins/core_mixins/_utils/nodes_tuple/build_nodes_tuple.py +104 -0
- simplibs/object/mixins/core_mixins/_utils/serialization/__init__.py +20 -0
- simplibs/object/mixins/core_mixins/_utils/serialization/from_dict.py +190 -0
- simplibs/object/mixins/core_mixins/_utils/serialization/from_dict_constants.py +151 -0
- simplibs/object/mixins/core_mixins/_utils/serialization/to_dict.py +158 -0
- simplibs/object/mixins/core_mixins/_utils/serialization/validations/__init__.py +30 -0
- simplibs/object/mixins/core_mixins/_utils/serialization/validations/raise_invalid_composite_structure.py +65 -0
- simplibs/object/mixins/core_mixins/_utils/serialization/validations/raise_missing_composite_key.py +64 -0
- simplibs/object/mixins/core_mixins/_utils/serialization/validations/raise_missing_value_key.py +66 -0
- simplibs/object/mixins/core_mixins/_utils/serialization/validations/raise_unvalid_owner_class_mismatch_for_state_dict.py +77 -0
- simplibs/object/mixins/core_mixins/_utils/serialization/validations/raise_unvalid_state_dict_input.py +67 -0
- simplibs/object/mixins/core_mixins/_utils/snapshot/__init__.py +15 -0
- simplibs/object/mixins/core_mixins/_utils/snapshot/compare_snapshots.py +102 -0
- simplibs/object/mixins/core_mixins/_utils/snapshot/validations/__init__.py +16 -0
- simplibs/object/mixins/core_mixins/_utils/snapshot/validations/raise_snapshot_incompatible_error.py +101 -0
- simplibs/object/mixins/dunders/__init__.py +61 -0
- simplibs/object/mixins/dunders/collections/CollectionBase.py +129 -0
- simplibs/object/mixins/dunders/collections/Iterable.py +81 -0
- simplibs/object/mixins/dunders/collections/Mapping.py +131 -0
- simplibs/object/mixins/dunders/collections/__init__.py +29 -0
- simplibs/object/mixins/dunders/collections/main/Collection.py +47 -0
- simplibs/object/mixins/dunders/collections/main/__init__.py +20 -0
- simplibs/object/mixins/dunders/comparison/Equality.py +128 -0
- simplibs/object/mixins/dunders/comparison/Ordering.py +130 -0
- simplibs/object/mixins/dunders/comparison/__init__.py +25 -0
- simplibs/object/mixins/dunders/generics/ClassGetItem.py +105 -0
- simplibs/object/mixins/dunders/generics/__init__.py +20 -0
- simplibs/object/mixins/dunders/interfaces/Call.py +101 -0
- simplibs/object/mixins/dunders/interfaces/Context.py +100 -0
- simplibs/object/mixins/dunders/interfaces/__init__.py +23 -0
- simplibs/object/mixins/dunders/lifecycles/Copyable.py +103 -0
- simplibs/object/mixins/dunders/lifecycles/PickleReduce.py +88 -0
- simplibs/object/mixins/dunders/lifecycles/PickleState.py +104 -0
- simplibs/object/mixins/dunders/lifecycles/__init__.py +29 -0
- simplibs/object/mixins/dunders/lifecycles/_utils/__init__.py +20 -0
- simplibs/object/mixins/dunders/lifecycles/_utils/rebuild_simple_instance.py +51 -0
- simplibs/object/mixins/dunders/lifecycles/main/Lifecycle.py +45 -0
- simplibs/object/mixins/dunders/lifecycles/main/__init__.py +20 -0
- simplibs/object/mixins/dunders/numeric/Arithmetic.py +195 -0
- simplibs/object/mixins/dunders/numeric/Bitwise.py +172 -0
- simplibs/object/mixins/dunders/numeric/Conversion.py +149 -0
- simplibs/object/mixins/dunders/numeric/Inplace.py +124 -0
- simplibs/object/mixins/dunders/numeric/Unary.py +89 -0
- simplibs/object/mixins/dunders/numeric/__init__.py +31 -0
- simplibs/object/mixins/dunders/numeric/_utils/__init__.py +41 -0
- simplibs/object/mixins/dunders/numeric/_utils/_align_operand_type.py +111 -0
- simplibs/object/mixins/dunders/numeric/_utils/execute_arithmetic_op.py +157 -0
- simplibs/object/mixins/dunders/numeric/_utils/execute_bitwise_op.py +116 -0
- simplibs/object/mixins/dunders/numeric/_utils/execute_conversion.py +107 -0
- simplibs/object/mixins/dunders/numeric/_utils/execute_inplace_op.py +139 -0
- simplibs/object/mixins/dunders/numeric/_utils/execute_unary_op.py +121 -0
- simplibs/object/mixins/dunders/representation/ValueDisplay.py +96 -0
- simplibs/object/mixins/dunders/representation/ValueFormatting.py +144 -0
- simplibs/object/mixins/dunders/representation/__init__.py +24 -0
- simplibs/object/mixins/others/__init__.py +48 -0
- simplibs/object/mixins/others/immutable/ImmutableMethods.py +142 -0
- simplibs/object/mixins/others/immutable/ImmutableMethodsWithInners.py +111 -0
- simplibs/object/mixins/others/immutable/__init__.py +24 -0
- simplibs/object/mixins/others/immutable/_validations/__init__.py +19 -0
- simplibs/object/mixins/others/immutable/_validations/raise_with_changes_input_not_dict.py +60 -0
- simplibs/object/mixins/others/numerical/Equalizer.py +129 -0
- simplibs/object/mixins/others/numerical/Volume.py +100 -0
- simplibs/object/mixins/others/numerical/__init__.py +25 -0
- simplibs/object/mixins/others/numerical/_stepper_class/Stepper.py +227 -0
- simplibs/object/mixins/others/numerical/_stepper_class/__init__.py +31 -0
- simplibs/object/mixins/others/numerical/_stepper_class/methods/__init__.py +35 -0
- simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/__init__.py +33 -0
- simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/process_step_value.py +114 -0
- simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/validations/__init__.py +29 -0
- simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/validations/raise_stepper_down_limit_reached.py +115 -0
- simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/validations/raise_stepper_up_limit_reached.py +110 -0
- simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/verify_down_limit.py +141 -0
- simplibs/object/mixins/others/numerical/_stepper_class/methods/processors/verify_up_limit.py +141 -0
- simplibs/object/mixins/others/numerical/_stepper_class/methods/set_value.py +163 -0
- simplibs/object/mixins/others/numerical/_stepper_class/methods/step_down.py +154 -0
- simplibs/object/mixins/others/numerical/_stepper_class/methods/step_up.py +154 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/__init__.py +38 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/process_down_limit_value.py +143 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/process_limit_action.py +118 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/process_up_limit_value.py +143 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/process_value.py +142 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/validate_instance.py +138 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/validations/__init__.py +39 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/validations/raise_stepper_invalid_action.py +118 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/validations/raise_stepper_invalid_down_limit.py +125 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/validations/raise_stepper_invalid_instance.py +117 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/validations/raise_stepper_invalid_up_limit.py +125 -0
- simplibs/object/mixins/others/numerical/_stepper_class/processors/validations/raise_stepper_non_numeric_value.py +122 -0
- simplibs/object/mixins/others/properties/InnersProperty.py +91 -0
- simplibs/object/mixins/others/properties/MetaShortcuts.py +113 -0
- simplibs/object/mixins/others/properties/__init__.py +24 -0
- simplibs/object/mixins/others/properties/_inners_property_utils/__init__.py +23 -0
- simplibs/object/mixins/others/properties/_inners_property_utils/_collect_nested_inner_properties.py +134 -0
- simplibs/object/mixins/others/properties/_inners_property_utils/collect_all_nested_properties.py +132 -0
- simplibs/object/mixins/others/state/DefaultState.py +119 -0
- simplibs/object/mixins/others/state/DirtyTracking.py +144 -0
- simplibs/object/mixins/others/state/History.py +248 -0
- simplibs/object/mixins/others/state/Permission.py +102 -0
- simplibs/object/mixins/others/state/__init__.py +31 -0
- simplibs/object/mixins/others/state/_history_utils/__init__.py +50 -0
- simplibs/object/mixins/others/state/_history_utils/core/__init__.py +32 -0
- simplibs/object/mixins/others/state/_history_utils/core/find_snapshot.py +142 -0
- simplibs/object/mixins/others/state/_history_utils/core/record_state.py +130 -0
- simplibs/object/mixins/others/state/_history_utils/core/set_history_limit.py +114 -0
- simplibs/object/mixins/others/state/_history_utils/core/validations/__init__.py +31 -0
- simplibs/object/mixins/others/state/_history_utils/core/validations/raise_history_limit_not_positive_integer.py +65 -0
- simplibs/object/mixins/others/state/_history_utils/core/validations/raise_unvalide_snapshot_index.py +67 -0
- simplibs/object/mixins/others/state/_history_utils/core/validations/raise_unvalide_snopshot_reference.py +67 -0
- simplibs/object/mixins/others/state/_history_utils/core/validations/raise_unvalide_snopshot_timestamp.py +66 -0
- simplibs/object/mixins/others/state/_history_utils/core/validations/raise_unvalide_timestamp.py +63 -0
- simplibs/object/mixins/others/state/_history_utils/navigations/__init__.py +38 -0
- simplibs/object/mixins/others/state/_history_utils/navigations/go_to_history_on_index.py +103 -0
- simplibs/object/mixins/others/state/_history_utils/navigations/go_to_history_on_timestamp.py +115 -0
- simplibs/object/mixins/others/state/_history_utils/navigations/go_to_last_history.py +103 -0
- simplibs/object/mixins/others/state/_history_utils/navigations/history_redo.py +103 -0
- simplibs/object/mixins/others/state/_history_utils/navigations/history_undo.py +104 -0
- simplibs/object/mixins/others/state/_history_utils/transfer/__init__.py +31 -0
- simplibs/object/mixins/others/state/_history_utils/transfer/export_history_to_dict.py +110 -0
- simplibs/object/mixins/others/state/_history_utils/transfer/import_history_from_dict.py +169 -0
- simplibs/object/mixins/others/state/_history_utils/transfer/validations/__init__.py +24 -0
- simplibs/object/mixins/others/state/_history_utils/transfer/validations/raise_unvalide_history_import_file.py +66 -0
- simplibs/object/mixins/others/state/_history_utils/transfer/validations/raise_unvalide_owner_class_mismatch.py +69 -0
- simplibs/object/settings/__init__.py +90 -0
- simplibs/object/settings/logging.py +138 -0
- simplibs/object/testing/__init__.py +90 -0
- simplibs/object/testing/assert_simple_mixin.py +150 -0
- simplibs/object/testing/assert_simple_object.py +219 -0
- simplibs/object/testing/asserts/__init__.py +53 -0
- simplibs/object/testing/asserts/base/__init__.py +22 -0
- simplibs/object/testing/asserts/base/assert_class_inheritance.py +75 -0
- simplibs/object/testing/asserts/base/assert_instance_creation.py +119 -0
- simplibs/object/testing/asserts/base/assert_user_instance_creation.py +97 -0
- simplibs/object/testing/asserts/base/assert_value_change.py +142 -0
- simplibs/object/testing/asserts/methods/__init__.py +20 -0
- simplibs/object/testing/asserts/methods/assert_calculate_value_method.py +113 -0
- simplibs/object/testing/asserts/methods/assert_decompose_value_method.py +109 -0
- simplibs/object/testing/asserts/methods/assert_validate_method.py +111 -0
- simplibs/object/testing/asserts/mixins/__init__.py +22 -0
- simplibs/object/testing/asserts/mixins/assert_instance_hasattr.py +94 -0
- simplibs/object/testing/asserts/mixins/assert_mixin_inheritance.py +72 -0
- simplibs/object/testing/asserts/mixins/assert_mixin_instance_creation.py +142 -0
- simplibs/object/testing/asserts/mixins/assert_mixins_slots_values.py +126 -0
- simplibs/object/testing/asserts/mutability/__init__.py +18 -0
- simplibs/object/testing/asserts/mutability/assert_immutable_behavior.py +118 -0
- simplibs/object/testing/asserts/mutability/assert_mutable_behavior.py +108 -0
- simplibs/object/testing/asserts/reactivity/__init__.py +17 -0
- simplibs/object/testing/asserts/reactivity/assert_reactivity_downward.py +141 -0
- simplibs/object/testing/asserts/reactivity/assert_reactivity_upward.py +109 -0
- simplibs/object/testing/bulk_test.py +150 -0
- simplibs/object/testing/containers/InnerValue.py +102 -0
- simplibs/object/testing/containers/MixinCase.py +89 -0
- simplibs/object/testing/containers/ObjectCase.py +101 -0
- simplibs/object/testing/containers/TestMixin.py +122 -0
- simplibs/object/testing/containers/__init__.py +20 -0
- simplibs/object/testing/containers/_validations/__init__.py +18 -0
- simplibs/object/testing/containers/_validations/raise_inner_value_empty_path.py +39 -0
- simplibs/object/testing/containers/_validations/raise_inner_value_invalid_path_type.py +44 -0
- simplibs/object/tools/__init__.py +0 -0
- simplibs/object/tools/automate_creators/__init__.py +0 -0
- simplibs/object/tools/automate_creators/_helpers/__init__.py +5 -0
- simplibs/object/tools/automate_creators/_helpers/_is_lambda.py +34 -0
- simplibs/object/tools/automate_creators/_helpers/_validations/__init__.py +3 -0
- simplibs/object/tools/automate_creators/_helpers/_validations/raise_calculate_default_failed.py +51 -0
- simplibs/object/tools/automate_creators/_helpers/_validations/raise_inner_is_not_simple_constant_subclass.py +44 -0
- simplibs/object/tools/automate_creators/_helpers/_validations/raise_inners_is_not_tuple.py +41 -0
- simplibs/object/tools/automate_creators/_helpers/calculate_default.py +51 -0
- simplibs/object/tools/automate_creators/_helpers/load_parameters_from_inners.py +72 -0
- simplibs/object/tools/automate_creators/_helpers/process_decompose.py +47 -0
- simplibs/object/tools/automate_creators/_helpers/process_logic.py +57 -0
- simplibs/object/tools/automate_creators/_helpers/process_validate.py +48 -0
- simplibs/object/tools/automate_creators/_validations/__init__.py +7 -0
- simplibs/object/tools/automate_creators/_validations/validate_class_name_is_str.py +36 -0
- simplibs/object/tools/automate_creators/_validations/validate_composite_has_inners.py +43 -0
- simplibs/object/tools/automate_creators/_validations/validate_composite_has_logic.py +44 -0
- simplibs/object/tools/automate_creators/_validations/validate_composite_has_not_default.py +37 -0
- simplibs/object/tools/automate_creators/_validations/validate_constant_has_default.py +48 -0
- simplibs/object/tools/automate_creators/_validations/validate_constant_has_not_decompose.py +37 -0
- simplibs/object/tools/automate_creators/_validations/validate_constant_has_not_logic.py +37 -0
- simplibs/object/tools/automate_creators/bulk/BulkCase.py +100 -0
- simplibs/object/tools/automate_creators/bulk/__init__.py +0 -0
- simplibs/object/tools/automate_creators/bulk/create_simple_object_bulk.py +77 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/__init__.py +0 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/__init__.py +8 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_csv_callable_not_supported.py +26 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_data_not_list.py +28 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_decode_failed.py +29 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_input_not_sequence.py +27 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_input_not_str.py +28 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_item_is_not_bulk_dict.py +39 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_table_row_not_sequence.py +26 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/_validations/raise_bulk_yaml_import_failed.py +22 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/create_simple_object_bulk_from_bulk_case_class.py +57 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/create_simple_object_bulk_from_csv.py +68 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/create_simple_object_bulk_from_dicts.py +19 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/create_simple_object_bulk_from_json.py +24 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/create_simple_object_bulk_from_table.py +43 -0
- simplibs/object/tools/automate_creators/bulk/specific_bulks/create_simple_object_bulk_from_yaml.py +29 -0
- simplibs/object/tools/automate_creators/create_constant_class.py +84 -0
- simplibs/object/tools/automate_creators/create_object_class.py +110 -0
- simplibs/object/tools/automate_creators/create_simple_object.py +97 -0
- simplibs/object/tools/randomize/__init__.py +18 -0
- simplibs/object/tools/randomize/_validations/__init__.py +28 -0
- simplibs/object/tools/randomize/_validations/raise_random_data_filler_exhausted.py +55 -0
- simplibs/object/tools/randomize/_validations/validate_instance_is_simple_constant_base.py +52 -0
- simplibs/object/tools/randomize/_validations/validate_registry_is_randomize_registry_base.py +51 -0
- simplibs/object/tools/randomize/_validations/validate_retries_is_greater_than_zero.py +48 -0
- simplibs/object/tools/randomize/_validations/validate_retries_is_int.py +49 -0
- simplibs/object/tools/randomize/_validations/validate_skip_immutable_is_bool.py +43 -0
- simplibs/object/tools/randomize/_validations/validate_skip_unregistered_is_bool.py +44 -0
- simplibs/object/tools/randomize/random_data_filler.py +133 -0
- simplibs/object/tools/randomize/randomize_value.py +122 -0
- simplibs_object-0.1.0.dist-info/METADATA +590 -0
- simplibs_object-0.1.0.dist-info/RECORD +580 -0
- simplibs_object-0.1.0.dist-info/WHEEL +5 -0
- simplibs_object-0.1.0.dist-info/licenses/LICENSE +21 -0
- simplibs_object-0.1.0.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
from typing import Any, TYPE_CHECKING
|
|
2
|
+
# Inners
|
|
3
|
+
from .validations import raise_stepper_invalid_action
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ......_core.protocols.mixins.numerical.stepper import StepperProtocol
|
|
7
|
+
from ......_core.protocols.mixins.numerical.stepper.internal_types import LimitAction
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
def process_limit_action(
|
|
11
|
+
self: "StepperProtocol",
|
|
12
|
+
value: Any
|
|
13
|
+
) -> "LimitAction":
|
|
14
|
+
"""
|
|
15
|
+
Validates and returns the limit action for the stepper.
|
|
16
|
+
|
|
17
|
+
Ensures that the provided value is a callable object that can be executed
|
|
18
|
+
when the upper or lower limit is reached.
|
|
19
|
+
"""
|
|
20
|
+
|
|
21
|
+
# 1. Validate callable
|
|
22
|
+
if not callable(value):
|
|
23
|
+
raise_stepper_invalid_action(self, value)
|
|
24
|
+
|
|
25
|
+
# 2. Return the validated action
|
|
26
|
+
return value
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
_DESIGN_NOTES = """
|
|
30
|
+
# process_limit_action
|
|
31
|
+
|
|
32
|
+
## Purpose
|
|
33
|
+
Validates and prepares the limit action used by the stepper.
|
|
34
|
+
This function ensures that any action assigned to:
|
|
35
|
+
|
|
36
|
+
- `up_limit_action`
|
|
37
|
+
- `down_limit_action`
|
|
38
|
+
|
|
39
|
+
is a valid callable object that can be executed when a limit is reached.
|
|
40
|
+
|
|
41
|
+
It provides the canonical logic for configuring limit callbacks.
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## Architectural role
|
|
46
|
+
`process_limit_action` is used by the setters:
|
|
47
|
+
|
|
48
|
+
```
|
|
49
|
+
Stepper.up_limit_action = ...
|
|
50
|
+
Stepper.down_limit_action = ...
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
It acts as the validation layer for callback configuration.
|
|
54
|
+
|
|
55
|
+
The function integrates with:
|
|
56
|
+
|
|
57
|
+
- `raise_stepper_invalid_action` for structured error reporting,
|
|
58
|
+
- Stepper’s limit‑checking functions (`verify_up_limit`, `verify_down_limit`),
|
|
59
|
+
- UNSET semantics for optional callback configuration.
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
## How it works
|
|
64
|
+
|
|
65
|
+
### 1. Callable validation
|
|
66
|
+
The function checks:
|
|
67
|
+
|
|
68
|
+
```
|
|
69
|
+
callable(value)
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
If false, the configuration is invalid because limit actions must be executable
|
|
73
|
+
callbacks.
|
|
74
|
+
Violations are reported using a structured diagnostic error.
|
|
75
|
+
|
|
76
|
+
### 2. Returning the validated action
|
|
77
|
+
If validation succeeds, the callable object is returned unchanged and stored
|
|
78
|
+
as the new limit action.
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## Why this function exists
|
|
83
|
+
Stepper supports optional callbacks that are executed when numeric boundaries
|
|
84
|
+
are crossed.
|
|
85
|
+
These callbacks must be:
|
|
86
|
+
|
|
87
|
+
- callable,
|
|
88
|
+
- side‑effect‑safe,
|
|
89
|
+
- predictable,
|
|
90
|
+
- consistent with the instance’s behavior.
|
|
91
|
+
|
|
92
|
+
This function encapsulates:
|
|
93
|
+
|
|
94
|
+
- validation,
|
|
95
|
+
- structured error raising,
|
|
96
|
+
- deterministic return behavior.
|
|
97
|
+
|
|
98
|
+
It ensures that invalid callbacks never reach deeper layers of the stepper
|
|
99
|
+
pipeline.
|
|
100
|
+
|
|
101
|
+
---
|
|
102
|
+
|
|
103
|
+
## Deterministic behavior
|
|
104
|
+
The function guarantees:
|
|
105
|
+
|
|
106
|
+
- stable validation,
|
|
107
|
+
- predictable error raising,
|
|
108
|
+
- deterministic return values.
|
|
109
|
+
|
|
110
|
+
This determinism is essential for safe numeric stepping.
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
## Notes
|
|
115
|
+
- This function is internal and not part of the public API.
|
|
116
|
+
- All structural logic is delegated to validation utilities.
|
|
117
|
+
- The function is intentionally minimal and side‑effect‑free.
|
|
118
|
+
"""
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
from typing import Any, TYPE_CHECKING
|
|
2
|
+
from simplibs.sentinels import UNSET
|
|
3
|
+
# Inners
|
|
4
|
+
from .process_value import process_value
|
|
5
|
+
from .validations import raise_stepper_invalid_up_limit
|
|
6
|
+
# Annotations
|
|
7
|
+
if TYPE_CHECKING:
|
|
8
|
+
from ......_core.protocols.mixins.numerical.stepper import StepperProtocol
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
def process_up_limit_value(
|
|
12
|
+
self: "StepperProtocol",
|
|
13
|
+
value: Any
|
|
14
|
+
) -> Any:
|
|
15
|
+
"""
|
|
16
|
+
Prepares and validates the upper‑limit value for the stepper.
|
|
17
|
+
|
|
18
|
+
Normalizes the provided value to the correct type and verifies
|
|
19
|
+
that the upper limit is not lower than the currently configured down limit.
|
|
20
|
+
"""
|
|
21
|
+
|
|
22
|
+
# 1. Normalize the value
|
|
23
|
+
_value = process_value(self, value)
|
|
24
|
+
|
|
25
|
+
# 2. Validate boundary consistency
|
|
26
|
+
if self.down_limit is not UNSET and self.down_limit > _value:
|
|
27
|
+
raise_stepper_invalid_up_limit(self, value)
|
|
28
|
+
|
|
29
|
+
return _value
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
_DESIGN_NOTES = """
|
|
33
|
+
# process_up_limit_value
|
|
34
|
+
|
|
35
|
+
## Purpose
|
|
36
|
+
Normalizes and validates the upper‑limit value for the stepper.
|
|
37
|
+
This function ensures that:
|
|
38
|
+
|
|
39
|
+
- the provided limit value is converted to the correct numeric type,
|
|
40
|
+
- the upper limit is not lower than the currently configured down limit (if one is set),
|
|
41
|
+
- invalid configurations are rejected early using structured errors.
|
|
42
|
+
|
|
43
|
+
It provides the canonical logic for configuring the upper numeric boundary.
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## Architectural role
|
|
48
|
+
`process_up_limit_value` is used by the setter:
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Stepper.up_limit = ...
|
|
54
|
+
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
It acts as the validation and normalization layer for upper‑limit configuration.
|
|
58
|
+
|
|
59
|
+
The function integrates with:
|
|
60
|
+
|
|
61
|
+
- `process_value` for type normalization,
|
|
62
|
+
- `raise_stepper_invalid_up_limit` for structured error reporting,
|
|
63
|
+
- UNSET semantics for optional limit configuration.
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
## How it works
|
|
68
|
+
|
|
69
|
+
### 1. Value normalization
|
|
70
|
+
The function first calls:
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
_value = process_value(self, value)
|
|
76
|
+
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
This ensures:
|
|
80
|
+
|
|
81
|
+
- type consistency with the instance’s numeric type,
|
|
82
|
+
- optional validation,
|
|
83
|
+
- safe conversion of user‑provided values.
|
|
84
|
+
|
|
85
|
+
### 2. Boundary consistency check
|
|
86
|
+
The function verifies:
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
self.down_limit is not UNSET and self.down_limit > _value
|
|
92
|
+
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
If `down_limit` is configured and is strictly greater than the requested up limit,
|
|
96
|
+
the configuration is invalid because:
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
up_limit must be >= down_limit
|
|
102
|
+
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
If `down_limit` is UNSET, the boundary check is skipped safely.
|
|
106
|
+
Violations are reported using a structured diagnostic error.
|
|
107
|
+
|
|
108
|
+
### 3. Returning the normalized value
|
|
109
|
+
If validation succeeds, the normalized value is returned and stored as the new
|
|
110
|
+
upper limit.
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
## Why this function exists
|
|
115
|
+
Stepper requires consistent numeric boundaries to operate safely.
|
|
116
|
+
This function encapsulates:
|
|
117
|
+
|
|
118
|
+
- normalization,
|
|
119
|
+
- boundary validation respecting UNSET states,
|
|
120
|
+
- structured error raising.
|
|
121
|
+
|
|
122
|
+
It ensures that invalid configurations never reach deeper layers of the stepper
|
|
123
|
+
pipeline.
|
|
124
|
+
|
|
125
|
+
---
|
|
126
|
+
|
|
127
|
+
## Deterministic behavior
|
|
128
|
+
The function guarantees:
|
|
129
|
+
|
|
130
|
+
- stable normalization,
|
|
131
|
+
- predictable validation,
|
|
132
|
+
- consistent error raising,
|
|
133
|
+
- deterministic return values.
|
|
134
|
+
|
|
135
|
+
This determinism is essential for safe numeric stepping.
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
## Notes
|
|
140
|
+
- This function is internal and not part of the public API.
|
|
141
|
+
- All structural logic is delegated to normalization and validation utilities.
|
|
142
|
+
- The function is intentionally minimal and side‑effect‑free.
|
|
143
|
+
"""
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
from typing import Any, TYPE_CHECKING
|
|
2
|
+
# Annotations
|
|
3
|
+
if TYPE_CHECKING:
|
|
4
|
+
from ......_core.protocols.mixins.numerical.stepper import StepperProtocol
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
def process_value(
|
|
8
|
+
self: "StepperProtocol",
|
|
9
|
+
value: Any,
|
|
10
|
+
*,
|
|
11
|
+
validate: bool = True
|
|
12
|
+
) -> Any:
|
|
13
|
+
"""
|
|
14
|
+
Normalizes and optionally validates a value for use in the stepper.
|
|
15
|
+
|
|
16
|
+
Converts the provided value to the correct instance type and optionally
|
|
17
|
+
validates it using the instance’s validation logic.
|
|
18
|
+
"""
|
|
19
|
+
|
|
20
|
+
# 1. Normalize the value
|
|
21
|
+
_value = (
|
|
22
|
+
value if isinstance(value, self._value_type)
|
|
23
|
+
else self._value_type(value)
|
|
24
|
+
)
|
|
25
|
+
|
|
26
|
+
# 2. Validate the value
|
|
27
|
+
if validate:
|
|
28
|
+
self._instance.validate(_value)
|
|
29
|
+
|
|
30
|
+
# 3. Return the normalized value
|
|
31
|
+
return _value
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
_DESIGN_NOTES = """
|
|
35
|
+
# process_value
|
|
36
|
+
|
|
37
|
+
## Purpose
|
|
38
|
+
Normalizes and optionally validates a value before it is used by the stepper.
|
|
39
|
+
This function ensures that:
|
|
40
|
+
|
|
41
|
+
- the value is converted to the correct numeric type,
|
|
42
|
+
- the value is compatible with the instance’s validation rules,
|
|
43
|
+
- stepper operations always work with type‑consistent, validated values.
|
|
44
|
+
|
|
45
|
+
It provides the canonical logic for preparing values used in stepping,
|
|
46
|
+
limit configuration, and direct value assignment.
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## Architectural role
|
|
51
|
+
`process_value` is used by:
|
|
52
|
+
|
|
53
|
+
- `process_step_value`
|
|
54
|
+
- `process_down_limit_value`
|
|
55
|
+
- `process_up_limit_value`
|
|
56
|
+
- `set_value`
|
|
57
|
+
- `step_up`
|
|
58
|
+
- `step_down`
|
|
59
|
+
|
|
60
|
+
It acts as the normalization and validation layer for all numeric inputs
|
|
61
|
+
entering the stepper pipeline.
|
|
62
|
+
|
|
63
|
+
The function integrates with:
|
|
64
|
+
|
|
65
|
+
- the instance’s `_value_type` for type conversion,
|
|
66
|
+
- the instance’s `validate` method for semantic validation,
|
|
67
|
+
- optional validation toggling via the `validate` parameter.
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
## How it works
|
|
72
|
+
|
|
73
|
+
### 1. Type normalization
|
|
74
|
+
The function converts the provided value into the instance’s numeric type:
|
|
75
|
+
|
|
76
|
+
```
|
|
77
|
+
self._value_type(value)
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
This ensures:
|
|
81
|
+
|
|
82
|
+
- type consistency across all stepper operations,
|
|
83
|
+
- predictable arithmetic behavior,
|
|
84
|
+
- compatibility with limit comparisons.
|
|
85
|
+
|
|
86
|
+
If the value is already of the correct type, it is used unchanged.
|
|
87
|
+
|
|
88
|
+
### 2. Optional validation
|
|
89
|
+
If `validate=True`, the function calls:
|
|
90
|
+
|
|
91
|
+
```
|
|
92
|
+
self._instance.validate(_value)
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
This allows the instance to enforce:
|
|
96
|
+
|
|
97
|
+
- custom numeric constraints,
|
|
98
|
+
- domain‑specific rules,
|
|
99
|
+
- semantic correctness.
|
|
100
|
+
|
|
101
|
+
Validation is optional because some internal operations (e.g., limit checks)
|
|
102
|
+
may require normalization without semantic validation.
|
|
103
|
+
|
|
104
|
+
### 3. Returning the normalized value
|
|
105
|
+
The normalized (and optionally validated) value is returned for further use.
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
## Why this function exists
|
|
110
|
+
Stepper operations must work with values that are:
|
|
111
|
+
|
|
112
|
+
- type‑consistent,
|
|
113
|
+
- semantically valid,
|
|
114
|
+
- safe for arithmetic operations.
|
|
115
|
+
|
|
116
|
+
This function encapsulates:
|
|
117
|
+
|
|
118
|
+
- normalization,
|
|
119
|
+
- optional validation,
|
|
120
|
+
- deterministic return behavior.
|
|
121
|
+
|
|
122
|
+
It ensures that invalid or inconsistent values never reach deeper layers of
|
|
123
|
+
the stepper pipeline.
|
|
124
|
+
|
|
125
|
+
---
|
|
126
|
+
|
|
127
|
+
## Deterministic behavior
|
|
128
|
+
The function guarantees:
|
|
129
|
+
|
|
130
|
+
- stable normalization,
|
|
131
|
+
- predictable validation,
|
|
132
|
+
- deterministic return values.
|
|
133
|
+
|
|
134
|
+
This determinism is essential for safe numeric stepping.
|
|
135
|
+
|
|
136
|
+
---
|
|
137
|
+
|
|
138
|
+
## Notes
|
|
139
|
+
- This function is internal and not part of the public API.
|
|
140
|
+
- All structural logic is delegated to instance‑level validation and type conversion.
|
|
141
|
+
- The function is intentionally minimal and side‑effect‑free.
|
|
142
|
+
"""
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
from numbers import Number
|
|
3
|
+
# Outers
|
|
4
|
+
from ......_core.metadata.instance_builders.atom_class import InstanceBase
|
|
5
|
+
# Inners
|
|
6
|
+
from .validations import (
|
|
7
|
+
raise_stepper_invalid_instance,
|
|
8
|
+
raise_stepper_non_numeric_value
|
|
9
|
+
)
|
|
10
|
+
# Annotations
|
|
11
|
+
if TYPE_CHECKING:
|
|
12
|
+
from ......_core.protocols.instance import SimpleInstanceLike
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
def validate_instance(
|
|
16
|
+
instance: "SimpleInstanceLike"
|
|
17
|
+
) -> None:
|
|
18
|
+
"""
|
|
19
|
+
Validates that the provided instance is suitable for use with the stepper.
|
|
20
|
+
|
|
21
|
+
Ensures that the instance implements the SimpleInstanceType protocol
|
|
22
|
+
and that its value supports numeric operations.
|
|
23
|
+
"""
|
|
24
|
+
|
|
25
|
+
# 1. Validate instance protocol
|
|
26
|
+
if not isinstance(instance, InstanceBase):
|
|
27
|
+
raise_stepper_invalid_instance(instance, InstanceBase)
|
|
28
|
+
|
|
29
|
+
# 2. Validate that the instance value is numeric
|
|
30
|
+
instance: "SimpleInstanceLike"
|
|
31
|
+
if not isinstance(instance.value, Number):
|
|
32
|
+
raise_stepper_non_numeric_value(instance, instance.value)
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
_DESIGN_NOTES = """
|
|
36
|
+
# validate_instance
|
|
37
|
+
|
|
38
|
+
## Purpose
|
|
39
|
+
Ensures that the object passed to the Stepper is a valid Simple instance
|
|
40
|
+
with a numeric value.
|
|
41
|
+
This function is the first and most fundamental validation step in the Stepper
|
|
42
|
+
initialization pipeline.
|
|
43
|
+
|
|
44
|
+
It guarantees that Stepper is only attached to objects that:
|
|
45
|
+
|
|
46
|
+
- implement the required SimpleInstanceType protocol,
|
|
47
|
+
- expose a numeric `value` attribute,
|
|
48
|
+
- support safe numeric stepping operations.
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
## Architectural role
|
|
53
|
+
`validate_instance` is called directly from the Stepper constructor:
|
|
54
|
+
|
|
55
|
+
```
|
|
56
|
+
Stepper(instance)
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
It acts as the gateway validation layer for all Stepper operations.
|
|
60
|
+
|
|
61
|
+
The function integrates with:
|
|
62
|
+
|
|
63
|
+
- `raise_stepper_invalid_instance` for protocol validation,
|
|
64
|
+
- `raise_stepper_non_numeric_value` for numeric validation.
|
|
65
|
+
|
|
66
|
+
Without this function, Stepper could be attached to invalid objects, leading to
|
|
67
|
+
runtime errors and inconsistent behavior.
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
## How it works
|
|
72
|
+
|
|
73
|
+
### 1. Protocol validation
|
|
74
|
+
The function checks:
|
|
75
|
+
|
|
76
|
+
```
|
|
77
|
+
isinstance(instance, SimpleInstanceType)
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
This ensures that the instance:
|
|
81
|
+
|
|
82
|
+
- exposes a `value` attribute,
|
|
83
|
+
- supports mixin initialization,
|
|
84
|
+
- participates in Simple’s object model.
|
|
85
|
+
|
|
86
|
+
If the check fails, a structured diagnostic error is raised.
|
|
87
|
+
|
|
88
|
+
### 2. Numeric value validation
|
|
89
|
+
The function checks:
|
|
90
|
+
|
|
91
|
+
```
|
|
92
|
+
isinstance(instance.value, Number)
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
This ensures that the instance’s value supports:
|
|
96
|
+
|
|
97
|
+
- arithmetic operations,
|
|
98
|
+
- limit comparisons,
|
|
99
|
+
- type‑consistent stepping.
|
|
100
|
+
|
|
101
|
+
If the check fails, a structured diagnostic error is raised.
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
## Why this function exists
|
|
106
|
+
Stepper relies on strict assumptions:
|
|
107
|
+
|
|
108
|
+
- the instance must be a Simple object,
|
|
109
|
+
- the value must be numeric,
|
|
110
|
+
- the instance must support mixin behavior.
|
|
111
|
+
|
|
112
|
+
This function enforces these assumptions early and clearly.
|
|
113
|
+
|
|
114
|
+
It prevents:
|
|
115
|
+
|
|
116
|
+
- invalid state transitions,
|
|
117
|
+
- broken limit checks,
|
|
118
|
+
- incorrect arithmetic operations,
|
|
119
|
+
- unpredictable callback behavior.
|
|
120
|
+
|
|
121
|
+
---
|
|
122
|
+
|
|
123
|
+
## Deterministic behavior
|
|
124
|
+
The function guarantees:
|
|
125
|
+
|
|
126
|
+
- stable protocol validation,
|
|
127
|
+
- predictable numeric validation,
|
|
128
|
+
- consistent error raising.
|
|
129
|
+
|
|
130
|
+
This determinism is essential for safe numeric stepping.
|
|
131
|
+
|
|
132
|
+
---
|
|
133
|
+
|
|
134
|
+
## Notes
|
|
135
|
+
- This function is internal and not part of the public API.
|
|
136
|
+
- All structural logic is delegated to validation utilities.
|
|
137
|
+
- The function is intentionally minimal and side‑effect‑free.
|
|
138
|
+
"""
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
from .raise_stepper_invalid_action import raise_stepper_invalid_action
|
|
2
|
+
from .raise_stepper_invalid_down_limit import raise_stepper_invalid_down_limit
|
|
3
|
+
from .raise_stepper_invalid_instance import raise_stepper_invalid_instance
|
|
4
|
+
from .raise_stepper_invalid_up_limit import raise_stepper_invalid_up_limit
|
|
5
|
+
from .raise_stepper_non_numeric_value import raise_stepper_non_numeric_value
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
_DESIGN_NOTES = """
|
|
9
|
+
# Stepper Configuration Validations
|
|
10
|
+
|
|
11
|
+
## Purpose
|
|
12
|
+
Provides the validation functions responsible for verifying the correctness
|
|
13
|
+
of all configuration values used by the Stepper subsystem. These validators
|
|
14
|
+
ensure that:
|
|
15
|
+
|
|
16
|
+
- limit values are consistent,
|
|
17
|
+
- limit actions are callable,
|
|
18
|
+
- instances satisfy the required protocol,
|
|
19
|
+
- numeric values are valid and safe for stepping.
|
|
20
|
+
|
|
21
|
+
They form the configuration safety layer of the Stepper and prevent invalid
|
|
22
|
+
states from entering the runtime pipeline.
|
|
23
|
+
|
|
24
|
+
## Components
|
|
25
|
+
|
|
26
|
+
| Component | Type | Description |
|
|
27
|
+
| :-------------------------------- | :--------| :----------------------------------------------------------------- |
|
|
28
|
+
| `raise_stepper_invalid_action` | Function | Raised when a limit action is not callable. |
|
|
29
|
+
| `raise_stepper_invalid_down_limit`| Function | Raised when the down limit is higher than the up limit. |
|
|
30
|
+
| `raise_stepper_invalid_instance` | Function | Raised when the provided instance does not satisfy the protocol. |
|
|
31
|
+
| `raise_stepper_invalid_up_limit` | Function | Raised when the up limit is lower than the down limit. |
|
|
32
|
+
| `raise_stepper_non_numeric_value` | Function | Raised when the instance value is not numeric. |
|
|
33
|
+
|
|
34
|
+
## Notes
|
|
35
|
+
- These utilities are internal and not part of the public API.
|
|
36
|
+
- They are used exclusively by configuration processors (`process_value`, `process_limit_action`, etc.).
|
|
37
|
+
- All errors follow the SimpleRuntimeError diagnostic format.
|
|
38
|
+
- Validators here protect the Stepper from invalid configuration before runtime.
|
|
39
|
+
"""
|
|
@@ -0,0 +1,118 @@
|
|
|
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_invalid_action(
|
|
10
|
+
stepper: "StepperProtocol",
|
|
11
|
+
action_value: Any,
|
|
12
|
+
) -> NoReturn:
|
|
13
|
+
"""
|
|
14
|
+
Raises a structured error when the provided limit action is not callable.
|
|
15
|
+
"""
|
|
16
|
+
|
|
17
|
+
raise SimpleRuntimeError(
|
|
18
|
+
error_name="STEPPER LIMIT ACTION ERROR",
|
|
19
|
+
label="limit action",
|
|
20
|
+
value=action_value,
|
|
21
|
+
expected="A callable object (function, method, or callable instance).",
|
|
22
|
+
problem=(
|
|
23
|
+
"The provided limit action is not callable. "
|
|
24
|
+
"Stepper limit actions must be executable callbacks."
|
|
25
|
+
),
|
|
26
|
+
context=(
|
|
27
|
+
f"Instance type: {type(stepper._instance).__name__}.",
|
|
28
|
+
f"Current value: {stepper._instance.value!r}.",
|
|
29
|
+
"Limit actions are executed when the stepper reaches configured boundaries.",
|
|
30
|
+
"Non-callable objects cannot be invoked as callbacks."
|
|
31
|
+
),
|
|
32
|
+
how_to_fix=(
|
|
33
|
+
"Provide a callable object, such as a function or method.",
|
|
34
|
+
"Ensure that the action does not require arguments when invoked.",
|
|
35
|
+
"If you need a more complex action, wrap it into a callable object.",
|
|
36
|
+
),
|
|
37
|
+
exception=TypeError,
|
|
38
|
+
)
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
_DESIGN_NOTES = """
|
|
42
|
+
# raise_stepper_invalid_action
|
|
43
|
+
|
|
44
|
+
## Purpose
|
|
45
|
+
Provides a structured diagnostic error when a user attempts to configure
|
|
46
|
+
a limit action that is not callable.
|
|
47
|
+
This replaces the generic `ValueError("Akce musí být volatelný objekt")`
|
|
48
|
+
with a rich, contextual, and actionable error message consistent with the
|
|
49
|
+
Simple ecosystem.
|
|
50
|
+
|
|
51
|
+
Limit actions are executed when the stepper reaches its numeric boundaries,
|
|
52
|
+
so they must always be valid callable objects.
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## Architectural reasoning
|
|
57
|
+
Stepper supports optional callbacks:
|
|
58
|
+
|
|
59
|
+
- `up_limit_action`
|
|
60
|
+
- `down_limit_action`
|
|
61
|
+
|
|
62
|
+
These callbacks are executed when the stepper reaches the configured limits.
|
|
63
|
+
Because they are invoked automatically, they **must be callable**.
|
|
64
|
+
|
|
65
|
+
If a non-callable object is provided:
|
|
66
|
+
|
|
67
|
+
- the callback cannot be executed,
|
|
68
|
+
- the stepper may enter an inconsistent state,
|
|
69
|
+
- limit handling becomes unpredictable,
|
|
70
|
+
- debugging becomes significantly harder.
|
|
71
|
+
|
|
72
|
+
Therefore, the error must:
|
|
73
|
+
|
|
74
|
+
- clearly explain the violation,
|
|
75
|
+
- show the offending value,
|
|
76
|
+
- describe what is expected,
|
|
77
|
+
- provide actionable steps,
|
|
78
|
+
- include contextual information about the instance.
|
|
79
|
+
|
|
80
|
+
This mirrors the design of immutability, history, metadata, and composite errors.
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
## Pipeline position
|
|
85
|
+
This function is used inside `process_limit_action`:
|
|
86
|
+
|
|
87
|
+
1. Check if `callable(value)` is false.
|
|
88
|
+
2. If yes → call this function.
|
|
89
|
+
3. Otherwise return the value unchanged.
|
|
90
|
+
|
|
91
|
+
This ensures:
|
|
92
|
+
|
|
93
|
+
- consistent validation,
|
|
94
|
+
- predictable error handling,
|
|
95
|
+
- clear separation of validation and error raising.
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
99
|
+
## Diagnostic value
|
|
100
|
+
The error message includes:
|
|
101
|
+
|
|
102
|
+
- the invalid action value,
|
|
103
|
+
- the expected type (callable),
|
|
104
|
+
- the current instance value,
|
|
105
|
+
- the instance type,
|
|
106
|
+
- actionable steps to resolve the issue.
|
|
107
|
+
|
|
108
|
+
This makes debugging significantly easier and aligns with the philosophy of
|
|
109
|
+
Simple’s structured error system.
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
## Notes
|
|
114
|
+
- This is a pure `raise_...` function: it performs no branching logic.
|
|
115
|
+
- It is internal and not part of the public API.
|
|
116
|
+
- All invalid limit actions must use this function.
|
|
117
|
+
- The error type is `SimpleRuntimeError` with `TypeError` as the underlying exception.
|
|
118
|
+
"""
|