Added even more methods.

Author: rshipp

nut2.py

@@ -108,6 +108,17 @@ def _connect(self):
             if not result == "OK\n":
                 raise PyNUTError(result.replace("\n", ""))
 
+    def description(self, ups):
+        """Returns the description for a given UPS."""
+        logging.debug("description called...")
+
+        self._srv_handler.write("GET UPSDESC %s\n" % ups)
+        result = self._srv_handler.read_until("\n", self._timeout)
+        try:
+            return result.split('"')[1].strip()
+        except IndexError:
+            raise PyNUTError(result.replace("\n", ""))
+
     def list_ups(self):
         """Returns the list of available UPS from the NUT server.
 
@@ -132,17 +143,6 @@ def list_ups(self):
 
         return ups_dict
 
-    def description(self, ups):
-        """Returns the description for a given UPS."""
-        logging.debug("description called...")
-
-        self._srv_handler.write("GET UPSDESC %s\n" % ups)
-        result = self._srv_handler.read_until("\n", self._timeout)
-        try:
-            return result.split('"')[1].strip()
-        except IndexError:
-            raise PyNUTError(result.replace("\n", ""))
-
     def list_vars(self, ups):
         """Get all available vars from the specified UPS.
 
@@ -261,6 +261,52 @@ def list_rw_vars(self, ups):
 
         return rw_vars
 
+    def list_enum(self, ups, var):
+        """Get a list of valid values for an enum variable.
+
+        The result is presented as a list.
+        """
+        logging.debug("list_enum from '%s'...", ups)
+
+        self._srv_handler.write("LIST ENUM %s %s\n" % (ups, var))
+        result = self._srv_handler.read_until("\n", self._timeout)
+        if result != "BEGIN LIST ENUM %s %s\n" % (ups, var):
+            raise PyNUTError(result.replace("\n", ""))
+
+        result = self._srv_handler.read_until("END LIST ENUM %s %s\n" % (ups, var),
+                self._timeout)
+        offset = len("ENUM %s %s" % (ups, var))
+        end_offset = 0 - (len("END LIST ENUM %s %s\n" % (ups, var)) + 1)
+
+        try:
+            return [ c[offset:].split('"')[1].strip() 
+                for c in result[:end_offset].split("\n") ]
+        except IndexError:
+            raise PyNUTError(result.replace("\n", ""))
+
+    def list_range(self, ups, var):
+        """Get a list of valid values for an range variable.
+
+        The result is presented as a list.
+        """
+        logging.debug("list_range from '%s'...", ups)
+
+        self._srv_handler.write("LIST RANGE %s %s\n" % (ups, var))
+        result = self._srv_handler.read_until("\n", self._timeout)
+        if result != "BEGIN LIST RANGE %s %s\n" % (ups, var):
+            raise PyNUTError(result.replace("\n", ""))
+
+        result = self._srv_handler.read_until("END LIST RANGE %s %s\n" % (ups, var),
+                self._timeout)
+        offset = len("RANGE %s %s" % (ups, var))
+        end_offset = 0 - (len("END LIST RANGE %s %s\n" % (ups, var)) + 1)
+
+        try:
+            return [ c[offset:].split('"')[1].strip() 
+                for c in result[:end_offset].split("\n") ]
+        except IndexError:
+            raise PyNUTError(result.replace("\n", ""))
+
     def set_var(self, ups, var, value):
         """Set a variable to the specified value on selected UPS.
 
@@ -281,7 +327,7 @@ def get_var(self, ups, var):
         self._srv_handler.write("GET VAR %s %s\n" % (ups, var))
         result = self._srv_handler.read_until("\n", self._timeout)
         try:
-            # result = 'VAR %s %s "%s"' % (ups, var, value)
+            # result = 'VAR %s %s "%s"\n' % (ups, var, value)
             return result.split('"')[1].strip()
         except IndexError:
             raise PyNUTError(result.replace("\n", ""))
@@ -298,11 +344,27 @@ def var_description(self, ups, var):
         self._srv_handler.write("GET DESC %s %s\n" % (ups, var))
         result = self._srv_handler.read_until("\n", self._timeout)
         try:
-            # result = 'DESC %s %s "%s"' % (ups, var, description)
+            # result = 'DESC %s %s "%s"\n' % (ups, var, description)
             return result.split('"')[1].strip()
         except IndexError:
             raise PyNUTError(result.replace("\n", ""))
 
+    def var_type(self, ups, var):
+        """Get a variable's type."""
+        logging.debug("var_type called...")
+
+        self._srv_handler.write("GET TYPE %s %s\n" % (ups, var))
+        result = self._srv_handler.read_until("\n", self._timeout)
+        try:
+            # result = 'TYPE %s %s %s\n' % (ups, var, type)
+            type_ = ' '.join(result.split(' ')[3:]).strip()
+            # Ensure the response was valid.
+            assert(len(type_) > 0)
+            assert(result.startswith("TYPE"))
+            return type_
+        except AssertionError:
+            raise PyNUTError(result.replace("\n", ""))
+
     def command_description(self, ups, command):
         """Get a command's description."""
         logging.debug("command_description called...")

tests/mockserver.py

@@ -65,13 +65,13 @@ def run_command(self):
             return 'ERR INVALID-ARGUMENT\n'
         elif self.command == "LIST ENUM %s %s\n" % (self.valid, self.valid) and self.first:
             self.first = False
-            return 'BEGIN LIST ENUM %s %s\n' (self.valid, self.valid)
+            return 'BEGIN LIST ENUM %s %s\n' % (self.valid, self.valid)
         elif self.command == "LIST ENUM %s %s\n" % (self.valid, self.valid):
             return 'ENUM %s %s %s\nEND LIST ENUM %s %s\n' % (self.valid,
                     self.valid, self.valid_desc, self.valid, self.valid)
         elif self.command == "LIST RANGE %s %s\n" % (self.valid, self.valid) and self.first:
             self.first = False
-            return 'BEGIN LIST RANGE %s %s\n' (self.valid, self.valid)
+            return 'BEGIN LIST RANGE %s %s\n' % (self.valid, self.valid)
         elif self.command == "LIST RANGE %s %s\n" % (self.valid, self.valid):
             return 'RANGE %s %s %s %s\nEND LIST RANGE %s %s\n' % (self.valid,
                     self.valid, self.valid_desc, self.valid_desc, self.valid, self.valid)

tests/testclient.py

@@ -227,3 +227,27 @@ def test_command_description(self):
     def test_command_description_broken(self):
         self.assertRaises(PyNUTError, self.broken_client.command_description,
                 self.valid, self.valid)
+
+    def test_list_enum(self):
+        self.assertEquals(self.client.list_enum(self.valid, self.valid), 
+                [self.valid_desc])
+
+    def test_list_enum_broken(self):
+        self.assertRaises(PyNUTError, self.broken_client.list_enum,
+                self.valid, self.valid)
+
+    def test_list_range(self):
+        self.assertEquals(self.client.list_range(self.valid, self.valid), 
+                [self.valid_desc])
+
+    def test_list_range_broken(self):
+        self.assertRaises(PyNUTError, self.broken_client.list_range,
+                self.valid, self.valid)
+
+    def test_var_type(self):
+        self.assertEquals(self.client.var_type(self.valid, self.valid), 
+                "RW STRING:3")
+
+    def test_var_type_broken(self):
+        self.assertRaises(PyNUTError, self.broken_client.var_type,
+                self.valid, self.valid)