Module enthought.​sweet_pickle.​global_registry

Manages a singleton updater that acts as a global registry.

Our goal is to enable the enthought.sweet_pickle framework to understand how pickled data should be treated during unpickling so that the resulting object hierarchy reflects the current versions of the object's classes -AND- that this should work no matter who is doing the unpickling. This requires a global registry since there is no way to know in advance what objects are contained within a given pickle file, and thus no way to gather the required information to know how to treat the pickle data during unpickling.

For example, a pickle of an Envisage project may contain many custom classes, instantiated at the behest of various plugins, which have gone through various versionings and refactorings. But it is the project plugin that needs to unpickle these objects to 'load' a project, not the other plugins that added those custom class instances into the project.

This registry is used by the enthought.sweet_pickle framework's unpickler only by default. That is, only if no updater was explicitly provided.

It is important that users interact with the registry through the provided methods. If they do not, then the reference they receive will be the one that was in place at the time of the import which may or MAY NOT be the current repository due to the way this framework manages the repository.