Merge pull request #686 from prospector-dev/add-sumary-everywhere

Have the summary also on pylint and vscode output

prospector/formatters/base_summary.py

@@ -0,0 +1,38 @@
+from prospector.formatters.base import Formatter
+
+
+class SummaryFormatter(Formatter):
+    """
+    This abstract formatter is used to output a summary of the prospector run.
+    """
+
+    summary_labels = (
+        ("started", "Started", None),
+        ("completed", "Finished", None),
+        ("time_taken", "Time Taken", lambda x: "%s seconds" % x),
+        ("formatter", "Formatter", None),
+        ("profiles", "Profiles", None),
+        ("strictness", "Strictness", None),
+        ("libraries", "Libraries Used", ", ".join),
+        ("tools", "Tools Run", ", ".join),
+        ("adaptors", "Adaptors", ", ".join),
+        ("message_count", "Messages Found", None),
+        ("external_config", "External Config", None),
+    )
+
+    def render_summary(self):
+        output = [
+            "Check Information",
+            "=================",
+        ]
+
+        label_width = max(len(label[1]) for label in self.summary_labels)
+
+        for key, label, formatter in self.summary_labels:
+            if key in self.summary:
+                value = self.summary[key]
+                if formatter is not None:
+                    value = formatter(value)
+                output.append(f" {label.rjust(label_width)}: {value}")
+
+        return "\n".join(output)

prospector/formatters/pylint.py

@@ -1,10 +1,10 @@
 import os
 import re
 
-from prospector.formatters.base import Formatter
+from prospector.formatters.base_summary import SummaryFormatter
 
 
-class PylintFormatter(Formatter):
+class PylintFormatter(SummaryFormatter):
     """
     This formatter outputs messages in the same way as pylint -f parseable , which is used by several
     tools to parse pylint output. This formatter is therefore a compatibility shim between tools built
@@ -41,4 +41,8 @@ def render(self, summary=True, messages=True, profile=False):
                 }
             )
 
+        if summary:
+            output.append("")
+            output.append(self.render_summary())
+
         return "\n".join(output)

prospector/formatters/text.py

@@ -1,51 +1,12 @@
-from prospector.formatters.base import Formatter
+from prospector.formatters.base_summary import SummaryFormatter
 
 __all__ = ("TextFormatter",)
 
 
 # pylint: disable=unnecessary-lambda
 
 
-class TextFormatter(Formatter):
-    summary_labels = (
-        ("started", "Started"),
-        ("completed", "Finished"),
-        ("time_taken", "Time Taken", lambda x: "%s seconds" % x),
-        ("formatter", "Formatter"),
-        ("profiles", "Profiles"),
-        ("strictness", "Strictness"),
-        ("libraries", "Libraries Used", lambda x: ", ".join(x)),
-        ("tools", "Tools Run", lambda x: ", ".join(x)),
-        ("adaptors", "Adaptors", lambda x: ", ".join(x)),
-        ("message_count", "Messages Found"),
-        ("external_config", "External Config"),
-    )
-
-    def render_summary(self):
-        output = [
-            "Check Information",
-            "=================",
-        ]
-
-        label_width = max(len(label[1]) for label in self.summary_labels)
-
-        for summary_label in self.summary_labels:
-            key = summary_label[0]
-            if key in self.summary:
-                label = summary_label[1]
-                if len(summary_label) > 2:
-                    value = summary_label[2](self.summary[key])
-                else:
-                    value = self.summary[key]
-                output.append(
-                    " %s: %s"
-                    % (
-                        label.rjust(label_width),
-                        value,
-                    )
-                )
-
-        return "\n".join(output)
+class TextFormatter(SummaryFormatter):
 
     def render_message(self, message):
         output = []

prospector/formatters/vscode.py

@@ -1,10 +1,10 @@
 import os
 import re
 
-from prospector.formatters.base import Formatter
+from prospector.formatters.base_summary import SummaryFormatter
 
 
-class VSCodeFormatter(Formatter):
+class VSCodeFormatter(SummaryFormatter):
     """
     This formatter outputs messages in the same way as vscode prospector linter expects.
     """
@@ -34,5 +34,8 @@ def render(self, summary=True, messages=True, profile=False):
                     "message": message.message.strip(),
                 }
             )
+        if summary:
+            output.append("")
+            output.append(self.render_summary())
 
         return "\n".join(output)