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,125 @@
|
|
|
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_down_limit(
|
|
10
|
+
stepper: "StepperProtocol",
|
|
11
|
+
down_limit_value: Any,
|
|
12
|
+
) -> NoReturn:
|
|
13
|
+
"""
|
|
14
|
+
Raises a structured error when the provided down limit is higher
|
|
15
|
+
than the currently configured up limit.
|
|
16
|
+
"""
|
|
17
|
+
|
|
18
|
+
raise SimpleRuntimeError(
|
|
19
|
+
error_name="STEPPER LIMIT CONFIGURATION ERROR",
|
|
20
|
+
label="down limit",
|
|
21
|
+
value=down_limit_value,
|
|
22
|
+
expected=f"Value <= {stepper.up_limit!r}",
|
|
23
|
+
problem=(
|
|
24
|
+
"The provided down limit is higher than the configured up limit. "
|
|
25
|
+
"This creates an invalid numeric boundary configuration."
|
|
26
|
+
),
|
|
27
|
+
context=(
|
|
28
|
+
f"Instance type: {type(stepper._instance).__name__}.",
|
|
29
|
+
f"Current value: {stepper._instance.value!r}.",
|
|
30
|
+
f"Up limit: {stepper.up_limit!r}.",
|
|
31
|
+
f"Attempted down limit: {down_limit_value!r}.",
|
|
32
|
+
"The stepper requires consistent numeric boundaries where "
|
|
33
|
+
"down_limit <= up_limit."
|
|
34
|
+
),
|
|
35
|
+
how_to_fix=(
|
|
36
|
+
"Set the down limit to a value lower than or equal to the up limit.",
|
|
37
|
+
"If you need to expand the allowed range, increase the up limit first.",
|
|
38
|
+
"Ensure that both limits reflect a valid numeric interval.",
|
|
39
|
+
),
|
|
40
|
+
exception=ValueError,
|
|
41
|
+
)
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
_DESIGN_NOTES = """
|
|
45
|
+
# raise_stepper_invalid_down_limit
|
|
46
|
+
|
|
47
|
+
## Purpose
|
|
48
|
+
Provides a structured diagnostic error when a user attempts to configure
|
|
49
|
+
a down limit that is higher than the currently configured up limit.
|
|
50
|
+
This replaces the generic `ValueError("Down limit nemůže být vyšší než up limit")`
|
|
51
|
+
with a rich, contextual, and actionable error message consistent with the
|
|
52
|
+
Simple ecosystem.
|
|
53
|
+
|
|
54
|
+
This protects the stepper from invalid numeric boundary configurations.
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## Architectural reasoning
|
|
59
|
+
Stepper enforces numeric boundaries:
|
|
60
|
+
|
|
61
|
+
- `down_limit` defines the minimum allowed value,
|
|
62
|
+
- `up_limit` defines the maximum allowed value.
|
|
63
|
+
|
|
64
|
+
These boundaries must satisfy:
|
|
65
|
+
|
|
66
|
+
```
|
|
67
|
+
down_limit <= up_limit
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
If this condition is violated:
|
|
71
|
+
|
|
72
|
+
- step operations become undefined,
|
|
73
|
+
- limit checks break,
|
|
74
|
+
- callbacks may fire incorrectly,
|
|
75
|
+
- the instance can enter an invalid state.
|
|
76
|
+
|
|
77
|
+
Therefore, the error must:
|
|
78
|
+
|
|
79
|
+
- clearly explain the violation,
|
|
80
|
+
- show both limits,
|
|
81
|
+
- show the attempted value,
|
|
82
|
+
- provide actionable steps,
|
|
83
|
+
- include contextual information about the instance.
|
|
84
|
+
|
|
85
|
+
This mirrors the design of immutability, history, metadata, and composite errors.
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## Pipeline position
|
|
90
|
+
This function is used inside `process_down_limit_value`:
|
|
91
|
+
|
|
92
|
+
1. Normalize the provided value.
|
|
93
|
+
2. Check if `down_limit > up_limit`.
|
|
94
|
+
3. If yes → call this function.
|
|
95
|
+
4. Otherwise return the normalized value.
|
|
96
|
+
|
|
97
|
+
This ensures:
|
|
98
|
+
|
|
99
|
+
- consistent validation,
|
|
100
|
+
- predictable error handling,
|
|
101
|
+
- clear separation of validation and error raising.
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
## Diagnostic value
|
|
106
|
+
The error message includes:
|
|
107
|
+
|
|
108
|
+
- the invalid down limit value,
|
|
109
|
+
- the expected maximum (up limit),
|
|
110
|
+
- the current instance value,
|
|
111
|
+
- the configured up limit,
|
|
112
|
+
- the instance type,
|
|
113
|
+
- actionable steps to resolve the issue.
|
|
114
|
+
|
|
115
|
+
This makes debugging significantly easier and aligns with the philosophy of
|
|
116
|
+
Simple’s structured error system.
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
## Notes
|
|
121
|
+
- This is a pure `raise_...` function: it performs no branching logic.
|
|
122
|
+
- It is internal and not part of the public API.
|
|
123
|
+
- All limit configuration errors must use this function.
|
|
124
|
+
- The error type is `SimpleRuntimeError` with `ValueError` as the underlying exception.
|
|
125
|
+
"""
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
from typing import NoReturn, Any
|
|
2
|
+
# Outers
|
|
3
|
+
from .......exceptions import SimpleRuntimeError
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
def raise_stepper_invalid_instance(
|
|
7
|
+
instance: Any,
|
|
8
|
+
expected_type: type,
|
|
9
|
+
) -> NoReturn:
|
|
10
|
+
"""
|
|
11
|
+
Raises a structured error when the provided object does not satisfy
|
|
12
|
+
the SimpleInstanceType protocol required by the Stepper.
|
|
13
|
+
"""
|
|
14
|
+
|
|
15
|
+
raise SimpleRuntimeError(
|
|
16
|
+
error_name="STEPPER INSTANCE ERROR",
|
|
17
|
+
label="instance",
|
|
18
|
+
value=instance,
|
|
19
|
+
expected=f"Instance implementing {expected_type.__name__}",
|
|
20
|
+
problem=(
|
|
21
|
+
"The provided object does not satisfy the required Simple instance "
|
|
22
|
+
"protocol. The Stepper can only operate on valid Simple instances "
|
|
23
|
+
"that expose a numeric `value` attribute and support mixin operations."
|
|
24
|
+
),
|
|
25
|
+
context=(
|
|
26
|
+
f"Received type: {type(instance).__name__}.",
|
|
27
|
+
"Stepper requires a Simple instance with a numeric value.",
|
|
28
|
+
"Invalid instances cannot participate in numeric stepping operations."
|
|
29
|
+
),
|
|
30
|
+
how_to_fix=(
|
|
31
|
+
"Ensure that the object passed to Stepper is a valid Simple instance.",
|
|
32
|
+
"Verify that the instance implements the required protocol.",
|
|
33
|
+
"Check that the instance exposes a numeric `value` attribute.",
|
|
34
|
+
),
|
|
35
|
+
exception=TypeError,
|
|
36
|
+
)
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
_DESIGN_NOTES = """
|
|
40
|
+
# raise_stepper_invalid_instance
|
|
41
|
+
|
|
42
|
+
## Purpose
|
|
43
|
+
Provides a structured diagnostic error when a user attempts to initialize
|
|
44
|
+
a Stepper with an object that does not satisfy the required Simple instance
|
|
45
|
+
protocol.
|
|
46
|
+
This replaces the generic `TypeError("Předaný objekt není validní instancí Simple systému")`
|
|
47
|
+
with a rich, contextual, and actionable error message consistent with the
|
|
48
|
+
Simple ecosystem.
|
|
49
|
+
|
|
50
|
+
This protects the Stepper from being attached to invalid or incompatible objects.
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## Architectural reasoning
|
|
55
|
+
Stepper is tightly integrated with Simple instances:
|
|
56
|
+
|
|
57
|
+
- it reads and writes the instance’s `value`,
|
|
58
|
+
- it enforces numeric boundaries,
|
|
59
|
+
- it triggers limit actions,
|
|
60
|
+
- it participates in mixin initialization.
|
|
61
|
+
|
|
62
|
+
Therefore, the Stepper **must** be attached only to objects that satisfy the
|
|
63
|
+
`SimpleInstanceType` protocol.
|
|
64
|
+
|
|
65
|
+
If an invalid object is passed:
|
|
66
|
+
|
|
67
|
+
- numeric operations cannot be performed,
|
|
68
|
+
- limit checks break,
|
|
69
|
+
- callbacks may fail,
|
|
70
|
+
- the instance may enter an inconsistent state.
|
|
71
|
+
|
|
72
|
+
Therefore, the error must:
|
|
73
|
+
|
|
74
|
+
- clearly explain the violation,
|
|
75
|
+
- show the offending object,
|
|
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 `validate_instance`:
|
|
86
|
+
|
|
87
|
+
1. Check if `isinstance(instance, SimpleInstanceType)` is false.
|
|
88
|
+
2. If yes → call this function.
|
|
89
|
+
3. Otherwise continue with numeric validation.
|
|
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 instance object,
|
|
103
|
+
- the expected protocol type,
|
|
104
|
+
- the received type,
|
|
105
|
+
- actionable steps to resolve the issue.
|
|
106
|
+
|
|
107
|
+
This makes debugging significantly easier and aligns with the philosophy of
|
|
108
|
+
Simple’s structured error system.
|
|
109
|
+
|
|
110
|
+
---
|
|
111
|
+
|
|
112
|
+
## Notes
|
|
113
|
+
- This is a pure `raise_...` function: it performs no branching logic.
|
|
114
|
+
- It is internal and not part of the public API.
|
|
115
|
+
- All invalid Stepper instance attachments must use this function.
|
|
116
|
+
- The error type is `SimpleRuntimeError` with `TypeError` as the underlying exception.
|
|
117
|
+
"""
|
|
@@ -0,0 +1,125 @@
|
|
|
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_up_limit(
|
|
10
|
+
stepper: "StepperProtocol",
|
|
11
|
+
up_limit_value: Any,
|
|
12
|
+
) -> NoReturn:
|
|
13
|
+
"""
|
|
14
|
+
Raises a structured error when the provided upper limit is lower
|
|
15
|
+
than the currently configured down limit.
|
|
16
|
+
"""
|
|
17
|
+
|
|
18
|
+
raise SimpleRuntimeError(
|
|
19
|
+
error_name="STEPPER LIMIT CONFIGURATION ERROR",
|
|
20
|
+
label="up limit",
|
|
21
|
+
value=up_limit_value,
|
|
22
|
+
expected=f"Value >= {stepper.down_limit!r}",
|
|
23
|
+
problem=(
|
|
24
|
+
"The provided upper limit is lower than the configured down limit. "
|
|
25
|
+
"This creates an invalid numeric boundary configuration."
|
|
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
|
+
f"Attempted up limit: {up_limit_value!r}.",
|
|
32
|
+
"The stepper requires consistent numeric boundaries where "
|
|
33
|
+
"down_limit <= up_limit."
|
|
34
|
+
),
|
|
35
|
+
how_to_fix=(
|
|
36
|
+
"Set the upper limit to a value greater than or equal to the down limit.",
|
|
37
|
+
"If you need to restrict the allowed range, lower the down limit first.",
|
|
38
|
+
"Ensure that both limits reflect a valid numeric interval.",
|
|
39
|
+
),
|
|
40
|
+
exception=ValueError,
|
|
41
|
+
)
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
_DESIGN_NOTES = """
|
|
45
|
+
# raise_stepper_invalid_up_limit
|
|
46
|
+
|
|
47
|
+
## Purpose
|
|
48
|
+
Provides a structured diagnostic error when a user attempts to configure
|
|
49
|
+
an upper limit that is lower than the currently configured down limit.
|
|
50
|
+
This replaces the generic `ValueError("Up limit nemůže být menší než down limit")`
|
|
51
|
+
with a rich, contextual, and actionable error message consistent with the
|
|
52
|
+
Simple ecosystem.
|
|
53
|
+
|
|
54
|
+
This protects the stepper from invalid numeric boundary configurations.
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## Architectural reasoning
|
|
59
|
+
Stepper enforces numeric boundaries:
|
|
60
|
+
|
|
61
|
+
- `down_limit` defines the minimum allowed value,
|
|
62
|
+
- `up_limit` defines the maximum allowed value.
|
|
63
|
+
|
|
64
|
+
These boundaries must satisfy:
|
|
65
|
+
|
|
66
|
+
```
|
|
67
|
+
down_limit <= up_limit
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
If this condition is violated:
|
|
71
|
+
|
|
72
|
+
- step operations become undefined,
|
|
73
|
+
- limit checks break,
|
|
74
|
+
- callbacks may fire incorrectly,
|
|
75
|
+
- the instance can enter an invalid state.
|
|
76
|
+
|
|
77
|
+
Therefore, the error must:
|
|
78
|
+
|
|
79
|
+
- clearly explain the violation,
|
|
80
|
+
- show both limits,
|
|
81
|
+
- show the attempted value,
|
|
82
|
+
- provide actionable steps,
|
|
83
|
+
- include contextual information about the instance.
|
|
84
|
+
|
|
85
|
+
This mirrors the design of immutability, history, metadata, and composite errors.
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## Pipeline position
|
|
90
|
+
This function is used inside `process_up_limit_value`:
|
|
91
|
+
|
|
92
|
+
1. Normalize the provided value.
|
|
93
|
+
2. Check if `up_limit < down_limit`.
|
|
94
|
+
3. If yes → call this function.
|
|
95
|
+
4. Otherwise return the normalized value.
|
|
96
|
+
|
|
97
|
+
This ensures:
|
|
98
|
+
|
|
99
|
+
- consistent validation,
|
|
100
|
+
- predictable error handling,
|
|
101
|
+
- clear separation of validation and error raising.
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
## Diagnostic value
|
|
106
|
+
The error message includes:
|
|
107
|
+
|
|
108
|
+
- the invalid upper limit value,
|
|
109
|
+
- the expected minimum (down limit),
|
|
110
|
+
- the current instance value,
|
|
111
|
+
- the configured down limit,
|
|
112
|
+
- the instance type,
|
|
113
|
+
- actionable steps to resolve the issue.
|
|
114
|
+
|
|
115
|
+
This makes debugging significantly easier and aligns with the philosophy of
|
|
116
|
+
Simple’s structured error system.
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
## Notes
|
|
121
|
+
- This is a pure `raise_...` function: it performs no branching logic.
|
|
122
|
+
- It is internal and not part of the public API.
|
|
123
|
+
- All limit configuration errors must use this function.
|
|
124
|
+
- The error type is `SimpleRuntimeError` with `ValueError` as the underlying exception.
|
|
125
|
+
"""
|
|
@@ -0,0 +1,122 @@
|
|
|
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.instance import SimpleInstanceLike
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def raise_stepper_non_numeric_value(
|
|
10
|
+
instance: "SimpleInstanceLike",
|
|
11
|
+
value: Any,
|
|
12
|
+
) -> NoReturn:
|
|
13
|
+
"""
|
|
14
|
+
Raises a structured error when the instance's value is not numeric.
|
|
15
|
+
Stepper requires numeric values to perform stepping operations.
|
|
16
|
+
"""
|
|
17
|
+
|
|
18
|
+
raise SimpleRuntimeError(
|
|
19
|
+
error_name="STEPPER VALUE TYPE ERROR",
|
|
20
|
+
label="instance.value",
|
|
21
|
+
value=value,
|
|
22
|
+
expected="A numeric type (int, float, or any subclass of Number).",
|
|
23
|
+
problem=(
|
|
24
|
+
"The instance's value is not numeric. Stepper operations require "
|
|
25
|
+
"a numeric value to perform increments, decrements, and limit checks."
|
|
26
|
+
),
|
|
27
|
+
context=(
|
|
28
|
+
f"Instance type: {type(instance).__name__}.",
|
|
29
|
+
f"Received value type: {type(value).__name__!r}.",
|
|
30
|
+
"Stepper can only operate on numeric values that support arithmetic operations."
|
|
31
|
+
),
|
|
32
|
+
how_to_fix=(
|
|
33
|
+
"Ensure that the instance's `value` attribute is numeric.",
|
|
34
|
+
"If the value comes from a composite calculation, verify that the composite returns a number.",
|
|
35
|
+
"If the value is user-provided, validate or convert it before assigning it to the instance.",
|
|
36
|
+
),
|
|
37
|
+
exception=TypeError,
|
|
38
|
+
)
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
_DESIGN_NOTES = """
|
|
42
|
+
# raise_stepper_non_numeric_value
|
|
43
|
+
|
|
44
|
+
## Purpose
|
|
45
|
+
Provides a structured diagnostic error when a Simple instance used by the
|
|
46
|
+
Stepper contains a non-numeric value.
|
|
47
|
+
This replaces the generic TypeError with a rich, contextual, and actionable
|
|
48
|
+
error message consistent with the Simple ecosystem.
|
|
49
|
+
|
|
50
|
+
Stepper requires numeric values to perform:
|
|
51
|
+
|
|
52
|
+
- increments,
|
|
53
|
+
- decrements,
|
|
54
|
+
- limit checks,
|
|
55
|
+
- type-consistent stepping.
|
|
56
|
+
|
|
57
|
+
Therefore, non-numeric values must be rejected early and clearly.
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## Architectural reasoning
|
|
62
|
+
Stepper is a numerical mixin subsystem.
|
|
63
|
+
Its correctness depends on the assumption that:
|
|
64
|
+
|
|
65
|
+
```
|
|
66
|
+
instance.value is a Number
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
If this assumption is violated:
|
|
70
|
+
|
|
71
|
+
- arithmetic operations fail,
|
|
72
|
+
- limit comparisons break,
|
|
73
|
+
- callbacks may misfire,
|
|
74
|
+
- the instance may enter an invalid state.
|
|
75
|
+
|
|
76
|
+
Therefore, the error must:
|
|
77
|
+
|
|
78
|
+
- clearly explain the violation,
|
|
79
|
+
- show the offending value,
|
|
80
|
+
- describe what is expected,
|
|
81
|
+
- provide actionable steps,
|
|
82
|
+
- include contextual information about the instance.
|
|
83
|
+
|
|
84
|
+
This mirrors the design of immutability, history, metadata, and composite errors.
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## Pipeline position
|
|
89
|
+
This function is used inside `validate_instance`:
|
|
90
|
+
|
|
91
|
+
1. Check if `instance.value` is numeric.
|
|
92
|
+
2. If not → call this function.
|
|
93
|
+
3. Otherwise continue with Stepper initialization.
|
|
94
|
+
|
|
95
|
+
This ensures:
|
|
96
|
+
|
|
97
|
+
- consistent validation,
|
|
98
|
+
- predictable error handling,
|
|
99
|
+
- clear separation of validation and error raising.
|
|
100
|
+
|
|
101
|
+
---
|
|
102
|
+
|
|
103
|
+
## Diagnostic value
|
|
104
|
+
The error message includes:
|
|
105
|
+
|
|
106
|
+
- the invalid value,
|
|
107
|
+
- the expected numeric type,
|
|
108
|
+
- the received type,
|
|
109
|
+
- the instance type,
|
|
110
|
+
- actionable steps to resolve the issue.
|
|
111
|
+
|
|
112
|
+
This makes debugging significantly easier and aligns with the philosophy of
|
|
113
|
+
Simple’s structured error system.
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
## Notes
|
|
118
|
+
- This is a pure `raise_...` function: it performs no branching logic.
|
|
119
|
+
- It is internal and not part of the public API.
|
|
120
|
+
- All non-numeric instance values must use this function.
|
|
121
|
+
- The error type is `SimpleRuntimeError` with `TypeError` as the underlying exception.
|
|
122
|
+
"""
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
# Outers
|
|
3
|
+
from ...base_class import SimpleMixin
|
|
4
|
+
# Inners
|
|
5
|
+
from ._inners_property_utils import collect_all_nested_properties
|
|
6
|
+
# Annotations
|
|
7
|
+
if TYPE_CHECKING:
|
|
8
|
+
from ...._core.protocols.instance import SimpleInstanceLike
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class InnersProperty(SimpleMixin):
|
|
12
|
+
"""
|
|
13
|
+
Mixin adding properties for inner elements.
|
|
14
|
+
|
|
15
|
+
Dynamically extends composite instances with properties for direct,
|
|
16
|
+
convenient access to their inner elements (inners), based on the
|
|
17
|
+
blueprint definition.
|
|
18
|
+
"""
|
|
19
|
+
|
|
20
|
+
# ----------------------------------------
|
|
21
|
+
# Basic interface
|
|
22
|
+
# ----------------------------------------
|
|
23
|
+
|
|
24
|
+
# Compatibility declaration
|
|
25
|
+
_composite_only = True
|
|
26
|
+
|
|
27
|
+
# Slot definition
|
|
28
|
+
__slots__ = ()
|
|
29
|
+
|
|
30
|
+
# ----------------------------------------
|
|
31
|
+
# Hook for modifying the instance class
|
|
32
|
+
# ----------------------------------------
|
|
33
|
+
|
|
34
|
+
@staticmethod
|
|
35
|
+
def __extend_instance_class__(
|
|
36
|
+
instance_cls: "SimpleInstanceLike"
|
|
37
|
+
) -> "SimpleInstanceLike":
|
|
38
|
+
"""
|
|
39
|
+
Internal method for attaching elements to the class, before the
|
|
40
|
+
initialization process.
|
|
41
|
+
"""
|
|
42
|
+
|
|
43
|
+
# 1. Build the required properties
|
|
44
|
+
nested_props = collect_all_nested_properties(instance_cls.meta)
|
|
45
|
+
|
|
46
|
+
# 2. Attach the attributes to the class
|
|
47
|
+
for name, prop in nested_props.items():
|
|
48
|
+
setattr(instance_cls, name, prop)
|
|
49
|
+
|
|
50
|
+
# 3. Return the modified class
|
|
51
|
+
return instance_cls
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
_DESIGN_NOTES = """
|
|
55
|
+
# InnersProperty
|
|
56
|
+
|
|
57
|
+
## Purpose
|
|
58
|
+
Generates direct-access properties for a composite's inner elements, so
|
|
59
|
+
`obj.first_name` works instead of requiring `obj["first_name"]` or
|
|
60
|
+
`obj.get("first_name")` via the `Mapping` dunder mixin. This is the
|
|
61
|
+
attribute-style counterpart to the dict-style access `Mapping` provides.
|
|
62
|
+
|
|
63
|
+
## Compatibility
|
|
64
|
+
- `_composite_only = True` — atoms have no inners to generate properties
|
|
65
|
+
for.
|
|
66
|
+
|
|
67
|
+
## Logic
|
|
68
|
+
`__extend_instance_class__` runs once at class-creation time:
|
|
69
|
+
1. Calls `collect_all_nested_properties(instance_cls.meta)`, which does
|
|
70
|
+
the actual work of walking the blueprint and building a `name →
|
|
71
|
+
property` mapping (including, per the name "nested," properties that
|
|
72
|
+
reach into deeper levels of the composite tree, not just direct
|
|
73
|
+
children).
|
|
74
|
+
2. Attaches every returned property to `instance_cls` via `setattr`.
|
|
75
|
+
|
|
76
|
+
This mixin itself is a thin orchestrator — all the real logic of
|
|
77
|
+
deciding which properties to build and how they read/write values lives
|
|
78
|
+
in `_utils_for_inners_property.collect_all_nested_properties`.
|
|
79
|
+
|
|
80
|
+
## Notes
|
|
81
|
+
- Unlike `Equalizer`/`ImmutableWithInners`, which build their properties
|
|
82
|
+
inline inside `__extend_instance_class__` with closures, this mixin
|
|
83
|
+
delegates the whole collection step to a utility function — worth
|
|
84
|
+
knowing which pattern is used where when reading the codebase, since
|
|
85
|
+
they achieve similar ends differently.
|
|
86
|
+
- "Nested" in `collect_all_nested_properties` suggests this mixin may
|
|
87
|
+
expose deep-path access (e.g. reaching two or more levels into a
|
|
88
|
+
composite tree), not just immediate children — useful context to keep
|
|
89
|
+
in mind since the sibling mixins here mostly only handle the direct
|
|
90
|
+
inners.
|
|
91
|
+
"""
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING, Any
|
|
2
|
+
# Outers
|
|
3
|
+
from ...base_class import SimpleMixin
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ...._core.protocols.instance import SimpleInstanceLike
|
|
7
|
+
from ...._core.protocols.alias_typings import ValidTypes
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class MetaShortcuts(SimpleMixin):
|
|
11
|
+
"""
|
|
12
|
+
Ergonomic shortcuts for frequently used items from the object's
|
|
13
|
+
metadata. Adds no logic of its own — it only exposes selected
|
|
14
|
+
information directly on the instance.
|
|
15
|
+
"""
|
|
16
|
+
|
|
17
|
+
# ----------------------------------------
|
|
18
|
+
# Basic interface
|
|
19
|
+
# ----------------------------------------
|
|
20
|
+
|
|
21
|
+
# Slot definition
|
|
22
|
+
__slots__ = ()
|
|
23
|
+
|
|
24
|
+
# -------------------------
|
|
25
|
+
# Property - Object identity
|
|
26
|
+
# -------------------------
|
|
27
|
+
@property
|
|
28
|
+
def name_snake(
|
|
29
|
+
self: "SimpleInstanceLike"
|
|
30
|
+
) -> str:
|
|
31
|
+
"""Snake_case name of the object's class."""
|
|
32
|
+
return self.meta.name_snake
|
|
33
|
+
|
|
34
|
+
# -------------------------
|
|
35
|
+
# Property - Type information
|
|
36
|
+
# -------------------------
|
|
37
|
+
@property
|
|
38
|
+
def value_type(
|
|
39
|
+
self: "SimpleInstanceLike"
|
|
40
|
+
) -> "ValidTypes":
|
|
41
|
+
"""The Python type of the value the object holds."""
|
|
42
|
+
return self.meta.value_type
|
|
43
|
+
|
|
44
|
+
@property
|
|
45
|
+
def default(
|
|
46
|
+
self: "SimpleInstanceLike"
|
|
47
|
+
) -> Any:
|
|
48
|
+
"""The object's default value, as defined in its metadata."""
|
|
49
|
+
return self.meta.default
|
|
50
|
+
|
|
51
|
+
# -------------------------
|
|
52
|
+
# Property - Object structure
|
|
53
|
+
# -------------------------
|
|
54
|
+
@property
|
|
55
|
+
def is_atom(
|
|
56
|
+
self: "SimpleInstanceLike"
|
|
57
|
+
) -> bool:
|
|
58
|
+
"""True if the object represents an atom (has no inners)."""
|
|
59
|
+
return self.meta.is_constant
|
|
60
|
+
|
|
61
|
+
@property
|
|
62
|
+
def is_composite(
|
|
63
|
+
self: "SimpleInstanceLike"
|
|
64
|
+
) -> bool:
|
|
65
|
+
"""True if the object represents a composite (has inners)."""
|
|
66
|
+
return not self.meta.is_constant
|
|
67
|
+
|
|
68
|
+
@property
|
|
69
|
+
def is_decomposeable(
|
|
70
|
+
self: "SimpleInstanceLike"
|
|
71
|
+
) -> bool:
|
|
72
|
+
"""True if the object's value can be changed via decomposition."""
|
|
73
|
+
return getattr(self.meta, "is_decomposeable", False)
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
_DESIGN_NOTES = """
|
|
77
|
+
# MetaShortcuts
|
|
78
|
+
|
|
79
|
+
## Purpose
|
|
80
|
+
Pure convenience mixin — pulls a handful of frequently-needed facts out
|
|
81
|
+
of `self.meta` and exposes them as top-level properties on the instance,
|
|
82
|
+
so callers can write `obj.is_atom` instead of `obj.meta.is_constant`.
|
|
83
|
+
|
|
84
|
+
> For newcomers: this mixin is a good example of a mixin that adds zero
|
|
85
|
+
> new behavior — every property is a direct, one-line pass-through to an
|
|
86
|
+
> existing `meta` attribute. Its entire value is ergonomics: shorter,
|
|
87
|
+
> more discoverable names on the object people actually interact with.
|
|
88
|
+
|
|
89
|
+
## Compatibility
|
|
90
|
+
- No compatibility flags — every property reads from `self.meta`, which
|
|
91
|
+
every Simple instance has regardless of atom/composite or mutable/
|
|
92
|
+
immutable status.
|
|
93
|
+
|
|
94
|
+
## Logic
|
|
95
|
+
Grouped into three small clusters, each a direct pass-through:
|
|
96
|
+
- **Identity**: `name_snake` → `meta.name_snake`.
|
|
97
|
+
- **Type info**: `value_type` → `meta.value_type`, `default` →
|
|
98
|
+
`meta.default`.
|
|
99
|
+
- **Structure**: `is_atom` → `meta.is_constant`; `is_composite` is
|
|
100
|
+
defined as its logical negation rather than a separate stored flag, so
|
|
101
|
+
the two can never disagree; `is_decomposeable` uses `getattr(...,
|
|
102
|
+
False)` rather than a direct attribute access, tolerating metadata
|
|
103
|
+
objects that don't define this optional flag at all.
|
|
104
|
+
|
|
105
|
+
## Notes
|
|
106
|
+
- `is_composite` deliberately isn't `self.meta.is_composite` — computing
|
|
107
|
+
it as `not self.meta.is_constant` keeps a single source of truth
|
|
108
|
+
(`is_constant`) instead of two flags that could drift out of sync.
|
|
109
|
+
- `is_decomposeable`'s defensive `getattr` fallback is the one spot in
|
|
110
|
+
this mixin that isn't a pure 1:1 passthrough — worth knowing if a
|
|
111
|
+
future metadata refactor makes the field mandatory, since the fallback
|
|
112
|
+
would then be silently redundant rather than protective.
|
|
113
|
+
"""
|