Refined report subpackage

Author: dhondta

src/tinyscript/report/base.py

@@ -13,9 +13,6 @@ def output(f):
     @wraps(f)
     def _wrapper(self, *args, **kwargs):
         from os.path import exists, splitext
-        if 'text' in kwargs:
-            kwargs.pop('text', None)
-            warn("'text' keyword has been deprecated, please use 'save_to_file' instead", DeprecationWarning)
         s2f = kwargs.pop('save_to_file', False)
         r = f(self, *args, **kwargs)
         if not s2f or r is None:
@@ -27,8 +24,6 @@ def _wrapper(self, *args, **kwargs):
             elif f.__name__ == "yaml":
                 from yaml import dump
                 r = dump(r, indent=kwargs.get('indent', 2), width=kwargs.get('width', 0))
-        if not isinstance(r, str):
-            raise TypeError("got report data in an unknown format (%s) ; should be str" % type(r).__name__)
         filename = "{}.{}".format(self.filename, f.__name__)
         while exists(filename):
             name, ext = splitext(filename)
@@ -89,7 +84,7 @@ def html(self, indent=4):
         return ""
 
     @output
-    def json(self):
+    def json(self, indent=2):
         return {self.name: self.data}
 
     @output
@@ -103,7 +98,7 @@ def xml(self, indent=2):
 
     @output
     def yaml(self, indent=2):
-        return self.json(indent=indent, save_to_file=False)
+        return self.json(indent=indent)
 
     @staticmethod
     def format_data(data, fmt):

src/tinyscript/report/objects.py

@@ -171,7 +171,7 @@ def html(self, indent=4):
         return s + ">"
 
     @output
-    def json(self):
+    def json(self, indent=2):
         return {}
 
     @output
@@ -263,7 +263,7 @@ def html(self, indent=4):
         return nl.join(r)
 
     @output
-    def json(self, orient="split"):
+    def json(self, indent=2, orient="split"):
         d = {}
         if len(self.data) > 0:
             ch = (self.column_headers[1:] if self.row_headers else self.column_headers) if self.column_headers else \

tests/test_report.py

@@ -7,9 +7,14 @@
 from utils import *
 
 
+FORMATS = ["csv", "html", "json", "md", "pdf", "rst", "xml", "yaml"]
+
+
 class TestReport(TestCase):
     def __try_formats(self, element):
-        for fmt in ["csv", "html", "json", "md", "rst", "xml"]:
+        for fmt in FORMATS:
+            if fmt == "pdf":
+                continue
             self.assertIsNotNone(getattr(element, fmt)())
 
     def test_report_text_elements(self):
@@ -49,7 +54,7 @@ def test_report_methods(self):
         r.extend(l)
         r.append("Free text")
         self.__try_formats(r)
-        for fmt in ["csv", "json", "md", "pdf", "rst", "xml", "yaml"]:
+        for fmt in FORMATS:
             getattr(r, fmt)(save_to_file=True)
             remove("report.%s" % fmt)
         r.clear()
@@ -68,12 +73,12 @@ def test_report_file_generation(self):
         remove("report-3.html")
         r.append(List("item1", "item2"))
         self.assertIsInstance(r.json(data_only=False), dict)
-        for fmt in ["csv", "json", "md", "pdf", "rst", "xml", "yaml"]:
+        for fmt in FORMATS:
             getattr(r, fmt)()
         r.pop()
         r.append(Table([["item1", "item2"]], column_headers=["h1", "h2"]))
         self.assertIsInstance(r.json(), dict)
-        for fmt in ["csv", "json", "md", "pdf", "rst", "xml", "yaml"]:
+        for fmt in FORMATS:
             getattr(r, fmt)(save_to_file=True)
             remove("report.%s" % fmt)
 
@@ -99,6 +104,6 @@ def test_report_table(self):
             getattr(t, fmt)()
         r = Report()
         r.append(t)
-        for fmt in ["csv", "json", "md", "pdf", "rst", "xml", "yaml"]:
+        for fmt in FORMATS:
             getattr(r, fmt)()