Merge pull request #22 from selurvedu/pretty_output

Prettify representation of Munches

@@ -21,6 +21,18 @@ eggs =
     robotframework-debuglibrary
 
 interpreter = python_interpreter
+# The following piece of code changes the default output format of Munch
+# for Munch-to-str conversion and for generation of so-called repr.
+#
+# As a result, Robot Framework records pretty human-readable (YAML) data in its
+# log files instead of ugly piles of Munch(data=Munch(foo=Munch(...))).
+#
+# Original idea: https://github.com/Infinidat/munch/blob/2.0.4/README.md#serialization
+initialization =
+    from munch import Munch
+    Munch.__str__ = lambda self: Munch.toYAML(self, allow_unicode=True,
+                                              default_flow_style=False)
+    Munch.__repr__ = Munch.__str__
 
 [remotes]
 gh = git://github.com/

@@ -58,15 +58,32 @@ def compare_date(data1, data2):
        return False
     return True
 
-def log_object_data(data, file_name="", format="yaml"):
+def log_object_data(data, file_name=None, format="yaml"):
+    """Log object data in pretty format (JSON or YAML)
+
+    Two output formats are supported: "yaml" and "json".
+
+    If a file name is specified, the output is written into that file.
+
+    If you would like to get similar output everywhere,
+    use the following snippet somewhere in your code
+    before actually using Munch. For instance,
+    put it into your __init__.py, or, if you use zc.buildout,
+    specify it in "initialization" setting of zc.recipe.egg.
+
+    from munch import Munch
+    Munch.__str__ = lambda self: Munch.toYAML(self, allow_unicode=True,
+                                              default_flow_style=False)
+    Munch.__repr__ = Munch.__str__
+    """
     if not isinstance(data, Munch):
         data = munchify(data)
-    if format == 'json':
+    if format.lower() == 'json':
         data = data.toJSON(indent=2)
     else:
         data = data.toYAML(allow_unicode=True, default_flow_style=False)
         format = 'yaml'
-    LOGGER.log_message(Message(data, "INFO"))
+    LOGGER.log_message(Message(data.decode('utf-8'), "INFO"))
     if file_name:
         output_dir = BuiltIn().get_variable_value("${OUTPUT_DIR}")
         with open(os.path.join(output_dir, file_name + '.' + format), "w") as file_obj: