better log formatting and limit lines to 80 char
[logparse.git] / logparse / formatting.py
index 00ea9e45f663d71836bcc1a336d0eb0c4e3c2c08..8528e1b262413bc00dd477b62b7a8298ff7da47b 100644 (file)
@@ -1,4 +1,3 @@
-#!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
 """   
@@ -19,6 +18,7 @@ import logparse
 from logparse import interface, util, mail, config
 
 import logging
+logger = None
 logger = logging.getLogger(__name__)
 
 
@@ -54,14 +54,17 @@ def init_var():
         if interface.argparser.parse_args().no_write:
             css_path = os.path.relpath(css_path, ".")
         elif interface.argparser.parse_args().destination:
-            css_path = os.path.relpath(css_path, interface.argparser.parse_args().destination())
+            css_path = os.path.relpath(
+                    css_path, interface.argparser.parse_args().destination())
         elif config.prefs.get("logparse", "output"):
-            css_path = os.path.relpath(css_path, config.prefs.get("logparse", "output"))
+            css_path = os.path.relpath(
+                    css_path, config.prefs.get("logparse", "output"))
     VARSUBST = {
         "title": config.prefs.get("logparse", "title"),
         "date": interface.start.strftime(DATEFMT),
         "time": interface.start.strftime(TIMEFMT),
-        "hostname": util.hostname(config.prefs.get("logparse", "hostname-path")),
+        "hostname": util.hostname(config.prefs.get(
+            "logparse", "hostname-path")),
         "version": logparse.__version__,
         "css": css_path
     }
@@ -104,7 +107,8 @@ class Output:
 
         print()
         if lines:
-            line = PlaintextLine(linewidth=config.prefs.getint("plain", "linewidth"), double=True)
+            line = PlaintextLine(linewidth=
+                    config.prefs.getint("plain", "linewidth"), double=True)
             print(line.draw())
         print(self.content)
         if lines:
@@ -114,7 +118,8 @@ class Output:
 
 class PlaintextOutput(Output):
     """
-    Processes & outputs data in a plaintext form which can be read with cat or plaintext email.
+    Processes & outputs data in a plaintext form which can be read with cat or
+    plaintext email.
     """
 
     def __init__(self, linewidth=80):
@@ -126,7 +131,10 @@ class PlaintextOutput(Output):
         """
         Print details with some primitive formatting
         """
-        box = PlaintextBox(content=Template("$title $version on $hostname\n\n$time $date").safe_substitute(VARSUBST), vpadding=2, hpadding="\t\t", linewidth=self.linewidth)
+        box = PlaintextBox(content=
+                Template("$title $version on $hostname\n\n$time $date")
+                .safe_substitute(VARSUBST),
+                vpadding=2, hpadding="\t\t", linewidth=self.linewidth)
         line = PlaintextLine(self.linewidth)
         self.append(box.draw() + line.draw())
 
@@ -143,9 +151,12 @@ class PlaintextOutput(Output):
         This should be run by interface.py after every instance of parse_log().
         """
 
-        self.append(PlaintextBox(content=section.title, double=False, fullwidth=False, vpadding=0, hpadding=" ").draw())
+        self.append(PlaintextBox(
+            content=section.title, double=False,
+            fullwidth=False, vpadding=0, hpadding=" ").draw())
         if section.period and section.period.unique:
-            self.append("\n(since {0})".format(section.period.startdate.strftime(DATEFMT + " " + TIMEFMT)))
+            self.append("\n(since {0})".format(
+                section.period.startdate.strftime(DATEFMT + " " + TIMEFMT)))
         self.append('\n'*2)
         for data in section.data:
             self.append(self._fmt_data(data.subtitle, data.items))
@@ -218,7 +229,9 @@ class HtmlOutput(Output):
         """
 
         if not self._embedded:
-            self._embedded = mail.mailprep(re.sub(".*" + re.escape(VARSUBST['css']) + ".*\n", "", self.content), css)
+            self._embedded = mail.mailprep(re.sub(
+                ".*" + re.escape(VARSUBST['css']) + ".*\n", "", self.content),
+                css)
         return self._embedded
 
     def write_embedded(self, destination = ""):
@@ -261,8 +274,9 @@ class HtmlOutput(Output):
 
     def append_section(self, section):
         """
