webapp.py

import sys
from .future import DSSFuture

if sys.version_info >= (3,0):
  import urllib.parse
  dku_quote_fn = urllib.parse.quote
else:
  import urllib
  dku_quote_fn = urllib.quote


class DSSWebApp(object):
    """
    A handle to manage a webapp
    """
    def __init__(self, client, project_key, webapp_id):
        """Do not call directly, use :meth:`dataikuapi.dss.project.DSSProject.get_webapps`"""
        self.client = client
        self.project_key = project_key
        self.webapp_id = webapp_id

    def get_state(self):
        """
        Return the state of the webapp

        :return: the state of the webapp
        :rtype: :class:`DSSWebAppBackendState`
        """
        state = self.client._perform_json("GET", "/projects/%s/webapps/%s/backend/state" % (self.project_key, self.webapp_id))
        return DSSWebAppBackendState(self.client, self.project_key, self.webapp_id, state)

    def stop_backend(self):
        """
        Stop a webapp
        """
        self.client._perform_empty("PUT", "/projects/%s/webapps/%s/backend/actions/stop" % (self.project_key, self.webapp_id))

    def restart_backend(self):
        """
        Restart a webapp
        :returns: a handle to a DSS future to track the progress of the restart
        :rtype: :class:`dataikuapi.dss.future.DSSFuture`
        """
        future = self.client._perform_json("PUT", "/projects/%s/webapps/%s/backend/actions/restart" % (self.project_key, self.webapp_id))
        return DSSFuture(self.client, future["jobId"])

    def get_definition(self):
        """
        Get a webapp definition

        :returns: a handle to manage the webapp definition
        :rtype: :class:`dataikuapi.dss.webapp.DSSWebAppDefinition`
        """
        definition = self.client._perform_json("GET", "/projects/%s/webapps/%s/" % (self.project_key, self.webapp_id))
        return DSSWebAppDefinition(self.client, self.project_key, self.webapp_id, definition)


class DSSWebAppBackendState(object):
    """
    A handle to manage WebApp backend state
    """
    def __init__(self, client, project_key, webapp_id, state):
        """Do not call directly, use :meth:`dataikuapi.dss.webapp.DSSWebApp.get_state`"""
        self.client = client
        self.project_key = project_key
        self.webapp_id = webapp_id
        self.state = state

    def get_state(self):
        """
        Returns the dict containing the current state of the webapp backend.
        Warning : this dict is replaced when webapp backend state changes

        :returns: a dict
        """
        return self.state

    def is_running(self):
        """
        Tells if the webapp app backend is running or not

        :returns: a bool
        """
        return "futureInfo" in self.state and \
               "alive" in self.state["futureInfo"] and \
               self.state["futureInfo"]["alive"]


class DSSWebAppDefinition(object):
    """
    A handle to manage a WebApp definition
    """
    def __init__(self, client, project_key, webapp_id, definition):
        """Do not call directly, use :meth:`dataikuapi.dss.webapp.DSSWebApp.get_definition`"""
        self.client = client
        self.project_key = project_key
        self.webapp_id = webapp_id
        self.definition = definition

    def get_definition(self):
        """
        Get the definition

        :returns: the definition of the webapp
        """
        return self.definition

    def set_definition(self, definition):
        """
        Set the definition

        :param definition : the definition of the webapp
        """
        self.definition = definition

    def save(self):
        """
        Save the current webapp definition and update it.
        """
        self.client._perform_json("PUT", "/projects/%s/webapps/%s" % (self.project_key, self.webapp_id), body=self.definition)
        self.definition = self.client._perform_json("GET", "/projects/%s/webapps/%s" % (self.project_key, self.webapp_id))