API Documentation

Modules

• abstract
  • Serializable
    • Serializable.check_in_serialization_context()
    • Serializable.check_in_deserialization_context()
    • Serializable.to_dict()
    • Serializable.from_dict()
    • Serializable.finalize()
  • VersionedSerializable
    • VersionedSerializable.VERSION
    • VersionedSerializable.get_version()
    • VersionedSerializable.get_version_object()
    • VersionedSerializable.get_conversion_manager()
    • VersionedSerializable.check_convert_update()
    • VersionedSerializable.conversion_manager_converted()
    • VersionedSerializable.get_versioning_endpoint()
  • make_kill_converter()
  • IASettings
    • IASettings.parent
    • IASettings.init_settings()
    • IASettings.get_versioning_endpoint()
    • IASettings.invalidate
    • IASettings.update()
    • IASettings.finalize()
    • IASettings.generate_key_value_pairs()
    • IASettings.get_validator()
    • IASettings.file_path
• base
  • Settings
    • Settings.sd
    • Settings.get_versioning_endpoint()
    • Settings.update()
    • Settings.generate_key_value_pairs()
    • Settings.to_dict()
  • SlotSettings
    • SlotSettings.SETTINGS_KEYS
    • SlotSettings.assemble_settings_keys_from_base()
    • SlotSettings.get_versioning_endpoint()
    • SlotSettings.get_settings_keys_rems()
    • SlotSettings.get_settings_keys_base_slots()
    • SlotSettings.get_settings_keys()
    • SlotSettings.safe_update()
    • SlotSettings.generate_key_value_pairs()
    • SlotSettings.to_dict()
• config_file
  • PassLogFilePath
    • PassLogFilePath.val
  • LogFileLink
    • LogFileLink.to_dict()
    • LogFileLink.from_dict()
  • ConfigFile
    • ConfigFile.FORMATTER_STR_DICT
    • ConfigFile.add_config_dependency()
    • ConfigFile.add_log_file_link()
    • ConfigFile.is_loaded()
    • ConfigFile.backup_settings_file()
    • ConfigFile.settings_invalidated()
    • ConfigFile.validate_file_path()
    • ConfigFile.save()
    • ConfigFile.check_in_serialization_context()
    • ConfigFile.get_serialization_context()
    • ConfigFile.handle_serialize_IASettings()
    • ConfigFile.load()
    • ConfigFile.check_in_deserialization_context()
    • ConfigFile.get_deserialization_context()
    • ConfigFile.handle_deserialize_LogFileLink()
    • ConfigFile.instantiate_data()
    • ConfigFile.get_load_data_obj()
    • ConfigFile.to_dict()
    • ConfigFile.from_dict()
    • ConfigFile.handle_me()
• conversion_manager
  • ConversionError
  • basic_converter()
  • ConversionManager
    • ConversionManager.converters
    • ConversionManager.converted
    • ConversionManager.get_version_info_from_class()
    • ConversionManager.get_version_object()
    • ConversionManager.add_converter()
    • ConversionManager.try_convert()
    • ConversionManager.update_to_current()
• default_handlers
  • force_instantiate()
  • NotSerializableException
  • SerializationHandler
    • SerializationHandler.init_handler()
    • SerializationHandler.handle_path()
    • SerializationHandler.handle_Complex()
    • SerializationHandler.handle_Rational()
    • SerializationHandler.handle_method()
    • SerializationHandler.omit()
    • SerializationHandler.handle_bytes()
    • SerializationHandler.handle_partial()
    • SerializationHandler.handle_Enum()
    • SerializationHandler.handle_PreservedReference()
    • SerializationHandler.handle_Iterable()
    • SerializationHandler.handle_Mapping()
    • SerializationHandler.handle_type()
    • SerializationHandler.handle_function_type()
    • SerializationHandler.handle_NoneType()
    • SerializationHandler.handle_serializable()
    • SerializationHandler.handle_datetime()
    • SerializationHandler.handle_date()
    • SerializationHandler.handle_timedelta()
    • SerializationHandler.default_handler()
    • SerializationHandler.handle()
  • DeSerializationHandler
    • DeSerializationHandler.init_handler()
    • DeSerializationHandler.handle_path()
    • DeSerializationHandler.handle_Complex()
    • DeSerializationHandler.handle_Rational()
    • DeSerializationHandler.handle_method()
    • DeSerializationHandler.handle_bytes()
    • DeSerializationHandler.handle_partial()
    • DeSerializationHandler.handle_Enum()
    • DeSerializationHandler.handle_NoneType()
    • DeSerializationHandler.handle_PreservedReference()
    • DeSerializationHandler.handle_KeySerializableDict()
    • DeSerializationHandler.handle_tuple()
    • DeSerializationHandler.handle_set()
    • DeSerializationHandler.handle_type()
    • DeSerializationHandler.handle_serializable()
    • DeSerializationHandler.handle_datetime()
    • DeSerializationHandler.handle_date()
    • DeSerializationHandler.handle_timedelta()
    • DeSerializationHandler.default_handler()
    • DeSerializationHandler.add_handlers_by_type_hints()
