Expanding controller.py with basic user functions, get_models and destroy (#89)
[osm/N2VC.git] / juju / unit.py
index ab9d1d0..29126cb 100644 (file)
@@ -63,13 +63,13 @@ class Unit(model.ModelEntity):
             form 'POOL,COUNT,SIZE'
 
         """
-        pass
+        raise NotImplementedError()
 
     def collect_metrics(self):
         """Collect metrics on this unit.
 
         """
-        pass
+        raise NotImplementedError()
 
     async def destroy(self):
         """Destroy this unit.
@@ -91,7 +91,7 @@ class Unit(model.ModelEntity):
             unit
 
         """
-        pass
+        raise NotImplementedError()
 
     def resolved(self, retry=False):
         """Mark unit errors resolved.
@@ -99,16 +99,14 @@ class Unit(model.ModelEntity):
         :param bool retry: Re-execute failed hooks
 
         """
-        pass
+        raise NotImplementedError()
 
     async def run(self, command, timeout=None):
         """Run command on this unit.
 
         :param str command: The command to run
         :param int timeout: Time to wait before command is considered failed
-
-        Returns a tuple containing the stdout, stderr, and return code
-        from the command.
+        :returns: A :class:`juju.action.Action` instance.
 
         """
         action = client.ActionFacade()
@@ -131,11 +129,12 @@ class Unit(model.ModelEntity):
 
         :param str action_name: Name of action to run
         :param \*\*params: Action parameters
-        :returns: A`juju.action.Action` instance.
+        :returns: A :class:`juju.action.Action` instance.
 
         Note that this only enqueues the action.  You will need to call
         ``action.wait()`` on the resulting `Action` instance if you wish
         to block until the action is complete.
+
         """
         action_facade = client.ActionFacade()
         action_facade.connect(self.connection)
@@ -173,13 +172,13 @@ class Unit(model.ModelEntity):
         :param str scp_opts: Additional options to the `scp` command
 
         """
-        pass
+        raise NotImplementedError()
 
     def set_meter_status(self):
         """Set the meter status on this unit.
 
         """
-        pass
+        raise NotImplementedError()
 
     def ssh(
             self, command, user=None, proxy=False, ssh_opts=None):
@@ -191,7 +190,7 @@ class Unit(model.ModelEntity):
         :param str ssh_opts: Additional options to the `ssh` command
 
         """
-        pass
+        raise NotImplementedError()
 
     def status_history(self, num=20, utc=False):
         """Get status history for this unit.
@@ -200,7 +199,7 @@ class Unit(model.ModelEntity):
         :param bool utc: Display time as UTC in RFC3339 format
 
         """
-        pass
+        raise NotImplementedError()
 
     async def is_leader_from_status(self):
         """
@@ -241,5 +240,10 @@ class Unit(model.ModelEntity):
                                                                 False)
 
     async def get_metrics(self):
+        """Get metrics for the unit.
+
+        :return: Dictionary of metrics for this unit.
+
+        """
         metrics = await self.model.get_metrics(self.tag)
         return metrics[self.name]