New style io (#18)

* ☔ reproduce #12

* release 0.5.0 🥚 🎡

* 🤝 take latest code from setupmobans and release 0.5.1 🥚 🎡, which carries LICENSE file, pyexcel/pyexcel#103

* 🥚 🎡 release 0.5.2. related to pyexcel/pyexcel#105

* ✨ refuse to write value that will not persist. pyexcel/pyexcel-ods#30

* 🔨 sort import list, code format using black, supreme pep 8 formatter. and update moban to use latest moban 0.3.4

* ✨ use pyexcel-io 0.5.10

* 🔥 replace python 2.6 3.3 with python 3.7-dev

* 🥚 🎡 release 0.5.3

* 🔨 minor update

* 🤝 apply common templates from pyexcel mobans. moremoban/moban#348

* 👕 update coding style

* 📰 add missing files

* 📚 pass moban stage

* 🔥 no longer to generate test files

* ✨ respect moban

* 👕 update format.sh

* 🤝 synchronize the organisational meta data

* 🚀 github actions for moban, pypi release and automatically extract contributors

* This is an auto-commit, updating project meta data, such as changelog.rst, contributors.rst

* 🤝 update project meta

* 🤝 update project meta data

* 🎉 new style ods reader

* 🎉 new style ods writer

* 📚 update changelog

* This is an auto-commit, updating project meta data, such as changelog.rst, contributors.rst

* 💄 update coding style

* 💚 use pyexcel-io v0.6.0 in test

Co-authored-by: chfw <[email protected]>

Author: chfw

CHANGELOG.rst

@@ -1,6 +1,13 @@
 Change log
 ================================================================================
 
+0.6.0 - 2020
+--------------------------------------------------------------------------------
+
+**added**
+
+#. new style reader and writer plugins. works with pyexcel-io v0.6.0
+
 0.5.3 - 27.11.2018
 --------------------------------------------------------------------------------
 

changelog.yml

@@ -1,6 +1,12 @@
 name: pyexcel-ods3
 organisation: pyexcel
 releases:
+- changes:
+  - action: added
+    details:
+    - 'new style reader and writer plugins. works with pyexcel-io v0.6.0'
+  date: 2020
+  version: 0.6.0
 - changes:
   - action: added
     details:

pyexcel_ods3/__init__.py

@@ -15,15 +15,22 @@
 
 # this line has to be place above all else
 # because of dynamic import
-from pyexcel_io.plugins import IOPluginInfoChain
+from pyexcel_io.plugins import IOPluginInfoChain, IOPluginInfoChainV2
 
 __FILE_TYPE__ = "ods"
-IOPluginInfoChain(__name__).add_a_reader(
+IOPluginInfoChainV2(__name__).add_a_reader(
     relative_plugin_class_path="odsr.ODSBook",
+    locations=["file", "memory"],
+    file_types=[__FILE_TYPE__],
+    stream_type="binary",
+).add_a_reader(
+    relative_plugin_class_path="odsr.ODSBookInContent",
+    locations=["content"],
     file_types=[__FILE_TYPE__],
     stream_type="binary",
 ).add_a_writer(
     relative_plugin_class_path="odsw.ODSWriter",
+    locations=["file", "memory"],
     file_types=[__FILE_TYPE__],
     stream_type="binary",
 )

pyexcel_ods3/odsr.py

@@ -4,39 +4,41 @@
 
     ods reader
 
-    :copyright: (c)  2015-2017 by Onni Software Ltd. & its contributors
+    :copyright: (c)  2015-2020 by Onni Software Ltd. & its contributors
     :license: New BSD License
 """
-import ezodf
+from io import BytesIO
 
+import ezodf
 import pyexcel_io.service as service
-from pyexcel_io.book import BookReader
-from pyexcel_io.sheet import SheetReader
-from pyexcel_io._compact import OrderedDict
+from pyexcel_io.plugin_api.abstract_sheet import ISheet
+from pyexcel_io.plugin_api.abstract_reader import IReader
 
 
-class ODSSheet(SheetReader):
+class ODSSheet(ISheet):
     """ODS sheet representation"""
 
     def __init__(self, sheet, auto_detect_int=True, **keywords):
-        SheetReader.__init__(self, sheet, **keywords)
         self.auto_detect_int = auto_detect_int
+        self._native_sheet = sheet
+        self._keywords = keywords
 
     @property
     def name(self):
         return self._native_sheet.name
 
-    def number_of_rows(self):
+    def row_iterator(self):
         """
         Number of rows in the xls sheet
         """
-        return self._native_sheet.nrows()
+        return range(self._native_sheet.nrows())
 
-    def number_of_columns(self):
+    def column_iterator(self, row):
         """
         Number of columns in the xls sheet
         """
-        return self._native_sheet.ncols()
+        for column in range(self._native_sheet.ncols()):
+            yield self.cell_value(row, column)
 
     def cell_value(self, row, column):
         cell = self._native_sheet.get_cell((row, column))
@@ -63,63 +65,34 @@ def cell_value(self, row, column):
         return ret
 
 
-class ODSBook(BookReader):
-    """read a ods book out"""
-
-    def open(self, file_name, **keywords):
-        """load ods from file"""
-        BookReader.open(self, file_name, **keywords)
-        self._load_from_file()
-
-    def open_stream(self, file_stream, **keywords):
-        """load ods from file stream"""
-        BookReader.open_stream(self, file_stream, **keywords)
-        self._load_from_memory()
-
-    def read_sheet_by_name(self, sheet_name):
-        """read a named sheet"""
-        rets = [
-            sheet
-            for sheet in self._native_book.sheets
-            if sheet.name == sheet_name
+class ODSBook(IReader):
+    def __init__(self, file_alike_object, file_type, **keywords):
+        self._native_book = ezodf.opendoc(file_alike_object)
+        self._keywords = keywords
+        self.content_array = [
+            NameObject(sheet.name, sheet) for sheet in self._native_book.sheets
         ]
-        if len(rets) == 0:
-            raise ValueError("%s cannot be found" % sheet_name)
-        elif len(rets) == 1:
-            return self.read_sheet(rets[0])
-        else:
-            raise ValueError(
-                "More than 1 sheet named as %s are found" % sheet_name
-            )
-
-    def read_sheet_by_index(self, sheet_index):
-        """read a sheet at an index"""
-        sheets = self._native_book.sheets
-        length = len(sheets)
-        if sheet_index < length:
-            return self.read_sheet(sheets[sheet_index])
-        else:
-            raise IndexError(
-                "Index %d of out bound %d." % (sheet_index, length)
-            )
-
-    def read_all(self):
-        """read all available sheets"""
-        result = OrderedDict()
-        for sheet in self._native_book.sheets:
-            data_dict = self.read_sheet(sheet)
-            result.update(data_dict)
-        return result
-
-    def read_sheet(self, native_sheet):
+
+    def read_sheet(self, native_sheet_index):
+        native_sheet = self.content_array[native_sheet_index].sheet
         sheet = ODSSheet(native_sheet, **self._keywords)
-        return {native_sheet.name: sheet.to_array()}
+        return sheet
 
     def close(self):
         self._native_book = None
 
-    def _load_from_file(self):
-        self._native_book = ezodf.opendoc(self._file_name)
 
-    def _load_from_memory(self):
-        self._native_book = ezodf.opendoc(self._file_stream)
+class ODSBookInContent(ODSBook):
+    """
+    Open xlsx as read only mode
+    """
+
+    def __init__(self, file_content, file_type, **keywords):
+        io = BytesIO(file_content)
+        super().__init__(io, file_type, **keywords)
+
+
+class NameObject(object):
+    def __init__(self, name, sheet):
+        self.name = name
+        self.sheet = sheet

pyexcel_ods3/odsw.py

@@ -10,24 +10,24 @@
 import types
 
 import ezodf
-
 import pyexcel_io.service as service
-from pyexcel_io.book import BookWriter
-from pyexcel_io.sheet import SheetWriter
 from pyexcel_io.constants import MAX_INTEGER
 from pyexcel_io.exceptions import IntegerAccuracyLossError
+from pyexcel_io.plugin_api.abstract_sheet import ISheetWriter
+from pyexcel_io.plugin_api.abstract_writer import IWriter
 
 
-class ODSSheetWriter(SheetWriter):
+class ODSSheetWriter(ISheetWriter):
     """
     ODS sheet writer
     """
 
-    def set_sheet_name(self, name):
-        self._native_sheet = ezodf.Sheet(name)
+    def __init__(self, ods_book, ods_sheet, sheet_name, **keywords):
+        self._native_book = ods_book
+        self._native_sheet = ezodf.Sheet(sheet_name)
         self.current_row = 0
 
-    def set_size(self, size):
+    def _set_size(self, size):
         self._native_sheet.reset(size=size)
 
     def write_row(self, array):
@@ -62,7 +62,7 @@ def write_array(self, table):
         if rows < 1:
             return
         columns = max([len(row) for row in to_write_data])
-        self.set_size((rows, columns))
+        self._set_size((rows, columns))
         for row in to_write_data:
             self.write_row(row)
 
@@ -74,25 +74,21 @@ def close(self):
         self._native_book.sheets += self._native_sheet
 
 
-class ODSWriter(BookWriter):
+class ODSWriter(IWriter):
     """
     open document spreadsheet writer
 
     """
 
-    def __init__(self):
-        BookWriter.__init__(self)
-        self._native_book = None
-
-    def open(self, file_name, **keywords):
+    def __init__(
+        self, file_alike_object, file_type, skip_backup=True, **keywords
+    ):
         """open a file for writing ods"""
-        BookWriter.open(self, file_name, **keywords)
         self._native_book = ezodf.newdoc(
-            doctype="ods", filename=self._file_alike_object
+            doctype=file_type, filename=file_alike_object
         )
 
-        skip_backup_flag = self._keywords.get("skip_backup", True)
-        if skip_backup_flag:
+        if skip_backup:
             self._native_book.backup = False
 
     def create_sheet(self, name):

rnd_requirements.txt

@@ -1,2 +1 @@
-https://github.com/pyexcel/pyexcel-ezodf/archive/master.zip
-https://github.com/pyexcel/pyexcel-io/archive/v0.5.10.zip
+https://github.com/pyexcel/pyexcel-io/archive/dev.zip

tests/test_bug_fixes.py

@@ -4,10 +4,10 @@
 
 import psutil
 import pyexcel as pe
+from pyexcel_io.exceptions import IntegerAccuracyLossError
 
 from nose import SkipTest
 from nose.tools import eq_, raises
-from pyexcel_io.exceptions import IntegerAccuracyLossError
 
 IN_TRAVIS = "TRAVIS" in os.environ
 

tests/test_filter.py

@@ -1,8 +1,9 @@
 import os
 
-from nose.tools import eq_
 from pyexcel_io import get_data, save_data
 
+from nose.tools import eq_
+
 
 class TestFilter:
     def setUp(self):

tests/test_ods_reader.py

@@ -7,8 +7,9 @@
 
 class TestODSReader(ODSCellTypes):
     def setUp(self):
-        r = ODSBook()
-        r.open(os.path.join("tests", "fixtures", "ods_formats.ods"))
+        r = ODSBook(
+            os.path.join("tests", "fixtures", "ods_formats.ods"), "ods"
+        )
         self.data = r.read_all()
         for key in self.data.keys():
             self.data[key] = list(self.data[key])
@@ -17,19 +18,17 @@ def setUp(self):
 
 class TestODSWriter(ODSCellTypes):
     def setUp(self):
-        r = ODSBook()
-        r.open(
+        r = ODSBook(
             os.path.join("tests", "fixtures", "ods_formats.ods"),
+            "ods",
             skip_empty_rows=True,
         )
         self.data1 = r.read_all()
         self.testfile = "odswriter.ods"
-        w = ODSWriter()
-        w.open(self.testfile)
+        w = ODSWriter(self.testfile, "ods")
         w.write(self.data1)
         w.close()
-        r2 = ODSBook()
-        r2.open(self.testfile)
+        r2 = ODSBook(self.testfile, "ods")
         self.data = r2.read_all()
         for key in self.data.keys():
             self.data[key] = list(self.data[key])

tests/test_writer.py

@@ -13,12 +13,10 @@ def test_write_book(self):
             "Sheet3": [[u"X", u"Y", u"Z"], [1, 4, 7], [2, 5, 8], [3, 6, 9]],
         }
         self.testfile = "writer.ods"
-        writer = Writer()
-        writer.open(self.testfile)
+        writer = Writer(self.testfile, "ods")
         writer.write(self.content)
         writer.close()
-        reader = Reader()
-        reader.open(self.testfile)
+        reader = Reader(self.testfile, "ods")
         content = reader.read_all()
         for key in content.keys():
             content[key] = list(content[key])