Merge lp:~ben-hutchings/ensoft-sextant/audit-table into lp:ensoft-sextant

[Ben Hutchings]

Audit command now prints output as a formatted table

[Robert (rjwills)]

review: Needs Fixing

[Robert (rjwills)]

review: Needs Fixing

[lp:~ben-hutchings/ensoft-sextant/audit-table]

26. By Ben Hutchings on 2014-09-29

Added a maximum width restriction on table columns, removed a couple of instances of trailing whitespace

27. By Ben Hutchings on 2014-09-29

Added space around binary operator

28. By Ben Hutchings on 2014-09-29

Capitalised COLMAXLENS to make it look like a constant

Unmerged revisions

=== modified file 'src/sextant/__main__.py'
--- src/sextant/__main__.py	2014-09-26 11:25:09 +0000
+++ src/sextant/__main__.py	2014-09-29 15:01:36 +0000
@@ -81,14 +81,41 @@
         location = _displayable_url(args)
         logging.warning('No programs on database at {}.'.format(location))
     else:
-        for program in audited:
-            st = ('Program {progname} with {numfuncs} functions '
-                  'uploaded by {uploader} (id {uploaderid}) on {date}.')
-            print(st.format(progname=program.program_name,
-                            numfuncs=program.number_of_funcs,
-                            uploader=program.uploader,
-                            uploaderid=program.uploader_id,
-                            date=program.date))
+        # print data about all the programs in the database in a formatted table
+        titles = ("Name", "#Func", "Uploader", "User-ID", "Upload Date")
+        colminlens = (len(entry) for entry in titles)
+        # maximum lengths to avoid one entry from throwing the whole table
+        # date format is <YYYY:MM:DD HH:MM:SS.UUUUUU> = 26 characters
+        COLMAXLENS = (25, 5, 25, 10, 26)
+
+        # make a table of the strings of each data entry we will display
+        text = [map(str, (p.program_name, p.number_of_funcs,
+                          p.uploader, p.uploader_id, p.date))
+                for p in audited]
+
+        # and a table of the corresponding lengths for every text entry
+        textlens = ((len(entry) for entry in pentry) for pentry in text)
+
+        # the maxes of the column maxes of the textlens table and the
+        # lengths of the title row words give the column widths
+        textcollens = map(max, zip(*textlens))
+        # the lambda is exactly equivalent to calling
+        # min(max(colminlens, textcollens), COLMAXLENS),
+        # eg for x < low: sorted((low, x, high))[1] = (x, low, high)[1] = low
+        collens = map(lambda l: sorted(l)[1], zip(colminlens, textcollens, COLMAXLENS))
+
+        # insert the column widths into the format string
+        st = ('{{0:{0}}}  {{1:>{1}}}  {{2:{2}}}  {{3:{3}}}  '
+              '{{4:{4}}}'.format(*collens))
+
+        # write the title line so we know how long to make the separator line
+        titleline = st.format(*titles)
+        sepline = '-' * len(titleline)
+
+        # output the formatted table
+        print(titleline)
+        print(sepline)
+        print('\n'.join(st.format(*pentry) for pentry in text))
 
 
 def _add_program(args):