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,102 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
# Outers
|
|
3
|
+
from ...._common_logic.constants import VALUE
|
|
4
|
+
# Inners
|
|
5
|
+
from .validations import raise_snapshot_incompatible_error
|
|
6
|
+
# Annotations
|
|
7
|
+
if TYPE_CHECKING:
|
|
8
|
+
from ....._core.protocols.alias_typings import SnapshotTuple, NodesTuple, SnapshotDiffTuple
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
def compare_snapshots(
|
|
12
|
+
nodes_tuple: "NodesTuple",
|
|
13
|
+
snapshot1: "SnapshotTuple",
|
|
14
|
+
snapshot2: "SnapshotTuple",
|
|
15
|
+
*,
|
|
16
|
+
constants_only: bool = False,
|
|
17
|
+
) -> "SnapshotDiffTuple":
|
|
18
|
+
"""
|
|
19
|
+
Compares two snapshots and returns a tuple of (path, old_value, new_value)
|
|
20
|
+
for all nodes whose values differ. Optionally filters out composite nodes
|
|
21
|
+
when `constants_only=True`.
|
|
22
|
+
"""
|
|
23
|
+
|
|
24
|
+
diffs = []
|
|
25
|
+
|
|
26
|
+
try:
|
|
27
|
+
# 1. Iterate through nodes and both snapshots simultaneously
|
|
28
|
+
for (_, path), snap1_value, snap2_value in zip(nodes_tuple, snapshot1, snapshot2):
|
|
29
|
+
|
|
30
|
+
# 2. Skip composite nodes when constants_only=True
|
|
31
|
+
if constants_only and path[-1] == VALUE:
|
|
32
|
+
continue
|
|
33
|
+
|
|
34
|
+
# 3. Append differences
|
|
35
|
+
if snap1_value != snap2_value:
|
|
36
|
+
diffs.append((path, snap1_value, snap2_value))
|
|
37
|
+
|
|
38
|
+
return tuple(diffs)
|
|
39
|
+
|
|
40
|
+
except (ValueError, TypeError) as error:
|
|
41
|
+
raise_snapshot_incompatible_error(
|
|
42
|
+
nodes_tuple=nodes_tuple,
|
|
43
|
+
snapshot1=snapshot1,
|
|
44
|
+
snapshot2=snapshot2,
|
|
45
|
+
error=error,
|
|
46
|
+
)
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
_DESIGN_NOTES = """
|
|
50
|
+
# compare_snapshots
|
|
51
|
+
|
|
52
|
+
## Purpose
|
|
53
|
+
Compares two snapshots and returns a structured list of differences. Each
|
|
54
|
+
difference is represented as `(path, old_value, new_value)`, where `path`
|
|
55
|
+
identifies the node in the object tree. This function is used by history
|
|
56
|
+
tracking, immutability pipelines, debugging tools, and diffing utilities.
|
|
57
|
+
|
|
58
|
+
## Architectural role
|
|
59
|
+
Snapshot comparison is a core operation in the Simple system. It enables:
|
|
60
|
+
|
|
61
|
+
- detecting changes between two states,
|
|
62
|
+
- building history entries,
|
|
63
|
+
- validating immutability transitions,
|
|
64
|
+
- computing diffs for debugging and serialization,
|
|
65
|
+
- determining which nodes require recalculation.
|
|
66
|
+
|
|
67
|
+
The function relies on `nodes_tuple`, which provides a deterministic structural
|
|
68
|
+
representation of the object tree.
|
|
69
|
+
|
|
70
|
+
## Constants-only mode
|
|
71
|
+
When `constants_only=True`, composite nodes (identified by `path[-1] == VALUE`)
|
|
72
|
+
are ignored. This mode is used by immutability pipelines where only leaf-level
|
|
73
|
+
changes matter.
|
|
74
|
+
|
|
75
|
+
## Error handling
|
|
76
|
+
Snapshot comparison requires both snapshots to:
|
|
77
|
+
|
|
78
|
+
- be iterable,
|
|
79
|
+
- have the same length as `nodes_tuple`,
|
|
80
|
+
- contain raw values in the correct order.
|
|
81
|
+
|
|
82
|
+
If any of these conditions fail, Python raises `ValueError` or `TypeError`.
|
|
83
|
+
These are caught and delegated to `raise_snapshot_incompatible_error`, which
|
|
84
|
+
provides a structured diagnostic message.
|
|
85
|
+
|
|
86
|
+
This ensures that invalid snapshots never silently propagate through the system.
|
|
87
|
+
|
|
88
|
+
## Deterministic behavior
|
|
89
|
+
The comparison is deterministic because:
|
|
90
|
+
|
|
91
|
+
- `nodes_tuple` is stable,
|
|
92
|
+
- traversal order is fixed,
|
|
93
|
+
- snapshots are positional,
|
|
94
|
+
- diff output preserves node order.
|
|
95
|
+
|
|
96
|
+
This determinism is essential for history tracking and immutability logic.
|
|
97
|
+
|
|
98
|
+
## Notes
|
|
99
|
+
- This function is intentionally minimal and side-effect-free.
|
|
100
|
+
- All structural logic is delegated to `nodes_tuple`.
|
|
101
|
+
- All error logic is delegated to `raise_snapshot_incompatible_error`.
|
|
102
|
+
"""
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
from .raise_snapshot_incompatible_error import raise_snapshot_incompatible_error
|
|
2
|
+
|
|
3
|
+
_DESIGN_NOTES = """
|
|
4
|
+
# Snapshot Validation Utilities
|
|
5
|
+
|
|
6
|
+
## Purpose
|
|
7
|
+
Provides structured diagnostic errors for snapshot comparison failures. Ensures
|
|
8
|
+
that invalid or incompatible snapshots never propagate through history or
|
|
9
|
+
immutability pipelines.
|
|
10
|
+
|
|
11
|
+
## Internal Components Registry
|
|
12
|
+
|
|
13
|
+
| Component | Type | Description |
|
|
14
|
+
| :-------------------------------- | :------- | :-------------------------------------------------- |
|
|
15
|
+
| `raise_snapshot_incompatible_error` | Function | Raises structured error for incompatible snapshots. |
|
|
16
|
+
"""
|
simplibs/object/mixins/core_mixins/_utils/snapshot/validations/raise_snapshot_incompatible_error.py
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING, NoReturn
|
|
2
|
+
# Outers
|
|
3
|
+
from ......exceptions import SimpleRuntimeError
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ......_core.protocols.alias_typings import SnapshotTuple, NodesTuple
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def raise_snapshot_incompatible_error(
|
|
10
|
+
nodes_tuple: "NodesTuple",
|
|
11
|
+
snapshot1: "SnapshotTuple",
|
|
12
|
+
snapshot2: "SnapshotTuple",
|
|
13
|
+
error: Exception,
|
|
14
|
+
) -> NoReturn:
|
|
15
|
+
"""
|
|
16
|
+
Raises a structured error when two snapshots cannot be compared due to
|
|
17
|
+
incompatible structure, length, or types.
|
|
18
|
+
"""
|
|
19
|
+
|
|
20
|
+
raise SimpleRuntimeError(
|
|
21
|
+
error_name="SNAPSHOT COMPARISON ERROR",
|
|
22
|
+
label="Incompatible snapshots",
|
|
23
|
+
expected=(
|
|
24
|
+
"Both snapshots must be iterable and must contain values matching "
|
|
25
|
+
"the length and structure of nodes_tuple."
|
|
26
|
+
),
|
|
27
|
+
value=(snapshot1, snapshot2),
|
|
28
|
+
problem=(
|
|
29
|
+
"The provided snapshots cannot be compared because their structure "
|
|
30
|
+
"does not match the expected node layout.",
|
|
31
|
+
f"Underlying error: {type(error).__name__}: {error}",
|
|
32
|
+
),
|
|
33
|
+
context="Snapshot comparison",
|
|
34
|
+
how_to_fix=(
|
|
35
|
+
"Ensure both snapshots were created using the same instance structure.",
|
|
36
|
+
"Verify that both snapshots have the same length as nodes_tuple.",
|
|
37
|
+
"Ensure snapshots contain only raw values, not nested structures.",
|
|
38
|
+
"If the instance structure changed, rebuild snapshots before comparing.",
|
|
39
|
+
),
|
|
40
|
+
exception=ValueError,
|
|
41
|
+
)
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
_DESIGN_NOTES = """
|
|
45
|
+
# raise_snapshot_incompatible_error
|
|
46
|
+
|
|
47
|
+
## Purpose
|
|
48
|
+
Raises a structured diagnostic error when two snapshots cannot be compared.
|
|
49
|
+
Snapshot comparison requires both snapshots to match the structure, length,
|
|
50
|
+
and ordering of `nodes_tuple`. Any deviation makes the comparison invalid.
|
|
51
|
+
|
|
52
|
+
This error consolidates all structural issues into a single, clear message.
|
|
53
|
+
|
|
54
|
+
## Why this error exists
|
|
55
|
+
Snapshot comparison is a core operation used by:
|
|
56
|
+
|
|
57
|
+
- history tracking,
|
|
58
|
+
- immutability pipelines,
|
|
59
|
+
- diffing logic,
|
|
60
|
+
- debugging tools.
|
|
61
|
+
|
|
62
|
+
If snapshots are malformed or incompatible, the system must fail fast with a
|
|
63
|
+
clear explanation. Python’s native `ValueError` and `TypeError` provide no
|
|
64
|
+
context, so a structured error is required.
|
|
65
|
+
|
|
66
|
+
## What incompatibility means
|
|
67
|
+
Snapshots are incompatible when:
|
|
68
|
+
|
|
69
|
+
- they have different lengths,
|
|
70
|
+
- they do not match the number of nodes,
|
|
71
|
+
- they contain non-iterable values,
|
|
72
|
+
- they contain nested structures,
|
|
73
|
+
- they were created from different instance shapes,
|
|
74
|
+
- the instance structure changed after snapshot creation.
|
|
75
|
+
|
|
76
|
+
## Architectural reasoning
|
|
77
|
+
Snapshot comparison is deterministic only when:
|
|
78
|
+
|
|
79
|
+
- `nodes_tuple` is stable,
|
|
80
|
+
- snapshot length matches node count,
|
|
81
|
+
- snapshot values correspond to node order.
|
|
82
|
+
|
|
83
|
+
This error ensures that invalid snapshots never silently propagate through
|
|
84
|
+
immutability or history pipelines.
|
|
85
|
+
|
|
86
|
+
## Diagnostic value
|
|
87
|
+
The error reports:
|
|
88
|
+
|
|
89
|
+
- both snapshots,
|
|
90
|
+
- the underlying Python exception,
|
|
91
|
+
- expected structure,
|
|
92
|
+
- actionable steps to fix the issue.
|
|
93
|
+
|
|
94
|
+
This makes debugging fast and predictable.
|
|
95
|
+
|
|
96
|
+
## Notes
|
|
97
|
+
- This is a pure `raise_...` function.
|
|
98
|
+
- It is used exclusively by snapshot comparison logic.
|
|
99
|
+
- All snapshot comparison failures funnel through this error.
|
|
100
|
+
|
|
101
|
+
"""
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
_DESIGN_NOTES = """
|
|
2
|
+
# Dunders Package Overview
|
|
3
|
+
|
|
4
|
+
The `dunders` package groups every mixin that implements a standard
|
|
5
|
+
Python "dunder" (double-underscore) protocol — the hooks Python itself
|
|
6
|
+
looks for to make an object iterable, comparable, callable, picklable,
|
|
7
|
+
printable, and so on. Each sub-package covers one coherent protocol
|
|
8
|
+
family.
|
|
9
|
+
|
|
10
|
+
This package does not re-export any components. All functionality is
|
|
11
|
+
accessed directly through the corresponding sub-packages.
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Sub-Packages
|
|
16
|
+
|
|
17
|
+
### 1. collections
|
|
18
|
+
Dict-like and iterable behavior over a composite's direct inners:
|
|
19
|
+
- iteration, reversed iteration, extended `dir()`,
|
|
20
|
+
- item access, assignment, containment, length,
|
|
21
|
+
- a combined bundle mixin for the full surface.
|
|
22
|
+
|
|
23
|
+
### 2. comparison
|
|
24
|
+
Value-based equality and magnitude ordering:
|
|
25
|
+
- `__eq__` / `__hash__`, mutability-aware hashing,
|
|
26
|
+
- `__lt__` / `__le__` / `__gt__` / `__ge__`.
|
|
27
|
+
|
|
28
|
+
### 3. generics
|
|
29
|
+
Generic-style subscript syntax for typing/IDE purposes:
|
|
30
|
+
- `__class_getitem__` fallback, no runtime effect.
|
|
31
|
+
|
|
32
|
+
### 4. interfaces
|
|
33
|
+
General-purpose Python object protocols:
|
|
34
|
+
- calling an instance like a function (`__call__`),
|
|
35
|
+
- context-manager support (`__enter__` / `__exit__`).
|
|
36
|
+
|
|
37
|
+
### 5. lifecycles
|
|
38
|
+
Object lifecycle protocols built on a shared snapshot foundation:
|
|
39
|
+
- `copy` / `deepcopy` support,
|
|
40
|
+
- full `pickle` support (`__reduce__`, `__getstate__`, `__setstate__`),
|
|
41
|
+
- a combined bundle mixin for both.
|
|
42
|
+
|
|
43
|
+
### 6. numeric
|
|
44
|
+
The full range of Python numeric protocols:
|
|
45
|
+
- binary and unary arithmetic, bitwise operations,
|
|
46
|
+
- in-place arithmetic,
|
|
47
|
+
- conversion to native Python numeric types.
|
|
48
|
+
|
|
49
|
+
### 7. representation
|
|
50
|
+
How an instance presents itself as text, bytes, and boolean:
|
|
51
|
+
- value-like `__repr__` / `__str__` (opt-in, constant-only),
|
|
52
|
+
- `format()` / `__format__` / `__bytes__` / `__bool__`.
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## Notes
|
|
57
|
+
- This package is internal and not intended for direct user interaction.
|
|
58
|
+
- Each sub-package is self-contained and exposes its own public API.
|
|
59
|
+
- Mixins here implement Python protocols specifically — see `others` for
|
|
60
|
+
mixins that add ecosystem-specific behavior instead.
|
|
61
|
+
"""
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
# Outers
|
|
3
|
+
from ...base_class import SimpleMixin
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ...._core.protocols.mixins.dunders import CollectionBaseProtocol
|
|
7
|
+
from ...._core.protocols.alias_typings import NamesSet, NamesTuple
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class CollectionBase(SimpleMixin):
|
|
11
|
+
"""
|
|
12
|
+
Base mapping mixin for composite instances.
|
|
13
|
+
Builds a frozen mapping {name_snake: inner_instance} and provides
|
|
14
|
+
the basic keys(), values(), items() API.
|
|
15
|
+
"""
|
|
16
|
+
|
|
17
|
+
# ----------------------------------------
|
|
18
|
+
# Basic interface
|
|
19
|
+
# ----------------------------------------
|
|
20
|
+
|
|
21
|
+
# Compatibility declaration
|
|
22
|
+
_composite_only = True
|
|
23
|
+
|
|
24
|
+
# Slot definition
|
|
25
|
+
__slots__ = ("_inners_name_set", "_inners_name_tuple")
|
|
26
|
+
|
|
27
|
+
# ----------------------------------------
|
|
28
|
+
# Initialization hook
|
|
29
|
+
# ----------------------------------------
|
|
30
|
+
|
|
31
|
+
# noinspection PyAttributeOutsideInit
|
|
32
|
+
def init_mixins(
|
|
33
|
+
self: "CollectionBaseProtocol"
|
|
34
|
+
) -> None:
|
|
35
|
+
"""
|
|
36
|
+
Initializes two immutable structures for working with inners:
|
|
37
|
+
|
|
38
|
+
- `_inners_name_tuple`: tuple of all name_snake keys in the
|
|
39
|
+
deterministic order defined by the blueprint. Serves as the
|
|
40
|
+
source for iteration, reversed(), keys(), values() and items().
|
|
41
|
+
|
|
42
|
+
- `_inners_name_set`: set of all name_snake keys. Used for fast
|
|
43
|
+
existence checks (O(1) lookup).
|
|
44
|
+
|
|
45
|
+
Both structures are derived only from direct inners and are
|
|
46
|
+
immutable for the entire lifetime of the instance.
|
|
47
|
+
"""
|
|
48
|
+
|
|
49
|
+
# 1. Tuple holding name_snake in exact order
|
|
50
|
+
self._inners_name_tuple: "NamesTuple" = tuple(
|
|
51
|
+
inner.meta.name_snake
|
|
52
|
+
for inner in self.meta.inners
|
|
53
|
+
)
|
|
54
|
+
|
|
55
|
+
# 2. Set for fast presence comparison
|
|
56
|
+
self._inners_name_set: "NamesSet" = set(self._inners_name_tuple)
|
|
57
|
+
|
|
58
|
+
# ----------------------------------------
|
|
59
|
+
# Methods - KEYS / VALUES / ITEMS
|
|
60
|
+
# ----------------------------------------
|
|
61
|
+
|
|
62
|
+
def keys(
|
|
63
|
+
self: "CollectionBaseProtocol"
|
|
64
|
+
) -> list[str]:
|
|
65
|
+
"""Returns a list of keys (name_snake) of all direct inners."""
|
|
66
|
+
return list(self._inners_name_tuple)
|
|
67
|
+
|
|
68
|
+
def values(
|
|
69
|
+
self: "CollectionBaseProtocol"
|
|
70
|
+
) -> list[object]:
|
|
71
|
+
"""Returns a list of values corresponding to each inner."""
|
|
72
|
+
return [
|
|
73
|
+
getattr(self, key)
|
|
74
|
+
for key in self._inners_name_tuple
|
|
75
|
+
]
|
|
76
|
+
|
|
77
|
+
def items(
|
|
78
|
+
self: "CollectionBaseProtocol"
|
|
79
|
+
) -> list[tuple[str, object]]:
|
|
80
|
+
"""Returns a list of (key, value) pairs for all inners."""
|
|
81
|
+
return [
|
|
82
|
+
(key, getattr(self, key))
|
|
83
|
+
for key in self._inners_name_tuple
|
|
84
|
+
]
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
_DESIGN_NOTES = """
|
|
88
|
+
# CollectionBase
|
|
89
|
+
|
|
90
|
+
## Purpose
|
|
91
|
+
Gives a composite instance basic "mapping" behavior — it starts to feel a
|
|
92
|
+
little like a read-only dict. Provides `keys()`, `values()`, `items()` over
|
|
93
|
+
the instance's direct inners (the parts it's composed of).
|
|
94
|
+
|
|
95
|
+
> For newcomers: a composite instance (e.g. `Person` made of `FirstName`
|
|
96
|
+
> and `LastName`) holds its inners as attributes. This mixin builds a
|
|
97
|
+
> familiar dict-like surface on top, so callers don't have to walk
|
|
98
|
+
> attributes manually.
|
|
99
|
+
|
|
100
|
+
## Compatibility
|
|
101
|
+
- `_composite_only = True` — only makes sense for composites. An atomic
|
|
102
|
+
`SimpleConstant` has no inners, so there is nothing to map.
|
|
103
|
+
|
|
104
|
+
## Logic
|
|
105
|
+
On `init_mixins`, the mixin computes and freezes two derived structures
|
|
106
|
+
once:
|
|
107
|
+
|
|
108
|
+
- `_inners_name_tuple` — ordered keys (`name_snake`), matching the
|
|
109
|
+
blueprint definition order. Source of truth for iteration and for the
|
|
110
|
+
order returned by `keys()` / `values()` / `items()`.
|
|
111
|
+
- `_inners_name_set` — same keys as a set, for O(1) membership checks
|
|
112
|
+
instead of a linear scan through the tuple.
|
|
113
|
+
|
|
114
|
+
Both are derived from direct inners only (not nested/deeper levels) and
|
|
115
|
+
never change again during the instance's lifetime — a one-time
|
|
116
|
+
computation, not something recalculated on every call.
|
|
117
|
+
|
|
118
|
+
> Why two structures for essentially the same data? The tuple is cheap to
|
|
119
|
+
> iterate and preserves order; the set is more expensive to build but
|
|
120
|
+
> cheap to query. The mixin trades a little memory for speed on both
|
|
121
|
+
> fronts.
|
|
122
|
+
|
|
123
|
+
## Notes
|
|
124
|
+
- `keys()`, `values()`, `items()` return fresh `list` objects, not views
|
|
125
|
+
like `dict` does — every call is a new copy.
|
|
126
|
+
- This is not a full `Mapping` (no `__getitem__`, `__len__`, `__iter__`,
|
|
127
|
+
etc.) — deliberately a minimal API, not a `dict` replacement. See
|
|
128
|
+
`Mapping` and `Iterable` for the rest.
|
|
129
|
+
"""
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
from collections.abc import Iterator
|
|
3
|
+
# Inners
|
|
4
|
+
from .CollectionBase import CollectionBase
|
|
5
|
+
# Annotations
|
|
6
|
+
if TYPE_CHECKING:
|
|
7
|
+
from ...._core.protocols.mixins.dunders.collections import IterableProtocol
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class Iterable(CollectionBase):
|
|
11
|
+
"""
|
|
12
|
+
Iteration API for composite instances.
|
|
13
|
+
Enables iteration, reverse iteration, and an extended dir() listing.
|
|
14
|
+
"""
|
|
15
|
+
|
|
16
|
+
# ----------------------------------------
|
|
17
|
+
# Basic interface
|
|
18
|
+
# ----------------------------------------
|
|
19
|
+
|
|
20
|
+
# Compatibility declaration
|
|
21
|
+
_composite_only = True
|
|
22
|
+
|
|
23
|
+
# Slot definition
|
|
24
|
+
__slots__ = ()
|
|
25
|
+
|
|
26
|
+
# ----------------------------------------
|
|
27
|
+
# Methods - ITER / REVERSED / DIR
|
|
28
|
+
# ----------------------------------------
|
|
29
|
+
|
|
30
|
+
def __iter__(
|
|
31
|
+
self: "IterableProtocol"
|
|
32
|
+
) -> Iterator[str]:
|
|
33
|
+
"""Iterates over the keys (name_snake) of all inners in defined order."""
|
|
34
|
+
return iter(self._inners_name_tuple)
|
|
35
|
+
|
|
36
|
+
def __reversed__(
|
|
37
|
+
self: "IterableProtocol"
|
|
38
|
+
) -> Iterator[str]:
|
|
39
|
+
"""Returns a reverse iterator over the inner keys."""
|
|
40
|
+
return reversed(self._inners_name_tuple)
|
|
41
|
+
|
|
42
|
+
def __dir__(
|
|
43
|
+
self: "IterableProtocol"
|
|
44
|
+
) -> list[str]:
|
|
45
|
+
"""Extends the attribute listing with the inner keys."""
|
|
46
|
+
base = list(object.__dir__(self))
|
|
47
|
+
base += list(self._inners_name_tuple)
|
|
48
|
+
return sorted(set(base))
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
_DESIGN_NOTES = """
|
|
52
|
+
# Iterable
|
|
53
|
+
|
|
54
|
+
## Purpose
|
|
55
|
+
Makes a composite instance iterable the way Python programmers expect:
|
|
56
|
+
`for key in person`, `reversed(person)`, and a `dir(person)` that also
|
|
57
|
+
shows the inner names — useful in a REPL or debugger.
|
|
58
|
+
|
|
59
|
+
> Note the iteration is over *keys* (name_snake), not values — mirroring
|
|
60
|
+
> how `for x in some_dict` iterates over dict keys, not items.
|
|
61
|
+
|
|
62
|
+
## Compatibility
|
|
63
|
+
- `_composite_only = True` — builds directly on `CollectionBase`'s
|
|
64
|
+
`_inners_name_tuple`, which only exists for composites.
|
|
65
|
+
|
|
66
|
+
## Logic
|
|
67
|
+
All three dunders are thin wrappers around the tuple already frozen by
|
|
68
|
+
`CollectionBase.init_mixins`:
|
|
69
|
+
|
|
70
|
+
- `__iter__` / `__reversed__` just forward to `iter()` / `reversed()` on
|
|
71
|
+
that tuple — no extra computation.
|
|
72
|
+
- `__dir__` merges the default `object.__dir__(self)` listing with the
|
|
73
|
+
inner keys, so autocomplete and `dir()` reveal the composite's
|
|
74
|
+
structure, not just its methods.
|
|
75
|
+
|
|
76
|
+
## Notes
|
|
77
|
+
- Combine with `Mapping` (see `Collection`) to get `obj[key]` access on
|
|
78
|
+
top of the keys this mixin lets you iterate.
|
|
79
|
+
- Inherits `_composite_only` from `CollectionBase` — declared again here
|
|
80
|
+
for clarity, not because the value changes.
|
|
81
|
+
"""
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING, Any
|
|
2
|
+
# Inners
|
|
3
|
+
from .CollectionBase import CollectionBase
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ...._core.protocols.mixins.dunders.collections import MappingProtocol
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
class Mapping(CollectionBase):
|
|
10
|
+
"""
|
|
11
|
+
Dict-like API for composite instances.
|
|
12
|
+
Provides access via obj[key], value assignment, and existence checks.
|
|
13
|
+
"""
|
|
14
|
+
|
|
15
|
+
# ----------------------------------------
|
|
16
|
+
# Basic interface
|
|
17
|
+
# ----------------------------------------
|
|
18
|
+
|
|
19
|
+
# Compatibility declaration
|
|
20
|
+
_composite_only = True
|
|
21
|
+
|
|
22
|
+
# Slot definition
|
|
23
|
+
__slots__ = ()
|
|
24
|
+
|
|
25
|
+
# ----------------------------------------
|
|
26
|
+
# Methods - LEN / CONTAINS / MISSING
|
|
27
|
+
# ----------------------------------------
|
|
28
|
+
|
|
29
|
+
def __len__(
|
|
30
|
+
self: "MappingProtocol"
|
|
31
|
+
) -> int:
|
|
32
|
+
"""Returns the number of direct inners."""
|
|
33
|
+
return len(self._inners_name_tuple)
|
|
34
|
+
|
|
35
|
+
def __contains__(
|
|
36
|
+
self: "MappingProtocol",
|
|
37
|
+
key: str
|
|
38
|
+
) -> bool:
|
|
39
|
+
"""Returns True if the composite contains an inner with the given key."""
|
|
40
|
+
return key in self._inners_name_set
|
|
41
|
+
|
|
42
|
+
def __missing__(
|
|
43
|
+
self: "MappingProtocol",
|
|
44
|
+
key: str
|
|
45
|
+
) -> None:
|
|
46
|
+
"""Raises KeyError with information about the available keys."""
|
|
47
|
+
raise KeyError(
|
|
48
|
+
f"Item '{key}' is not defined on {self.meta.class_name}. "
|
|
49
|
+
f"Available items: {self.keys()}"
|
|
50
|
+
)
|
|
51
|
+
|
|
52
|
+
# ----------------------------------------
|
|
53
|
+
# Methods - GETITEM / GET / SETITEM
|
|
54
|
+
# ----------------------------------------
|
|
55
|
+
|
|
56
|
+
def __getitem__(
|
|
57
|
+
self: "MappingProtocol",
|
|
58
|
+
key: str
|
|
59
|
+
):
|
|
60
|
+
"""Returns the value of an inner by key, or raises via __missing__."""
|
|
61
|
+
if key not in self._inners_name_set:
|
|
62
|
+
self.__missing__(key)
|
|
63
|
+
return getattr(self, key)
|
|
64
|
+
|
|
65
|
+
def get(
|
|
66
|
+
self: "MappingProtocol",
|
|
67
|
+
key: str,
|
|
68
|
+
default: Any = None
|
|
69
|
+
):
|
|
70
|
+
"""Safely returns the value of an inner, or default if the key doesn't exist."""
|
|
71
|
+
if key not in self._inners_name_set:
|
|
72
|
+
return default
|
|
73
|
+
return getattr(self, key)
|
|
74
|
+
|
|
75
|
+
def __setitem__(
|
|
76
|
+
self: "MappingProtocol",
|
|
77
|
+
key: str,
|
|
78
|
+
value: Any
|
|
79
|
+
):
|
|
80
|
+
"""Sets the value of an inner by key, if it exists."""
|
|
81
|
+
|
|
82
|
+
# 1. Check that we are not on an immutable object
|
|
83
|
+
if not self.__is_mutable__:
|
|
84
|
+
raise TypeError(
|
|
85
|
+
f"Immutable composite '{self.meta.class_name}' "
|
|
86
|
+
f"does not allow changing values via __setitem__."
|
|
87
|
+
)
|
|
88
|
+
|
|
89
|
+
# 2. Check that the key exists
|
|
90
|
+
if key not in self._inners_name_set:
|
|
91
|
+
self.__missing__(key)
|
|
92
|
+
|
|
93
|
+
# 3. Request the value change
|
|
94
|
+
# (May be blocked on a composite without decomposition - an
|
|
95
|
+
# exception is raised in that case)
|
|
96
|
+
setattr(self, key, value)
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
_DESIGN_NOTES = """
|
|
100
|
+
# Mapping
|
|
101
|
+
|
|
102
|
+
## Purpose
|
|
103
|
+
Gives a composite instance `dict`-style item access: `obj[key]`,
|
|
104
|
+
`obj[key] = value`, `key in obj`, `obj.get(key, default)`, `len(obj)`.
|
|
105
|
+
Built on top of the same frozen key set `CollectionBase` already prepared.
|
|
106
|
+
|
|
107
|
+
## Compatibility
|
|
108
|
+
- `_composite_only = True` — items only exist on composites (inners).
|
|
109
|
+
|
|
110
|
+
## Logic
|
|
111
|
+
- `__len__` / `__contains__` are direct lookups against
|
|
112
|
+
`_inners_name_tuple` / `_inners_name_set` — no extra work.
|
|
113
|
+
- `__getitem__` / `get()` both check key existence first; `__getitem__`
|
|
114
|
+
delegates the "not found" case to `__missing__` (which raises a
|
|
115
|
+
`KeyError` listing the available keys), while `get()` just returns the
|
|
116
|
+
given `default` instead of raising.
|
|
117
|
+
- `__setitem__` is guarded by mutability: on an immutable composite it
|
|
118
|
+
raises `TypeError` before even checking the key. On a mutable composite
|
|
119
|
+
it validates the key, then delegates to `setattr`, which means the
|
|
120
|
+
normal reactivity/validation pipeline for setting a value still runs —
|
|
121
|
+
this mixin adds syntax, not a parallel write path.
|
|
122
|
+
|
|
123
|
+
## Notes
|
|
124
|
+
- `__missing__` is the single place that decides what "key not found"
|
|
125
|
+
looks like — overriding just that method changes the error message
|
|
126
|
+
everywhere without touching `__getitem__` itself.
|
|
127
|
+
- A composite without decomposition logic can still reject a `setattr`
|
|
128
|
+
further down the pipeline — `__setitem__` only handles the
|
|
129
|
+
mutability/key-existence checks that are its own responsibility.
|
|
130
|
+
- Pairs naturally with `Iterable`; together they form `Collection`.
|
|
131
|
+
"""
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
from .CollectionBase import CollectionBase
|
|
2
|
+
from .Iterable import Iterable
|
|
3
|
+
from .Mapping import Mapping
|
|
4
|
+
from .main import Collection
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
_DESIGN_NOTES = """
|
|
8
|
+
# Collections Dunders
|
|
9
|
+
|
|
10
|
+
## Purpose
|
|
11
|
+
Gives composite instances dict-like and iterable behavior over their
|
|
12
|
+
direct inners — iteration, `len()`, item access, and the combined
|
|
13
|
+
`Collection` bundle.
|
|
14
|
+
|
|
15
|
+
## Components
|
|
16
|
+
|
|
17
|
+
| Component | Type | Description |
|
|
18
|
+
| :------------------ | :---- | :--------------------------------------------------------------- |
|
|
19
|
+
| `CollectionBase` | Mixin | Base mapping foundation — `keys()`, `values()`, `items()`. |
|
|
20
|
+
| `Iterable` | Mixin | `__iter__`, `__reversed__`, `__dir__` over inner keys. |
|
|
21
|
+
| `Mapping` | Mixin | `__getitem__`, `__setitem__`, `__contains__`, `__len__`, `get()`.|
|
|
22
|
+
| `Collection` | Mixin | Combines `Iterable` + `Mapping` (see `.main`). |
|
|
23
|
+
|
|
24
|
+
## Notes
|
|
25
|
+
- All components are `_composite_only` — atoms have no inners to
|
|
26
|
+
collect over.
|
|
27
|
+
- `Iterable` and `Mapping` share their frozen key set via `CollectionBase`,
|
|
28
|
+
computed once in `init_mixins`.
|
|
29
|
+
"""
|