flowspec.py

from itertools import islice
import os
import sys
import inspect
import traceback

from . import cmd_with_io
from .parameters import Parameter
from .exception import MetaflowException, MetaflowInternalError, MergeArtifactsException
from .graph import FlowGraph

# For Python 3 compatibility
try:
    basestring
except NameError:
    basestring = str


class InvalidNextException(MetaflowException):
    headline = "Invalid self.next() transition detected"

    def __init__(self, msg):
        # NOTE this assume that InvalidNextException is only raised
        # at the top level of next()
        _, line_no, _, _ = traceback.extract_stack()[-3]
        super(InvalidNextException, self).__init__(msg, line_no)


class FlowSpec(object):
    """
    Main class from which all Flows should inherit.

    Attributes
    ----------
    script_name
    index
    input
    """

    # Attributes that are not saved in the datastore when checkpointing.
    # Name starting with '__', methods, functions and Parameters do not need
    # to be listed.
    _EPHEMERAL = {'_EPHEMERAL',
                  '_datastore',
                  '_cached_input',
                  '_graph',
                  '_flow_decorators',
                  '_steps',
                  'index',
                  'input'}

    _flow_decorators = {}

    def __init__(self, use_cli=True):
        """
        Construct a FlowSpec

        Parameters
        ----------
        use_cli : bool, optional, default: True
            Set to True if the flow is invoked from __main__ or the command line
        """

        self.name = self.__class__.__name__

        self._datastore = None
        self._transition = None
        self._cached_input = {}

        self._graph = FlowGraph(self.__class__)
        self._steps = [getattr(self, node.name) for node in self._graph]

        if use_cli:
            # we import cli here to make sure custom parameters in
            # args.py get fully evaluated before cli.py is imported.
            from . import cli
            cli.main(self)

    @property
    def script_name(self):
        """
        Returns the name of the script containing the flow

        Returns
        -------
        str
            A string containing the name of the script
        """
        fname = inspect.getfile(self.__class__)
        if fname.endswith('.pyc'):
            fname = fname[:-1]
        return os.path.basename(fname)

    def _get_parameters(self):
        for var in dir(self):
            if var[0] == '_':
                continue
            try:
                val = getattr(self, var)
            except:
                continue
            if isinstance(val, Parameter):
                yield var, val

    def _set_datastore(self, datastore):
        self._datastore = datastore

    def __iter__(self):
        """
        Iterate over all steps in the Flow

        Returns
        -------
        Iterator[graph.DAGNode]
            Iterator over the steps in the flow
        """
        return iter(self._steps)

    def __getattr__(self, name):
        if self._datastore and name in self._datastore:
            # load the attribute from the datastore...
            x = self._datastore[name]
            # ...and cache it in the object for faster access
            setattr(self, name, x)
            return x
        else:
            raise AttributeError("Flow %s has no attribute '%s'" %
                                 (self.name, name))

    def cmd(self, cmdline, input={}, output=[]):
        return cmd_with_io.cmd(cmdline,
                               input=input,
                               output=output)

    @property
    def index(self):
        """
        Index of the task in a foreach step

        In a foreach step, multiple instances of this step (tasks) will be executed,
        one for each element in the foreach.
        This property returns the zero based index of the current task. If this is not
        a foreach step, this returns None.

        See Also
        --------
        foreach_stack: A detailed example is given in the documentation of this function

        Returns
        -------
        int
            Index of the task in a foreach step
        """
        if self._foreach_stack:
            return self._foreach_stack[-1].index

    @property
    def input(self):
        """
        Value passed to the task in a foreach step

        In a foreach step, multiple instances of this step (tasks) will be executed,
        one for each element in the foreach.
        This property returns the element passed to the current task. If this is not
        a foreach step, this returns None.

        See Also
        --------
        foreach_stack: A detailed example is given in the documentation of this function

        Returns
        -------
        object
            Input passed to the task (can be any object)
        """
        return self._find_input()

    def foreach_stack(self):
        """
        Returns the current stack of foreach steps for the current step

        This effectively corresponds to the indexes and values at the various levels of nesting.
        For example, considering the following code:
        ```
        @step
        def root(self):
            self.split_1 = ['a', 'b', 'c']
            self.next(self.nest_1, foreach='split_1')

        @step
        def nest_1(self):
            self.split_2 = ['d', 'e', 'f', 'g']
            self.next(self.nest_2, foreach='split_2'):

        @step
        def nest_2(self):
            foo = self.foreach_stack()
        ```
        foo will take the following values in the various tasks for nest_2:
            [(0, 3, 'a'), (0, 4, 'd')]
            [(0, 3, 'a'), (1, 4, 'e')]
            ...
            [(0, 3, 'a'), (3, 4, 'g')]
            [(1, 3, 'b'), (0, 4, 'd')]
            ...

        where each tuple corresponds to:
            - the index of the task for that level of the loop
            - the number of splits for that level of the loop
            - the value for that level of the loop
        Note that the last tuple returned in a task corresponds to:
            - first element: value returned by self.index
            - third element: value returned by self.input

        Returns
        -------
        List[Tuple[int, int, object]]
            An array describing the current stack of foreach steps
        """
        return [(frame.index, frame.num_splits, self._find_input(stack_index=i))
                for i, frame in enumerate(self._foreach_stack)]

    def _find_input(self, stack_index=None):

        if stack_index is None:
            stack_index = len(self._foreach_stack) - 1

        if stack_index in self._cached_input:
            return self._cached_input[stack_index]
        elif self._foreach_stack:
            # NOTE this is obviously an O(n) operation which also requires
            # downloading the whole input data object in order to find the
            # right split. One can override this method with a more efficient
            # input data handler if this is a problem.
            frame = self._foreach_stack[stack_index]
            try:
                var = getattr(self, frame.var)
            except AttributeError:
                # this is where AttributeError happens:
                # [ foreach x ]
                #   [ foreach y ]
                #     [ inner ]
                #   [ join y ] <- call self.foreach_stack here,
                #                 self.x is not available
                self._cached_input[stack_index] = None
            else:
                try:
                    self._cached_input[stack_index] = var[frame.index]
                except TypeError:
                    # __getitem__ not supported, fall back to an iterator
                    self._cached_input[stack_index] = next(islice(var,
                                                                  frame.index,
                                                                  frame.index + 1))
            return self._cached_input[stack_index]

    def merge_artifacts(self, inputs, exclude=[]):
        """
        Merge the artifacts coming from each merge branch (from inputs)

        This function takes all the artifacts coming from the branches of a
        join point and assigns them to self in the calling step. Only artifacts
        not set in the current step are considered. If, for a given artifact, different
        values are present on the incoming edges, an error will be thrown (and the artifacts
        that "conflict" will be reported).

        As a few examples, in the simple graph: A splitting into B and C and joining in D:
        A:
          self.x = 5
          self.y = 6
        B:
          self.b_var = 1
          self.x = from_b
        C:
          self.x = from_c

        D:
          merge_artifacts(inputs)

        In D, the following artifacts are set:
          - y (value: 6), b_var (value: 1)
          - if from_b and from_c are the same, x will be accessible and have value from_b
          - if from_b and from_c are different, an error will be thrown. To prevent this error,
            you need to manually set self.x in D to a merged value (for example the max) prior to
            calling merge_artifacts.

        Parameters
        ----------
        inputs : List[Steps]
            Incoming steps to the join point
        exclude : List[str], optional

        Raises
        ------
        MetaflowException
            This exception is thrown if this is not called in a join step
        MergeArtifactsException
            This exception is thrown in case of unresolved conflicts
        """
        node = self._graph[self._current_step]
        if node.type != 'join':
            msg = "merge_artifacts can only be called in a join and step *{step}* "\
                  "is not a join".format(step=self._current_step)
            raise MetaflowException(msg)

        to_merge = {}
        unresolved = []
        for inp in inputs:
            # available_vars is the list of variables from inp that should be considered
            available_vars = ((var, sha) for var, sha in inp._datastore.items()
                              if (var not in exclude) and (not hasattr(self, var)))
            for var, sha in available_vars:
                _, previous_sha = to_merge.setdefault(var, (inp, sha))
                if previous_sha != sha:
                    # We have a conflict here
                    unresolved.append(var)

        if unresolved:
            # We have unresolved conflicts so we do not set anything and error out
            msg = "Step *{step}* cannot merge the following artifacts due to them "\
                  "having conflicting values:\n[{artifacts}].\nTo remedy this issue, "\
                  "be sure to explictly set those artifacts (using "\
                  "self.<artifact_name> = ...) prior to calling merge_artifacts."\
                  .format(step=self._current_step, artifacts=', '.join(unresolved))
            raise MergeArtifactsException(msg, unresolved)
        # If things are resolved, we go and fetch from the datastore and set here
        for var, (inp, _) in to_merge.items():
            setattr(self, var, getattr(inp, var))

    def next(self, *dsts, **kwargs):
        """
        Indicates the next step to execute at the end of this step

        This statement should appear once and only once in each and every step (except the `end`
        step). Furthermore, it should be the last statement in the step.

        There are several valid formats to specify the next step:
            - Straight-line connection: self.next(self.next_step) where `next_step` is a method in
              the current class decorated with the `@step` decorator
            - Static fan-out connection: self.next(self.step1, self.step2, ...) where `stepX` are
              methods in the current class decorated with the `@step` decorator
            - Foreach branch:
                self.next(self.foreach_step, foreach='foreach_iterator')
              In this situation, `foreach_step` is a method in the current class decorated with the
              `@step` docorator and `foreach_iterator` is a variable name in the current class that
              evaluates to an iterator. A task will be launched for each value in the iterator and
              each task will execute the code specified by the step `foreach_step`.

        Raises
        ------
        InvalidNextException
            Raised if the format of the arguments does not match one of the ones given above.
        """

        step = self._current_step

        foreach = kwargs.pop('foreach', None)
        condition = kwargs.pop('condition', None)
        if kwargs:
            kw = next(iter(kwargs))
            msg = "Step *{step}* passes an unknown keyword argument "\
                  "'{invalid}' to self.next().".format(step=step, invalid=kw)
            raise InvalidNextException(msg)

        # check: next() is called only once
        if self._transition is not None:
            msg = "Multiple self.next() calls detected in step *{step}*. "\
                  "Call self.next() only once.".format(step=step)
            raise InvalidNextException(msg)

        # check: all destinations are methods of this object
        funcs = []
        for i, dst in enumerate(dsts):
            try:
                name = dst.__func__.__name__
            except:
                msg = "In step *{step}* the {arg}. argument in self.next() is "\
                      "not a function. Make sure all arguments in self.next() "\
                      "are methods of the Flow class."\
                      .format(step=step, arg=i + 1)
                raise InvalidNextException(msg)
            if not hasattr(self, name):
                msg = "Step *{step}* specifies a self.next() transition to an "\
                      "unknown step, *{name}*.".format(step=step,
                                                       name=name)
                raise InvalidNextException(msg)
            funcs.append(name)

        # check: foreach and condition are mutually exclusive
        if not (foreach is None or condition is None):
            msg = "Step *{step}* has an invalid self.next() transition. "\
                  "Specify either 'foreach' or 'condition', not both."\
                  .format(step=step)
            raise InvalidNextException(msg)

        # check: foreach is valid
        if foreach:
            if not isinstance(foreach, basestring):
                msg = "Step *{step}* has an invalid self.next() transition. "\
                      "The argument to 'foreach' must be a string."\
                      .format(step=step)
                raise InvalidNextException(msg)

            if len(dsts) != 1:
                msg = "Step *{step}* has an invalid self.next() transition. "\
                      "Specify exactly one target for 'foreach'."\
                      .format(step=step)
                raise InvalidNextException(msg)

            try:
                foreach_iter = getattr(self, foreach)
            except:
                msg = "Foreach variable *self.{var}* in step *{step}* "\
                      "does not exist. Check your variable."\
                      .format(step=step, var=foreach)
                raise InvalidNextException(msg)

            try:
                self._foreach_num_splits = sum(1 for _ in foreach_iter)
            except TypeError:
                msg = "Foreach variable *self.{var}* in step *{step}* "\
                      "is not iterable. Check your variable."\
                      .format(step=step, var=foreach)
                raise InvalidNextException(msg)

            if self._foreach_num_splits == 0:
                msg = "Foreach iterator over *{var}* in step *{step}* "\
                      "produced zero splits. Check your variable."\
                      .format(step=step, var=foreach)
                raise InvalidNextException(msg)

            self._foreach_var = foreach

        # check: condition is valid
        if condition:
            if not isinstance(condition, basestring):
                msg = "Step *{step}* has an invalid self.next() transition. "\
                      "The argument to 'condition' must be a string."\
                      .format(step=step)
                raise InvalidNextException(msg)
            if len(dsts) != 2:
                msg = "Step *{step}* has an invalid self.next() transition. "\
                      "Specify two targets for 'condition': The first target "\
                      "is used if the condition evaluates to true, the second "\
                      "otherwise.".format(step=step)
                raise InvalidNextException(msg)

        # check: non-keyword transitions are valid
        if foreach is None and condition is None:
            if len(dsts) < 1:
                msg = "Step *{step}* has an invalid self.next() transition. "\
                      "Specify at least one step function as an argument in "\
                      "self.next().".format(step=step)
                raise InvalidNextException(msg)

        self._transition = (funcs, foreach, condition)

    def __str__(self):
        step_name = getattr(self, '_current_step', None)
        if step_name:
            index = ','.join(str(idx) for idx, _, _ in self.foreach_stack())
            if index:
                inp = self.input
                if inp is None:
                    return '<flow %s step %s[%s]>' %\
                           (self.name, step_name, index)
                else:
                    inp = str(inp)
                    if len(inp) > 20:
                        inp = inp[:20] + '...'
                    return '<flow %s step %s[%s] (input: %s)>' %\
                        (self.name, step_name, index, inp)
            else:
                return '<flow %s step %s>' % (self.name, step_name)
        else:
            return '<flow %s>' % self.name

    def __getstate__(self):
        raise MetaflowException("Flows can't be serialized. Maybe you tried "
                                "to assign *self* or one of the *inputs* "
                                "to an attribute? Instead of serializing the "
                                "whole flow, you should choose specific "
                                "attributes, e.g. *input.some_var*, to be "
                                "stored.")