• formatter
  • ProcessingException
  • Processor
    • Processor.root_obj
    • Processor.set_default_semantics()
    • Processor.it_quack()
    • Processor.process()
    • Processor.path_to_str()
    • Processor.dispose()
  • IFormatter
    • IFormatter.to_buffer()
    • IFormatter.write_to_file()
    • IFormatter.from_buffer()
    • IFormatter.read_from_file()
    • IFormatter.serialized_obj_to_buffer()
    • IFormatter.buffer_to_obj()
    • IFormatter.get_serialization_handler()
    • IFormatter.get_deserialization_handler()
    • IFormatter.get_serialization_frame_context()
    • IFormatter.get_deserialization_frame_context()
    • IFormatter.get_serialization_context()
    • IFormatter.get_deserialization_context()
    • IFormatter.dumps()
    • IFormatter.loads()
    • IFormatter.get_serializer()
    • IFormatter.get_deserializer()
    • IFormatter.serialize()
    • IFormatter.free_deser_obj()
    • IFormatter.deserialize()
  • Serializer
    • Serializer.set_default_semantics()
    • Serializer.supports_semantic()
    • Serializer.check_in_object()
    • Serializer.handle_serialize_list_in_place()
    • Serializer.handle_serialize_dict_in_place()
    • Serializer.handle_user_list()
    • Serializer.handle_user_dict()
    • Serializer.handle_add_semantics()
    • Serializer.handle_temporary()
    • Serializer.template_object_serialize()
    • Serializer.handle_default()
    • Serializer.process()
    • Serializer.serialize()
    • Serializer.dispose()
  • DeSerializer
    • DeSerializer.set_default_semantics()
    • DeSerializer.supports_semantic()
    • DeSerializer.run_semantics_through_path()
    • DeSerializer.handle_list()
    • DeSerializer.handle_dict()
    • DeSerializer.handle_preserved_referece()
    • DeSerializer.handle_default()
    • DeSerializer.handle_secondary_preserved_reference()
    • DeSerializer.cache_instance_ref()
    • DeSerializer.process()
    • DeSerializer.deserialize()
    • DeSerializer.dispose()
  • Formatter
    • Formatter.FORMAT_SETTINGS
    • Formatter.TYPES
    • Formatter.get_serialization_handler()
    • Formatter.get_deserialization_handler()
    • Formatter.get_serializer()
    • Formatter.get_deserializer()
    • Formatter.add_semantics()
• formatter_settings
  • AddSemantics
    • AddSemantics.val
    • AddSemantics.semantics
    • AddSemantics.frame_semantics
  • NoRef
  • Temporary
  • PreservedReference
    • PreservedReference.ref
    • PreservedReference.obj
  • FormatterSpec
    • FormatterSpec.ROUTE_PATH_TRANSLATION
    • FormatterSpec.ROUTE_PATH_REGEX
    • FormatterSpec.PRIMITIVES
    • FormatterSpec.SPECIAL
    • FormatterSpec.ATTRIBUTE
    • FormatterSpec.TYPES
    • FormatterSpec.get_primitive_types()
    • FormatterSpec.get_special_types()
    • FormatterSpec.get_attribute_types()
    • FormatterSpec.path_to_str()
    • FormatterSpec.str_to_path()
    • FormatterSpec.get_part_from_path()
    • FormatterSpec.is_circular_ref()
    • FormatterSpec.copy()
  • FormatterContext
    • FormatterContext.handler
    • FormatterContext.handle()
    • FormatterContext.update()
    • FormatterContext.find()
    • FormatterContext.check_ref()
    • FormatterContext.add_frame_semantics()
    • FormatterContext.add_semantics()
    • FormatterContext.get_stack_depth()
    • FormatterContext.load_type()
    • FormatterContext.dispose()
• framestack_context
  • FrameStackContext
    • FrameStackContext.clear()
    • FrameStackContext.set_handler()
