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,169 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING, Any
|
|
2
|
+
from simplibs.sentinels import UNSET
|
|
3
|
+
# Outers
|
|
4
|
+
from ....._common_logic.constants import OWNER_CLASS, HISTORY
|
|
5
|
+
# Inners
|
|
6
|
+
from .validations import (
|
|
7
|
+
raise_unvalide_history_import_file,
|
|
8
|
+
raise_unvalide_owner_class_mismatch,
|
|
9
|
+
)
|
|
10
|
+
# Annotations
|
|
11
|
+
if TYPE_CHECKING:
|
|
12
|
+
from ......_core.protocols.mixins.state import HistoryProtocol
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
def import_history_from_dict(
|
|
16
|
+
self: "HistoryProtocol",
|
|
17
|
+
history_dict: dict[str, Any]
|
|
18
|
+
) -> None:
|
|
19
|
+
"""
|
|
20
|
+
Imports history from a portable dictionary format with owner_class validation.
|
|
21
|
+
"""
|
|
22
|
+
|
|
23
|
+
# 1. Validate input type
|
|
24
|
+
if not isinstance(history_dict, dict):
|
|
25
|
+
raise_unvalide_history_import_file(self, history_dict)
|
|
26
|
+
|
|
27
|
+
# 2. Validate owner class
|
|
28
|
+
owner_class = history_dict.get(OWNER_CLASS, UNSET)
|
|
29
|
+
if self.meta.owner_class != owner_class:
|
|
30
|
+
raise_unvalide_owner_class_mismatch(self, owner_class)
|
|
31
|
+
|
|
32
|
+
# 3. Backup previous history and state
|
|
33
|
+
backup_history = list(self._history)
|
|
34
|
+
backup_count = self._history_count
|
|
35
|
+
backup_index = self._history_index
|
|
36
|
+
|
|
37
|
+
# 4. Replace history
|
|
38
|
+
try:
|
|
39
|
+
# 4.1 Load new history and sync count
|
|
40
|
+
self._history = list(history_dict[HISTORY])
|
|
41
|
+
self._history_count = len(self._history)
|
|
42
|
+
|
|
43
|
+
# 4.2 Jump to the newest state
|
|
44
|
+
self.go_to_last()
|
|
45
|
+
|
|
46
|
+
# 4.3 Apply limit trimming (if configured)
|
|
47
|
+
if self.history_limit:
|
|
48
|
+
self.history_limit = self.history_limit
|
|
49
|
+
|
|
50
|
+
# 5. Restore previous state on failure
|
|
51
|
+
except Exception as e:
|
|
52
|
+
self._history = backup_history
|
|
53
|
+
self._history_count = backup_count
|
|
54
|
+
self._history_index = backup_index
|
|
55
|
+
self.go_to_last()
|
|
56
|
+
raise e
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
_DESIGN_NOTES = """
|
|
60
|
+
# import_history_from_dict
|
|
61
|
+
|
|
62
|
+
## Purpose
|
|
63
|
+
Imports a complete history structure from a portable dictionary format.
|
|
64
|
+
This function is the counterpart to `export_history_to_dict` and enables
|
|
65
|
+
history restoration, state replay, debugging, and cross‑process transfer.
|
|
66
|
+
|
|
67
|
+
## Architectural role
|
|
68
|
+
`import_history_from_dict` is used by:
|
|
69
|
+
|
|
70
|
+
- `History.import_history_from_dict`
|
|
71
|
+
- serialization pipelines
|
|
72
|
+
- debugging tools
|
|
73
|
+
- external state replay utilities
|
|
74
|
+
- migration and persistence layers
|
|
75
|
+
|
|
76
|
+
It provides a safe, validated mechanism for reconstructing history from
|
|
77
|
+
external sources.
|
|
78
|
+
|
|
79
|
+
## How it works
|
|
80
|
+
The function performs five deterministic steps:
|
|
81
|
+
|
|
82
|
+
### 1. Validate input type
|
|
83
|
+
Ensures the provided object is a dictionary.
|
|
84
|
+
Invalid inputs trigger a structured validation error.
|
|
85
|
+
|
|
86
|
+
### 2. Validate owner class
|
|
87
|
+
Checks that the dictionary belongs to the same class as the current instance.
|
|
88
|
+
This prevents accidental or malicious history injection from incompatible
|
|
89
|
+
objects.
|
|
90
|
+
|
|
91
|
+
### 3. Backup previous history and state
|
|
92
|
+
Creates a complete shallow copy of `_history` and captures `_history_count`
|
|
93
|
+
and `_history_index` so that the entire navigation subsystem state can be
|
|
94
|
+
atomically restored if the import fails.
|
|
95
|
+
|
|
96
|
+
### 4. Replace history and synchronize state
|
|
97
|
+
Attempts to load the new history:
|
|
98
|
+
|
|
99
|
+
- converts the imported history list to a mutable Python list,
|
|
100
|
+
- synchronizes `_history_count = len(_history)` to maintain subsystem invariants,
|
|
101
|
+
- calls `go_to_last()` to navigate to the newest entry and restore its snapshot,
|
|
102
|
+
- re-applies history limit trimming via the `history_limit` setter if configured.
|
|
103
|
+
|
|
104
|
+
All operations are performed inside a `try` block to guarantee transaction-like safety.
|
|
105
|
+
|
|
106
|
+
### 5. Restore previous state on failure
|
|
107
|
+
If any exception occurs during import:
|
|
108
|
+
|
|
109
|
+
- `_history`, `_history_count`, and `_history_index` are restored from backup,
|
|
110
|
+
- `go_to_last()` is invoked to guarantee that the instance snapshot reflects the original state,
|
|
111
|
+
- the original exception is re‑raised.
|
|
112
|
+
|
|
113
|
+
This ensures atomicity: either the import succeeds fully, or the instance
|
|
114
|
+
remains completely unchanged.
|
|
115
|
+
|
|
116
|
+
## Integration requirements
|
|
117
|
+
The function assumes the instance implements:
|
|
118
|
+
|
|
119
|
+
- **History internals**
|
|
120
|
+
`_history`, `_history_limit`, `_history_index`, `_history_count`
|
|
121
|
+
|
|
122
|
+
- **SnapshotMixin**
|
|
123
|
+
Provides `_restore_snapshot(snapshot)`.
|
|
124
|
+
|
|
125
|
+
- **Serialization metadata**
|
|
126
|
+
`meta.owner_class`
|
|
127
|
+
|
|
128
|
+
Without these components, history import cannot operate correctly.
|
|
129
|
+
|
|
130
|
+
## Why this function exists
|
|
131
|
+
History must be importable for:
|
|
132
|
+
|
|
133
|
+
- persistence,
|
|
134
|
+
- debugging,
|
|
135
|
+
- external analysis,
|
|
136
|
+
- replaying state transitions,
|
|
137
|
+
- transferring state between processes or machines.
|
|
138
|
+
|
|
139
|
+
This function encapsulates the minimal logic required to safely reconstruct
|
|
140
|
+
history from a portable representation while enforcing consistency across
|
|
141
|
+
all internal pointers and counters.
|
|
142
|
+
|
|
143
|
+
## Deterministic behavior
|
|
144
|
+
History import is guaranteed to be:
|
|
145
|
+
|
|
146
|
+
- validated,
|
|
147
|
+
- owner‑safe,
|
|
148
|
+
- atomic and rollback-safe,
|
|
149
|
+
- consistent with export format,
|
|
150
|
+
- synchronized with internal navigation pointers (`_history_count`, `_history_index`),
|
|
151
|
+
- compatible with undo/redo and navigation tools.
|
|
152
|
+
|
|
153
|
+
## Stability guarantee
|
|
154
|
+
Any change to this function would affect:
|
|
155
|
+
|
|
156
|
+
- serialization consistency,
|
|
157
|
+
- import behavior,
|
|
158
|
+
- debugging tools,
|
|
159
|
+
- replay mechanisms,
|
|
160
|
+
- history navigation.
|
|
161
|
+
|
|
162
|
+
Therefore, `import_history_from_dict` is treated as a **core invariant** of the
|
|
163
|
+
history subsystem.
|
|
164
|
+
|
|
165
|
+
## Notes
|
|
166
|
+
- This function is intentionally minimal and side‑effect‑free.
|
|
167
|
+
- It is not part of the public API; it is used internally by mixins.
|
|
168
|
+
- All structural logic is delegated to history internals and metadata.
|
|
169
|
+
"""
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
from .raise_unvalide_history_import_file import raise_unvalide_history_import_file
|
|
2
|
+
from .raise_unvalide_owner_class_mismatch import raise_unvalide_owner_class_mismatch
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
_DESIGN_NOTES = """
|
|
6
|
+
# Validations for History Transfer
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
Provides structured raise functions used by the history import/export pipeline.
|
|
10
|
+
These validations ensure that:
|
|
11
|
+
|
|
12
|
+
- the imported history container is a valid dictionary,
|
|
13
|
+
- the owner class of the imported history matches the current instance.
|
|
14
|
+
|
|
15
|
+
These checks protect the integrity of history restoration and prevent
|
|
16
|
+
cross‑component contamination.
|
|
17
|
+
|
|
18
|
+
## Components
|
|
19
|
+
|
|
20
|
+
| Component | Type | Description |
|
|
21
|
+
| :---------------------------------------| :--------| :--------------------------------------------------- |
|
|
22
|
+
| `raise_unvalide_history_import_file` | Function | Ensures the import container is a dictionary. |
|
|
23
|
+
| `raise_unvalide_owner_class_mismatch` | Function | Validates owner class identity during import. |
|
|
24
|
+
"""
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING, NoReturn
|
|
2
|
+
# Outers
|
|
3
|
+
from .......exceptions import SimpleRuntimeError
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ......._core.protocols.mixins.state import HistoryProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def raise_unvalide_history_import_file(
|
|
10
|
+
instance: "HistoryProtocol",
|
|
11
|
+
value: object,
|
|
12
|
+
) -> NoReturn:
|
|
13
|
+
"""
|
|
14
|
+
Raises an error when the provided history import container is not a dictionary.
|
|
15
|
+
"""
|
|
16
|
+
|
|
17
|
+
raise SimpleRuntimeError(
|
|
18
|
+
error_name="HISTORY IMPORT FORMAT ERROR",
|
|
19
|
+
label="history import container",
|
|
20
|
+
expected="A dictionary containing OWNER_CLASS and HISTORY fields.",
|
|
21
|
+
value=type(value).__name__,
|
|
22
|
+
problem=(
|
|
23
|
+
"Invalid history import format.",
|
|
24
|
+
"History import requires a dictionary structure."
|
|
25
|
+
),
|
|
26
|
+
context=(
|
|
27
|
+
f"History import attempted on instance '{type(instance).__name__}'.",
|
|
28
|
+
f"Provided value type: {type(value).__name__}"
|
|
29
|
+
),
|
|
30
|
+
how_to_fix=(
|
|
31
|
+
"Ensure the input is a dictionary.",
|
|
32
|
+
"Use `export_history_to_dict()` to generate a valid import structure.",
|
|
33
|
+
"Do not pass lists, tuples, strings, or other unsupported types."
|
|
34
|
+
),
|
|
35
|
+
exception=TypeError,
|
|
36
|
+
)
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
_DESIGN_NOTES = """
|
|
40
|
+
# raise_unvalide_history_import_file
|
|
41
|
+
|
|
42
|
+
## Purpose
|
|
43
|
+
Raises a structured error when the user attempts to import history from a value
|
|
44
|
+
that is not a dictionary.
|
|
45
|
+
|
|
46
|
+
## Why this validation exists
|
|
47
|
+
History import requires a strict dictionary format containing:
|
|
48
|
+
- OWNER_CLASS,
|
|
49
|
+
- HISTORY,
|
|
50
|
+
- optional metadata fields.
|
|
51
|
+
|
|
52
|
+
Passing anything else (list, tuple, string, None, etc.) would make the import
|
|
53
|
+
ambiguous or impossible.
|
|
54
|
+
|
|
55
|
+
Failing early ensures:
|
|
56
|
+
- predictable import behavior,
|
|
57
|
+
- safe restoration,
|
|
58
|
+
- clear diagnostics.
|
|
59
|
+
|
|
60
|
+
## Execution context
|
|
61
|
+
Used inside `import_history_from_dict` as the first validation step.
|
|
62
|
+
|
|
63
|
+
## Notes
|
|
64
|
+
- Pure raise function, no conditional logic.
|
|
65
|
+
- Used exclusively by the History mixin.
|
|
66
|
+
"""
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING, NoReturn, Any
|
|
2
|
+
# Outers
|
|
3
|
+
from .......exceptions import SimpleRuntimeError
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ......._core.protocols.mixins.state import HistoryProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def raise_unvalide_owner_class_mismatch(
|
|
10
|
+
instance: "HistoryProtocol",
|
|
11
|
+
got_owner_class: Any,
|
|
12
|
+
) -> NoReturn:
|
|
13
|
+
"""
|
|
14
|
+
Raises an error when the imported history belongs to a different owner class.
|
|
15
|
+
"""
|
|
16
|
+
expected_owner_class = instance.meta.owner_class
|
|
17
|
+
|
|
18
|
+
raise SimpleRuntimeError(
|
|
19
|
+
error_name="HISTORY OWNER CLASS MISMATCH",
|
|
20
|
+
label="owner_class",
|
|
21
|
+
expected=f"Owner class: {expected_owner_class}",
|
|
22
|
+
value=repr(got_owner_class),
|
|
23
|
+
problem=(
|
|
24
|
+
"Imported history belongs to a different class.",
|
|
25
|
+
"History snapshots must originate from the same component type."
|
|
26
|
+
),
|
|
27
|
+
context=(
|
|
28
|
+
f"History import attempted on instance '{type(instance).__name__}'.",
|
|
29
|
+
f"Expected owner class: {expected_owner_class}",
|
|
30
|
+
f"Got owner class: {got_owner_class!r}"
|
|
31
|
+
),
|
|
32
|
+
how_to_fix=(
|
|
33
|
+
"Ensure the imported dictionary was produced by the same class.",
|
|
34
|
+
"Use `export_history_to_dict()` on an instance of the correct type.",
|
|
35
|
+
"Do not mix histories between different components."
|
|
36
|
+
),
|
|
37
|
+
exception=ValueError,
|
|
38
|
+
)
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
_DESIGN_NOTES = """
|
|
42
|
+
# raise_unvalide_owner_class_mismatch
|
|
43
|
+
|
|
44
|
+
## Purpose
|
|
45
|
+
Raises a structured error when the user attempts to import history from a
|
|
46
|
+
different component class.
|
|
47
|
+
|
|
48
|
+
## Why this validation exists
|
|
49
|
+
Snapshots encode structural metadata tied to the component class.
|
|
50
|
+
Importing history from a different class would cause:
|
|
51
|
+
|
|
52
|
+
- corrupted state,
|
|
53
|
+
- invalid snapshot restoration,
|
|
54
|
+
- mismatched node ordering,
|
|
55
|
+
- unpredictable behavior.
|
|
56
|
+
|
|
57
|
+
Failing early ensures:
|
|
58
|
+
- structural safety,
|
|
59
|
+
- deterministic behavior,
|
|
60
|
+
- clear diagnostics.
|
|
61
|
+
|
|
62
|
+
## Execution context
|
|
63
|
+
Used inside `import_history_from_dict` immediately after validating the input
|
|
64
|
+
container.
|
|
65
|
+
|
|
66
|
+
## Notes
|
|
67
|
+
- Pure raise function, no conditional logic.
|
|
68
|
+
- Used exclusively by the History mixin.
|
|
69
|
+
"""
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
_DESIGN_NOTES = """
|
|
2
|
+
Settings subsystem for the Simple object library.
|
|
3
|
+
|
|
4
|
+
This package contains optional configuration modules that allow users to
|
|
5
|
+
customize certain aspects of the library’s behavior. The subsystem is
|
|
6
|
+
minimal by design and follows Python best practices for non-intrusive
|
|
7
|
+
configuration.
|
|
8
|
+
|
|
9
|
+
Available modules:
|
|
10
|
+
|
|
11
|
+
- logging: Provides the internal library logger and an optional callback
|
|
12
|
+
for reacting to value changes inside Simple objects.
|
|
13
|
+
|
|
14
|
+
Usage example:
|
|
15
|
+
|
|
16
|
+
import simplibs.object.settings.logging as simple_logging
|
|
17
|
+
|
|
18
|
+
# Enable debug logging
|
|
19
|
+
import logging
|
|
20
|
+
logging.getLogger("simple").setLevel(logging.DEBUG)
|
|
21
|
+
|
|
22
|
+
# Register a callback
|
|
23
|
+
simple_logging.on_value_change = lambda cls, value, event: print(
|
|
24
|
+
f"{cls.__name__}: {event} -> {value}"
|
|
25
|
+
)
|
|
26
|
+
|
|
27
|
+
## Purpose
|
|
28
|
+
The settings subsystem provides optional configuration modules for the
|
|
29
|
+
Simple object library. It is intentionally minimal and non-intrusive,
|
|
30
|
+
following best practices used by major Python libraries.
|
|
31
|
+
|
|
32
|
+
The subsystem does not define global configuration classes or mutable
|
|
33
|
+
singletons. Instead, it exposes small, focused modules that users may
|
|
34
|
+
import and configure explicitly.
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## Structure
|
|
39
|
+
|
|
40
|
+
| Module | Description |
|
|
41
|
+
| :--------| :----------------------------------------------------------------- |
|
|
42
|
+
| logging | Internal logger + optional callback for reacting to value changes. |
|
|
43
|
+
|
|
44
|
+
The subsystem may be extended in the future with additional modules
|
|
45
|
+
(e.g., debugging, profiling), but the current design keeps it lightweight
|
|
46
|
+
and easy to understand.
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## Philosophy
|
|
51
|
+
|
|
52
|
+
### 1. Explicit configuration
|
|
53
|
+
Users configure settings explicitly:
|
|
54
|
+
|
|
55
|
+
```python
|
|
56
|
+
import simplibs.object.settings.logging as simple_logging
|
|
57
|
+
simple_logging.on_value_change = ...
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
No hidden global state, no implicit initialization.
|
|
61
|
+
|
|
62
|
+
### 2. Non-intrusive behavior
|
|
63
|
+
The library never:
|
|
64
|
+
|
|
65
|
+
- configures logging handlers,
|
|
66
|
+
- modifies the root logger,
|
|
67
|
+
- sets logging levels,
|
|
68
|
+
- installs global hooks.
|
|
69
|
+
|
|
70
|
+
Users retain full control.
|
|
71
|
+
|
|
72
|
+
### 3. Minimal surface area
|
|
73
|
+
The `settings` package does not reexport modules.
|
|
74
|
+
This avoids ambiguity and keeps imports explicit:
|
|
75
|
+
|
|
76
|
+
```python
|
|
77
|
+
from simplibs.object.settings import logging # discouraged
|
|
78
|
+
from simplibs.object.settings import logging as simple_logging # explicit
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Explicit imports make the subsystem easier to maintain and reason about.
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
## Notes
|
|
86
|
+
- The subsystem is internal but safe for users to import.
|
|
87
|
+
- Modules inside `settings` are stable and predictable.
|
|
88
|
+
- The design avoids global mutable configuration objects.
|
|
89
|
+
- Logging is the only settings module currently provided.
|
|
90
|
+
"""
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
import logging
|
|
2
|
+
from typing import Any, TYPE_CHECKING, Callable
|
|
3
|
+
# Annotations
|
|
4
|
+
if TYPE_CHECKING:
|
|
5
|
+
from .._core.protocols.classes import SimpleClassType
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
# ----------------------------------------
|
|
9
|
+
# Internal library logger
|
|
10
|
+
# ----------------------------------------
|
|
11
|
+
_logger = logging.getLogger("simple")
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
# ----------------------------------------
|
|
15
|
+
# Optional callback for reacting to value changes
|
|
16
|
+
# ----------------------------------------
|
|
17
|
+
# Usage:
|
|
18
|
+
# import simplibs.object.settings.logging as simple_logging
|
|
19
|
+
# simple_logging.on_value_change = lambda cls, value, event: ...
|
|
20
|
+
on_value_change: Callable[["SimpleClassType", Any, str], None] | None = None
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
# ----------------------------------------
|
|
24
|
+
# Central logging entry point
|
|
25
|
+
# ----------------------------------------
|
|
26
|
+
def log_value_event(
|
|
27
|
+
cls: "SimpleClassType",
|
|
28
|
+
value: Any,
|
|
29
|
+
event: str
|
|
30
|
+
) -> None:
|
|
31
|
+
"""
|
|
32
|
+
Centralized logging function used by the entire Simple library.
|
|
33
|
+
|
|
34
|
+
Logs the event through the internal stdlib logger and optionally
|
|
35
|
+
triggers a user-defined callback.
|
|
36
|
+
"""
|
|
37
|
+
|
|
38
|
+
# 1. Stdlib logging
|
|
39
|
+
if _logger.isEnabledFor(logging.DEBUG):
|
|
40
|
+
_logger.debug(
|
|
41
|
+
"[%s] %s = %r",
|
|
42
|
+
event,
|
|
43
|
+
cls.__name__,
|
|
44
|
+
value
|
|
45
|
+
)
|
|
46
|
+
|
|
47
|
+
# 2. Optional user callback
|
|
48
|
+
if on_value_change is not None:
|
|
49
|
+
# noinspection PyCallingNonCallable
|
|
50
|
+
on_value_change(cls, value, event)
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
_DESIGN_NOTES = """
|
|
54
|
+
# Logging Subsystem
|
|
55
|
+
|
|
56
|
+
## Purpose
|
|
57
|
+
Provides a minimal, safe, and idiomatic logging interface for the Simple
|
|
58
|
+
object library. It integrates with Python’s standard logging module and
|
|
59
|
+
offers an optional callback mechanism for advanced users who want to react
|
|
60
|
+
to value changes inside Simple objects.
|
|
61
|
+
|
|
62
|
+
This module is intentionally lightweight and follows best practices used by
|
|
63
|
+
major Python libraries (requests, sqlalchemy, pydantic, fastapi).
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
## Architectural Role
|
|
68
|
+
The logging subsystem serves two purposes:
|
|
69
|
+
|
|
70
|
+
1. **Internal diagnostics**
|
|
71
|
+
- All internal logging goes through a single logger: `"simple"`.
|
|
72
|
+
- The library never configures handlers or levels — users control logging.
|
|
73
|
+
|
|
74
|
+
2. **User-defined reactions**
|
|
75
|
+
- The `on_value_change` callback allows users to hook into value changes
|
|
76
|
+
for debugging, monitoring, auditing, or custom behavior.
|
|
77
|
+
|
|
78
|
+
This design keeps the library predictable and non-intrusive while still
|
|
79
|
+
providing powerful extension points.
|
|
80
|
+
|
|
81
|
+
---
|
|
82
|
+
|
|
83
|
+
## Components
|
|
84
|
+
|
|
85
|
+
| Component | Type | Description |
|
|
86
|
+
| :---------------------- | :--------| :----------------------------------------------------------------- |
|
|
87
|
+
| `_logger` | Logger | Internal stdlib logger (`logging.getLogger("simple")`). |
|
|
88
|
+
| `on_value_change` | Callable | Optional callback triggered on value changes. |
|
|
89
|
+
| `log_value_event` | Function | Central logging entry point used by the entire library. |
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## Usage Examples
|
|
94
|
+
|
|
95
|
+
### Enable debug logging
|
|
96
|
+
```python
|
|
97
|
+
import logging
|
|
98
|
+
logging.getLogger("simple").setLevel(logging.DEBUG)
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### Add a custom handler
|
|
102
|
+
```python
|
|
103
|
+
handler = logging.FileHandler("simple.log")
|
|
104
|
+
logging.getLogger("simple").addHandler(handler)
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### Register a callback
|
|
108
|
+
```python
|
|
109
|
+
import simplibs.object.settings.logging as simple_logging
|
|
110
|
+
|
|
111
|
+
def my_callback(cls, value, event):
|
|
112
|
+
print(f"{cls.__name__}: {event} -> {value}")
|
|
113
|
+
|
|
114
|
+
simple_logging.on_value_change = my_callback
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
### What gets logged?
|
|
118
|
+
Any event triggered by Simple objects, such as:
|
|
119
|
+
|
|
120
|
+
- value assignment
|
|
121
|
+
- recalculation
|
|
122
|
+
- stepping
|
|
123
|
+
- normalization
|
|
124
|
+
- validation
|
|
125
|
+
|
|
126
|
+
---
|
|
127
|
+
|
|
128
|
+
## Notes
|
|
129
|
+
- The library **never** configures logging automatically.
|
|
130
|
+
- The library **never** modifies the root logger.
|
|
131
|
+
- The library **never** installs handlers.
|
|
132
|
+
- All logging is opt-in and fully controlled by the user.
|
|
133
|
+
- The callback mechanism is optional and disabled by default.
|
|
134
|
+
- This module is internal but safe to import and configure by users.
|
|
135
|
+
|
|
136
|
+
This subsystem is intentionally minimalistic, predictable, and fully aligned
|
|
137
|
+
with Python’s logging best practices.
|
|
138
|
+
"""
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
from .assert_simple_mixin import assert_simple_mixin
|
|
2
|
+
from .assert_simple_object import assert_simple_object
|
|
3
|
+
from .bulk_test import bulk_test
|
|
4
|
+
from .asserts import (
|
|
5
|
+
assert_calculate_value_method,
|
|
6
|
+
assert_class_inheritance,
|
|
7
|
+
assert_decompose_value_method,
|
|
8
|
+
assert_immutable_behavior,
|
|
9
|
+
assert_instance_creation,
|
|
10
|
+
assert_instance_hasattr,
|
|
11
|
+
assert_mixin_inheritance,
|
|
12
|
+
assert_mixin_instance_creation,
|
|
13
|
+
assert_mixins_slots_values,
|
|
14
|
+
assert_mutable_behavior,
|
|
15
|
+
assert_reactivity_downward,
|
|
16
|
+
assert_reactivity_upward,
|
|
17
|
+
assert_user_instance_creation,
|
|
18
|
+
assert_validate_method,
|
|
19
|
+
assert_value_change,
|
|
20
|
+
)
|
|
21
|
+
from .containers import (
|
|
22
|
+
InnerValue,
|
|
23
|
+
MixinCase,
|
|
24
|
+
ObjectCase,
|
|
25
|
+
TestMixin,
|
|
26
|
+
)
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
__all__ = (
|
|
30
|
+
# Top-Level Entry Points
|
|
31
|
+
"assert_simple_mixin",
|
|
32
|
+
"assert_simple_object",
|
|
33
|
+
"bulk_test",
|
|
34
|
+
# Containers
|
|
35
|
+
"InnerValue",
|
|
36
|
+
"MixinCase",
|
|
37
|
+
"ObjectCase",
|
|
38
|
+
"TestMixin",
|
|
39
|
+
# Detailed Asserts
|
|
40
|
+
"assert_calculate_value_method",
|
|
41
|
+
"assert_class_inheritance",
|
|
42
|
+
"assert_decompose_value_method",
|
|
43
|
+
"assert_immutable_behavior",
|
|
44
|
+
"assert_instance_creation",
|
|
45
|
+
"assert_instance_hasattr",
|
|
46
|
+
"assert_mixin_inheritance",
|
|
47
|
+
"assert_mixin_instance_creation",
|
|
48
|
+
"assert_mixins_slots_values",
|
|
49
|
+
"assert_mutable_behavior",
|
|
50
|
+
"assert_reactivity_downward",
|
|
51
|
+
"assert_reactivity_upward",
|
|
52
|
+
"assert_user_instance_creation",
|
|
53
|
+
"assert_validate_method",
|
|
54
|
+
"assert_value_change",
|
|
55
|
+
)
|
|
56
|
+
|
|
57
|
+
_DESIGN_NOTES = """
|
|
58
|
+
# Testing Sub-Package Root
|
|
59
|
+
|
|
60
|
+
## Purpose
|
|
61
|
+
Serves as the primary API interface for the `simplibs.object.testing` suite, exposing high-level suite runners,
|
|
62
|
+
dataclass case containers, individual assertion functions, and randomization fuzzing utilities.
|
|
63
|
+
|
|
64
|
+
## Internal Components Registry
|
|
65
|
+
|
|
66
|
+
| Component | Type | Description |
|
|
67
|
+
| :------------------------------ | :------- | :------------------------------------------------------------------------ |
|
|
68
|
+
| `assert_simple_mixin` | Function | Complete test suite execution runner for `SimpleMixin` targets. |
|
|
69
|
+
| `assert_simple_object` | Function | Complete test suite execution runner for `SimpleObject` targets. |
|
|
70
|
+
| `bulk_test` | Function | Executes a collection of test cases against target classes. |
|
|
71
|
+
| `InnerValue` | Class | Dataclass specifying nested leaf inner path and expected values. |
|
|
72
|
+
| `MixinCase` | Class | Dataclass container for mixin suite configuration parameters. |
|
|
73
|
+
| `ObjectCase` | Class | Dataclass container for full object suite configuration parameters. |
|
|
74
|
+
| `TestMixin` | Class | Abstract base class target for constructing mixin tests. |
|
|
75
|
+
| `assert_calculate_value_method` | Function | Asserts calculation behavior on computed leaves. |
|
|
76
|
+
| `assert_class_inheritance` | Function | Asserts base class inheritance hierarchy. |
|
|
77
|
+
| `assert_decompose_value_method` | Function | Asserts top-down value decomposition into inner nodes. |
|
|
78
|
+
| `assert_immutable_behavior` | Function | Asserts error handling on immutable/locked instance modifications. |
|
|
79
|
+
| `assert_instance_creation` | Function | Asserts default instance instantiation. |
|
|
80
|
+
| `assert_instance_hasattr` | Function | Asserts presence of mixin attributes on instances. |
|
|
81
|
+
| `assert_mixin_inheritance` | Function | Asserts mixin base class structure. |
|
|
82
|
+
| `assert_mixin_instance_creation`| Function | Asserts successful creation of mixin test targets. |
|
|
83
|
+
| `assert_mixins_slots_values` | Function | Inspects `__slots__` layout for memory safety. |
|
|
84
|
+
| `assert_mutable_behavior` | Function | Asserts standard mutable state assignments. |
|
|
85
|
+
| `assert_reactivity_downward` | Function | Asserts top-down reactive tree updates. |
|
|
86
|
+
| `assert_reactivity_upward` | Function | Asserts bottom-up reactive calculation updates. |
|
|
87
|
+
| `assert_user_instance_creation` | Function | Asserts instantiation with explicit input parameters. |
|
|
88
|
+
| `assert_validate_method` | Function | Asserts user-defined validation rule execution. |
|
|
89
|
+
| `assert_value_change` | Function | Asserts state mutation and value updates. |
|
|
90
|
+
"""
|