adjust function names of sheet for better maintenance

Author: chfw

pyexcel_io/database/querysets.py

@@ -19,11 +19,11 @@ def to_array(self):
         for element in SheetReader.to_array(self):
             yield element
 
-    def _iterate_rows(self):
+    def row_iterator(self):
         return chain([self.__column_names],
                      self.__query_sets)
 
-    def _iterate_columns(self, row):
+    def column_iterator(self, row):
         if self.__column_names is not None:
             if isinstance(row, list):
                 for element in row:

pyexcel_io/fileformat/_csv.py

@@ -88,10 +88,10 @@ def __init__(self, sheet, encoding="utf-8",
     def get_file_handle(self):
         raise NotImplementedError("Please implement get_file_handle()")
 
-    def _iterate_rows(self):
+    def row_iterator(self):
         return csv.reader(self.get_file_handle(), **self._keywords)
 
-    def _iterate_columns(self, row):
+    def column_iterator(self, row):
         for element in row:
             if compact.PY2:
                 element = element.decode('utf-8')

pyexcel_io/sheet.py

@@ -52,7 +52,7 @@ def __init__(self, sheet,
     def to_array(self):
         """2 dimentional representation of the content
         """
-        for row_index, row in enumerate(self._iterate_rows()):
+        for row_index, row in enumerate(self.row_iterator()):
             row_position = self._skip_row(
                 row_index, self._start_row, self._row_limit)
             if row_position == constants.SKIP_DATA:
@@ -64,7 +64,7 @@ def to_array(self):
             tmp_row = []
 
             for column_index, cell_value in enumerate(
-                    self._iterate_columns(row)):
+                    self.column_iterator(row)):
                 column_position = self._skip_column(
                     column_index, self._start_column, self._column_limit)
                 if column_position == constants.SKIP_DATA:
@@ -86,19 +86,30 @@ def to_array(self):
                 return_row = self._row_renderer(return_row)
             yield return_row
 
-    def _iterate_rows(self):
+    def row_iterator(self):
         return irange(self.number_of_rows())
 
-    def _iterate_columns(self, row):
+    def column_iterator(self, row):
         for column in irange(self.number_of_columns()):
-            yield self._cell_value(row, column)
+            yield self.cell_value(row, column)
 
-    def _cell_value(self, row, column):
+    def number_of_rows(self):
         """
-        implement this method if the customer driver
-        provides random access
+        implement this method for easy extension
         """
-        raise NotImplementedError("Please implement to_array()")
+        raise NotImplementedError("Please implement number_of_rows()")
+
+    def number_of_columns(self):
+        """
+        implement this method for easy extension
+        """
+        raise NotImplementedError("Please implement number_of_columns()")
+
+    def cell_value(self, row, column):
+        """
+        implement this method for easy extension
+        """
+        raise NotImplementedError("Please implement cell_value()")
 
 
 class SheetWriter(object):

tests/test_base.py

@@ -45,7 +45,7 @@ class TestSheetReader:
     @raises(NotImplementedError)
     def test_abstractness(self):
         reader = SheetReader("test")
-        reader._cell_value(1, 2)
+        reader.cell_value(1, 2)
 
     def test_to_array(self):
         name = "test"