• handlers
  • HandlerNotFound
  • Handler
    • Handler.init_handler()
    • Handler.add_handlers_by_type_hints()
    • Handler.add_handlers()
    • Handler.update()
    • Handler.add_handler()
    • Handler.set_default_handler()
    • Handler.get_key_func()
    • Handler.handle_node()
    • Handler.handle()
  • OrderedHandler
    • OrderedHandler.init_handler()
    • OrderedHandler.update()
    • OrderedHandler.add_handler()
    • OrderedHandler.get_key_func()
    • OrderedHandler.handle_node()
    • OrderedHandler.handle()
  • OrderedMethodHandler
    • OrderedMethodHandler.add_handlers_by_type_hints()
    • OrderedMethodHandler.handle_node()
    • OrderedMethodHandler.handle()
  • MroHandler
    • MroHandler.update()
    • MroHandler.add_handler()
    • MroHandler.add_handlers()
    • MroHandler.get_ordered_handlers()
    • MroHandler.handle()
    • MroHandler.handle_custom()
  • StackedHandler
    • StackedHandler.update()
    • StackedHandler.handle()
• helper_objects
  • PreservedReferenceNotDissolvedError
  • KeySerializableDict
    • KeySerializableDict.wrapped_dict
    • KeySerializableDict.to_dict()
    • KeySerializableDict.from_dict()
  • KeySerializableDictKvpList
    • KeySerializableDictKvpList.to_dict()
    • KeySerializableDictKvpList.from_dict()
  • KeySerializableDictNumbered
    • KeySerializableDictNumbered.to_dict()
    • KeySerializableDictNumbered.from_dict()
• semantics
  • SymantecNotSupportedError
  • SymantecConfigurationInvalid
  • SecurityException
  • OmitMeError
  • Negate
    • Negate.semantic
  • Semantic
    • Semantic.COLLECTION
    • Semantic.C_T
    • Semantic.val
    • Semantic.collection_add()
    • Semantic.collection_remove()
    • Semantic.collection_copy()
    • Semantic.collection_concatenate()
  • Semantics
    • Semantics.update()
    • Semantics.add_semantics()
    • Semantics.get_semantic()
    • Semantics.pop()
    • Semantics.remove_semantic()
    • Semantics.copy()
  • SemanticContext
    • SemanticContext.add_frame_semantics()
    • SemanticContext.remove_frame_semantic()
    • SemanticContext.add_semantics()
    • SemanticContext.get_semantic()
    • SemanticContext.remove_semantic()
    • SemanticContext.copy_semantics()
    • SemanticContext.context_push()
    • SemanticContext.context_pop()
  • IgnoreDuckTypingForType
    • IgnoreDuckTypingForType.val
  • IgnoreDuckTypingForSubclasses
    • IgnoreDuckTypingForSubclasses.val
  • OmitMe
    • OmitMe.val
  • PreserveDictionaryOrdering
    • PreserveDictionaryOrdering.val
  • PreserveSerializableKeyOrdering
    • PreserveSerializableKeyOrdering.val
  • OverrideClassString
    • OverrideClassString.val
  • SerializeNoneVersionInfo
    • SerializeNoneVersionInfo.val
  • AutoKeySerializableDictType
    • AutoKeySerializableDictType.val
  • Indentation
    • Indentation.val
  • AutoPreserveReferences
    • AutoPreserveReferences.val
  • EnforceReferenceLifecycle
    • EnforceReferenceLifecycle.val
  • DetonateDanglingPreservedReferences
    • DetonateDanglingPreservedReferences.val
  • ResolvePreservedReferences
    • ResolvePreservedReferences.val
  • NotifyFinalizedMethodName
    • NotifyFinalizedMethodName.val
  • DoNotAllowImportingModules
    • DoNotAllowImportingModules.val
  • ClassStringPassFunction
    • ClassStringPassFunction.COLLECTION
    • ClassStringPassFunction.val
  • KeySemanticsTemplate
    • KeySemanticsTemplate.val
• utilities
  • unwrap_slots_to_base()
  • build_attribute_string()
  • generate_slots_kvps()
  • ext_str_slots()
  • ext_str_fmt()
  • ex_str()
  • format_class_str()
  • generate_type_hierarchy_to_base()
  • load_type()
  • get_type_hints()
  • get_first_parameter_type_hint()
• validation
  • ValidationReport
    • ValidationReport.settings
    • ValidationReport.settings_key
    • ValidationReport.name
    • ValidationReport.description
    • ValidationReport.long_description
    • ValidationReport.fixes
  • Validation
    • Validation.validate()
    • Validation.make_validation_report()
  • ValidationCapsule
    • ValidationCapsule.make_validation_report
  • NotNoneValidation
    • NotNoneValidation.validate()
  • TypeCheckValidation
    • TypeCheckValidation.validate()
  • SettingsValidator
    • SettingsValidator.create_validation()
    • SettingsValidator.create_validations()
    • SettingsValidator.add_validation()
    • SettingsValidator.add_validations()
    • SettingsValidator.get_validation_issues()
• Formatters