Source code for galaxy.webapps.galaxy.api.tool_dependencies

"""
API operations allowing clients to manage tool dependencies.
"""
import logging

from galaxy.tool_util.deps import views
from galaxy.web import (
    expose_api,
    require_admin
)
from galaxy.webapps.base.controller import BaseAPIController

log = logging.getLogger(__name__)


[docs]class ToolDependenciesAPIController(BaseAPIController):

[docs]    def __init__(self, app):
        super(ToolDependenciesAPIController, self).__init__(app)
        self._view = views.DependencyResolversView(app)

[docs]    @expose_api
    @require_admin
    def index(self, trans, **kwd):
        """
        GET /api/dependency_resolvers
        """
        return self._view.index()

[docs]    @expose_api
    @require_admin
    def show(self, trans, id):
        """
        GET /api/dependency_resolvers/<id>
        """
        return self._view.show(id)

[docs]    @expose_api
    @require_admin
    def update(self, trans):
        """
        PUT /api/dependency_resolvers

        Reload tool dependency resolution configuration.
        """
        return self._view.reload()

[docs]    @expose_api
    @require_admin
    def resolver_dependency(self, trans, id, **kwds):
        """
        GET /api/dependency_resolvers/{index}/dependency

        Resolve described requirement against specified dependency resolver.

        :type   index:    int
        :param  index:    index of the dependency resolver
        :type   kwds:     dict
        :param  kwds:     dictionary structure containing extra parameters
        :type   name:     str
        :param  name:     name of the requirement to find a dependency for (required)
        :type   version:  str
        :param  version:  version of the requirement to find a dependency for (required)
        :type   exact:    bool
        :param  exact:    require an exact match to specify requirement (do not discard
                          version information to resolve dependency).

        :rtype:     dict
        :returns:   a dictified description of the dependency, with attribute
                    ``dependency_type: None`` if no match was found.
        """
        return self._view.resolver_dependency(id, **kwds)

[docs]    @expose_api
    @require_admin
    def install_dependency(self, trans, id=None, **kwds):
        """
        POST /api/dependency_resolvers/{index}/dependency

        Install described requirement against specified dependency resolver.

        :type   index:    int
        :param  index:    index of the dependency resolver
        :type   kwds:     dict
        :param  kwds:     dictionary structure containing extra parameters
        :type   name:     str
        :param  name:     name of the requirement to find a dependency for (required)
        :type   version:  str
        :param  version:  version of the requirement to find a dependency for (required)
        :type   exact:    bool
        :param  exact:    require an exact match to specify requirement (do not discard
                          version information to resolve dependency).

        :rtype:     dict
        :returns:   a dictified description of the dependency, with attribute
                    ``dependency_type: None`` if no match was found.
        """
        self._view.install_dependency(id, **kwds)
        return self._view.manager_dependency(**kwds)

[docs]    @expose_api
    @require_admin
    def manager_dependency(self, trans, **kwds):
        """
        GET /api/dependency_resolvers/dependency

        Resolve described requirement against all dependency resolvers, returning
        the match with highest priority.

        :type   index:    int
        :param  index:    index of the dependency resolver
        :type   kwds:     dict
        :param  kwds:     dictionary structure containing extra parameters
        :type   name:     str
        :param  name:     name of the requirement to find a dependency for (required)
        :type   version:  str
        :param  version:  version of the requirement to find a dependency for (required)
        :type   exact:    bool
        :param  exact:    require an exact match to specify requirement (do not discard
                          version information to resolve dependency).

        :rtype:     dict
        :returns:   a dictified description of the dependency, with type: None
                    if no match was found.
        """
        return self._view.manager_dependency(**kwds)

[docs]    @expose_api
    @require_admin
    def resolver_requirements(self, trans, id, **kwds):
        """
        GET /api/dependency_resolvers/{index}/requirements

        Find all "simple" requirements that could be resolved "exactly"
        by this dependency resolver. The dependency resolver must implement
        ListDependencyResolver.

        :type   index:    int
        :param  index:    index of the dependency resolver

        :rtype:     dict
        :returns:   a dictified description of the requirement that could
                    be resolved.
        """
        return self._view.resolver_requirements(id)

[docs]    @expose_api
    @require_admin
    def manager_requirements(self, trans, **kwds):
        """
        GET /api/dependency_resolvers/requirements

        Find all "simple" requirements that could be resolved "exactly"
        by all dependency resolvers that support this operation.

        :type   index:    int
        :param  index:    index of the dependency resolver

        :rtype:     dict
        :returns:   a dictified description of the requirement that could
                    be resolved (keyed on 'requirement') and the index of
                    the corresponding resolver (keyed on 'index').
        """
        return self._view.manager_requirements()

[docs]    @expose_api
    @require_admin
    def clean(self, trans, id=None, **kwds):
        """
        POST /api/dependency_resolvers/{index}/clean

        Cleans up intermediate files created by resolvers during the dependency
        installation.

        :type   index:    int
        :param  index:    index of the dependency resolver

        :rtype:     dict
        :returns:   a dictified description of the requirement that could
                    be resolved (keyed on 'requirement') and the index of
                    the corresponding resolver (keyed on 'index').
        """
        return self._view.clean(id, **kwds)