Warning

This document is for an in-development version of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.

Source code for galaxy.workflow.schedulers

""" Module containing Galaxy workflow scheduling plugins. Galaxy's interface
for workflow scheduling is highly experimental and the interface required for
scheduling plugins will almost certainly change.
"""
from abc import (
    ABCMeta,
    abstractmethod
)

import six


@six.add_metaclass(ABCMeta)
class WorkflowSchedulingPlugin(object):
    """ A plugin defining how Galaxy should schedule plugins. By default
    plugins are passive and should monitor Galaxy's work queue for
    WorkflowRequests. Inherit from ActiveWorkflowSchedulingPlugin instead if
    the scheduling plugin should be forced (i.e. if scheduling happen all at
    once or the request will be stored and monitored outside of Galaxy.)
    """

    @property
    @abstractmethod
    def plugin_type(self):
        """ Short string providing labelling this plugin """

    def startup(self, app):
        """ Called when Galaxy starts up if the plugin is enabled.
        """

    def shutdown(self):
        """ Called when Galaxy is shutting down, workflow scheduling should
        end.
        """


@six.add_metaclass(ABCMeta)
class ActiveWorkflowSchedulingPlugin(WorkflowSchedulingPlugin):

    @abstractmethod
    def schedule(self, workflow_invocation):
        """ Optionally return one or more commands to instrument job. These
        commands will be executed on the compute server prior to the job
        running.
        """