-        Call the appropriate methods to generate HTML tags for a section (provided by a parser).
-        This should be run by interface.py after every instance of parse_log().
+        Call the appropriate methods to generate HTML tags for a section
+        (provided by a parser). This should be run by interface.py after every
+        instance of parse_log().
         """
 
         self.append(opentag('div', 1, section.title, 'section'))
@@ -304,10 +318,12 @@ class HtmlOutput(Output):
             logger.debug("Received data " + str(data))
             subtitle += ':'
             if (len(data) == 1):
-                return tag('p', False, subtitle + ' ' + data[0], cl="severity-" + str(severity))
+                return tag('p', False, subtitle + ' ' + data[0],
+                        cl="severity-" + str(severity))
             else:
                 output = ""
-                output += tag('p', False, subtitle, cl="severity-" + str(severity))
+                output += tag('p', False, subtitle,
+                        cl="severity-" + str(severity))
                 output += opentag('ul', 1)
                 coderegex = re.compile('`(.*)`')
                 for datum in data:
@@ -334,7 +350,8 @@ class HtmlOutput(Output):
             self.embed_css(config.prefs.get("html", "css"))
         print()
         if lines:
-            line = PlaintextLine(linewidth=config.prefs.getint("plain", "linewidth"), double=True)
+            line = PlaintextLine(linewidth=
+                    config.prefs.getint("plain", "linewidth"), double=True)
             print(line.draw())
         print(self._embedded)
         if lines:
@@ -382,7 +399,8 @@ class Data:
 
     def truncl(self, limit):      # truncate list
         """
-        Truncate self.items to a specified value and state how many items are hidden.
+        Truncate self.items to a specified value and state how many items are
+        hidden.
         """
 
         if (len(self.items) > limit):
@@ -400,7 +418,8 @@ class Data:
         """
 
         unsorted = list(self.items)
-        self.items = ["{0} ({1})".format(y, unsorted.count(y)) for y in sorted(set(unsorted), key = lambda x: -unsorted.count(x))]
+        self.items = ["{0} ({1})".format(y, unsorted.count(y)) for y in sorted(
+            set(unsorted), key = lambda x: -unsorted.count(x))]
         return self
 
 
@@ -409,7 +428,8 @@ class Table(object):
     A wrapper for python-tabulate's Tabulate type.
     """
     
-    def __init__(self, double=False, borders=False, hpadding=" ", maxwidth=80, headers=[]):
+    def __init__(self, double=False, borders=False, hpadding=" ",
+            maxwidth=80, headers=[]):
         """
         Initialise variables. Note the keymap is used for a faster index map,
         but is not currently used anywhere (may be removed in future).
@@ -446,7 +466,7 @@ class Table(object):
         self._align_cols[i] = align
         for row in self.rows:
             row.columns[i].align = align
-        logger.debug("Column alignment is now {0}".format(str(self._align_cols)))
+        logger.debug("Column alignment is now {0}".format(self._align_cols))
 
     def _gen_list(self):
         """
@@ -466,7 +486,8 @@ class Table(object):
         Output HTML string (wrapper for tabulate)
         """
 
-        output = tabulate(self._gen_list(), self.headers, tablefmt="html", colalign=tuple(self._align_cols))
+        output = tabulate(self._gen_list(), self.headers, tablefmt="html",
+                colalign=tuple(self._align_cols))
         return output
 
     def draw_plain(self):
@@ -474,7 +495,9 @@ class Table(object):
         Output plain text string (wrapper for tabulate)
         """
 
-        output = tabulate(self._gen_list(), self.headers, tablefmt="fancy_grid" if self.borders else "plain", colalign=tuple(self._align_cols))
+        output = tabulate(self._gen_list(), self.headers,
+                tablefmt="fancy_grid" if self.borders
+                else "plain", colalign=tuple(self._align_cols))
         return output + "\n"*2
 
 
@@ -549,7 +572,9 @@ class PlaintextLine:
         """
 
         line = (LINECHARS_DOUBLE[1] if self.double else LINECHARS_SINGLE[1])
