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,23 @@
|
|
|
1
|
+
from .Call import Call
|
|
2
|
+
from .Context import ContextManager
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
_DESIGN_NOTES = """
|
|
6
|
+
# Interfaces Dunders
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
Gives Simple instances two general-purpose Python protocol interfaces:
|
|
10
|
+
calling the instance like a function, and using it as a context manager.
|
|
11
|
+
|
|
12
|
+
## Components
|
|
13
|
+
|
|
14
|
+
| Component | Type | Description |
|
|
15
|
+
| :------------------- | :---- | :----------------------------------------------------------- |
|
|
16
|
+
| `Call` | Mixin | `__call__` — syntactic sugar over the `with_any` change API. |
|
|
17
|
+
| `ContextManager` | Mixin | `__enter__` / `__exit__` — inert, no-op context support. |
|
|
18
|
+
|
|
19
|
+
## Notes
|
|
20
|
+
- Both mixins are universal — no compatibility restrictions on either.
|
|
21
|
+
- `ContextManager` never suppresses exceptions and never changes state;
|
|
22
|
+
it exists purely to allow `with obj:` usage.
|
|
23
|
+
"""
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
from typing import Any, TYPE_CHECKING
|
|
2
|
+
import copy as _copy
|
|
3
|
+
# Outers
|
|
4
|
+
from ...core_mixins import NodesDicts, Snapshot
|
|
5
|
+
from ..._common_logic.immutability import create_new_instance
|
|
6
|
+
# Annotations
|
|
7
|
+
if TYPE_CHECKING:
|
|
8
|
+
from ...._core.protocols.mixins.dunders.lifecycles import CopyableProtocol
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class Copyable(NodesDicts, Snapshot):
|
|
12
|
+
"""
|
|
13
|
+
Shared mixin for both mutable and immutable variants.
|
|
14
|
+
|
|
15
|
+
Mutable lifecycle:
|
|
16
|
+
- shallow copy via create_instance(validate=False)
|
|
17
|
+
- deep copy via create_instance(validate=False)
|
|
18
|
+
|
|
19
|
+
Immutable lifecycle:
|
|
20
|
+
- shallow copy via snapshot
|
|
21
|
+
- deep copy via deepcopy of the snapshot
|
|
22
|
+
"""
|
|
23
|
+
|
|
24
|
+
# ----------------------------------------
|
|
25
|
+
# Basic interface
|
|
26
|
+
# ----------------------------------------
|
|
27
|
+
|
|
28
|
+
# Slot definition
|
|
29
|
+
__slots__ = ()
|
|
30
|
+
|
|
31
|
+
# ----------------------------------------
|
|
32
|
+
# Methods - COPY / DEEPCOPY
|
|
33
|
+
# ----------------------------------------
|
|
34
|
+
|
|
35
|
+
def __copy__(
|
|
36
|
+
self: "CopyableProtocol"
|
|
37
|
+
) -> "CopyableProtocol":
|
|
38
|
+
"""
|
|
39
|
+
Creates and returns a shallow copy of this instance.
|
|
40
|
+
Reacts safely to the object's mutable/immutable mode.
|
|
41
|
+
"""
|
|
42
|
+
|
|
43
|
+
# 1. Build a snapshot
|
|
44
|
+
snapshot = self._build_snapshot()
|
|
45
|
+
|
|
46
|
+
# 2. Build and return the new instance
|
|
47
|
+
return create_new_instance(self, snapshot)
|
|
48
|
+
|
|
49
|
+
def __deepcopy__(
|
|
50
|
+
self: "CopyableProtocol",
|
|
51
|
+
memo: dict[int, Any]
|
|
52
|
+
) -> "CopyableProtocol":
|
|
53
|
+
"""
|
|
54
|
+
Creates and returns a deep copy of this instance.
|
|
55
|
+
The `memo` dict is used internally to track already-visited
|
|
56
|
+
objects, to avoid infinite recursion on cycles.
|
|
57
|
+
"""
|
|
58
|
+
|
|
59
|
+
# 1. Build a snapshot
|
|
60
|
+
snapshot = tuple(
|
|
61
|
+
_copy.deepcopy(v, memo)
|
|
62
|
+
for v in self._build_snapshot()
|
|
63
|
+
)
|
|
64
|
+
|
|
65
|
+
# 2. Build and return the new instance
|
|
66
|
+
return create_new_instance(self, snapshot)
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
_DESIGN_NOTES = """
|
|
70
|
+
# Copyable
|
|
71
|
+
|
|
72
|
+
## Purpose
|
|
73
|
+
Implements Python's standard `copy.copy()` / `copy.deepcopy()` protocol
|
|
74
|
+
(`__copy__` / `__deepcopy__`) for Simple instances, so they interoperate
|
|
75
|
+
with the built-in `copy` module the same way any other Python object
|
|
76
|
+
would.
|
|
77
|
+
|
|
78
|
+
## Compatibility
|
|
79
|
+
- No compatibility flags — works for both mutable and immutable
|
|
80
|
+
instances. The distinction between the two lifecycles isn't handled
|
|
81
|
+
here directly; it's absorbed by `_build_snapshot()` and
|
|
82
|
+
`create_new_instance()`, which already know how to build a correct copy
|
|
83
|
+
for either mode.
|
|
84
|
+
|
|
85
|
+
## Logic
|
|
86
|
+
Both dunders follow the same two-step shape:
|
|
87
|
+
1. Build a snapshot of the current state via `_build_snapshot()`
|
|
88
|
+
(inherited from `Snapshot`).
|
|
89
|
+
2. Feed that snapshot into `create_new_instance()` to produce the copy.
|
|
90
|
+
|
|
91
|
+
The only difference between shallow and deep copy is what happens to the
|
|
92
|
+
snapshot in between: `__deepcopy__` runs every value in the snapshot
|
|
93
|
+
through `copy.deepcopy(v, memo)` first, using the standard `memo` dict to
|
|
94
|
+
correctly handle shared references and cycles; `__copy__` uses the
|
|
95
|
+
snapshot as-is.
|
|
96
|
+
|
|
97
|
+
## Notes
|
|
98
|
+
- Depends on `NodesDicts` and `Snapshot` for `_build_snapshot()` — this
|
|
99
|
+
mixin doesn't rebuild that logic itself, it only orchestrates it.
|
|
100
|
+
- Named `Copyable` at the mixin level, but combined with pickle support
|
|
101
|
+
in the `Lifecycle` bundle mixin — the two protocols share the same
|
|
102
|
+
snapshot-based foundation.
|
|
103
|
+
"""
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
# Inners
|
|
3
|
+
from .PickleState import PickleState
|
|
4
|
+
from ._utils import rebuild_simple_instance
|
|
5
|
+
# Annotations
|
|
6
|
+
if TYPE_CHECKING:
|
|
7
|
+
from ...._core.protocols.mixins.dunders.lifecycles import PickleReduceProtocol
|
|
8
|
+
from ...._core.protocols.mixins.dunders.lifecycles.internal_types import PicklePlan
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class PickleReduce(PickleState):
|
|
12
|
+
"""
|
|
13
|
+
Provides an implementation of the pickle protocol (__reduce__).
|
|
14
|
+
|
|
15
|
+
Logic:
|
|
16
|
+
- Callable = rebuild_simple_instance helper function
|
|
17
|
+
- Arguments = (owner_class, mixins, is_constant, is_mutable, state)
|
|
18
|
+
|
|
19
|
+
PickleState ensures __getstate__/__setstate__ work through
|
|
20
|
+
to_dict/from_dict.
|
|
21
|
+
|
|
22
|
+
This mixin inherits from PickleState so it has access to the default
|
|
23
|
+
__getstate__ implementation, which relies on SerializationBase logic
|
|
24
|
+
and its to_dict() method. If a user needs __getstate__ to work
|
|
25
|
+
differently, they can simply override it with their own mixin, placed
|
|
26
|
+
above this one in the MRO, replacing the original implementation.
|
|
27
|
+
"""
|
|
28
|
+
|
|
29
|
+
# ----------------------------------------
|
|
30
|
+
# Basic interface
|
|
31
|
+
# ----------------------------------------
|
|
32
|
+
|
|
33
|
+
# Slot definition
|
|
34
|
+
__slots__ = ()
|
|
35
|
+
|
|
36
|
+
# ----------------------------------------
|
|
37
|
+
# Methods - REDUCE
|
|
38
|
+
# ----------------------------------------
|
|
39
|
+
|
|
40
|
+
def __reduce__(
|
|
41
|
+
self: "PickleReduceProtocol"
|
|
42
|
+
) -> "PicklePlan":
|
|
43
|
+
"""
|
|
44
|
+
Pickle protocol:
|
|
45
|
+
- callable: top-level helper rebuild_simple_instance
|
|
46
|
+
- args: configuration tuple required to reconstruct mutable/immutable instance
|
|
47
|
+
"""
|
|
48
|
+
return (
|
|
49
|
+
rebuild_simple_instance,
|
|
50
|
+
(
|
|
51
|
+
self.meta.owner_class,
|
|
52
|
+
self.__mixins__,
|
|
53
|
+
self.__is_constant__,
|
|
54
|
+
self.__is_mutable__,
|
|
55
|
+
self.__getstate__(),
|
|
56
|
+
),
|
|
57
|
+
)
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
_DESIGN_NOTES = """
|
|
61
|
+
# PickleReduce
|
|
62
|
+
|
|
63
|
+
## Purpose
|
|
64
|
+
Implements `__reduce__`, the top-level hook `pickle` calls first to learn
|
|
65
|
+
how to reconstruct an object: what callable to invoke and what arguments
|
|
66
|
+
to pass it.
|
|
67
|
+
|
|
68
|
+
## Compatibility
|
|
69
|
+
- No compatibility flags. Inherits from `PickleState` specifically to
|
|
70
|
+
reuse its `__getstate__` implementation — this mixin adds the
|
|
71
|
+
`__reduce__` layer on top rather than duplicating state logic.
|
|
72
|
+
|
|
73
|
+
## Logic
|
|
74
|
+
`__reduce__` returns a 2-tuple:
|
|
75
|
+
1. `rebuild_simple_instance` — static, module-level factory function capable of
|
|
76
|
+
rebuilding dynamically compiled instance classes.
|
|
77
|
+
2. `(owner_class, mixins, is_constant, is_mutable, state)` — tuple of parameters
|
|
78
|
+
and the saved state produced by `PickleState` via `to_dict()`.
|
|
79
|
+
|
|
80
|
+
This design guarantees seamless unpickling for both mutable and immutable instances
|
|
81
|
+
without relying on in-place `__setstate__` side effects from Python's standard
|
|
82
|
+
deserializer.
|
|
83
|
+
|
|
84
|
+
## Notes
|
|
85
|
+
- To customize pickling behavior, override `__getstate__` in a mixin
|
|
86
|
+
placed above this one in the MRO — `__reduce__` itself rarely needs to
|
|
87
|
+
change.
|
|
88
|
+
"""
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING
|
|
2
|
+
# Outers
|
|
3
|
+
from ...core_mixins import Serialization
|
|
4
|
+
# Annotations
|
|
5
|
+
if TYPE_CHECKING:
|
|
6
|
+
from ...._core.protocols.mixins.dunders.lifecycles import PickleStateProtocol
|
|
7
|
+
from ...._core.protocols.alias_typings import StateDict
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class PickleState(Serialization):
|
|
11
|
+
"""
|
|
12
|
+
Mixin providing pickle/unpickle behavior based on to_dict()/from_dict().
|
|
13
|
+
|
|
14
|
+
This mixin implements the __getstate__ and __setstate__ dunders so
|
|
15
|
+
that serialization happens through a readable dict (to_dict) and
|
|
16
|
+
deserialization through the from_dict method. This keeps pickling
|
|
17
|
+
stable, readable, and independent of the object's internal
|
|
18
|
+
representation.
|
|
19
|
+
|
|
20
|
+
Requirements:
|
|
21
|
+
- The class MUST provide a from_dict() method (from
|
|
22
|
+
MutableSerialization or ImmutableSerialization).
|
|
23
|
+
- The mixin works both for mutable instances (in-place mutation) and
|
|
24
|
+
immutable instances (from_dict returns a new instance, which pickle
|
|
25
|
+
automatically uses).
|
|
26
|
+
"""
|
|
27
|
+
|
|
28
|
+
# ----------------------------------------
|
|
29
|
+
# Basic interface
|
|
30
|
+
# ----------------------------------------
|
|
31
|
+
|
|
32
|
+
# Slot definition
|
|
33
|
+
__slots__ = ()
|
|
34
|
+
|
|
35
|
+
# ----------------------------------------
|
|
36
|
+
# Methods - GETSTATE / SETSTATE
|
|
37
|
+
# ----------------------------------------
|
|
38
|
+
|
|
39
|
+
def __getstate__(
|
|
40
|
+
self: "PickleStateProtocol"
|
|
41
|
+
) -> "StateDict":
|
|
42
|
+
"""
|
|
43
|
+
Returns the instance's state as a dict via to_dict().
|
|
44
|
+
|
|
45
|
+
Pickle stores this dict as the object's representation. The
|
|
46
|
+
benefit is that serialization is stable, readable, and
|
|
47
|
+
independent of the instance's internal and private attributes.
|
|
48
|
+
"""
|
|
49
|
+
return self.to_dict()
|
|
50
|
+
|
|
51
|
+
def __setstate__(
|
|
52
|
+
self: "PickleStateProtocol",
|
|
53
|
+
state: "StateDict"
|
|
54
|
+
) -> None:
|
|
55
|
+
"""
|
|
56
|
+
Restores the instance's state from a dict via from_dict().
|
|
57
|
+
|
|
58
|
+
Checks whether the class provides a from_dict() method. If not,
|
|
59
|
+
raises TypeError with a clear explanation. For mutable instances,
|
|
60
|
+
the state is restored directly into self. For immutable
|
|
61
|
+
instances, from_dict() returns a new instance, which pickle
|
|
62
|
+
automatically uses as the resulting object.
|
|
63
|
+
"""
|
|
64
|
+
if not hasattr(self.__class__, "from_dict"):
|
|
65
|
+
raise TypeError(
|
|
66
|
+
f"{self.__class__.__name__} requires a from_dict() method "
|
|
67
|
+
f"(provided by MutableSerialization or ImmutableSerialization)."
|
|
68
|
+
)
|
|
69
|
+
|
|
70
|
+
self.from_dict(state)
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
_DESIGN_NOTES = """
|
|
74
|
+
# PickleState
|
|
75
|
+
|
|
76
|
+
## Purpose
|
|
77
|
+
Bridges the `pickle` module's `__getstate__`/`__setstate__` hooks to the
|
|
78
|
+
Simple ecosystem's own `to_dict()`/`from_dict()` serialization, so pickled
|
|
79
|
+
data is a readable dict rather than an opaque dump of internal attributes.
|
|
80
|
+
|
|
81
|
+
## Compatibility
|
|
82
|
+
- No compatibility flags, but has a hard runtime requirement: the class
|
|
83
|
+
must provide `from_dict()` (supplied by `MutableSerialization` or
|
|
84
|
+
`ImmutableSerialization`). Missing it raises a `TypeError` with a clear
|
|
85
|
+
message rather than failing obscurely inside `pickle`.
|
|
86
|
+
|
|
87
|
+
## Logic
|
|
88
|
+
- `__getstate__` simply returns `self.to_dict()` — pickle stores that
|
|
89
|
+
dict as the object's saved state.
|
|
90
|
+
- `__setstate__` first checks `from_dict` exists, then calls it with the
|
|
91
|
+
restored dict:
|
|
92
|
+
- **Mutable** instances apply the state in place onto `self`.
|
|
93
|
+
- **Immutable** instances have `from_dict()` return a brand-new
|
|
94
|
+
instance, which `pickle` transparently swaps in as the unpickled
|
|
95
|
+
result — the caller never has to know this happened.
|
|
96
|
+
|
|
97
|
+
## Notes
|
|
98
|
+
- This mixin is the foundation `PickleReduce` builds on: it supplies
|
|
99
|
+
`__getstate__`, which `PickleReduce.__reduce__` calls to fill the
|
|
100
|
+
"state" slot of the pickle protocol.
|
|
101
|
+
- Overriding `__getstate__`/`__setstate__` in a mixin placed above this
|
|
102
|
+
one in the MRO is the supported way to customize pickling without
|
|
103
|
+
touching this file.
|
|
104
|
+
"""
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
from .Copyable import Copyable
|
|
2
|
+
from .PickleState import PickleState
|
|
3
|
+
from .PickleReduce import PickleReduce
|
|
4
|
+
from .main import Lifecycle
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
_DESIGN_NOTES = """
|
|
8
|
+
# Lifecycles Dunders
|
|
9
|
+
|
|
10
|
+
## Purpose
|
|
11
|
+
Gives Simple instances standard Python object-lifecycle protocols —
|
|
12
|
+
`copy`/`deepcopy` support and full `pickle` support — both built on the
|
|
13
|
+
same underlying snapshot/serialization foundation.
|
|
14
|
+
|
|
15
|
+
## Components
|
|
16
|
+
|
|
17
|
+
| Component | Type | Description |
|
|
18
|
+
| :----------------- | :---- | :--------------------------------------------------------------------- |
|
|
19
|
+
| `Copyable` | Mixin | `__copy__` / `__deepcopy__` via snapshot. |
|
|
20
|
+
| `PickleState` | Mixin | `__getstate__` / `__setstate__` via `to_dict()` / `from_dict()`. |
|
|
21
|
+
| `PickleReduce` | Mixin | `__reduce__` — top-level pickle protocol hook, built on `PickleState`. |
|
|
22
|
+
| `Lifecycle` | Mixin | Combines `Copyable` + `PickleReduce` (see `.main`). |
|
|
23
|
+
|
|
24
|
+
## Notes
|
|
25
|
+
- `PickleReduce` keeps its original spelling (missing a "k") to match the
|
|
26
|
+
existing codebase — not a translation artifact.
|
|
27
|
+
- Dependency order: `PickleState` → `PickleReduce`; `Copyable` and
|
|
28
|
+
`PickleReduce` are combined into `Lifecycle`.
|
|
29
|
+
"""
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
from .rebuild_simple_instance import rebuild_simple_instance
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
_DESIGN_NOTES = """
|
|
5
|
+
# Lifecycles Utils
|
|
6
|
+
|
|
7
|
+
## Purpose
|
|
8
|
+
Provides low-level reconstruction helpers and internal utilities supporting
|
|
9
|
+
the lifecycle and serialization mixin implementations.
|
|
10
|
+
|
|
11
|
+
## Components
|
|
12
|
+
|
|
13
|
+
| Component | Type | Description |
|
|
14
|
+
| :------------------------ | :------- | :------------------------------------------------------------------- |
|
|
15
|
+
| `rebuild_simple_instance` | Function | Module-level factory helper for unpickling dynamic runtime instances.|
|
|
16
|
+
|
|
17
|
+
## Notes
|
|
18
|
+
- These utilities are intended for internal framework mechanics and pickle
|
|
19
|
+
protocol callbacks; they are not part of the primary public API.
|
|
20
|
+
"""
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
from typing import Any, Tuple, Type
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
def rebuild_simple_instance(
|
|
5
|
+
owner_class: Type[Any],
|
|
6
|
+
mixins: Tuple[Type[Any], ...],
|
|
7
|
+
as_atom: bool,
|
|
8
|
+
mutable: bool,
|
|
9
|
+
state: dict,
|
|
10
|
+
) -> Any:
|
|
11
|
+
"""Module-level, picklable reconstruction helper for PickleReduce."""
|
|
12
|
+
|
|
13
|
+
# 1. Create bare runtime instance via blueprint caller
|
|
14
|
+
instance = owner_class(mixins=mixins, as_atom=as_atom, mutable=mutable)
|
|
15
|
+
|
|
16
|
+
# 2. Restore state via __setstate__ (handles mutable and immutable branches)
|
|
17
|
+
result = instance.__setstate__(state)
|
|
18
|
+
|
|
19
|
+
# 3. Return newly created instance (immutable mode) or mutated instance (mutable mode)
|
|
20
|
+
return result if result is not None else instance
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
_DESIGN_NOTES = """
|
|
24
|
+
# rebuild_simple_instance
|
|
25
|
+
|
|
26
|
+
## Purpose
|
|
27
|
+
Serves as a module-level, top-level picklable reconstruction helper.
|
|
28
|
+
Because dynamic runtime instance classes (`*Instance`) cannot be resolved
|
|
29
|
+
by name during unpickling, this function acts as the static factory invoked
|
|
30
|
+
by Python's pickle engine.
|
|
31
|
+
|
|
32
|
+
## Lifecycle Pipeline
|
|
33
|
+
1. **Bare Instance Construction**
|
|
34
|
+
Invokes the blueprint class `owner_class` with the original configuration
|
|
35
|
+
(`mixins`, `as_atom`, `mutable`) to compile the runtime class and allocate
|
|
36
|
+
a bare instance.
|
|
37
|
+
|
|
38
|
+
2. **State Restoration**
|
|
39
|
+
Executes `instance.__setstate__(state)` to decode and apply the serialized
|
|
40
|
+
dictionary payload.
|
|
41
|
+
|
|
42
|
+
3. **Dual-Mode Materialization**
|
|
43
|
+
- **Mutable mode**: `__setstate__` mutates the instance in-place and returns `None`
|
|
44
|
+
or `self`; the original `instance` is returned.
|
|
45
|
+
- **Immutable mode**: `__setstate__` delegates to `from_dict`, which produces a brand-new
|
|
46
|
+
snapshot-based instance; the new instance `result` is returned.
|
|
47
|
+
|
|
48
|
+
## Architectural Notes
|
|
49
|
+
- By handling state injection directly inside this factory function, pickle's default
|
|
50
|
+
in-place expectation is safely bridged to support immutable snapshot workflows.
|
|
51
|
+
"""
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Inners
|
|
2
|
+
from ..PickleReduce import PickleReduce
|
|
3
|
+
from ..Copyable import Copyable
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
class Lifecycle(Copyable, PickleReduce):
|
|
7
|
+
"""
|
|
8
|
+
Provides a complete Lifecycle implementation by combining all the
|
|
9
|
+
necessary mixins.
|
|
10
|
+
"""
|
|
11
|
+
|
|
12
|
+
# ----------------------------------------
|
|
13
|
+
# Basic interface
|
|
14
|
+
# ----------------------------------------
|
|
15
|
+
|
|
16
|
+
# Slot definition
|
|
17
|
+
__slots__ = ()
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
_DESIGN_NOTES = """
|
|
21
|
+
# Lifecycle
|
|
22
|
+
|
|
23
|
+
## Purpose
|
|
24
|
+
Convenience "bundle" mixin — combines `Copyable` and `PickleReduce` so an
|
|
25
|
+
instance gets full `copy`/`deepcopy`/`pickle` support from a single
|
|
26
|
+
mixin, instead of listing both separately.
|
|
27
|
+
|
|
28
|
+
## Compatibility
|
|
29
|
+
- No compatibility flags — inherited compatibility comes entirely from
|
|
30
|
+
its two parents, both of which are themselves universal (mutable and
|
|
31
|
+
immutable, atom and composite).
|
|
32
|
+
|
|
33
|
+
## Composition
|
|
34
|
+
Adds no logic of its own. `Copyable` supplies `__copy__`/`__deepcopy__`;
|
|
35
|
+
`PickleReduce` (via `PickleState`) supplies `__reduce__`/`__getstate__`/
|
|
36
|
+
`__setstate__`. Both ultimately rely on the same snapshot/serialization
|
|
37
|
+
foundation, so combining them here doesn't duplicate work — it just gives
|
|
38
|
+
one name to reach for both protocols together.
|
|
39
|
+
|
|
40
|
+
## Notes
|
|
41
|
+
- Mirrors the `Collection` mixin's "main/" bundling pattern used
|
|
42
|
+
elsewhere in `dunders/`.
|
|
43
|
+
- Use the individual mixins (`Copyable`, `PickleReduce`) directly if an
|
|
44
|
+
instance needs only one of the two protocols.
|
|
45
|
+
"""
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
from .Lifecycle import Lifecycle
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
_DESIGN_NOTES = """
|
|
5
|
+
# Lifecycle Main
|
|
6
|
+
|
|
7
|
+
## Purpose
|
|
8
|
+
Bundles the individual lifecycle-related dunder mixins into one
|
|
9
|
+
ready-to-use combined mixin.
|
|
10
|
+
|
|
11
|
+
## Components
|
|
12
|
+
|
|
13
|
+
| Component | Type | Description |
|
|
14
|
+
| :------------ | :---- | :----------------------------------------------------------- |
|
|
15
|
+
| `Lifecycle` | Mixin | Combines `Copyable` + `PickleReduce` for copy/pickle support. |
|
|
16
|
+
|
|
17
|
+
## Notes
|
|
18
|
+
- Use `Lifecycle` when an instance needs both `copy`/`deepcopy` and
|
|
19
|
+
`pickle` support; use the individual mixins for just one protocol.
|
|
20
|
+
"""
|
|
@@ -0,0 +1,195 @@
|
|
|
1
|
+
from typing import TYPE_CHECKING, Any
|
|
2
|
+
import operator
|
|
3
|
+
from numbers import Number
|
|
4
|
+
# Outers
|
|
5
|
+
from ...core_mixins import NodesDicts, Snapshot
|
|
6
|
+
# Inners
|
|
7
|
+
from ._utils import execute_arithmetic_op
|
|
8
|
+
# Annotations
|
|
9
|
+
if TYPE_CHECKING:
|
|
10
|
+
from ...._core.protocols.mixins.dunders.numeric import ArithmeticProtocol
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
class Arithmetic(NodesDicts, Snapshot):
|
|
14
|
+
"""
|
|
15
|
+
Provides arithmetic operations (+, -, *, /, //, %, **) for SimpleObject.
|
|
16
|
+
|
|
17
|
+
Supports:
|
|
18
|
+
- atoms (constants)
|
|
19
|
+
- composites (recomputes inners and owner values)
|
|
20
|
+
|
|
21
|
+
Includes a lazy fallback type conversion:
|
|
22
|
+
- if the operation fails, it attempts to convert the other operand to
|
|
23
|
+
the type of the default value
|
|
24
|
+
- the conversion is only performed if it is safe (e.g. int ->
|
|
25
|
+
float/Decimal/Fraction)
|
|
26
|
+
"""
|
|
27
|
+
|
|
28
|
+
# ----------------------------------------
|
|
29
|
+
# Basic interface
|
|
30
|
+
# ----------------------------------------
|
|
31
|
+
|
|
32
|
+
# Compatibility declaration
|
|
33
|
+
_only_types = Number
|
|
34
|
+
|
|
35
|
+
# Slot definition
|
|
36
|
+
__slots__ = ()
|
|
37
|
+
|
|
38
|
+
# -------------------------
|
|
39
|
+
# Methods - Addition (+)
|
|
40
|
+
# -------------------------
|
|
41
|
+
def __add__(
|
|
42
|
+
self: "ArithmeticProtocol",
|
|
43
|
+
other: Any
|
|
44
|
+
) -> "ArithmeticProtocol":
|
|
45
|
+
"""Returns a new instance with the value self.value + other (with lazy fallback conversion)."""
|
|
46
|
+
return execute_arithmetic_op(self, operator.add, other)
|
|
47
|
+
|
|
48
|
+
def __radd__(
|
|
49
|
+
self: "ArithmeticProtocol",
|
|
50
|
+
other: Any
|
|
51
|
+
) -> "ArithmeticProtocol":
|
|
52
|
+
"""Returns a new instance with the value other + self.value (with lazy fallback conversion)."""
|
|
53
|
+
return execute_arithmetic_op(self, operator.add, other, is_reversed=True)
|
|
54
|
+
|
|
55
|
+
# -------------------------
|
|
56
|
+
# Methods - Subtraction (-)
|
|
57
|
+
# -------------------------
|
|
58
|
+
def __sub__(
|
|
59
|
+
self: "ArithmeticProtocol",
|
|
60
|
+
other: Any
|
|
61
|
+
) -> "ArithmeticProtocol":
|
|
62
|
+
"""Returns a new instance with the value self.value - other (with lazy fallback conversion)."""
|
|
63
|
+
return execute_arithmetic_op(self, operator.sub, other)
|
|
64
|
+
|
|
65
|
+
def __rsub__(
|
|
66
|
+
self: "ArithmeticProtocol",
|
|
67
|
+
other: Any
|
|
68
|
+
) -> "ArithmeticProtocol":
|
|
69
|
+
"""Returns a new instance with the value other - self.value (with lazy fallback conversion)."""
|
|
70
|
+
return execute_arithmetic_op(self, operator.sub, other, is_reversed=True)
|
|
71
|
+
|
|
72
|
+
# -------------------------
|
|
73
|
+
# Methods - Multiplication (*)
|
|
74
|
+
# -------------------------
|
|
75
|
+
def __mul__(
|
|
76
|
+
self: "ArithmeticProtocol",
|
|
77
|
+
other: Any
|
|
78
|
+
) -> "ArithmeticProtocol":
|
|
79
|
+
"""Returns a new instance with the value self.value * other (with lazy fallback conversion)."""
|
|
80
|
+
return execute_arithmetic_op(self, operator.mul, other)
|
|
81
|
+
|
|
82
|
+
def __rmul__(
|
|
83
|
+
self: "ArithmeticProtocol",
|
|
84
|
+
other: Any
|
|
85
|
+
) -> "ArithmeticProtocol":
|
|
86
|
+
"""Returns a new instance with the value other * self.value (with lazy fallback conversion)."""
|
|
87
|
+
return execute_arithmetic_op(self, operator.mul, other, is_reversed=True)
|
|
88
|
+
|
|
89
|
+
# -------------------------
|
|
90
|
+
# Methods - Division (/)
|
|
91
|
+
# -------------------------
|
|
92
|
+
def __truediv__(
|
|
93
|
+
self: "ArithmeticProtocol",
|
|
94
|
+
other: Any
|
|
95
|
+
) -> "ArithmeticProtocol":
|
|
96
|
+
"""Returns a new instance with the value self.value / other (with lazy fallback conversion)."""
|
|
97
|
+
return execute_arithmetic_op(self, operator.truediv, other)
|
|
98
|
+
|
|
99
|
+
def __rtruediv__(
|
|
100
|
+
self: "ArithmeticProtocol",
|
|
101
|
+
other: Any
|
|
102
|
+
) -> "ArithmeticProtocol":
|
|
103
|
+
"""Returns a new instance with the value other / self.value (with lazy fallback conversion)."""
|
|
104
|
+
return execute_arithmetic_op(self, operator.truediv, other, is_reversed=True)
|
|
105
|
+
|
|
106
|
+
# -------------------------
|
|
107
|
+
# Methods - Floor division (//)
|
|
108
|
+
# -------------------------
|
|
109
|
+
def __floordiv__(
|
|
110
|
+
self: "ArithmeticProtocol",
|
|
111
|
+
other: Any
|
|
112
|
+
) -> "ArithmeticProtocol":
|
|
113
|
+
"""Returns a new instance with the value self.value // other (with lazy fallback conversion)."""
|
|
114
|
+
return execute_arithmetic_op(self, operator.floordiv, other)
|
|
115
|
+
|
|
116
|
+
def __rfloordiv__(
|
|
117
|
+
self: "ArithmeticProtocol",
|
|
118
|
+
other: Any
|
|
119
|
+
) -> "ArithmeticProtocol":
|
|
120
|
+
"""Returns a new instance with the value other // self.value (with lazy fallback conversion)."""
|
|
121
|
+
return execute_arithmetic_op(self, operator.floordiv, other, is_reversed=True)
|
|
122
|
+
|
|
123
|
+
# -------------------------
|
|
124
|
+
# Methods - Modulo (%)
|
|
125
|
+
# -------------------------
|
|
126
|
+
def __mod__(
|
|
127
|
+
self: "ArithmeticProtocol",
|
|
128
|
+
other: Any
|
|
129
|
+
) -> "ArithmeticProtocol":
|
|
130
|
+
"""Returns a new instance with the value self.value % other (with lazy fallback conversion)."""
|
|
131
|
+
return execute_arithmetic_op(self, operator.mod, other)
|
|
132
|
+
|
|
133
|
+
def __rmod__(
|
|
134
|
+
self: "ArithmeticProtocol",
|
|
135
|
+
other: Any
|
|
136
|
+
) -> "ArithmeticProtocol":
|
|
137
|
+
"""Returns a new instance with the value other % self.value (with lazy fallback conversion)."""
|
|
138
|
+
return execute_arithmetic_op(self, operator.mod, other, is_reversed=True)
|
|
139
|
+
|
|
140
|
+
# -------------------------
|
|
141
|
+
# Methods - Power (**)
|
|
142
|
+
# -------------------------
|
|
143
|
+
def __pow__(
|
|
144
|
+
self: "ArithmeticProtocol",
|
|
145
|
+
other: Any
|
|
146
|
+
) -> "ArithmeticProtocol":
|
|
147
|
+
"""Returns a new instance with the value self.value ** other (with lazy fallback conversion)."""
|
|
148
|
+
return execute_arithmetic_op(self, operator.pow, other)
|
|
149
|
+
|
|
150
|
+
def __rpow__(
|
|
151
|
+
self: "ArithmeticProtocol",
|
|
152
|
+
other: Any
|
|
153
|
+
) -> "ArithmeticProtocol":
|
|
154
|
+
"""Returns a new instance with the value other ** self.value (with lazy fallback conversion)."""
|
|
155
|
+
return execute_arithmetic_op(self, operator.pow, other, is_reversed=True)
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
_DESIGN_NOTES = """
|
|
159
|
+
# Arithmetic
|
|
160
|
+
|
|
161
|
+
## Purpose
|
|
162
|
+
Gives a SimpleObject the standard arithmetic operators (`+`, `-`, `*`,
|
|
163
|
+
`/`, `//`, `%`, `**`), including their reflected counterparts (`__radd__`
|
|
164
|
+
etc.), so numeric-valued instances behave like plain numbers in
|
|
165
|
+
expressions — `price + 10`, `10 + price`, and so on.
|
|
166
|
+
|
|
167
|
+
## Compatibility
|
|
168
|
+
- `_only_types = Number` — only applicable where `self.value` is expected
|
|
169
|
+
to be numeric (`numbers.Number`), since every operation is delegated
|
|
170
|
+
straight to Python's own arithmetic on the wrapped value.
|
|
171
|
+
- Works for both atoms and composites: composites recompute their inners
|
|
172
|
+
and owner values as part of producing the result, atoms just
|
|
173
|
+
recompute their own value.
|
|
174
|
+
|
|
175
|
+
## Logic
|
|
176
|
+
Every operator is a one-line call into the shared `execute_arithmetic_op`
|
|
177
|
+
helper, passing the matching `operator.*` function. The forward/reflected
|
|
178
|
+
pairs (`__add__`/`__radd__`, etc.) differ only in the `is_reversed=True`
|
|
179
|
+
flag, which tells the helper to compute `other <op> self.value` instead of
|
|
180
|
+
`self.value <op> other`.
|
|
181
|
+
|
|
182
|
+
The "lazy fallback conversion" mentioned in the class docstring lives
|
|
183
|
+
inside `execute_arithmetic_op`, not here: if the raw operation fails
|
|
184
|
+
(e.g. mixing `int` and `Decimal`), it attempts a safe conversion of the
|
|
185
|
+
other operand toward the type of the instance's default value before
|
|
186
|
+
giving up.
|
|
187
|
+
|
|
188
|
+
## Notes
|
|
189
|
+
- Every operator returns a **new instance**, never mutates in place —
|
|
190
|
+
in-place arithmetic (`+=` etc.) is handled by the separate `Inplace`
|
|
191
|
+
mixin, which is explicitly `_mutable_only`.
|
|
192
|
+
- All the actual arithmetic and conversion logic is centralized in
|
|
193
|
+
`_utils.execute_arithmetic_op`, keeping this file a flat, readable list
|
|
194
|
+
of operator wiring rather than duplicated logic per operator.
|
|
195
|
+
"""
|