deb-python-taskflow/taskflow/task.py

# -*- coding: utf-8 -*-

# vim: tabstop=4 shiftwidth=4 softtabstop=4

#    Copyright (C) 2013 Rackspace Hosting Inc. All Rights Reserved.
#    Copyright (C) 2013 Yahoo! Inc. All Rights Reserved.
#
#    Licensed under the Apache License, Version 2.0 (the "License"); you may
#    not use this file except in compliance with the License. You may obtain
#    a copy of the License at
#
#         http://www.apache.org/licenses/LICENSE-2.0
#
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
#    License for the specific language governing permissions and limitations
#    under the License.

import abc

from taskflow.utils import misc
from taskflow.utils import reflection


class BaseTask(object):
    """An abstraction that defines a potential piece of work that can be
    applied and can be reverted to undo the work as a single unit.
    """
    __metaclass__ = abc.ABCMeta

    def __init__(self, name):
        self._name = name
        # An *immutable* input 'resource' name set this task depends
        # on existing before this task can be applied.
        self.requires = set()
        # An *immutable* input 'resource' name set this task would like to
        # depends on existing before this task can be applied (but does not
        # strongly depend on existing).
        self.optional = set()
        # An *immutable* output 'resource' name set this task
        # produces that other tasks may depend on this task providing.
        self.provides = set()
        # This identifies the version of the task to be ran which
        # can be useful in resuming older versions of tasks. Standard
        # major, minor version semantics apply.
        self.version = (1, 0)

    @property
    def name(self):
        return self._name

    def __str__(self):
        return "%s==%s" % (self.name, misc.get_task_version(self))

    @abc.abstractmethod
    def execute(self, *args, **kwargs):
        """Activate a given task which will perform some operation and return.

           This method can be used to apply some given context and given set
           of args and kwargs to accomplish some goal. Note that the result
           that is returned needs to be serializable so that it can be passed
           back into this task if reverting is triggered.
        """

    def revert(self, *args, **kwargs):
        """Revert this task using the given context, result that the apply
           provided as well as any information which may have caused
           said reversion.
        """


class Task(BaseTask):
    """Base class for user-defined tasks

    Adds following features to Task:
        - auto-generates name from type of self
        - adds all execute argument names to task requiremets
    """

    def __init__(self, name=None, requires_from_args=True):
        """Initialize task instance

        :param name: task name, if None (the default) name will
            be autogenerated
        :param requires_from_args: if True (the default) execute
            arguments names will be added to task requirements
        """
        if name is None:
            name = reflection.get_callable_name(self)
        super(Task, self).__init__(name)
        if requires_from_args:
            f_args = reflection.get_required_callable_args(self.execute)
            self.requires.update(a for a in f_args if a != 'context')


class FunctorTask(BaseTask):
    """Adaptor to make task from a callable

    Take any callable and make a task from it.
    """

    def __init__(self, execute, **kwargs):
        """Initialize FunctorTask instance with given callable and kwargs

        :param execute: the callable
        :param kwargs: reserved keywords (all optional) are
            name: name of the task, default None (auto generate)
            revert: the callable to revert, default None
            version: version of the task, default Task's version 1.0
            optionals: optionals of the task, default ()
            provides: provides of the task, default ()
            requires: requires of the task, default ()
            auto_extract: auto extract execute's args and put it into
                requires, default True
        """
        name = kwargs.pop('name', None)
        if name is None:
            name = reflection.get_callable_name(execute)
        super(FunctorTask, self).__init__(name)
        self._execute = execute
        self._revert = kwargs.pop('revert', None)
        self.version = kwargs.pop('version', self.version)
        self.optional.update(kwargs.pop('optional', ()))
        self.provides.update(kwargs.pop('provides', ()))
        self.requires.update(kwargs.pop('requires', ()))
        if kwargs.pop('auto_extract', True):
            f_args = reflection.get_required_callable_args(execute)
            self.requires.update(a for a in f_args if a != 'context')
        if kwargs:
            raise TypeError('__init__() got an unexpected keyword argument %r'
                            % kwargs.keys[0])

    def execute(self, *args, **kwargs):
        return self._execute(*args, **kwargs)

    def revert(self, *args, **kwargs):
        if self._revert:
            return self._revert(*args, **kwargs)
        else:
            return None