Added a table formatter, applied it to --device-list.

Author: mvidner

Makefile

@@ -6,7 +6,7 @@ check: check-nonm
 	for T in test/test02*.py; do $$T; done
 
 check-nonm:
-	for T in networkmanager/util.py; do python $$T; done
+	for T in `find . -name \*.py | xargs grep -l '>>>'`; do python $$T; done
 	for T in test/test01*.py; do $$T; done
 
 install:

cnetworkmanager

@@ -9,6 +9,7 @@ from networkmanager.monitor import Monitor
 from networkmanager.applet import NetworkManagerSettings, SYSTEM_SERVICE, USER_SERVICE
 from networkmanager.applet.service import NetworkManagerUserSettings
 import networkmanager.applet.settings as settings
+from networkmanager.util import Table
 
 # must be set before we ask for signals
 from dbus.mainloop.glib import DBusGMainLoop
@@ -22,6 +23,10 @@ from optparse import OptionParser
 
 op = OptionParser(version="%prog " + VERSION)
 
+op.add_option("--terse",
+              action="store_true", default=False,
+              help="No table headings and padding, suitable for parsing")
+
 # TODO http://docs.python.org/lib/optparse-adding-new-types.html
 op.add_option("-w", "--wifi",
               choices=["0","1","off","on","no","yes","false","true"],
@@ -94,6 +99,8 @@ op.add_option("--wpa-pass",
 
 (options, args) = op.parse_args()
 
+Table.terse = options.terse
+
 nm = NetworkManager()
 
 true_choices =  ["1", "on", "yes", "true"]
@@ -110,8 +117,10 @@ if options.whe:
 
 if options.device_list:
     devs = nm.GetDevices()
+    t = Table("Interface", "Type", "State")
     for dev in devs:
-        print dev["Interface"], dev["DeviceType"], dev["State"]
+        t.row(dev["Interface"], dev["DeviceType"], dev["State"])
+    print t
 
 # --device-info, TODO clean up 
 def get_device(dev_spec, hint):

networkmanager/util.py

@@ -68,6 +68,78 @@ def __str__(self):
         # TODO unknown values?
         return ",".join(names)
 
+class Table(object):
+    """Formats a table
+
+    >>> t = Table("A", "Bee", "C")
+
+    >>> t.row("ay", "B", "sea")
+
+    >>> t.row("", "b", "c")
+
+    >>> print t
+    A  | Bee | C  
+    ---+-----+----
+    ay | B   | sea
+       | b   | c  
+
+    >>> Table.terse = True
+
+    >>> print t
+    ay|B|sea
+    |b|c
+    """
+    # there are trailing spaces in the above non-terse printout
+
+    terse = False
+    "No headings and no padding, suitable for parsing."
+
+    def __init__(self, *args):
+        "The arguments are column headings."
+
+        self.headings = args
+        self.rows = []
+
+    def row(self, *args):
+        """The arguments are row items.
+
+        str is applied to them"""
+        self.rows.append(map(str,args))
+
+    @staticmethod
+    def pad_row(row, col_sizes):
+        return map(str.ljust, row, col_sizes)
+
+    def col_widths(self):
+        "Returns a list of the column widths."
+
+        # the table of lengths of original items
+        lengths = map(lambda cells: map(len, cells), self.rows + [self.headings])
+        return reduce(lambda cells1, cells2: map(max, cells1, cells2), lengths)
+
+    def terse_str(self):
+        "Formats the table, tersely."
+
+        rs = map("|".join, self.rows)
+        return "\n".join(rs)
+
+    def __str__(self):
+        "Formats the table."
+
+        if self.terse:
+            return self.terse_str()
+
+        cw = self.col_widths()
+        def fmt_row(items):
+            return " | ".join(self.pad_row(items, cw))
+        h = fmt_row(self.headings)
+        s = "-+-".join(map(lambda w: "-" * w, cw))
+        rs = map(fmt_row, self.rows)
+        rs.insert(0, s)
+        rs.insert(0, h)
+        return "\n".join(rs)
+
+
 if __name__ == "__main__":
     import doctest
     doctest.testmod()