Api implementation
IApiInterfaceImplementation
Bases: ABC
Source code in src/officialeye/_internal/api_implementation.py
clear_api_context()
abstractmethod
This method should clear the public API's context stored in the current object, and in all internal objects implementing this interface. It is essential that after running this method, the object is picklable.
Source code in src/officialeye/_internal/api_implementation.py
set_api_context(context)
abstractmethod
This method should be used to propagate the public API's context to the objects returned by the internal implementation of the API. Those objects are called 'external' and should be picklable if the API context has not yet been set via this method. If it was, then all methods guaranteed by the corresponding object's public API interface can be implemented properly.