Source code for soakdb3_api.datafaces.context

import logging

# Things created in the context.
from soakdb3_api.datafaces.datafaces import Datafaces, datafaces_set_default

logger = logging.getLogger(__name__)


class Context:
    """
    Client context for a dataface object.
    On entering, it creates the object according to the specification (a dict).
    On exiting, it closes client connection.

    The aenter and aexit methods are exposed for use by an enclosing context and the base class.
    """

    # ----------------------------------------------------------------------------------------
    def __init__(self, specification):
        self.__specification = specification
        self.__dataface = None

    # ----------------------------------------------------------------------------------------
    async def __aenter__(self):
        """ """

        await self.aenter()

    # ----------------------------------------------------------------------------------------
    async def __aexit__(self, type, value, traceback):
        """ """

        await self.aexit()

    # ----------------------------------------------------------------------------------------
    async def aenter(self):
        """ """

        # Build the object according to the specification.
        self.__dataface = Datafaces().build_object(self.__specification)

        # If there is more than one dataface, the last one defined will be the default.
        datafaces_set_default(self.__dataface)

    # ----------------------------------------------------------------------------------------
    async def aexit(self):
        """ """

        if self.__dataface is not None:
            await self.__dataface.close_client_session()

            # Clear the global variable.  Important between pytests.
            datafaces_set_default(None)