adding json support, save_as and save_to_stream

Author: chfw

.travis.yml

@@ -14,6 +14,6 @@ install:
   - pip install git+https://github.com/chfw/pyexcel.git
   - pip install -r tests/requirements.txt --use-mirrors
 script:
-  nosetests --rednose --with-cov
+  nosetests --rednose --with-cov --with-doctest --doctest-extension=.rst
 after_success:
   codecov

README.rst

@@ -1,4 +1,95 @@
 pyexcel-text
 ============
 
-It is a plugin to pyexcel and provides the capbility to present and write data in text fromats
+.. image:: https://api.travis-ci.org/chfw/pyexcel-text.svg?branch=master
+    :target: http://travis-ci.org/chfw/pyexcel-text
+
+It is a plugin to [pyexcel and extends its capbility to present and write data in text fromats mainly through `tabulate`:
+
+* "plain"
+* "simple"
+* "grid"
+* "pipe"
+* "orgtbl"
+* "rst"
+* "mediawiki"
+* "latex"
+* "latex_booktabs"
+* "json"
+
+Usage::
+
+    >>> import pyexcel as pe
+    >>> import pyexcel.ext.text as text
+    >>> content = [
+    ...     ["Column 1", "Column 2", "Column 3"],
+    ...     [1, 2, 3],
+    ...     [4, 5, 6],
+    ...     [7, 8, 9]
+    ... ]
+    >>> sheet = pe.Sheet(content)
+    >>> sheet
+    Sheet Name: pyexcel
+    --------  --------  --------
+    Column 1  Column 2  Column 3
+    1         2         3
+    4         5         6
+    7         8         9
+    --------  --------  --------
+    >>> sheet.name_columns_by_row(0)
+    >>> sheet
+    Sheet Name: pyexcel
+      Column 1    Column 2    Column 3
+    ----------  ----------  ----------
+             1           2           3
+             4           5           6
+             7           8           9
+    >>> multiple_sheets = {
+    ...      'Sheet 1':
+    ...          [
+    ...              [1.0, 2.0, 3.0],
+    ...              [4.0, 5.0, 6.0],
+    ...              [7.0, 8.0, 9.0]
+    ...          ],
+    ...      'Sheet 2':
+    ...          [
+    ...              ['X', 'Y', 'Z'],
+    ...              [1.0, 2.0, 3.0],
+    ...              [4.0, 5.0, 6.0]
+    ...          ],
+    ...      'Sheet 3':
+    ...          [
+    ...              ['O', 'P', 'Q'],
+    ...              [3.0, 2.0, 1.0],
+    ...              [4.0, 3.0, 2.0]
+    ...          ]
+    ...  }
+    >>> book = pe.Book(multiple_sheets)
+    >>> text.TABLEFMT = "rst"
+    >>> text.save_as(book, "myfile.rst")
+    >>> myfile = open("myfile.rst")
+    >>> print(myfile.read())
+    Sheet Name: Sheet 1
+    =  =  =
+    1  2  3
+    4  5  6
+    7  8  9
+    =  =  =
+    Sheet Name: Sheet 2
+    ===  ===  ===
+    X    Y    Z
+    1.0  2.0  3.0
+    4.0  5.0  6.0
+    ===  ===  ===
+    Sheet Name: Sheet 3
+    ===  ===  ===
+    O    P    Q
+    3.0  2.0  1.0
+    4.0  3.0  2.0
+    ===  ===  ===
+
+
+Dependencies
+============
+
+* tabulate

pyexcel_text/__init__.py

@@ -13,6 +13,7 @@
 
 TABLEFMT="simple"
 
+
 def class_name(name):
     if sys.version_info[0] > 2:
         return "<class '%s'>" % name
@@ -21,26 +22,53 @@ def class_name(name):
 
 
 def present_matrix(matrix_instance):
-    import tabulate
-    return tabulate.tabulate(matrix_instance.to_array(), tablefmt=TABLEFMT)
+    """Textualize a Matrix"""
+    if TABLEFMT == "json":
+        import json
+        return json.dumps(matrix_instance.to_array())
+    else:
+        import tabulate
+        return tabulate.tabulate(matrix_instance.to_array(), tablefmt=TABLEFMT)
 
 
 def present_nominable_sheet(nmsheet_instance):
-    import tabulate
-    ret = "Sheet Name: %s\n" % nmsheet_instance.name
-    if len(nmsheet_instance.colnames) > 0:
-        data = nmsheet_instance.to_array()
-        return ret+tabulate.tabulate(data, headers="firstrow")
+    """Textualize a NominableSheet"""
+    if TABLEFMT == "json":
+        import json
+        return json.dumps({nmsheet_instance.name:nmsheet_instance.to_array()})
     else:
-        return ret+present_matrix(nmsheet_instance)
+        import tabulate
+        ret = "Sheet Name: %s\n" % nmsheet_instance.name
+        if len(nmsheet_instance.colnames) > 0:
+            data = nmsheet_instance.to_array()
+            return ret+tabulate.tabulate(data, headers="firstrow")
+        else:
+            return ret+present_matrix(nmsheet_instance)
 
 
 def present_book(book_instance):
-    ret = ""
-    for sheet in book_instance.sheets:
-        ret += present_nominable_sheet(book_instance.sheets[sheet])
-        ret += "\n"
-    return ret.strip('\n')
+    """Textualize a pyexcel Book"""
+    if TABLEFMT == "json":
+        import json
+        return json.dumps(book_instance.to_dict())
+    else:
+        ret = ""
+        for sheet in book_instance.sheets:
+            ret += present_nominable_sheet(book_instance.sheets[sheet])
+            ret += "\n"
+        return ret.strip('\n')
+        
+
+def save_as(instance, filename):
+    """Save a pyexcel instance as text to a file"""
+    f = open(filename, "w")
+    f.write(str(instance))
+    f.close()
+
+
+def save_to_memory(instance, stream):
+    """Save a pyexcel instance as text to a stream"""
+    stream.write(str(instance))
 
 
 STRINGIFICATION[class_name("pyexcel.sheets.matrix.Matrix")] = present_matrix

tests/test_io.py

@@ -0,0 +1,60 @@
+import os
+import sys
+from textwrap import dedent
+import pyexcel as pe
+from pyexcel.ext import text
+if sys.version_info[0] < 3:
+    from StringIO import StringIO
+else:
+    from io import StringIO
+
+class TestIO:
+    def setUp(self):
+        self.testfile = "testfile.txt"
+    def test_normal_usage(self):
+        content = [
+            [1, 2, 3],
+            [4, 588, 6],
+            [7, 8, 999]
+        ]
+        s = pe.Sheet(content)
+        text.save_as(s, self.testfile)
+        f = open(self.testfile, "r")
+        written_content = f.read()
+        f.close()
+        content = dedent("""
+            Sheet Name: pyexcel
+            -  ---  ---
+            1    2    3
+            4  588    6
+            7    8  999
+            -  ---  ---""").strip('\n')
+        print written_content
+        assert written_content == content
+
+    def tearDown(self):
+        if os.path.exists(self.testfile):
+            os.unlink(self.testfile)
+
+
+class TestStream:
+    def setUp(self):
+        self.testfile = StringIO()
+    def test_normal_usage(self):
+        content = [
+            [1, 2, 3],
+            [4, 588, 6],
+            [7, 8, 999]
+        ]
+        s = pe.Sheet(content)
+        text.save_to_memory(s, self.testfile)
+        written_content = self.testfile.getvalue()
+        content = dedent("""
+            Sheet Name: pyexcel
+            -  ---  ---
+            1    2    3
+            4  588    6
+            7    8  999
+            -  ---  ---""").strip('\n')
+        print written_content
+        assert written_content == content

tests/test_presentation.py

@@ -3,7 +3,60 @@
 from pyexcel.ext import text
 
 
+class TestJson:
+    def setUp(self):
+        text.TABLEFMT = "json"
+
+    def test_matrix(self):
+        content = [
+            [1, 2, 3],
+            [4, 588, 6],
+            [7, 8, 999]
+        ]
+        s = pe.sheets.Matrix(content)
+        content = "[[1, 2, 3], [4, 588, 6], [7, 8, 999]]"
+        assert str(s) == content
+
+    def test_sheet(self):
+        content = [
+            [1, 2, 3],
+            [4, 588, 6],
+            [7, 8, 999]
+        ]
+        s = pe.Sheet(content, "mytest")
+        content = "{\"mytest\": [[1, 2, 3], [4, 588, 6], [7, 8, 999]]}"
+        assert str(s) == content
+
+    def test_book_presentation(self):
+        data = {
+            'Sheet 1':
+            [
+                [1.0, 2.0, 3.0],
+                [4.0, 5.0, 6.0],
+                [7.0, 8.0, 9.0]
+            ],
+            'Sheet 2':
+            [
+                ['X', 'Y', 'Z'],
+                [1.0, 2.0, 3.0],
+                [4.0, 5.0, 6.0]
+            ],
+            'Sheet 3':
+            [
+                ['O', 'P', 'Q'],
+                [3.0, 2.0, 1.0],
+                [4.0, 3.0, 2.0]
+            ]
+        }
+        book = pe.Book(data)
+        content = '{"Sheet 1": [[1.0, 2.0, 3.0], [4.0, 5.0, 6.0], [7.0, 8.0, 9.0]], "Sheet 2": [["X", "Y", "Z"], [1.0, 2.0, 3.0], [4.0, 5.0, 6.0]], "Sheet 3": [["O", "P", "Q"], [3.0, 2.0, 1.0], [4.0, 3.0, 2.0]]}'
+        assert str(book) == content
+
+
 class TestPresentation:
+    def setUp(self):
+        text.TABLEFMT = "simple"
+
     def test_normal_usage(self):
         content = [
             [1, 2, 3],
@@ -130,4 +183,3 @@ def test_book_presentation(self):
             4.0  3.0  2.0
             ---  ---  ---""").strip("\n")
         assert str(book) == content
-