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,66 @@
|
|
|
1
|
+
from typing import Protocol, runtime_checkable, Any, Self
|
|
2
|
+
# Outers
|
|
3
|
+
from ...base_class import SimpleMixinProtocol
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
@runtime_checkable
|
|
7
|
+
class InplaceProtocol(
|
|
8
|
+
SimpleMixinProtocol,
|
|
9
|
+
Protocol
|
|
10
|
+
):
|
|
11
|
+
"""
|
|
12
|
+
Protocol for the Inplace mixin.
|
|
13
|
+
|
|
14
|
+
Guarantees a set of in-place arithmetic operators (+=, -=, *=, /=, //=, %=, **=).
|
|
15
|
+
All operations modify the object's value in place, trigger reactivity,
|
|
16
|
+
and return the updated instance (Self).
|
|
17
|
+
"""
|
|
18
|
+
|
|
19
|
+
# ----------------------------------------
|
|
20
|
+
# In-place Addition (+=)
|
|
21
|
+
# ----------------------------------------
|
|
22
|
+
def __iadd__(self, other: Any) -> Self:
|
|
23
|
+
"""Modifies value in place: (self.value += other) and returns self."""
|
|
24
|
+
...
|
|
25
|
+
|
|
26
|
+
# ----------------------------------------
|
|
27
|
+
# In-place Subtraction (-=)
|
|
28
|
+
# ----------------------------------------
|
|
29
|
+
def __isub__(self, other: Any) -> Self:
|
|
30
|
+
"""Modifies value in place: (self.value -= other) and returns self."""
|
|
31
|
+
...
|
|
32
|
+
|
|
33
|
+
# ----------------------------------------
|
|
34
|
+
# In-place Multiplication (*=)
|
|
35
|
+
# ----------------------------------------
|
|
36
|
+
def __imul__(self, other: Any) -> Self:
|
|
37
|
+
"""Modifies value in place: (self.value *= other) and returns self."""
|
|
38
|
+
...
|
|
39
|
+
|
|
40
|
+
# ----------------------------------------
|
|
41
|
+
# In-place True Division (/=)
|
|
42
|
+
# ----------------------------------------
|
|
43
|
+
def __itruediv__(self, other: Any) -> Self:
|
|
44
|
+
"""Modifies value in place: (self.value /= other) and returns self."""
|
|
45
|
+
...
|
|
46
|
+
|
|
47
|
+
# ----------------------------------------
|
|
48
|
+
# In-place Floor Division (//=)
|
|
49
|
+
# ----------------------------------------
|
|
50
|
+
def __ifloordiv__(self, other: Any) -> Self:
|
|
51
|
+
"""Modifies value in place: (self.value //= other) and returns self."""
|
|
52
|
+
...
|
|
53
|
+
|
|
54
|
+
# ----------------------------------------
|
|
55
|
+
# In-place Modulo (%=)
|
|
56
|
+
# ----------------------------------------
|
|
57
|
+
def __imod__(self, other: Any) -> Self:
|
|
58
|
+
"""Modifies value in place: (self.value %= other) and returns self."""
|
|
59
|
+
...
|
|
60
|
+
|
|
61
|
+
# ----------------------------------------
|
|
62
|
+
# In-place Power (**=)
|
|
63
|
+
# ----------------------------------------
|
|
64
|
+
def __ipow__(self, other: Any) -> Self:
|
|
65
|
+
"""Modifies value in place: (self.value **= other) and returns self."""
|
|
66
|
+
...
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
from typing import Protocol, runtime_checkable, Self
|
|
2
|
+
# Outers
|
|
3
|
+
from ...core_mixins import NodesDictsProtocol, SnapshotProtocol
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
@runtime_checkable
|
|
7
|
+
class UnaryProtocol(
|
|
8
|
+
NodesDictsProtocol,
|
|
9
|
+
SnapshotProtocol,
|
|
10
|
+
Protocol
|
|
11
|
+
):
|
|
12
|
+
"""
|
|
13
|
+
Protocol for the Unary mixin.
|
|
14
|
+
|
|
15
|
+
Guarantees a set of unary numerical operators (-x, +x, abs(x)).
|
|
16
|
+
All operations are pure and return a new instance of the same type (Self).
|
|
17
|
+
"""
|
|
18
|
+
|
|
19
|
+
# ----------------------------------------
|
|
20
|
+
# Unary Sign Operations
|
|
21
|
+
# ----------------------------------------
|
|
22
|
+
def __neg__(self) -> Self:
|
|
23
|
+
"""Mathematical negation. Returns a new instance with value (-self.value)."""
|
|
24
|
+
...
|
|
25
|
+
|
|
26
|
+
def __pos__(self) -> Self:
|
|
27
|
+
"""Unary plus. Returns a new instance with value (+self.value)."""
|
|
28
|
+
...
|
|
29
|
+
|
|
30
|
+
# ----------------------------------------
|
|
31
|
+
# Absolute Value
|
|
32
|
+
# ----------------------------------------
|
|
33
|
+
def __abs__(self) -> Self:
|
|
34
|
+
"""Returns a new instance with absolute value: abs(self.value)."""
|
|
35
|
+
...
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
from .ArithmeticProtocol import ArithmeticProtocol
|
|
2
|
+
from .BitwiseProtocol import BitwiseProtocol
|
|
3
|
+
from .ConversionProtocol import ConversionProtocol
|
|
4
|
+
from .InplaceProtocol import InplaceProtocol
|
|
5
|
+
from .UnaryProtocol import UnaryProtocol
|
|
6
|
+
|
|
7
|
+
_DESIGN_NOTES = """
|
|
8
|
+
# Numeric Dunder Protocols Sub-Package
|
|
9
|
+
|
|
10
|
+
## Purpose
|
|
11
|
+
Defines mathematical, bitwise, unary, and in-place operator protocols for underlying object values.
|
|
12
|
+
|
|
13
|
+
## Internal Components Registry
|
|
14
|
+
|
|
15
|
+
| Component | Type | Description |
|
|
16
|
+
| :------------------- | :------- | :--------------------------------------------------------------------------- |
|
|
17
|
+
| `ArithmeticProtocol` | Protocol | Standard and right-hand arithmetic operators (`+`, `-`, `*`, `/`, etc.). |
|
|
18
|
+
| `BitwiseProtocol` | Protocol | Bitwise logical operators (`&`, `|`, `^`, `<<`, `>>`, `~`). |
|
|
19
|
+
| `ConversionProtocol` | Protocol | Native type conversion (`int`, `float`, `complex`) and rounding math functions.|
|
|
20
|
+
| `InplaceProtocol` | Protocol | In-place arithmetic assignment operators (`+=`, `-=`, `*=`, etc.). |
|
|
21
|
+
| `UnaryProtocol` | Protocol | Unary mathematical sign and absolute value operators (`-x`, `+x`, `abs(x)`). |
|
|
22
|
+
"""
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
from .Operator import Operator
|
|
2
|
+
from .UnaryOperator import UnaryOperator
|
|
3
|
+
|
|
4
|
+
_DESIGN_NOTES = """
|
|
5
|
+
# Numeric Internal Types Sub-Package
|
|
6
|
+
|
|
7
|
+
## Purpose
|
|
8
|
+
Provides type aliases for standard binary and unary operator callables from Python's operator module.
|
|
9
|
+
|
|
10
|
+
## Internal Components Registry
|
|
11
|
+
|
|
12
|
+
| Component | Type | Description |
|
|
13
|
+
| :-------------- | :-------- | :--------------------------------------------------------------------------- |
|
|
14
|
+
| `Operator` | TypeAlias | Binary operator function accepting two arguments and returning a result. |
|
|
15
|
+
| `UnaryOperator` | TypeAlias | Unary operator function accepting a single argument and returning a result. |
|
|
16
|
+
"""
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
from typing import Protocol, runtime_checkable
|
|
2
|
+
# Outers
|
|
3
|
+
from ...base_class import SimpleMixinProtocol
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
@runtime_checkable
|
|
7
|
+
class ValueDisplayProtocol(
|
|
8
|
+
SimpleMixinProtocol,
|
|
9
|
+
Protocol
|
|
10
|
+
):
|
|
11
|
+
"""
|
|
12
|
+
Protocol for the ValueDisplay mixin (formerly ValueDisplayRepr).
|
|
13
|
+
|
|
14
|
+
Guarantees that the object represents itself externally as the raw value
|
|
15
|
+
it wraps. Overrides technical representation (__repr__) for debugging
|
|
16
|
+
and user-facing display (__str__) for text output.
|
|
17
|
+
"""
|
|
18
|
+
|
|
19
|
+
def __repr__(self) -> str:
|
|
20
|
+
"""
|
|
21
|
+
Returns a technical string representation for developers and logging
|
|
22
|
+
in the format: ClassName(value_repr).
|
|
23
|
+
"""
|
|
24
|
+
...
|
|
25
|
+
|
|
26
|
+
def __str__(self) -> str:
|
|
27
|
+
"""
|
|
28
|
+
Returns the clean, human-readable value converted to a string.
|
|
29
|
+
"""
|
|
30
|
+
...
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
from typing import Protocol, runtime_checkable, Any
|
|
2
|
+
# Outers
|
|
3
|
+
from ...base_class import SimpleMixinProtocol
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
@runtime_checkable
|
|
7
|
+
class ValueFormattingProtocol(
|
|
8
|
+
SimpleMixinProtocol,
|
|
9
|
+
Protocol
|
|
10
|
+
):
|
|
11
|
+
"""
|
|
12
|
+
Protocol for the Conversion mixin (formerly Representation).
|
|
13
|
+
|
|
14
|
+
Guarantees support for f-string formatting using metadata masks,
|
|
15
|
+
along with native conversion of the object to bytes and bool based on its internal value.
|
|
16
|
+
"""
|
|
17
|
+
|
|
18
|
+
def format(self, pattern: str | None = None) -> str:
|
|
19
|
+
"""
|
|
20
|
+
Formats the internal value of the instance according to the specified pattern
|
|
21
|
+
or mask defined in the metadata.
|
|
22
|
+
"""
|
|
23
|
+
...
|
|
24
|
+
|
|
25
|
+
def __format__(self, format_spec: str = "") -> str:
|
|
26
|
+
"""
|
|
27
|
+
Support for f-string formatting. Enables f"{obj:pattern}" syntax.
|
|
28
|
+
"""
|
|
29
|
+
...
|
|
30
|
+
|
|
31
|
+
def __bytes__(self) -> bytes:
|
|
32
|
+
"""
|
|
33
|
+
Native conversion of the instance's internal value to bytes.
|
|
34
|
+
Raises TypeError for incompatible types.
|
|
35
|
+
"""
|
|
36
|
+
...
|
|
37
|
+
|
|
38
|
+
def __bool__(self) -> bool:
|
|
39
|
+
"""
|
|
40
|
+
Returns the truth value of the object evaluated from its internal value.
|
|
41
|
+
"""
|
|
42
|
+
...
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
from .ValueDisplayProtocol import ValueDisplayProtocol
|
|
2
|
+
from .ValueFormattingProtocol import ValueFormattingProtocol
|
|
3
|
+
|
|
4
|
+
_DESIGN_NOTES = """
|
|
5
|
+
# Representation Dunder Protocols Sub-Package
|
|
6
|
+
|
|
7
|
+
## Purpose
|
|
8
|
+
Provides protocols for string representation, developer debugging outputs, f-string formatting, and truthiness evaluation.
|
|
9
|
+
|
|
10
|
+
## Internal Components Registry
|
|
11
|
+
|
|
12
|
+
| Component | Type | Description |
|
|
13
|
+
| :------------------------- | :------- | :--------------------------------------------------------------------------- |
|
|
14
|
+
| `ValueDisplayProtocol` | Protocol | Interface for string conversion (`__str__`) and developer repr (`__repr__`). |
|
|
15
|
+
| `ValueFormattingProtocol` | Protocol | Interface for f-string formatting, byte conversion, and boolean evaluation. |
|
|
16
|
+
"""
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
from typing import Protocol, runtime_checkable, Any, Self, TYPE_CHECKING
|
|
2
|
+
# outers
|
|
3
|
+
from ..core_mixins import InfrastructureProtocol
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ...alias_typings import ChangesTuple, ChangesDict
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
@runtime_checkable
|
|
10
|
+
class ImmutableMethodsProtocol(
|
|
11
|
+
InfrastructureProtocol,
|
|
12
|
+
Protocol
|
|
13
|
+
):
|
|
14
|
+
"""
|
|
15
|
+
Protocol for the ImmutableMethods mixin.
|
|
16
|
+
|
|
17
|
+
Guarantees a complete set of methods for immutable (functional) state transformations.
|
|
18
|
+
None of the methods mutate the existing instance; instead, they safely produce
|
|
19
|
+
a new updated instance (Self).
|
|
20
|
+
"""
|
|
21
|
+
|
|
22
|
+
# --- IMMUTABLE API - CORE ---
|
|
23
|
+
|
|
24
|
+
def with_constants(
|
|
25
|
+
self,
|
|
26
|
+
changes_tuple: "ChangesTuple | None" = None
|
|
27
|
+
) -> Self:
|
|
28
|
+
"""
|
|
29
|
+
Creates and returns a new immutable instance based on one or more
|
|
30
|
+
provided changes to constant elements.
|
|
31
|
+
"""
|
|
32
|
+
...
|
|
33
|
+
|
|
34
|
+
def with_constant(self, name: str, new_value: Any) -> Self:
|
|
35
|
+
"""
|
|
36
|
+
Creates and returns a new immutable instance with an updated value
|
|
37
|
+
for a single specific constant (atom) specified by its name.
|
|
38
|
+
"""
|
|
39
|
+
...
|
|
40
|
+
|
|
41
|
+
def with_composite(self, name: str, new_value: Any) -> Self:
|
|
42
|
+
"""
|
|
43
|
+
Creates and returns a new immutable instance with an updated value
|
|
44
|
+
for a single specific composite element specified by its name.
|
|
45
|
+
"""
|
|
46
|
+
...
|
|
47
|
+
|
|
48
|
+
# --- IMMUTABLE API - EXTENDED ---
|
|
49
|
+
|
|
50
|
+
def with_changes(self, changes_dict: "ChangesDict") -> Self:
|
|
51
|
+
"""
|
|
52
|
+
Ergonomic method allowing multiple constant change mappings to be provided
|
|
53
|
+
as a standard dictionary. Returns a new immutable instance.
|
|
54
|
+
"""
|
|
55
|
+
...
|
|
56
|
+
|
|
57
|
+
def with_value(self, new_value: Any) -> Self:
|
|
58
|
+
"""
|
|
59
|
+
Ergonomic alias for updating the main value of this entire instance.
|
|
60
|
+
Returns a new immutable instance.
|
|
61
|
+
"""
|
|
62
|
+
...
|
|
63
|
+
|
|
64
|
+
def duplicate(self) -> Self:
|
|
65
|
+
"""
|
|
66
|
+
Creates and returns an identical new copy (duplicate) of this immutable instance
|
|
67
|
+
while preserving its full current state.
|
|
68
|
+
"""
|
|
69
|
+
...
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
from typing import Protocol, runtime_checkable, Any, Callable
|
|
2
|
+
# Inners
|
|
3
|
+
from .ImmutableMethodsProtocol import ImmutableMethodsProtocol
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
@runtime_checkable
|
|
7
|
+
class ImmutableMethodsWithInnersProtocol(
|
|
8
|
+
ImmutableMethodsProtocol,
|
|
9
|
+
Protocol
|
|
10
|
+
):
|
|
11
|
+
"""
|
|
12
|
+
Protocol for the ImmutableInnerMethods mixin.
|
|
13
|
+
|
|
14
|
+
Guarantees the presence of dynamically generated immutable methods (setters)
|
|
15
|
+
for individual inner elements (e.g., `obj.with_node(value)`).
|
|
16
|
+
All such methods produce a new transformed instance (Self).
|
|
17
|
+
"""
|
|
18
|
+
|
|
19
|
+
def __getattr__(self, name: str) -> Callable[[Any], Any]:
|
|
20
|
+
"""
|
|
21
|
+
Dynamic fallback for accessing generated sub-node transformation methods
|
|
22
|
+
(e.g., accessing `obj.with_engine`).
|
|
23
|
+
|
|
24
|
+
Guarantees that invoking a method obtained this way results in a new,
|
|
25
|
+
updated immutable instance of the same type (Self).
|
|
26
|
+
"""
|
|
27
|
+
...
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
from .ImmutableMethodsProtocol import ImmutableMethodsProtocol
|
|
2
|
+
from .ImmutableMethodsWithInnersProtocol import ImmutableMethodsWithInnersProtocol
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
_DESIGN_NOTES = """
|
|
6
|
+
# Immutable Mixin Protocols Sub-Package
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
Defines protocols for functional, immutable state transformations that produce new updated
|
|
10
|
+
instances without mutating existing objects.
|
|
11
|
+
|
|
12
|
+
## Internal Components Registry
|
|
13
|
+
|
|
14
|
+
| Component | Type | Description |
|
|
15
|
+
| :------------------------------------ | :------- | :--------------------------------------------------------------------------- |
|
|
16
|
+
| `ImmutableMethodsProtocol` | Protocol | Core functional interface for immutable constants, composites, and copies. |
|
|
17
|
+
| `ImmutableMethodsWithInnersProtocol` | Protocol | Dynamic attribute fallback (`__getattr__`) for generated inner node setters. |
|
|
18
|
+
"""
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
from typing import Protocol, runtime_checkable, TYPE_CHECKING
|
|
2
|
+
# Outers
|
|
3
|
+
from ..core_mixins import NodesTupleProtocol
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from .stepper import StepperProtocol
|
|
7
|
+
from .internal_types import SteppersMap
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
@runtime_checkable
|
|
11
|
+
class EqualizerProtocol(
|
|
12
|
+
NodesTupleProtocol,
|
|
13
|
+
Protocol
|
|
14
|
+
):
|
|
15
|
+
"""
|
|
16
|
+
Protocol for the Equalizer mixin.
|
|
17
|
+
|
|
18
|
+
Guarantees the presence of numerical controllers (steppers) for all sub-node elements
|
|
19
|
+
of a composition. These controllers are generated dynamically based on a blueprint
|
|
20
|
+
and are accessible via dynamic properties with a designated suffix.
|
|
21
|
+
"""
|
|
22
|
+
|
|
23
|
+
# --- TECHNICAL ATTRIBUTES (Initialized in init_mixins) ---
|
|
24
|
+
|
|
25
|
+
# Maps internal element name_snake keys directly to their respective instance Steppers
|
|
26
|
+
_steppers: "SteppersMap"
|
|
27
|
+
|
|
28
|
+
# --- DYNAMIC PROPERTY ACCESS ---
|
|
29
|
+
|
|
30
|
+
def __getattr__(self, name: str) -> "StepperProtocol":
|
|
31
|
+
"""
|
|
32
|
+
Dynamic fallback for accessing generated stepper properties of individual nodes
|
|
33
|
+
(e.g., accessing `obj.node_stepper`).
|
|
34
|
+
|
|
35
|
+
Guarantees that every dynamically returned controller strictly conforms to StepperProtocol.
|
|
36
|
+
"""
|
|
37
|
+
...
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
from typing import Protocol, runtime_checkable, TYPE_CHECKING
|
|
2
|
+
# Outers
|
|
3
|
+
from ..base_class import SimpleMixinProtocol
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from .stepper import StepperProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
@runtime_checkable
|
|
10
|
+
class VolumeProtocol(
|
|
11
|
+
SimpleMixinProtocol,
|
|
12
|
+
Protocol
|
|
13
|
+
):
|
|
14
|
+
"""
|
|
15
|
+
Protocol for the Volume mixin.
|
|
16
|
+
|
|
17
|
+
Guarantees the presence of a numerical controller (stepper) bound directly
|
|
18
|
+
to the main value of the instance, enabling safe stepping and limit enforcement.
|
|
19
|
+
"""
|
|
20
|
+
|
|
21
|
+
# --- TECHNICAL ATTRIBUTES (Initialized in init_mixins) ---
|
|
22
|
+
_value_stepper: "StepperProtocol"
|
|
23
|
+
|
|
24
|
+
# --- PUBLIC API / PROPERTIES ---
|
|
25
|
+
|
|
26
|
+
@property
|
|
27
|
+
def value_stepper(self) -> "StepperProtocol":
|
|
28
|
+
"""
|
|
29
|
+
Returns the numerical controller (stepper) for safe manipulation
|
|
30
|
+
of the main value of this instance.
|
|
31
|
+
"""
|
|
32
|
+
...
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
from .EqualizerProtocol import EqualizerProtocol
|
|
2
|
+
from .VolumeProtocol import VolumeProtocol
|
|
3
|
+
|
|
4
|
+
_DESIGN_NOTES = """
|
|
5
|
+
# Numerical Mixin Protocols Sub-Package
|
|
6
|
+
|
|
7
|
+
## Purpose
|
|
8
|
+
Provides high-level protocols for numerical manipulation mixins, binding single-value steppers
|
|
9
|
+
or multi-node equalizer controllers to object instances.
|
|
10
|
+
|
|
11
|
+
## Internal Components Registry
|
|
12
|
+
|
|
13
|
+
| Component | Type | Description |
|
|
14
|
+
| :------------------ | :------- | :--------------------------------------------------------------------------- |
|
|
15
|
+
| `EqualizerProtocol` | Protocol | Interface for node compositions exposing dynamic stepper properties. |
|
|
16
|
+
| `VolumeProtocol` | Protocol | Interface for instances with a bound primary value stepper controller. |
|
|
17
|
+
"""
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
from typing import TypeAlias, TYPE_CHECKING
|
|
2
|
+
# Annotations
|
|
3
|
+
if TYPE_CHECKING:
|
|
4
|
+
from ..stepper import StepperProtocol
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
# Fast mapping for retrieving a service controller (Stepper) by subnode snake_case name
|
|
8
|
+
SteppersMap: TypeAlias = dict[str, "StepperProtocol"]
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
from .SteppersMap import SteppersMap
|
|
2
|
+
|
|
3
|
+
_DESIGN_NOTES = """
|
|
4
|
+
# Numerical Internal Types Sub-Package
|
|
5
|
+
|
|
6
|
+
## Purpose
|
|
7
|
+
Provides internal type aliases used by numerical mixins for stepper mapping and lookup.
|
|
8
|
+
|
|
9
|
+
## Internal Components Registry
|
|
10
|
+
|
|
11
|
+
| Component | Type | Description |
|
|
12
|
+
| :------------- | :-------- | :--------------------------------------------------------------------------- |
|
|
13
|
+
| `SteppersMap` | TypeAlias | Key-value mapping of snake_case node names to their respective Steppers. |
|
|
14
|
+
"""
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
from typing import Protocol, runtime_checkable, Any, TYPE_CHECKING
|
|
2
|
+
# Annotations
|
|
3
|
+
if TYPE_CHECKING:
|
|
4
|
+
from ....instance import SimpleInstanceLike
|
|
5
|
+
from .internal_types import StepValue, LimitAction
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
@runtime_checkable
|
|
9
|
+
class StepperProtocol(
|
|
10
|
+
Protocol
|
|
11
|
+
):
|
|
12
|
+
"""
|
|
13
|
+
Protocol for the Stepper service class.
|
|
14
|
+
|
|
15
|
+
Guarantees an encapsulated interface for incrementing, decrementing, and enforcing
|
|
16
|
+
limit restrictions on numerical values bound to an object instance.
|
|
17
|
+
"""
|
|
18
|
+
|
|
19
|
+
# --- TECHNICAL ATTRIBUTES (Initialized in __init__) ---
|
|
20
|
+
_instance: "SimpleInstanceLike"
|
|
21
|
+
_value_type: type
|
|
22
|
+
_step: Any
|
|
23
|
+
_up_limit: Any
|
|
24
|
+
_down_limit: Any
|
|
25
|
+
_up_limit_action: "LimitAction"
|
|
26
|
+
_down_limit_action: "LimitAction"
|
|
27
|
+
|
|
28
|
+
# --- PROPERTIES (Getters & Setters) ---
|
|
29
|
+
|
|
30
|
+
@property
|
|
31
|
+
def step(self) -> Any:
|
|
32
|
+
"""Step size by which the value shifts (matches the type of the instance value)."""
|
|
33
|
+
...
|
|
34
|
+
|
|
35
|
+
@step.setter
|
|
36
|
+
def step(self, value: Any) -> None:
|
|
37
|
+
...
|
|
38
|
+
|
|
39
|
+
@property
|
|
40
|
+
def up_limit(self) -> Any:
|
|
41
|
+
"""Upper limit beyond which the value cannot rise (or UNSET)."""
|
|
42
|
+
...
|
|
43
|
+
|
|
44
|
+
@up_limit.setter
|
|
45
|
+
def up_limit(self, value: Any) -> None:
|
|
46
|
+
...
|
|
47
|
+
|
|
48
|
+
@property
|
|
49
|
+
def down_limit(self) -> Any:
|
|
50
|
+
"""Lower limit below which the value cannot fall (or UNSET)."""
|
|
51
|
+
...
|
|
52
|
+
|
|
53
|
+
@down_limit.setter
|
|
54
|
+
def down_limit(self, value: Any) -> None:
|
|
55
|
+
...
|
|
56
|
+
|
|
57
|
+
@property
|
|
58
|
+
def up_limit_action(self) -> "LimitAction":
|
|
59
|
+
"""Callback/Action executed upon exceeding the upper limit (or UNSET)."""
|
|
60
|
+
...
|
|
61
|
+
|
|
62
|
+
@up_limit_action.setter
|
|
63
|
+
def up_limit_action(self, value: "LimitAction") -> None:
|
|
64
|
+
...
|
|
65
|
+
|
|
66
|
+
@property
|
|
67
|
+
def down_limit_action(self) -> "LimitAction":
|
|
68
|
+
"""Callback/Action executed upon dropping below the lower limit (or UNSET)."""
|
|
69
|
+
...
|
|
70
|
+
|
|
71
|
+
@down_limit_action.setter
|
|
72
|
+
def down_limit_action(self, value: "LimitAction") -> None:
|
|
73
|
+
...
|
|
74
|
+
|
|
75
|
+
# --- CONTROL AND NAVIGATION METHODS ---
|
|
76
|
+
|
|
77
|
+
def step_up(self, value: "StepValue" = ..., *, validate: bool = True, raise_exception: bool = False) -> Any:
|
|
78
|
+
"""
|
|
79
|
+
Shifts the bound instance's value upward by the defined step (or specified value).
|
|
80
|
+
Validates configured limits and triggers corresponding actions if threshold reached.
|
|
81
|
+
"""
|
|
82
|
+
...
|
|
83
|
+
|
|
84
|
+
def step_down(self, value: "StepValue" = ..., *, validate: bool = True, raise_exception: bool = False) -> Any:
|
|
85
|
+
"""
|
|
86
|
+
Shifts the bound instance's value downward by the defined step (or specified value).
|
|
87
|
+
Validates configured limits and triggers corresponding actions if threshold reached.
|
|
88
|
+
"""
|
|
89
|
+
...
|
|
90
|
+
|
|
91
|
+
def set_value(self, value: Any, *, validate: bool = True, raise_exception: bool = False) -> Any:
|
|
92
|
+
"""
|
|
93
|
+
Safely writes a new value to the instance with full validation of all limits and actions.
|
|
94
|
+
"""
|
|
95
|
+
...
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
from .StepperProtocol import StepperProtocol
|
|
2
|
+
|
|
3
|
+
_DESIGN_NOTES = """
|
|
4
|
+
# Stepper Protocol Sub-Package
|
|
5
|
+
|
|
6
|
+
## Purpose
|
|
7
|
+
Defines the protocol for encapsulated numerical stepping, limit checking, and threshold actions.
|
|
8
|
+
|
|
9
|
+
## Internal Components Registry
|
|
10
|
+
|
|
11
|
+
| Component | Type | Description |
|
|
12
|
+
| :---------------- | :------- | :--------------------------------------------------------------------------- |
|
|
13
|
+
| `StepperProtocol` | Protocol | Interface for stepping controller managing bounds and increment/decrement. |
|
|
14
|
+
"""
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
from .LimitAction import LimitAction
|
|
2
|
+
from .StepValue import StepValue
|
|
3
|
+
|
|
4
|
+
_DESIGN_NOTES = """
|
|
5
|
+
# Stepper Internal Types Sub-Package
|
|
6
|
+
|
|
7
|
+
## Purpose
|
|
8
|
+
Provides specialized type definitions for step value inputs and limit event callbacks.
|
|
9
|
+
|
|
10
|
+
## Internal Components Registry
|
|
11
|
+
|
|
12
|
+
| Component | Type | Description |
|
|
13
|
+
| :------------ | :-------- | :--------------------------------------------------------------------------- |
|
|
14
|
+
| `LimitAction` | TypeAlias | Action or callback invoked when a numerical limit threshold is reached. |
|
|
15
|
+
| `StepValue` | TypeAlias | Value shift amount supporting explicit numbers or Ellipsis (`...`) default. |
|
|
16
|
+
"""
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
from typing import Protocol, runtime_checkable, TYPE_CHECKING
|
|
2
|
+
# Outers
|
|
3
|
+
from ..base_class import SimpleMixinProtocol
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ...instance import SimpleInstanceLike
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
@runtime_checkable
|
|
10
|
+
class InnersPropertyProtocol(
|
|
11
|
+
SimpleMixinProtocol,
|
|
12
|
+
Protocol
|
|
13
|
+
):
|
|
14
|
+
"""
|
|
15
|
+
Protocol for the InnersProperty mixin.
|
|
16
|
+
|
|
17
|
+
Indicates that a composite instance was dynamically extended with properties
|
|
18
|
+
enabling convenient direct access to its inner elements (inners)
|
|
19
|
+
based on the blueprint definition.
|
|
20
|
+
"""
|
|
21
|
+
|
|
22
|
+
# The mixin itself has no slots; properties are generated at runtime.
|
|
23
|
+
|
|
24
|
+
def __getattr__(self, name: str) -> "SimpleInstanceLike":
|
|
25
|
+
"""
|
|
26
|
+
Dynamic fallback for accessing generated inner element properties.
|
|
27
|
+
|
|
28
|
+
Guarantees that any dynamically retrieved element (sub-composite or atom)
|
|
29
|
+
conforms to the base instance interface.
|
|
30
|
+
"""
|
|
31
|
+
...
|