-        return "\n" * self.vpadding + self.hpadding +  line * (self.linewidth - 2 * len(self.hpadding)) + self.hpadding + "\n" * self.vpadding
+        return "\n" * self.vpadding + self.hpadding \
+                +  line * (self.linewidth - 2 * len(self.hpadding)) \
+                + self.hpadding + "\n" * self.vpadding
 
 
 class PlaintextBox:
@@ -557,7 +582,8 @@ class PlaintextBox:
     Draw a rectangular box around text, with customisable padding/size/style
     """
 
-    def __init__(self, content="", double=True, fullwidth=True, linewidth=80, hpadding="\t", vpadding=1):
+    def __init__(self, content="", double=True, fullwidth=True, linewidth=80,
+            hpadding="\t", vpadding=1):
         """
         Initialise variables
         """
@@ -587,9 +613,12 @@ class PlaintextBox:
 
         # Calculate number of characters per line
         contentlines = self.content.splitlines()
-        contentwidth = int((self.linewidth if self.linewidth > 0 else 80) if self.content.splitlines() else len(max(contentlines, key=len)))
+        contentwidth = int((self.linewidth if self.linewidth > 0 else 80)
+                if self.content.splitlines()
+                else len(max(contentlines, key=len)))
         logger.debug("Contentwidth is {0}".format(str(contentwidth)))
-        logger.debug("Longest line is {0}".format(len(max(contentlines, key=len))))
+        logger.debug("Longest line is {0}".format(
+            len(max(contentlines, key=len))))
         contentwidth += -2*(len(self.hpadding)+1)
         if not self.fullwidth:
             longestline = len(max(contentlines, key=len))
@@ -614,7 +643,8 @@ class PlaintextBox:
                 contentlines[i] = res
 
         # Flatten list
-        #   Note list comprehension doesn't work here, so we must iterate through each item
+        #   Note list comprehension doesn't work here, so we must iterate
+        #   through each item
         newlines = []
         for line in contentlines:
             if isinstance(line, list):
@@ -630,9 +660,14 @@ class PlaintextBox:
             contentlines.append(' '*contentwidth)
 
         # Insert horizontal padding on lines that are too short
-        contentlines = [linechars[0] + self.hpadding + x + ' '*(self.linewidth-(len(x)+2*len(self.hpadding)+2) if len(x) < contentwidth else 0) + self.hpadding + linechars[0] for x in contentlines]
-        contentlines.insert(0, cornerchars[3] + linechars[1] * (contentwidth + len(self.hpadding)*2) + cornerchars[2])
-        contentlines.append(cornerchars[0] + linechars[1] * (contentwidth + len(self.hpadding)*2) + cornerchars[1])
+        contentlines = [linechars[0] + self.hpadding + x
+                + ' '*(self.linewidth-(len(x)+2*len(self.hpadding)+2)
+                    if len(x) < contentwidth else 0)
+                + self.hpadding + linechars[0] for x in contentlines]
+        contentlines.insert(0, cornerchars[3] + linechars[1] 
+                * (contentwidth + len(self.hpadding)*2) + cornerchars[2])
+        contentlines.append(cornerchars[0] + linechars[1]
+                * (contentwidth + len(self.hpadding)*2) + cornerchars[1])
         return ('\n').join(contentlines)
 
 
@@ -701,7 +736,8 @@ def opentag(tag, block=False, id=None, cl=None, style=None):
         output += " class='" + cl + "'"
     if style:
         output += " style='"
-        output += " ".join("{0}: {1};".format(attr, value) for attr, value in style.items())
+        output += " ".join("{0}: {1};".format(attr, value)
+                for attr, value in style.items())
         output += "'"
     output += '>'
     if block: