simplibs-object 0.1.1__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.1.dist-info/METADATA +590 -0
- simplibs_object-0.1.1.dist-info/RECORD +580 -0
- simplibs_object-0.1.1.dist-info/WHEEL +5 -0
- simplibs_object-0.1.1.dist-info/licenses/LICENSE +21 -0
- simplibs_object-0.1.1.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
_DESIGN_NOTES = """
|
|
2
|
+
# _core Package Overview
|
|
3
|
+
|
|
4
|
+
The `_core` package contains the internal building blocks that power the
|
|
5
|
+
SimpleObject system. Each sub-package focuses on a specific part of the object
|
|
6
|
+
infrastructure: constants, metadata, composite logic, and property generation.
|
|
7
|
+
|
|
8
|
+
This package does not re-export any components. All functionality is accessed
|
|
9
|
+
directly through the corresponding sub-packages.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Sub-Packages
|
|
14
|
+
|
|
15
|
+
### 1. constant_methods
|
|
16
|
+
Implements the core logic used by `SimpleConstant` and `SimpleObject` for:
|
|
17
|
+
- type validation,
|
|
18
|
+
- user-defined validation,
|
|
19
|
+
- normalization,
|
|
20
|
+
- structured error handling.
|
|
21
|
+
|
|
22
|
+
This package defines the functional backbone of constant behavior.
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
### 2. metadata
|
|
27
|
+
Contains the metadata system used to describe and configure Simple classes.
|
|
28
|
+
Metadata defines:
|
|
29
|
+
- declared types,
|
|
30
|
+
- default values,
|
|
31
|
+
- inner structure,
|
|
32
|
+
- decomposability,
|
|
33
|
+
- logic and decomposition hooks.
|
|
34
|
+
|
|
35
|
+
Metadata is the central registry that binds user-defined class attributes with
|
|
36
|
+
runtime behavior.
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
### 3. object_methods
|
|
41
|
+
Implements the functional logic used by composite objects:
|
|
42
|
+
- parameter processing for `_logic`,
|
|
43
|
+
- composite value calculation,
|
|
44
|
+
- composite value decomposition,
|
|
45
|
+
- structured validation errors for object-level operations.
|
|
46
|
+
|
|
47
|
+
This package defines how composite objects behave at runtime.
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
### 4. property_builders
|
|
52
|
+
Generates instance-level properties for Simple classes:
|
|
53
|
+
- value getters and setters,
|
|
54
|
+
- inner element properties,
|
|
55
|
+
- composite property behavior,
|
|
56
|
+
- validation and normalization integration.
|
|
57
|
+
|
|
58
|
+
This package transforms metadata into actual Python properties on instances.
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
|
|
62
|
+
## Notes
|
|
63
|
+
- This package is internal and not intended for direct user interaction.
|
|
64
|
+
- Each sub-package is self-contained and exposes its own public API.
|
|
65
|
+
- The structure is designed for clarity, modularity, and predictable behavior.
|
|
66
|
+
"""
|
|
File without changes
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
from .validate_type import validate_type
|
|
2
|
+
from .validate import validate
|
|
3
|
+
from .normalize import normalize
|
|
4
|
+
from .bool_or_raise_validate_error import bool_or_raise_validate_error
|
|
5
|
+
|
|
6
|
+
_DESIGN_NOTES = """
|
|
7
|
+
# Constant Methods Sub-Package
|
|
8
|
+
|
|
9
|
+
## Purpose
|
|
10
|
+
Provides the core functional building blocks used by `SimpleConstant` and
|
|
11
|
+
`SimpleObject` classes to perform type validation, user-defined validation,
|
|
12
|
+
normalization, and structured error handling.
|
|
13
|
+
|
|
14
|
+
## Internal Components Registry
|
|
15
|
+
|
|
16
|
+
| Component | Type | Description |
|
|
17
|
+
| :------------------------------- | :------- | :------------------------------------------------------------------------- |
|
|
18
|
+
| `validate_type` | Function | Performs deterministic type validation based on metadata. |
|
|
19
|
+
| `validate` | Function | Executes the full validation pipeline (type + user-defined). |
|
|
20
|
+
| `normalize` | Function | Normalizes values, handles None rules, and enforces default semantics. |
|
|
21
|
+
| `bool_or_raise_validate_error` | Function | Helper for user-defined `_validate` methods to raise structured errors. |
|
|
22
|
+
"""
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
from typing import Any, TYPE_CHECKING
|
|
2
|
+
# Outers
|
|
3
|
+
from ....exceptions import SimpleRuntimeError
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ...protocols.classes import SimpleConstantProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def bool_or_raise_validate_error(
|
|
10
|
+
cls: "SimpleConstantProtocol",
|
|
11
|
+
value: Any,
|
|
12
|
+
problem: str,
|
|
13
|
+
*,
|
|
14
|
+
return_bool: bool = False,
|
|
15
|
+
) -> bool:
|
|
16
|
+
"""Internal implementation of the shared validation helper."""
|
|
17
|
+
|
|
18
|
+
# 1. Boolean mode — return False instead of raising
|
|
19
|
+
if return_bool:
|
|
20
|
+
return False
|
|
21
|
+
|
|
22
|
+
# 2. Raise a structured validation error
|
|
23
|
+
raise SimpleRuntimeError(
|
|
24
|
+
error_name="VALIDATION ERROR",
|
|
25
|
+
label="input_value",
|
|
26
|
+
value=value,
|
|
27
|
+
expected=f"Valid configuration for '{cls.__name__}'",
|
|
28
|
+
problem=problem,
|
|
29
|
+
how_to_fix=(
|
|
30
|
+
f"Ensure that the data provided to '{cls.__name__}' meets the validation criteria.",
|
|
31
|
+
f"The expected base type or format is '{cls.meta.value_type_name}'.",
|
|
32
|
+
),
|
|
33
|
+
context=f"Triggered inside custom validation of '{cls.__name__}'.",
|
|
34
|
+
exception=ValueError,
|
|
35
|
+
)
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
_DESIGN_NOTES = """
|
|
39
|
+
# bool_or_raise_validate_error
|
|
40
|
+
|
|
41
|
+
## Purpose
|
|
42
|
+
Provides a convenience helper for developers implementing custom validation
|
|
43
|
+
logic in the `_validate` method of constant classes. It allows users to write
|
|
44
|
+
simple, readable validation rules without manually constructing structured
|
|
45
|
+
exceptions.
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
## Behavior
|
|
50
|
+
1. **Boolean Mode**
|
|
51
|
+
- When `return_bool=True`, the function returns `False` instead of raising an
|
|
52
|
+
error.
|
|
53
|
+
- This supports the boolean-style validation pattern used throughout the
|
|
54
|
+
validation pipeline.
|
|
55
|
+
|
|
56
|
+
2. **Exception Mode**
|
|
57
|
+
- When `return_bool=False`, the function raises a structured `SimpleRuntimeError`
|
|
58
|
+
containing:
|
|
59
|
+
- the problematic value,
|
|
60
|
+
- a user-provided description of the issue (`problem`),
|
|
61
|
+
- expected type information,
|
|
62
|
+
- contextual information about where the error occurred.
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## Usage
|
|
67
|
+
This helper is intended to be used exclusively inside user-defined `_validate`
|
|
68
|
+
methods, for example:
|
|
69
|
+
|
|
70
|
+
```python
|
|
71
|
+
@classmethod
|
|
72
|
+
def _validate(cls, value, *, return_bool=False):
|
|
73
|
+
if value < 0:
|
|
74
|
+
return cls.bool_or_raise_validate_error(value, "Value must be non-negative.", return_bool=return_bool)
|
|
75
|
+
return True
|
|
76
|
+
"""
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
from typing import Any, TYPE_CHECKING
|
|
2
|
+
# Inners
|
|
3
|
+
from .validations import raise_missing_value_error
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ...protocols.classes import SimpleConstantProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def normalize(
|
|
10
|
+
cls: "SimpleConstantProtocol",
|
|
11
|
+
value: Any,
|
|
12
|
+
*,
|
|
13
|
+
process_none: bool = False,
|
|
14
|
+
) -> Any:
|
|
15
|
+
"""Normalizes a value according to constant metadata rules."""
|
|
16
|
+
|
|
17
|
+
# 1. Handle None
|
|
18
|
+
if value is None:
|
|
19
|
+
|
|
20
|
+
# 1.1 None is allowed only when explicitly requested
|
|
21
|
+
if process_none:
|
|
22
|
+
return cls.meta.default
|
|
23
|
+
|
|
24
|
+
# 1.2 Otherwise raise a structured error
|
|
25
|
+
raise_missing_value_error(cls)
|
|
26
|
+
|
|
27
|
+
# 2. Handle default value identity optimization
|
|
28
|
+
# noinspection PyBroadException
|
|
29
|
+
try:
|
|
30
|
+
# 2.1 If the value equals the default, return the default instance
|
|
31
|
+
if value == cls.meta.default:
|
|
32
|
+
return cls.meta.default
|
|
33
|
+
|
|
34
|
+
except Exception:
|
|
35
|
+
# 2.2 Non-comparable values fall through to validation
|
|
36
|
+
pass
|
|
37
|
+
|
|
38
|
+
# 3. Validate the value
|
|
39
|
+
cls.validate(value)
|
|
40
|
+
|
|
41
|
+
# 4. Return validated value
|
|
42
|
+
return value
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
_DESIGN_NOTES = """
|
|
46
|
+
# normalize
|
|
47
|
+
|
|
48
|
+
## Purpose
|
|
49
|
+
Normalizes incoming values for constant definitions. This function enforces the
|
|
50
|
+
rules for handling `None`, default values, and validation. It is used by both
|
|
51
|
+
constant and object classes whenever a value is assigned.
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## Why `None` is forbidden
|
|
56
|
+
The SimpleObject ecosystem does not allow `None` as a valid value. This is
|
|
57
|
+
intentional:
|
|
58
|
+
|
|
59
|
+
- Composite objects compute their value from inner elements.
|
|
60
|
+
- If any inner element were `None`, the composite value could not be computed.
|
|
61
|
+
- Metadata already prevents `None` from being used as a declared default.
|
|
62
|
+
- `normalize` enforces this rule at runtime for user-provided values.
|
|
63
|
+
|
|
64
|
+
The only exception is when `process_none=True`, which instructs the system to
|
|
65
|
+
replace `None` with the class’s default value.
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## Behavior
|
|
70
|
+
1. **Handling `None`**
|
|
71
|
+
- If `process_none=True`, return the default value.
|
|
72
|
+
- Otherwise, raise `raise_missing_value_error`.
|
|
73
|
+
|
|
74
|
+
2. **Default Value Optimization**
|
|
75
|
+
- If the provided value equals the default, return the default instance.
|
|
76
|
+
- This avoids unnecessary allocations and keeps identity stable.
|
|
77
|
+
|
|
78
|
+
3. **Validation**
|
|
79
|
+
- All non-default values are validated through the full validation pipeline.
|
|
80
|
+
|
|
81
|
+
4. **Return**
|
|
82
|
+
- Returns either the default instance or the validated value.
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## Notes
|
|
87
|
+
- This function is intentionally minimal; all diagnostics are delegated to
|
|
88
|
+
specialized error helpers.
|
|
89
|
+
- The public-facing docstring belongs to the class method `SimpleConstant.normalize`,
|
|
90
|
+
not to this internal helper.
|
|
91
|
+
- Composite objects reuse this normalization logic through their own pipelines.
|
|
92
|
+
"""
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
from typing import Any, NoReturn, TYPE_CHECKING
|
|
2
|
+
# Outers
|
|
3
|
+
from ....exceptions import SimpleObjectError
|
|
4
|
+
# Inners
|
|
5
|
+
from .validations import raise_unexpected_validation_error, raise_validation_error
|
|
6
|
+
# Annotations
|
|
7
|
+
if TYPE_CHECKING:
|
|
8
|
+
from ...protocols.classes import SimpleConstantProtocol
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
def validate(
|
|
12
|
+
cls: "SimpleConstantProtocol",
|
|
13
|
+
value: Any,
|
|
14
|
+
*,
|
|
15
|
+
return_bool: bool = False,
|
|
16
|
+
) -> bool | None | NoReturn:
|
|
17
|
+
"""Runs the full validation pipeline: type validation + user-defined validation."""
|
|
18
|
+
|
|
19
|
+
# 1. Run type validation and user-defined validation
|
|
20
|
+
try:
|
|
21
|
+
result = (
|
|
22
|
+
cls.validate_type(value, return_bool=return_bool)
|
|
23
|
+
and cls.meta.validate(value, return_bool=return_bool)
|
|
24
|
+
)
|
|
25
|
+
|
|
26
|
+
# 2. Handle exceptions raised during validation
|
|
27
|
+
except Exception as e:
|
|
28
|
+
|
|
29
|
+
# 2.1 Boolean mode — suppress errors and return False
|
|
30
|
+
if return_bool:
|
|
31
|
+
return False
|
|
32
|
+
|
|
33
|
+
# 2.2 Expected SimpleObjectError — re-raise unchanged
|
|
34
|
+
if isinstance(e, SimpleObjectError):
|
|
35
|
+
raise
|
|
36
|
+
|
|
37
|
+
# 2.3 Unexpected exception — wrap into a standardized error
|
|
38
|
+
raise_unexpected_validation_error(cls, value, e)
|
|
39
|
+
|
|
40
|
+
# 3. If validation returned False and we are not in boolean mode, raise error
|
|
41
|
+
if result is False and not return_bool:
|
|
42
|
+
raise_validation_error(cls, value)
|
|
43
|
+
|
|
44
|
+
# 4. Return boolean result
|
|
45
|
+
return result
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
_DESIGN_NOTES = """
|
|
49
|
+
# validate
|
|
50
|
+
|
|
51
|
+
## Purpose
|
|
52
|
+
Executes the complete validation pipeline for constant definitions. This pipeline
|
|
53
|
+
combines deterministic type validation with optional user-defined validation
|
|
54
|
+
logic (`_validate`). It ensures consistent behavior across all constant classes,
|
|
55
|
+
whether or not the user provides custom validation.
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## Pipeline Structure
|
|
60
|
+
1. **Type Validation**
|
|
61
|
+
- Performed via `cls.validate_type`.
|
|
62
|
+
- Ensures the value matches the type declared in metadata.
|
|
63
|
+
|
|
64
|
+
2. **User-Defined Validation**
|
|
65
|
+
- Performed via `cls.meta.validate`, which delegates to the class’s `_validate`
|
|
66
|
+
method.
|
|
67
|
+
- If the user does not override `_validate`, the default implementation
|
|
68
|
+
returns `True`, meaning “no additional validation”.
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## Exception Handling
|
|
73
|
+
- **Boolean Mode (`return_bool=True`)**
|
|
74
|
+
- All errors are suppressed.
|
|
75
|
+
- The function returns `False` for any failure.
|
|
76
|
+
|
|
77
|
+
- **Expected Errors (`SimpleObjectError`)**
|
|
78
|
+
- Re-raised unchanged.
|
|
79
|
+
- These represent structured, user-facing validation errors.
|
|
80
|
+
|
|
81
|
+
- **Unexpected Errors**
|
|
82
|
+
- Wrapped using `raise_unexpected_validation_error`.
|
|
83
|
+
- Ensures consistent error formatting even when user-defined validation
|
|
84
|
+
raises arbitrary exceptions.
|
|
85
|
+
|
|
86
|
+
- **Validation Result = False**
|
|
87
|
+
- Triggers `raise_validation_error`, indicating that validation failed without
|
|
88
|
+
raising an exception.
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
|
|
92
|
+
## Notes
|
|
93
|
+
- This function is intentionally minimal; all diagnostic detail is delegated to
|
|
94
|
+
the specialized error helpers.
|
|
95
|
+
- The default `_validate` method always returns `True`, allowing constants to
|
|
96
|
+
rely solely on type validation unless the user explicitly adds custom logic.
|
|
97
|
+
- The public-facing docstring belongs to the class method `SimpleConstant.validate`,
|
|
98
|
+
not to this internal helper.
|
|
99
|
+
"""
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
from typing import Any, NoReturn, TYPE_CHECKING
|
|
2
|
+
# Inners
|
|
3
|
+
from .validations import raise_type_error
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ...protocols.classes import SimpleConstantProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def validate_type(
|
|
10
|
+
cls: "SimpleConstantProtocol",
|
|
11
|
+
value: Any,
|
|
12
|
+
*,
|
|
13
|
+
return_bool: bool = False,
|
|
14
|
+
) -> bool | NoReturn:
|
|
15
|
+
"""Performs deterministic type validation based on class metadata."""
|
|
16
|
+
|
|
17
|
+
# 1. Happy path — value matches expected type
|
|
18
|
+
if isinstance(value, cls.meta.value_type):
|
|
19
|
+
return True
|
|
20
|
+
|
|
21
|
+
# 2. Boolean mode — return False instead of raising
|
|
22
|
+
if return_bool:
|
|
23
|
+
return False
|
|
24
|
+
|
|
25
|
+
# 3. Raise detailed type mismatch error
|
|
26
|
+
raise_type_error(cls, value)
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
_DESIGN_NOTES = """
|
|
31
|
+
# validate_type
|
|
32
|
+
|
|
33
|
+
## Purpose
|
|
34
|
+
Performs strict, deterministic type validation for constant definitions based on
|
|
35
|
+
the type declared in metadata (`meta.value_type`). This function is the first
|
|
36
|
+
step in the validation pipeline (`validate_type` → `validate` → `normalize`).
|
|
37
|
+
|
|
38
|
+
## Behavior
|
|
39
|
+
1. Accepts the value if it is an instance of the expected type.
|
|
40
|
+
2. Returns `False` when `return_bool=True`.
|
|
41
|
+
3. Raises a structured `SimpleRuntimeError` via `raise_type_error` otherwise.
|
|
42
|
+
|
|
43
|
+
## Notes
|
|
44
|
+
- This function is intentionally minimal; all diagnostic detail is delegated to
|
|
45
|
+
`raise_type_error`.
|
|
46
|
+
- The public-facing docstring belongs to the *class method* (`SimpleConstant.validate_type`),
|
|
47
|
+
not to this internal helper.
|
|
48
|
+
"""
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
from .raise_type_error import raise_type_error
|
|
2
|
+
from .raise_missing_value_error import raise_missing_value_error
|
|
3
|
+
from .raise_unexpected_validation_error import raise_unexpected_validation_error
|
|
4
|
+
from .raise_validation_error import raise_validation_error
|
|
5
|
+
|
|
6
|
+
_DESIGN_NOTES = """
|
|
7
|
+
# Constant Validation Errors Sub-Package
|
|
8
|
+
|
|
9
|
+
## Purpose
|
|
10
|
+
Contains all structured error generators used during constant validation and
|
|
11
|
+
normalization. These functions ensure consistent, user-facing diagnostics across
|
|
12
|
+
the entire validation pipeline.
|
|
13
|
+
|
|
14
|
+
## Internal Components Registry
|
|
15
|
+
|
|
16
|
+
| Component | Type | Description |
|
|
17
|
+
| :---------------------------------- | :------- | :------------------------------------------------------------------------- |
|
|
18
|
+
| `raise_type_error` | Function | Raised when a value does not match the declared type. |
|
|
19
|
+
| `raise_missing_value_error` | Function | Raised when None is provided where a valid value is required. |
|
|
20
|
+
| `raise_unexpected_validation_error` | Function | Wraps unexpected exceptions from user-defined validation logic. |
|
|
21
|
+
| `raise_validation_error` | Function | Raised when `_validate` returns False. |
|
|
22
|
+
"""
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import inspect
|
|
2
|
+
import ast
|
|
3
|
+
from typing import Callable
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
def _extract_clean_code_lines(
|
|
7
|
+
function: Callable,
|
|
8
|
+
) -> list[str]:
|
|
9
|
+
"""
|
|
10
|
+
Returns cleaned code lines from the body of a function:
|
|
11
|
+
- without the function header
|
|
12
|
+
- without decorators
|
|
13
|
+
- without docstring
|
|
14
|
+
- without comments
|
|
15
|
+
- each line preserved with original indentation
|
|
16
|
+
"""
|
|
17
|
+
|
|
18
|
+
# 1. Retrieve source code
|
|
19
|
+
source = inspect.getsource(function)
|
|
20
|
+
|
|
21
|
+
# 2. Parse into AST
|
|
22
|
+
tree = ast.parse(source)
|
|
23
|
+
|
|
24
|
+
# 3. Locate the first function definition
|
|
25
|
+
func_node = next(
|
|
26
|
+
node for node in ast.walk(tree)
|
|
27
|
+
if isinstance(node, ast.FunctionDef)
|
|
28
|
+
)
|
|
29
|
+
|
|
30
|
+
# 4. Split source into lines
|
|
31
|
+
lines = source.splitlines()
|
|
32
|
+
|
|
33
|
+
# 5. Determine body range
|
|
34
|
+
body_start = func_node.body[0].lineno - 1
|
|
35
|
+
body_end = func_node.body[-1].end_lineno
|
|
36
|
+
body_lines = lines[body_start:body_end]
|
|
37
|
+
|
|
38
|
+
# 6. Remove docstring if present
|
|
39
|
+
if (
|
|
40
|
+
isinstance(func_node.body[0], ast.Expr)
|
|
41
|
+
and isinstance(func_node.body[0].value, ast.Constant)
|
|
42
|
+
):
|
|
43
|
+
docstring_end = func_node.body[0].end_lineno - func_node.body[0].lineno + 1
|
|
44
|
+
body_lines = body_lines[docstring_end:]
|
|
45
|
+
|
|
46
|
+
# 7. Clean lines
|
|
47
|
+
code_line_list = []
|
|
48
|
+
for line in body_lines:
|
|
49
|
+
stripped = line.strip()
|
|
50
|
+
|
|
51
|
+
if not stripped:
|
|
52
|
+
continue
|
|
53
|
+
if stripped.startswith("#"):
|
|
54
|
+
continue
|
|
55
|
+
|
|
56
|
+
code_line_list.append(line)
|
|
57
|
+
|
|
58
|
+
return code_line_list
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
_DESIGN_NOTES = """
|
|
62
|
+
# extract_clean_code_lines
|
|
63
|
+
|
|
64
|
+
## Purpose
|
|
65
|
+
Extracts a clean, human-readable representation of the logical body of a Python
|
|
66
|
+
function. This is used primarily for error reporting, allowing users to see the
|
|
67
|
+
exact validation logic they wrote inside `_validate`.
|
|
68
|
+
|
|
69
|
+
## Behavior
|
|
70
|
+
- Retrieves the function’s source code using `inspect.getsource`.
|
|
71
|
+
- Parses the code into an AST to locate the function body.
|
|
72
|
+
- Removes:
|
|
73
|
+
- decorators
|
|
74
|
+
- the function header
|
|
75
|
+
- docstring
|
|
76
|
+
- comments
|
|
77
|
+
- empty lines
|
|
78
|
+
- Preserves original indentation and formatting of logical lines.
|
|
79
|
+
|
|
80
|
+
## Notes
|
|
81
|
+
- Intended exclusively for user-defined validation methods (`_validate`).
|
|
82
|
+
- If the source code cannot be retrieved (e.g., builtins, lambdas, REPL-defined
|
|
83
|
+
functions), the caller should fall back to a placeholder message.
|
|
84
|
+
- This function is used inside `raise_validation_error` to display the user’s
|
|
85
|
+
validation logic directly in the error message.
|
|
86
|
+
"""
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING, NoReturn
|
|
2
|
+
# Outers
|
|
3
|
+
from .....exceptions import SimpleRuntimeError
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ....protocols.classes import SimpleConstantProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def raise_missing_value_error(
|
|
10
|
+
cls: "SimpleConstantProtocol",
|
|
11
|
+
) -> NoReturn:
|
|
12
|
+
"""Raises an error when None is provided where a valid value is required."""
|
|
13
|
+
|
|
14
|
+
class_name = cls.__name__
|
|
15
|
+
expected_type = cls.meta.value_type_name
|
|
16
|
+
|
|
17
|
+
raise SimpleRuntimeError(
|
|
18
|
+
error_name="MISSING VALUE ERROR",
|
|
19
|
+
label="value",
|
|
20
|
+
value=None,
|
|
21
|
+
expected=f"A valid instance of type '{expected_type}' (not None)",
|
|
22
|
+
problem=f"The class '{class_name}' requires a concrete value, but received None.",
|
|
23
|
+
context=(
|
|
24
|
+
f"Normalization phase for '{class_name}' rejected a None value because "
|
|
25
|
+
f"None is not permitted in the SimpleObject ecosystem."
|
|
26
|
+
),
|
|
27
|
+
how_to_fix=(
|
|
28
|
+
"Provide a valid value or an instance of the required type.",
|
|
29
|
+
"If you want the system to automatically substitute the default value "
|
|
30
|
+
"when None is provided, call the method with 'process_none=True'.",
|
|
31
|
+
),
|
|
32
|
+
exception=ValueError,
|
|
33
|
+
)
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
_DESIGN_NOTES = """
|
|
37
|
+
# raise_missing_value_error
|
|
38
|
+
|
|
39
|
+
## Purpose
|
|
40
|
+
Signals that a `None` value was provided where a valid, non-null value is
|
|
41
|
+
required. This error is user-facing and explains why `None` cannot be accepted
|
|
42
|
+
during normalization.
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## Why `None` is forbidden
|
|
47
|
+
The SimpleObject ecosystem does not allow `None` as a valid runtime value:
|
|
48
|
+
|
|
49
|
+
- Composite objects compute their value from inner elements.
|
|
50
|
+
- If any inner element were `None`, the composite value could not be computed.
|
|
51
|
+
- Metadata prevents `None` from being used as a declared default.
|
|
52
|
+
- `normalize` enforces this rule at runtime for user-provided values.
|
|
53
|
+
|
|
54
|
+
The only exception is when `process_none=True`, which instructs the system to
|
|
55
|
+
replace `None` with the class’s default value.
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## Behavior
|
|
60
|
+
- Always raises a structured `SimpleRuntimeError`.
|
|
61
|
+
- Explains that the class requires a concrete value.
|
|
62
|
+
- Provides guidance on how to use `process_none=True` when appropriate.
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## Notes
|
|
67
|
+
- This function is used exclusively by `normalize`.
|
|
68
|
+
- The public-facing documentation belongs to `SimpleConstant.normalize`, not to
|
|
69
|
+
this internal helper.
|
|
70
|
+
- The error message is intentionally concise and user-oriented.
|
|
71
|
+
"""
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
from typing import Any, NoReturn, TYPE_CHECKING
|
|
2
|
+
# Outers
|
|
3
|
+
from .....exceptions import SimpleRuntimeError
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ....protocols.classes import SimpleConstantProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def raise_type_error(
|
|
10
|
+
cls: "SimpleConstantProtocol",
|
|
11
|
+
value: Any,
|
|
12
|
+
) -> NoReturn:
|
|
13
|
+
"""Raises a detailed user-facing type mismatch error."""
|
|
14
|
+
|
|
15
|
+
expected_types = cls.meta.value_type_name
|
|
16
|
+
class_name = cls.__name__
|
|
17
|
+
|
|
18
|
+
raise SimpleRuntimeError(
|
|
19
|
+
error_name="TYPE ERROR",
|
|
20
|
+
label="value",
|
|
21
|
+
value=value,
|
|
22
|
+
expected=f"Instance of type '{expected_types}'",
|
|
23
|
+
problem=(
|
|
24
|
+
f"The provided value does not match the required type for constant "
|
|
25
|
+
f"'{class_name}'."
|
|
26
|
+
),
|
|
27
|
+
context=(
|
|
28
|
+
f"Runtime type enforcement for '{class_name}' requires a value of "
|
|
29
|
+
f"type {expected_types}."
|
|
30
|
+
),
|
|
31
|
+
how_to_fix=(
|
|
32
|
+
f"Ensure that the provided value is an instance of: {expected_types}.",
|
|
33
|
+
"Check whether any unintended type conversion or transformation "
|
|
34
|
+
"occurs before this validation.",
|
|
35
|
+
),
|
|
36
|
+
exception=TypeError,
|
|
37
|
+
)
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
_DESIGN_NOTES = """
|
|
41
|
+
# raise_type_error
|
|
42
|
+
|
|
43
|
+
## Purpose
|
|
44
|
+
Signals that a value passed to a constant definition does not match the expected
|
|
45
|
+
type declared in the constant’s metadata. This error is user-facing and explains
|
|
46
|
+
why the value cannot be accepted.
|
|
47
|
+
|
|
48
|
+
## Behavior
|
|
49
|
+
- Retrieves the expected type name from metadata.
|
|
50
|
+
- Reports the mismatch between the provided value and the required type.
|
|
51
|
+
- Raises a structured `SimpleRuntimeError` with clear diagnostics and guidance.
|
|
52
|
+
|
|
53
|
+
## Notes
|
|
54
|
+
- This validation is part of the constant-level API (`validate_type`, `validate`,
|
|
55
|
+
`normalize`).
|
|
56
|
+
- The error does not instruct the developer to modify metadata; instead, it
|
|
57
|
+
informs the *user* that the provided value is incompatible.
|
|
58
|
+
- Type validation is deterministic and does not perform implicit conversions.
|
|
59
|
+
"""
|