Source code for science_jubilee.tools.Tool


[docs]
class ToolStateError(Exception):
    """Raise this error if the tool is in the wrong state to perform such a command."""

    pass




[docs]
class ToolConfigurationError(Exception):
    """Raise this error if there is something wrong with how the tool is configured"""

    pass




[docs]
class Tool:
    # TODO: Is this init supposed to take a machine?
    def __init__(self, index, name, **kwargs):
        if not isinstance(index, int) or not isinstance(name, str):
            raise ToolConfigurationError(
                "Incorrect usage: load_tool(<tool_number>, <name>, **kwargs)"
            )

[docs]
        self._machine = None


[docs]
        self.index = index


[docs]
        self.name = name


[docs]
        self.is_active_tool = False


[docs]
        self.tool_offset = None


        for k, v in kwargs.items():
            setattr(self, k, v)


[docs]
    def post_load(self):
        """Run any code after tool has been associated with the machine."""
        pass



    # TODO:
    # add a park tool method that every tool config can define to do things that need to be done pre or post parking
    # ex: make sure pipette has dropped tips before parking



[docs]
def requires_active_tool(func):
    """Decorator to ensure that a tool cannot complete an action unless it is the
    current active tool.
    """

    def wrapper(self, *args, **kwargs):
        if self.is_active_tool == False:
            raise ToolStateError(
                f"Error: Tool {self.name} is not the current `Active Tool`. Cannot perform this action"
            )
        else:
            return func(self, *args, **kwargs)

    return wrapper