added --raw-data option

qvm-tools/qvm-ls

@@ -24,7 +24,7 @@
 from qubes.qubes import QubesVmCollection
 from qubes.qubes import QubesHost
 from qubes.qubes import QubesException
-from optparse import OptionParser
+from argparse import ArgumentParser
 import sys
 
 
@@ -91,91 +91,104 @@ fields = {
 
 
 def main():
-    usage = "usage: %prog [options] <vm-name>"
+    usage = "%(prog)s [options]"
-    parser = OptionParser (usage)
+    parser = ArgumentParser ()
 
-    parser.add_option ("-n", "--network", dest="network",
+    parser.add_argument ("VMs", action="store", nargs="*",
+                        help="Specify VMs to be queried")
+
+    parser.add_argument ("-n", "--network", dest="network",
                        action="store_true", default=False,
                        help="Show network addresses assigned to VMs")
 
-    parser.add_option ("-c", "--cpu", dest="cpu",
+    parser.add_argument ("-c", "--cpu", dest="cpu",
                        action="store_true", default=False,
                        help="Show CPU load")
 
-    parser.add_option ("-m", "--mem", dest="mem",
+    parser.add_argument ("-m", "--mem", dest="mem",
                        action="store_true", default=False,
                        help="Show memory usage")
 
-    parser.add_option ("-d", "--disk", dest="disk",
+    parser.add_argument ("-d", "--disk", dest="disk",
                        action="store_true", default=False,
                        help="Show VM disk utilization statistics")
 
-    parser.add_option ("-k", "--kernel", dest="kernel",
+    parser.add_argument ("-k", "--kernel", dest="kernel",
                        action="store_true", default=False,
-                       help="Show VM kernel options")
+                       help="Show VM kernel arguments")
 
-    parser.add_option ("-i", "--ids", dest="ids",
+    parser.add_argument ("-i", "--ids", dest="ids",
                        action="store_true", default=False,
                        help="Show Qubes and Xen id#s")
 
-    parser.add_option("-b", "--last-backup", dest="backup",
+    parser.add_argument("-b", "--last-backup", dest="backup",
                       action="store_true", default=False,
                       help="Show date of last VM backup")
 
-    parser.add_option("--raw-list", dest="raw_list",
+    parser.add_argument("--raw-list", dest="raw_list",
                       action="store_true", default=False,
                       help="List only VM names one per line")
 
+    parser.add_argument("--raw-data", dest="raw_data",
+                        action="store", nargs="+",
+                        help="Display specify data of specified VMs.\
+                              Intended for bash-parsing.")
 
-    (options, args) = parser.parse_args ()
+
+    arguments = parser.parse_args ()
 
     qvm_collection = QubesVmCollection()
     qvm_collection.lock_db_for_reading()
     qvm_collection.load()
     qvm_collection.unlock_db()
 
-    if options.raw_list:
+    if arguments.raw_list:
         for vm in qvm_collection.values():
             print vm.name
         return
 
-    fields_to_display = ["name", "on", "state", "updbl", "type", "template", "netvm", "label" ]
-
     cpu_usages = None
 
-    if (options.ids):
+    if arguments.raw_data:
+        if ''
+    fields_to_display = ["name", "on", "state", "updbl", "type", "template", "netvm", "label" ]
+
+    if (arguments.ids):
         fields_to_display += ["qid", "xid"]
 
-    if (options.cpu):
+    if (arguments.cpu):
         qhost = QubesHost()
         (measure_time, cpu_usages) = qhost.measure_cpu_usage(qvm_collection)
         fields_to_display += ["cpu"]
 
-    if (options.mem):
+    if (arguments.mem):
         fields_to_display += ["mem"]
 
-    if options.backup:
+    if arguments.backup:
         fields_to_display += ["last backup"]
 
-    if (options.network):
+    if (arguments.network):
         if 'template' in fields_to_display:
             fields_to_display.remove ("template")
         fields_to_display += ["ip", "ip back", "gateway/DNS"]
 
-    if (options.disk):
+    if (arguments.disk):
         if 'template' in fields_to_display:
             fields_to_display.remove ("template")
         if 'netvm' in fields_to_display:
             fields_to_display.remove ("netvm")
         fields_to_display += ["priv-curr", "priv-max", "root-curr", "root-max", "disk" ]
 
-    if (options.kernel):
+    if (arguments.kernel):
         fields_to_display += ["kernel", "kernelopts" ]
 
     
     vms_list = [vm for vm in qvm_collection.values()]
-    if len(args) > 0:
+    #assume VMs are presented in desired order:
-        vms_list = [vm for vm in vms_list if vm.name in args]
+    if len(arguments.VMs) > 0:
+        vms_list = [vm for vm in vms_list if vm.name in arguments.VMs]
+    #otherwise, format them accordingly:
+    else:
         no_vms = len (vms_list)
         vms_to_display = []
         # Frist, the NetVMs...
@@ -200,10 +213,14 @@ def main():
 
         assert len(vms_to_display) == no_vms
 
+        #We DON'T NEED a max_width if we devide output by pipes!
+
         # First calculate the maximum width of each field we want to display
         #  also collect data to display
         for f in fields_to_display:
             fields[f]["max_width"] = len(f)
+
+
     data_to_display = []
     for vm in vms_to_display:
         data_row = {}
@@ -213,7 +230,7 @@ def main():
             else:
                 data_row[f] = str(eval(fields[f]["func"]))
             l = len(data_row[f])
-            if l > fields[f]["max_width"]:
+            if 'max_width' in fields[f] and l > fields[f]["max_width"]:
                 fields[f]["max_width"] = l
         data_to_display.append(data_row)
         try:
@@ -221,6 +238,8 @@ def main():
         except QubesException as err:
             print >> sys.stderr, "WARNING: VM '{0}' has corrupted files!".format(vm.name)
 
+    #Nicely formatted header only needed for humans
+    if not arguments.raw_data:
         # XXX: For what?
         total_width = 0;
         for f in fields_to_display:
@@ -251,4 +270,9 @@ def main():
                 s += fmt.format(row[f]) 
             print s
 
+    #won't look pretty, but is easy to parse!
+    else:
+        for row in data_to_display:
+            print '|'.join([row[f] for f in fields_to_display])
+
 main()