Skip to content

Api implementation

IApiInterfaceImplementation

Bases: ABC

Source code in src/officialeye/_internal/api_implementation.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
class IApiInterfaceImplementation(ABC):

    @abstractmethod
    def set_api_context(self, context: Context, /) -> None:
        """
        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.
        """
        raise NotImplementedError()

    @abstractmethod
    def clear_api_context(self) -> None:
        """
        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.
        """
        raise NotImplementedError()

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 
22
23
24
25
26
27
28
@abstractmethod
def clear_api_context(self) -> None:
    """
    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.
    """
    raise NotImplementedError()

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.

Source code in src/officialeye/_internal/api_implementation.py 
13
14
15
16
17
18
19
20
@abstractmethod
def set_api_context(self, context: Context, /) -> None:
    """
    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.
    """
    raise NotImplementedError()