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,24 @@
|
|
|
1
|
+
from .ImmutableMethods import ImmutableMethods
|
|
2
|
+
from .ImmutableMethodsWithInners import ImmutableWithInners
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
_DESIGN_NOTES = """
|
|
6
|
+
# Immutable Mixins
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
The "change without mutating" API for immutable instances — both the
|
|
10
|
+
generic core methods and the per-inner generated setters.
|
|
11
|
+
|
|
12
|
+
## Components
|
|
13
|
+
|
|
14
|
+
| Component | Type | Description |
|
|
15
|
+
| :------------------------- | :---- | :-------------------------------------------------------------- |
|
|
16
|
+
| `ImmutableMethods` | Mixin | `with_constant`, `with_composite`, `with_changes`, `duplicate`. |
|
|
17
|
+
| `ImmutableWithInners` | Mixin | Generates a dedicated `with_<name>(value)` per inner. |
|
|
18
|
+
|
|
19
|
+
## Notes
|
|
20
|
+
- Both are `_immutable_only`; `ImmutableWithInners` is additionally
|
|
21
|
+
`_composite_only`, since it has nothing to generate for atoms.
|
|
22
|
+
- `ImmutableWithInners` extends `ImmutableMethods` and reuses
|
|
23
|
+
`with_composite` internally for every generated setter.
|
|
24
|
+
"""
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
from .raise_with_changes_input_not_dict import raise_with_changes_input_not_dict
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
_DESIGN_NOTES = """
|
|
5
|
+
# Validations for ImmutableMethods
|
|
6
|
+
|
|
7
|
+
## Purpose
|
|
8
|
+
Provides structured raise functions used by the immutable update API
|
|
9
|
+
(`with_changes`). These validations ensure that:
|
|
10
|
+
|
|
11
|
+
- the input container for multiple updates is a dictionary,
|
|
12
|
+
- the immutable update pipeline receives well‑formed data.
|
|
13
|
+
|
|
14
|
+
## Components
|
|
15
|
+
|
|
16
|
+
| Component | Type | Description |
|
|
17
|
+
| :---------------------------------------| :--------| :----------------------------------------------- |
|
|
18
|
+
| `raise_with_changes_input_not_dict` | Function | Ensures `changes_dict` is a dictionary. |
|
|
19
|
+
"""
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING, NoReturn, Any
|
|
2
|
+
# Outers
|
|
3
|
+
from .....exceptions import SimpleRuntimeError
|
|
4
|
+
|
|
5
|
+
# Annotations
|
|
6
|
+
if TYPE_CHECKING:
|
|
7
|
+
from ....._core.protocols.mixins.immutable import ImmutableMethodsProtocol
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
def raise_with_changes_input_not_dict(
|
|
11
|
+
instance: "ImmutableMethodsProtocol",
|
|
12
|
+
value: Any,
|
|
13
|
+
) -> NoReturn:
|
|
14
|
+
"""
|
|
15
|
+
Raises an error when the input to `with_changes` is not a dictionary.
|
|
16
|
+
"""
|
|
17
|
+
|
|
18
|
+
raise SimpleRuntimeError(
|
|
19
|
+
error_name="IMMUTABILITY UPDATE ERROR",
|
|
20
|
+
label="changes_dict",
|
|
21
|
+
expected="A dictionary mapping constant names to new values.",
|
|
22
|
+
value=repr(value),
|
|
23
|
+
problem=(
|
|
24
|
+
"Invalid input provided to `with_changes`.",
|
|
25
|
+
"The method expects a dictionary of constant updates."
|
|
26
|
+
),
|
|
27
|
+
context=(
|
|
28
|
+
f"Immutable update attempted on instance '{type(instance).__name__}'.",
|
|
29
|
+
f"Provided value type: {type(value).__name__}"
|
|
30
|
+
),
|
|
31
|
+
how_to_fix=(
|
|
32
|
+
"Ensure that `changes_dict` is a dictionary.",
|
|
33
|
+
"Example: {'width': 10, 'height': 20}",
|
|
34
|
+
"For tuple-based updates, use `with_constants` instead."
|
|
35
|
+
),
|
|
36
|
+
exception=TypeError,
|
|
37
|
+
)
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
_DESIGN_NOTES = """
|
|
41
|
+
# raise_with_changes_input_not_dict
|
|
42
|
+
|
|
43
|
+
## Purpose
|
|
44
|
+
Raises a structured error when `with_changes` receives a non-dictionary input.
|
|
45
|
+
|
|
46
|
+
## Why this validation exists
|
|
47
|
+
`with_changes` is a convenience wrapper over `with_any`, which expects a tuple
|
|
48
|
+
of `(name, value)` pairs.
|
|
49
|
+
To keep the API ergonomic, `with_changes` accepts a dictionary and converts it
|
|
50
|
+
to a tuple internally.
|
|
51
|
+
|
|
52
|
+
If the input is not a dictionary, the conversion cannot be performed safely.
|
|
53
|
+
|
|
54
|
+
## Execution context
|
|
55
|
+
Used inside `ImmutableMethods.with_changes` before delegating to `with_any`.
|
|
56
|
+
|
|
57
|
+
## Notes
|
|
58
|
+
- Pure raise function, no conditional logic.
|
|
59
|
+
- Consistent with the immutability validation style.
|
|
60
|
+
"""
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
from numbers import Number
|
|
3
|
+
# Outers
|
|
4
|
+
from ..._common_logic.constants import STEPPER
|
|
5
|
+
from ...core_mixins import NodesTuple
|
|
6
|
+
# Inners
|
|
7
|
+
from ._stepper_class import Stepper
|
|
8
|
+
# Annotations
|
|
9
|
+
if TYPE_CHECKING:
|
|
10
|
+
from ...._core.protocols.mixins.numerical import EqualizerProtocol
|
|
11
|
+
from ...._core.protocols.mixins.numerical.internal_types import SteppersMap
|
|
12
|
+
from ...._core.protocols.instance import SimpleInstanceLike
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
class Equalizer(NodesTuple):
|
|
16
|
+
"""
|
|
17
|
+
Provides access to a stepper for every inner.
|
|
18
|
+
|
|
19
|
+
Guarantees the presence of numeric controllers (steppers) for every
|
|
20
|
+
sub-node element of the composite. These controllers are generated
|
|
21
|
+
dynamically based on the blueprint and are exposed via dynamic
|
|
22
|
+
properties with a suffix.
|
|
23
|
+
"""
|
|
24
|
+
|
|
25
|
+
# ----------------------------------------
|
|
26
|
+
# Basic interface
|
|
27
|
+
# ----------------------------------------
|
|
28
|
+
|
|
29
|
+
# Compatibility declaration
|
|
30
|
+
_composite_only = True
|
|
31
|
+
_mutable_only = True
|
|
32
|
+
_only_types = Number
|
|
33
|
+
|
|
34
|
+
# Slot definition
|
|
35
|
+
__slots__ = ("_steppers",)
|
|
36
|
+
|
|
37
|
+
# ----------------------------------------
|
|
38
|
+
# Hook for modifying the instance class
|
|
39
|
+
# ----------------------------------------
|
|
40
|
+
|
|
41
|
+
@staticmethod
|
|
42
|
+
def __extend_instance_class__(
|
|
43
|
+
instance_cls: "SimpleInstanceLike"
|
|
44
|
+
) -> "SimpleInstanceLike":
|
|
45
|
+
"""
|
|
46
|
+
Internal method for attaching elements to the class, before the
|
|
47
|
+
initialization process.
|
|
48
|
+
"""
|
|
49
|
+
|
|
50
|
+
# 1. Build the required properties
|
|
51
|
+
for name in instance_cls.meta.node_names_set:
|
|
52
|
+
|
|
53
|
+
# 1.1 Getter definition
|
|
54
|
+
def getter(self: "EqualizerProtocol", _name: str = name):
|
|
55
|
+
return self._steppers[_name]
|
|
56
|
+
|
|
57
|
+
# 1.2 Set the getter's name and docstring
|
|
58
|
+
prop_name = f"{name}{STEPPER}"
|
|
59
|
+
getter.__name__ = f"get_{prop_name}"
|
|
60
|
+
getter.__doc__ = (
|
|
61
|
+
f"Returns the Stepper object for node `{name}`.\n"
|
|
62
|
+
f"Generated dynamically based on the object's structure."
|
|
63
|
+
)
|
|
64
|
+
|
|
65
|
+
# 1.3 Create the property and store it on the class
|
|
66
|
+
setattr(instance_cls, prop_name, property(getter))
|
|
67
|
+
|
|
68
|
+
# 2. Return the modified class
|
|
69
|
+
return instance_cls
|
|
70
|
+
|
|
71
|
+
# ----------------------------------------
|
|
72
|
+
# Initialization hook
|
|
73
|
+
# ----------------------------------------
|
|
74
|
+
|
|
75
|
+
# noinspection PyAttributeOutsideInit
|
|
76
|
+
def init_mixins(
|
|
77
|
+
self: "EqualizerProtocol"
|
|
78
|
+
) -> None:
|
|
79
|
+
"""
|
|
80
|
+
Method forwarding its logic into the instance's initialization
|
|
81
|
+
process.
|
|
82
|
+
"""
|
|
83
|
+
|
|
84
|
+
# 1. Dict of steppers for every element
|
|
85
|
+
self._steppers: "SteppersMap" = {
|
|
86
|
+
instance.meta.name_snake: Stepper(instance)
|
|
87
|
+
for instance, _ in self._nodes_tuple
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
_DESIGN_NOTES = """
|
|
92
|
+
# Equalizer
|
|
93
|
+
|
|
94
|
+
## Purpose
|
|
95
|
+
Gives every inner of a composite its own `Stepper`, exposed as a dynamic
|
|
96
|
+
property named `<inner_name><STEPPER suffix>` (e.g. `volume_stepper`) —
|
|
97
|
+
so each numeric field can be stepped/clamped independently, the way a
|
|
98
|
+
mixing-desk equalizer has one fader per channel.
|
|
99
|
+
|
|
100
|
+
## Compatibility
|
|
101
|
+
- `_composite_only = True` — needs inners to attach per-node steppers to;
|
|
102
|
+
an atom is handled instead by `Volume`.
|
|
103
|
+
- `_mutable_only = True` / `_only_types = Number` — same reasoning as
|
|
104
|
+
`Volume`: stepping mutates in place, and only makes sense on numbers.
|
|
105
|
+
|
|
106
|
+
## Logic
|
|
107
|
+
Two separate mechanisms work together:
|
|
108
|
+
|
|
109
|
+
1. `__extend_instance_class__` (class-creation time) — for every node
|
|
110
|
+
name in `meta.node_names_set`, dynamically defines and attaches a
|
|
111
|
+
read-only `property` named `f"{name}{STEPPER}"`. Each property's
|
|
112
|
+
getter closes over its own `name` via the `_name: str = name` default
|
|
113
|
+
argument trick (same pattern as `ImmutableWithInners`), so every
|
|
114
|
+
generated property correctly reads its own entry rather than all
|
|
115
|
+
sharing the last loop value.
|
|
116
|
+
2. `init_mixins` (instance-creation time) — builds the actual
|
|
117
|
+
`_steppers` dict, one `Stepper(instance)` per node in `_nodes_tuple`,
|
|
118
|
+
keyed by `name_snake`. The properties defined in step 1 simply read
|
|
119
|
+
from this dict at access time.
|
|
120
|
+
|
|
121
|
+
## Notes
|
|
122
|
+
- Two-phase design is intentional: the *properties* only need to be
|
|
123
|
+
defined once per class (step 1), but the *stepper objects* need to be
|
|
124
|
+
built fresh per instance (step 2), since each instance has its own
|
|
125
|
+
node values to step.
|
|
126
|
+
- Compare with `Volume`, which does the single-value equivalent for an
|
|
127
|
+
atom — `Equalizer` is effectively "one `Volume` per inner," generated
|
|
128
|
+
dynamically rather than declared per field.
|
|
129
|
+
"""
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
from numbers import Number
|
|
3
|
+
# Outers
|
|
4
|
+
from ...base_class import SimpleMixin
|
|
5
|
+
# Innser
|
|
6
|
+
from ._stepper_class import Stepper
|
|
7
|
+
# Annotations
|
|
8
|
+
if TYPE_CHECKING:
|
|
9
|
+
from ...._core.protocols.mixins.numerical import VolumeProtocol
|
|
10
|
+
from ...._core.protocols.mixins.numerical.stepper import StepperProtocol
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
class Volume(SimpleMixin):
|
|
14
|
+
"""
|
|
15
|
+
Provides access to a stepper for the main value.
|
|
16
|
+
|
|
17
|
+
Guarantees the presence of a numeric controller (stepper) attached
|
|
18
|
+
directly to the instance's main value, enabling safe stepping and
|
|
19
|
+
limit enforcement.
|
|
20
|
+
"""
|
|
21
|
+
|
|
22
|
+
# ----------------------------------------
|
|
23
|
+
# Basic interface
|
|
24
|
+
# ----------------------------------------
|
|
25
|
+
|
|
26
|
+
# Compatibility declaration
|
|
27
|
+
_mutable_only = True
|
|
28
|
+
_only_types = Number
|
|
29
|
+
|
|
30
|
+
# Slot definition
|
|
31
|
+
__slots__ = ("_value_stepper",)
|
|
32
|
+
|
|
33
|
+
# ----------------------------------------
|
|
34
|
+
# Initialization hook
|
|
35
|
+
# ----------------------------------------
|
|
36
|
+
|
|
37
|
+
# noinspection PyAttributeOutsideInit
|
|
38
|
+
def init_mixins(
|
|
39
|
+
self: "VolumeProtocol"
|
|
40
|
+
) -> None:
|
|
41
|
+
"""
|
|
42
|
+
Method forwarding its logic into the instance's initialization
|
|
43
|
+
process.
|
|
44
|
+
"""
|
|
45
|
+
|
|
46
|
+
# 1. Stepper for the base value
|
|
47
|
+
self._value_stepper: "StepperProtocol" = Stepper(self)
|
|
48
|
+
|
|
49
|
+
# ----------------------------------------
|
|
50
|
+
# Property - getters
|
|
51
|
+
# ----------------------------------------
|
|
52
|
+
|
|
53
|
+
@property
|
|
54
|
+
def value_stepper(
|
|
55
|
+
self: "VolumeProtocol"
|
|
56
|
+
) -> "StepperProtocol":
|
|
57
|
+
"""
|
|
58
|
+
Returns the numeric controller (stepper) for safely manipulating
|
|
59
|
+
this instance's main value.
|
|
60
|
+
"""
|
|
61
|
+
return self._value_stepper
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
_DESIGN_NOTES = """
|
|
65
|
+
# Volume
|
|
66
|
+
|
|
67
|
+
## Purpose
|
|
68
|
+
Attaches a `Stepper` — a numeric controller supporting safe stepping and
|
|
69
|
+
limit enforcement — directly to an instance's own value. Named "Volume"
|
|
70
|
+
for the mental image of a volume knob: turn it up/down safely, without
|
|
71
|
+
overshooting bounds.
|
|
72
|
+
|
|
73
|
+
> For newcomers: a naive `obj.value += 1` has no built-in concept of
|
|
74
|
+
> "don't go above 100" or "clamp at 0." A `Stepper` wraps that logic once,
|
|
75
|
+
> so callers can step values up/down without re-implementing bounds
|
|
76
|
+
> checking everywhere.
|
|
77
|
+
|
|
78
|
+
## Compatibility
|
|
79
|
+
- `_mutable_only = True` — stepping is an in-place operation on the
|
|
80
|
+
instance's own value; on an immutable instance there'd be nothing to
|
|
81
|
+
step in place.
|
|
82
|
+
- `_only_types = Number` — a stepper's increment/decrement/clamp logic
|
|
83
|
+
only makes sense for numeric values.
|
|
84
|
+
|
|
85
|
+
## Logic
|
|
86
|
+
On `init_mixins`, a single `Stepper(self)` is built and stored as
|
|
87
|
+
`_value_stepper`, exposed publicly through the read-only `value_stepper`
|
|
88
|
+
property. All the actual stepping/clamping logic lives inside the
|
|
89
|
+
`Stepper` class itself (`_stepper_class`) — this mixin's only job is to
|
|
90
|
+
construct one, bound to `self`, and expose it.
|
|
91
|
+
|
|
92
|
+
## Notes
|
|
93
|
+
- Compare with `Equalizer`, which does the same thing but for every
|
|
94
|
+
*inner* of a composite (one stepper per node) rather than for the
|
|
95
|
+
instance's own single value — `Volume` is the atom/single-value
|
|
96
|
+
counterpart to `Equalizer`'s per-inner version.
|
|
97
|
+
- The property is named `value_stepper`, distinct from the private
|
|
98
|
+
`_value_stepper` slot — the usual public/private naming split used
|
|
99
|
+
throughout the ecosystem.
|
|
100
|
+
"""
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
from .Equalizer import Equalizer
|
|
2
|
+
from .Volume import Volume
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
_DESIGN_NOTES = """
|
|
6
|
+
# Numerical Mixins
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
Attaches `Stepper` controllers — safe, bounded numeric stepping — to
|
|
10
|
+
instance values, either the single value of an atom or every inner of a
|
|
11
|
+
composite.
|
|
12
|
+
|
|
13
|
+
## Components
|
|
14
|
+
|
|
15
|
+
| Component | Type | Description |
|
|
16
|
+
| :------------- | :---- | :---------------------------------------------------------- |
|
|
17
|
+
| `Volume` | Mixin | One stepper for the instance's own main value. |
|
|
18
|
+
| `Equalizer` | Mixin | One stepper per inner, exposed as dynamic properties. |
|
|
19
|
+
|
|
20
|
+
## Notes
|
|
21
|
+
- Both are `_mutable_only` and `_only_types = Number`.
|
|
22
|
+
- `Volume` targets atoms (single value); `Equalizer` targets composites
|
|
23
|
+
(`_composite_only`), generating one property per inner via
|
|
24
|
+
`__extend_instance_class__`.
|
|
25
|
+
"""
|
|
@@ -0,0 +1,227 @@
|
|
|
1
|
+
from typing import Any, TYPE_CHECKING
|
|
2
|
+
from simplibs.sentinels import UNSET
|
|
3
|
+
# Inners
|
|
4
|
+
from .processors import (
|
|
5
|
+
validate_instance,
|
|
6
|
+
process_value,
|
|
7
|
+
process_up_limit_value,
|
|
8
|
+
process_down_limit_value,
|
|
9
|
+
process_limit_action,
|
|
10
|
+
)
|
|
11
|
+
from .methods import step_up, step_down, set_value
|
|
12
|
+
# Annotations
|
|
13
|
+
if TYPE_CHECKING:
|
|
14
|
+
from ....._core.protocols.mixins.numerical.stepper import StepperProtocol
|
|
15
|
+
from ....._core.protocols.mixins.numerical.stepper.internal_types import StepValue, LimitAction
|
|
16
|
+
from ....._core.protocols.instance import SimpleInstanceLike
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
class Stepper:
|
|
20
|
+
"""
|
|
21
|
+
Service class for controlled numeric value manipulation.
|
|
22
|
+
|
|
23
|
+
Provides an encapsulated interface for incrementing, decrementing, and
|
|
24
|
+
enforcing numeric limits on the value of a bound instance.
|
|
25
|
+
"""
|
|
26
|
+
|
|
27
|
+
__slots__ = (
|
|
28
|
+
"_instance",
|
|
29
|
+
"_step",
|
|
30
|
+
"_up_limit",
|
|
31
|
+
"_down_limit",
|
|
32
|
+
"_up_limit_action",
|
|
33
|
+
"_down_limit_action",
|
|
34
|
+
"_value_type"
|
|
35
|
+
)
|
|
36
|
+
|
|
37
|
+
def __init__(
|
|
38
|
+
self: "StepperProtocol",
|
|
39
|
+
instance: "SimpleInstanceLike"
|
|
40
|
+
) -> None:
|
|
41
|
+
|
|
42
|
+
# 1. Validate instance
|
|
43
|
+
validate_instance(instance)
|
|
44
|
+
|
|
45
|
+
# 2. Bind instance
|
|
46
|
+
self._instance: "SimpleInstanceLike" = instance
|
|
47
|
+
|
|
48
|
+
# 3. Determine numeric type
|
|
49
|
+
self._value_type: type = type(instance.value)
|
|
50
|
+
|
|
51
|
+
# 4. Default step value
|
|
52
|
+
self._step: Any = self._value_type(1)
|
|
53
|
+
|
|
54
|
+
# 5. Default limits and actions
|
|
55
|
+
self._up_limit: Any = UNSET
|
|
56
|
+
self._down_limit: Any = UNSET
|
|
57
|
+
self._up_limit_action: "LimitAction" = UNSET
|
|
58
|
+
self._down_limit_action: "LimitAction" = UNSET
|
|
59
|
+
|
|
60
|
+
# ----------------------------------------
|
|
61
|
+
# Property - getters
|
|
62
|
+
# ----------------------------------------
|
|
63
|
+
@property
|
|
64
|
+
def step(self: "StepperProtocol") -> Any:
|
|
65
|
+
"""Step value used for increment/decrement operations."""
|
|
66
|
+
return self._step
|
|
67
|
+
|
|
68
|
+
@property
|
|
69
|
+
def up_limit(self: "StepperProtocol") -> Any:
|
|
70
|
+
"""Upper limit for the value (or UNSET)."""
|
|
71
|
+
return self._up_limit
|
|
72
|
+
|
|
73
|
+
@property
|
|
74
|
+
def down_limit(self: "StepperProtocol") -> Any:
|
|
75
|
+
"""Lower limit for the value (or UNSET)."""
|
|
76
|
+
return self._down_limit
|
|
77
|
+
|
|
78
|
+
@property
|
|
79
|
+
def up_limit_action(self: "StepperProtocol") -> "LimitAction":
|
|
80
|
+
"""Callback executed when the upper limit is exceeded (or UNSET)."""
|
|
81
|
+
return self._up_limit_action
|
|
82
|
+
|
|
83
|
+
@property
|
|
84
|
+
def down_limit_action(self: "StepperProtocol") -> "LimitAction":
|
|
85
|
+
"""Callback executed when the lower limit is exceeded (or UNSET)."""
|
|
86
|
+
return self._down_limit_action
|
|
87
|
+
|
|
88
|
+
# ----------------------------------------
|
|
89
|
+
# Property - setters
|
|
90
|
+
# ----------------------------------------
|
|
91
|
+
@step.setter
|
|
92
|
+
def step(self: "StepperProtocol", value: Any) -> None:
|
|
93
|
+
"""Step value used for increment/decrement operations."""
|
|
94
|
+
self._step = process_value(self, value)
|
|
95
|
+
|
|
96
|
+
@up_limit.setter
|
|
97
|
+
def up_limit(self: "StepperProtocol", value) -> None:
|
|
98
|
+
"""Upper limit for the value (or UNSET)."""
|
|
99
|
+
self._up_limit = process_up_limit_value(self, value)
|
|
100
|
+
|
|
101
|
+
@down_limit.setter
|
|
102
|
+
def down_limit(self: "StepperProtocol", value: Any) -> None:
|
|
103
|
+
"""Lower limit for the value (or UNSET)."""
|
|
104
|
+
self._down_limit = process_down_limit_value(self, value)
|
|
105
|
+
|
|
106
|
+
@up_limit_action.setter
|
|
107
|
+
def up_limit_action(self: "StepperProtocol", value: "LimitAction") -> None:
|
|
108
|
+
"""Callback executed when the upper limit is exceeded (or UNSET)."""
|
|
109
|
+
self._up_limit_action = process_limit_action(self, value)
|
|
110
|
+
|
|
111
|
+
@down_limit_action.setter
|
|
112
|
+
def down_limit_action(self: "StepperProtocol", value: "LimitAction") -> None:
|
|
113
|
+
"""Callback executed when the lower limit is exceeded (or UNSET)."""
|
|
114
|
+
self._down_limit_action = process_limit_action(self, value)
|
|
115
|
+
|
|
116
|
+
# ----------------------------------------
|
|
117
|
+
# Methods
|
|
118
|
+
# ----------------------------------------
|
|
119
|
+
def step_up(
|
|
120
|
+
self: "StepperProtocol",
|
|
121
|
+
value: "StepValue" = UNSET,
|
|
122
|
+
*,
|
|
123
|
+
validate: bool = True,
|
|
124
|
+
raise_exception: bool = False
|
|
125
|
+
) -> Any:
|
|
126
|
+
"""Increase the instance value by a step or custom amount."""
|
|
127
|
+
return step_up(self, value, validate=validate, raise_exception=raise_exception)
|
|
128
|
+
|
|
129
|
+
def step_down(
|
|
130
|
+
self: "StepperProtocol",
|
|
131
|
+
value: "StepValue" = UNSET,
|
|
132
|
+
*,
|
|
133
|
+
validate: bool = True,
|
|
134
|
+
raise_exception: bool = False
|
|
135
|
+
) -> Any:
|
|
136
|
+
"""Decrease the instance value by a step or custom amount."""
|
|
137
|
+
return step_down(self, value, validate=validate, raise_exception=raise_exception)
|
|
138
|
+
|
|
139
|
+
def set_value(
|
|
140
|
+
self: "StepperProtocol",
|
|
141
|
+
value: Any,
|
|
142
|
+
*,
|
|
143
|
+
validate: bool = True,
|
|
144
|
+
raise_exception: bool = False
|
|
145
|
+
) -> Any:
|
|
146
|
+
"""Safely assign a new value with full limit enforcement."""
|
|
147
|
+
return set_value(self, value, validate=validate, raise_exception=raise_exception)
|
|
148
|
+
|
|
149
|
+
# ----------------------------------------
|
|
150
|
+
# Dunders
|
|
151
|
+
# ----------------------------------------
|
|
152
|
+
def __repr__(self: "StepperProtocol") -> str:
|
|
153
|
+
"""String representation of the Stepper."""
|
|
154
|
+
return f"<Stepper value={self._instance.value!r} step={self._step}>"
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
_DESIGN_NOTES = """
|
|
158
|
+
# Stepper Class
|
|
159
|
+
|
|
160
|
+
## Purpose
|
|
161
|
+
The Stepper is the core controller for safe numeric manipulation inside the
|
|
162
|
+
Simple object system. It provides a fully encapsulated interface for:
|
|
163
|
+
|
|
164
|
+
- incrementing values,
|
|
165
|
+
- decrementing values,
|
|
166
|
+
- assigning values directly,
|
|
167
|
+
- enforcing upper and lower limits,
|
|
168
|
+
- executing limit actions,
|
|
169
|
+
- normalizing and validating numeric inputs.
|
|
170
|
+
|
|
171
|
+
It is automatically attached to numerical mixins (`Volume`, `Equalizer`) and
|
|
172
|
+
never instantiated directly by the user.
|
|
173
|
+
|
|
174
|
+
---
|
|
175
|
+
|
|
176
|
+
## Architectural Role
|
|
177
|
+
The Stepper acts as a dedicated numeric engine.
|
|
178
|
+
It integrates with:
|
|
179
|
+
|
|
180
|
+
- configuration processors (`process_value`, `process_limit_action`, …),
|
|
181
|
+
- runtime processors (`verify_up_limit`, `verify_down_limit`),
|
|
182
|
+
- stepping methods (`step_up`, `step_down`, `set_value`),
|
|
183
|
+
- instance-level validation (`instance.validate`).
|
|
184
|
+
|
|
185
|
+
It guarantees deterministic, safe, and predictable numeric transitions.
|
|
186
|
+
|
|
187
|
+
---
|
|
188
|
+
|
|
189
|
+
## Components
|
|
190
|
+
|
|
191
|
+
### 1. Initialization
|
|
192
|
+
- Validates the bound instance.
|
|
193
|
+
- Determines the numeric type.
|
|
194
|
+
- Sets default step value.
|
|
195
|
+
- Initializes limits and limit actions.
|
|
196
|
+
|
|
197
|
+
### 2. Properties
|
|
198
|
+
- `step` — step size for stepping operations.
|
|
199
|
+
- `up_limit` — maximum allowed value.
|
|
200
|
+
- `down_limit` — minimum allowed value.
|
|
201
|
+
- `up_limit_action` — callback triggered when exceeding upper limit.
|
|
202
|
+
- `down_limit_action` — callback triggered when exceeding lower limit.
|
|
203
|
+
|
|
204
|
+
### 3. Methods
|
|
205
|
+
- `step_up(value=UNSET, validate=True, raise_exception=False)`
|
|
206
|
+
Increases the value by the configured step or a custom amount.
|
|
207
|
+
Enforces upper limit and triggers actions.
|
|
208
|
+
|
|
209
|
+
- `step_down(value=UNSET, validate=True, raise_exception=False)`
|
|
210
|
+
Decreases the value by the configured step or a custom amount.
|
|
211
|
+
Enforces lower limit and triggers actions.
|
|
212
|
+
|
|
213
|
+
- `set_value(value, validate=True, raise_exception=False)`
|
|
214
|
+
Assigns a new value directly.
|
|
215
|
+
Enforces both limits depending on direction of change.
|
|
216
|
+
|
|
217
|
+
### 4. Dunders
|
|
218
|
+
- `__repr__` — simple debug-friendly representation.
|
|
219
|
+
|
|
220
|
+
---
|
|
221
|
+
|
|
222
|
+
## Notes
|
|
223
|
+
- Stepper is internal and not part of the public API.
|
|
224
|
+
- All heavy logic is delegated to processors and validation helpers.
|
|
225
|
+
- The class itself remains minimal, predictable, and easy to reason about.
|
|
226
|
+
- Guarantees deterministic behavior across all numeric transitions.
|
|
227
|
+
"""
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
from .Stepper import Stepper
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
_DESIGN_NOTES = """
|
|
5
|
+
# Stepper Class
|
|
6
|
+
|
|
7
|
+
## Purpose
|
|
8
|
+
Provides the core Stepper class used by numerical mixins to safely manipulate
|
|
9
|
+
numeric values with full support for:
|
|
10
|
+
|
|
11
|
+
- type normalization,
|
|
12
|
+
- semantic validation,
|
|
13
|
+
- upper and lower limit enforcement,
|
|
14
|
+
- limit actions,
|
|
15
|
+
- controlled stepping operations.
|
|
16
|
+
|
|
17
|
+
The Stepper acts as a dedicated controller for numeric transitions and forms
|
|
18
|
+
the backbone of the numerical subsystem (`Volume`, `Equalizer`).
|
|
19
|
+
|
|
20
|
+
## Components
|
|
21
|
+
|
|
22
|
+
| Component | Type | Description |
|
|
23
|
+
| :-------- | :-------| :----------------------------------------------- |
|
|
24
|
+
| `Stepper` | Class | Implements the full stepping, validation, and limit logic. |
|
|
25
|
+
|
|
26
|
+
## Notes
|
|
27
|
+
- This class is internal and not part of the public API.
|
|
28
|
+
- All operational logic is delegated to processor and validation submodules.
|
|
29
|
+
- The Stepper guarantees deterministic, safe numeric transitions.
|
|
30
|
+
- It is instantiated automatically by numerical mixins and never directly by the user.
|
|
31
|
+
"""
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
from .set_value import set_value
|
|
2
|
+
from .step_down import step_down
|
|
3
|
+
from .step_up import step_up
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
_DESIGN_NOTES = """
|
|
7
|
+
# Stepper Core Methods
|
|
8
|
+
|
|
9
|
+
## Purpose
|
|
10
|
+
Provides the primary operational methods of the Stepper subsystem. These
|
|
11
|
+
methods implement the controlled mutation of the instance's numeric value,
|
|
12
|
+
including:
|
|
13
|
+
|
|
14
|
+
- direct value assignment,
|
|
15
|
+
- upward stepping,
|
|
16
|
+
- downward stepping,
|
|
17
|
+
- full enforcement of numeric limits and optional limit actions.
|
|
18
|
+
|
|
19
|
+
They form the public-facing API of the Stepper and are used by all numerical
|
|
20
|
+
mixins (`Volume`, `Equalizer`) and any user-level stepping operations.
|
|
21
|
+
|
|
22
|
+
## Components
|
|
23
|
+
|
|
24
|
+
| Component | Type | Description |
|
|
25
|
+
| :------------ | :--------| :----------------------------------------------------------------- |
|
|
26
|
+
| `set_value` | Function | Safely assigns a new value with full limit validation. |
|
|
27
|
+
| `step_down` | Function | Decreases the value by a defined step and enforces down limits. |
|
|
28
|
+
| `step_up` | Function | Increases the value by a defined step and enforces up limits. |
|
|
29
|
+
|
|
30
|
+
## Notes
|
|
31
|
+
- These methods form the core public API of the Stepper.
|
|
32
|
+
- All structural logic is delegated to processor utilities and validation helpers.
|
|
33
|
+
- Limit actions and structured errors follow the SimpleRuntimeError diagnostic format.
|
|
34
|
+
- These methods guarantee deterministic, safe numeric transitions.
|
|
35
|
+
"""
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
from .process_step_value import process_step_value
|
|
2
|
+
from .verify_down_limit import verify_down_limit
|
|
3
|
+
from .verify_up_limit import verify_up_limit
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
_DESIGN_NOTES = """
|
|
7
|
+
# Stepper Runtime Processors
|
|
8
|
+
|
|
9
|
+
## Purpose
|
|
10
|
+
Provides the core runtime helper functions used by the Stepper's stepping
|
|
11
|
+
operations. These processors implement the essential mechanics of:
|
|
12
|
+
|
|
13
|
+
- step value normalization,
|
|
14
|
+
- upward and downward limit enforcement,
|
|
15
|
+
- structured error raising and optional limit actions.
|
|
16
|
+
|
|
17
|
+
They form the operational backbone of the stepper subsystem and are used by
|
|
18
|
+
all stepping methods (`step_up`, `step_down`, `set_value`).
|
|
19
|
+
|
|
20
|
+
## Components
|
|
21
|
+
|
|
22
|
+
| Component | Type | Description |
|
|
23
|
+
| :------------------- | :--------| :---------------------------------------------------------------- |
|
|
24
|
+
| `process_step_value` | Function | Normalizes and validates the step value used for stepping. |
|
|
25
|
+
| `verify_down_limit` | Function | Checks lower limit violations and triggers optional actions. |
|
|
26
|
+
| `verify_up_limit` | Function | Checks upper limit violations and triggers optional actions. |
|
|
27
|
+
|
|
28
|
+
## Notes
|
|
29
|
+
- These utilities are internal and not part of the public API.
|
|
30
|
+
- They are used exclusively by the stepper's stepping and value‑assignment methods.
|
|
31
|
+
- All structural logic is delegated to the stepper's validation subsystem.
|
|
32
|
+
- Errors raised here follow the SimpleRuntimeError diagnostic format.
|
|
33
|
+
"""
|