pylinting and use pyexcel-xlsx as nick name for pyexcel-xlsx

Author: chfw

pyexcel_xlsx/__init__.py

@@ -9,20 +9,23 @@
 """
 # this line has to be place above all else
 # because of dynamic import
-__pyexcel_io_plugins__ = ['xlsx']
+_FILE_TYPE = 'xlsx'
+__pyexcel_io_plugins__ = [_FILE_TYPE]
 
 
 from pyexcel_io.io import get_data as read_data, isstream, store_data as write_data
 
 
 def save_data(afile, data, file_type=None, **keywords):
+    """standalone module function for writing module supported file type"""
     if isstream(afile) and file_type is None:
-        file_type='xlsx'
+        file_type = _FILE_TYPE
     write_data(afile, data, file_type=file_type, **keywords)
 
 
 def get_data(afile, file_type=None, **keywords):
+    """standalone module function for reading module supported file type"""
     if isstream(afile) and file_type is None:
-        file_type='xlsx'
+        file_type = _FILE_TYPE
     return read_data(afile, file_type=file_type, **keywords)
 

pyexcel_xlsx/xlsx.py

@@ -8,27 +8,30 @@
     :license: New BSD License
 """
 import sys
-import openpyxl
-
 from pyexcel_io.book import BookReader, BookWriter
 from pyexcel_io.sheet import SheetReader, SheetWriter
+import openpyxl
 
-PY2 = sys.version_info[0] == 2
-if PY2 and sys.version_info[1] < 7:
+PY27_BELOW = sys.version_info[0] == 2 and sys.version_info[1] < 7
+if PY27_BELOW:
     from ordereddict import OrderedDict
 else:
-    from collections import OrderedDict    
+    from collections import OrderedDict
 
 
 COLUMNS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
 COLUMN_LENGTH = 26
 
 
 def get_columns(index):
+    """
+    Convert column index to column name
+    """
     if index < COLUMN_LENGTH:
         return COLUMNS[index]
     else:
-        return (get_columns(int(index // COLUMN_LENGTH) - 1) + COLUMNS[index % COLUMN_LENGTH])
+        return (get_columns(int(index // COLUMN_LENGTH) - 1) +
+                COLUMNS[index % COLUMN_LENGTH])
 
 
 class XLSXSheet(SheetReader):
@@ -37,6 +40,7 @@ class XLSXSheet(SheetReader):
     """
     @property
     def name(self):
+        """sheet name"""
         return self.native_sheet.title
 
     def number_of_rows(self):
@@ -60,16 +64,16 @@ def cell_value(self, row, column):
         return self.native_sheet.cell(cell_location).value
 
     def to_array(self):
-        for r in range(0, self.number_of_rows()):
-            row = []
+        for row in range(0, self.number_of_rows()):
+            return_row = []
             tmp_row = []
-            for c in range(0, self.number_of_columns()):
-                cell_value = self.cell_value(r, c)
+            for column in range(0, self.number_of_columns()):
+                cell_value = self.cell_value(row, column)
                 tmp_row.append(cell_value)
                 if cell_value is not None and cell_value != '':
-                    row += tmp_row
+                    return_row += tmp_row
                     tmp_row = []
-            yield row
+            yield return_row
 
 
 class XLSXBook(BookReader):
@@ -78,10 +82,6 @@ class XLSXBook(BookReader):
 
     It reads xls, xlsm, xlsx work book
     """
-    def __init__(self):
-        BookReader.__init__(self)
-        self.book = None
-
     def open(self, file_name, **keywords):
         BookReader.open(self, file_name, **keywords)
         self._load_from_file()
@@ -91,37 +91,40 @@ def open_stream(self, file_stream, **keywords):
         self._load_from_memory()
 
     def read_sheet_by_name(self, sheet_name):
-        sheet = self.book.get_sheet_by_name(sheet_name)
+        sheet = self.native_book.get_sheet_by_name(sheet_name)
         if sheet is None:
             raise ValueError("%s cannot be found" % sheet_name)
         else:
-            sheet = XLSXSheet(sheet)
-            return {sheet_name: sheet.to_array()}
+            return self.read_sheet(sheet)
 
     def read_sheet_by_index(self, sheet_index):
-        names = self.book.sheetnames
+        names = self.native_book.sheetnames
         length = len(names)
         if sheet_index < length:
             return self.read_sheet_by_name(names[sheet_index])
         else:
-            raise IndexError("Index %d of out bound %d" %(
+            raise IndexError("Index %d of out bound %d" % (
                 sheet_index,
                 length))
 
     def read_all(self):
         result = OrderedDict()
-        for sheet in self.book:
-            sheet = XLSXSheet(sheet)
-            result[sheet.name] = sheet.to_array()
+        for sheet in self.native_book:
+            data_dict = self.read_sheet(sheet)
+            result.update(data_dict)
         return result
-        
+
+    def read_sheet(self, native_sheet):
+        sheet = XLSXSheet(native_sheet, **self.keywords)
+        return {sheet.name: sheet.to_array()}
+
     def _load_from_memory(self):
-        self.book =  openpyxl.load_workbook(filename=self.file_stream,
-                                            data_only=True)
+        self.native_book = openpyxl.load_workbook(filename=self.file_stream,
+                                                  data_only=True)
 
     def _load_from_file(self):
-        self.book = openpyxl.load_workbook(filename=self.file_name,
-                                           data_only=True)
+        self.native_book = openpyxl.load_workbook(filename=self.file_name,
+                                                  data_only=True)
 
 
 class XLSXSheetWriter(SheetWriter):
@@ -177,7 +180,7 @@ def close(self):
     "writer": XLSXWriter,
     "stream_type": "binary",
     "mime_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
-    "library": "openpyxl"
+    "library": "pyexcel-xlsx"
 }
 
 _xlsm_registry = {
@@ -186,7 +189,7 @@ def close(self):
     "writer": XLSXWriter,
     "stream_type": "binary",
     "mime_type": "application/vnd.ms-excel.sheet.macroenabled.12",
-    "library": "openpyxl"
+    "library": "pyexcel-xlsx"
 }
 
-exports = (_xlsx_registry, _xlsm_registry)
+exports = (_xlsx_registry, _xlsm_registry)

tests/test_formatters.py

@@ -12,7 +12,7 @@ def test_reading_date_format(self):
         01/01/15 13:13:13
         0.0      0.0        
         """
-        r = pe.get_sheet(file_name=os.path.join("tests", "fixtures", "date_field.xlsx"), library="openpyxl")
+        r = pe.get_sheet(file_name=os.path.join("tests", "fixtures", "date_field.xlsx"), library="pyexcel-xlsx")
         assert isinstance(r[1,0], datetime.date) == True
         assert r[1,0].strftime("%d/%m/%y") == "25/12/14"
         assert isinstance(r[1,1], datetime.time) == True
@@ -27,7 +27,7 @@ def test_writing_date_format(self):
                 datetime.time(11,11,11),
                  datetime.datetime(2014,12,25,11,11,11)]]
         pe.save_as(dest_file_name=excel_filename, array=data)
-        r = pe.get_sheet(file_name=excel_filename, library="openpyxl")
+        r = pe.get_sheet(file_name=excel_filename, library="pyexcel-xlsx")
         assert isinstance(r[0,0], datetime.date) == True
         assert r[0,0].strftime("%d/%m/%y") == "25/12/14"
         assert isinstance(r[0,1], datetime.time) == True

tests/test_mutliple_sheets.py

@@ -65,12 +65,12 @@ def setUp(self):
         self._write_test_file(self.testfile2)
 
     def test_load_a_single_sheet(self):
-        b1 = pyexcel.get_book(file_name=self.testfile, sheet_name="Sheet1", library="openpyxl")
+        b1 = pyexcel.get_book(file_name=self.testfile, sheet_name="Sheet1", library="pyexcel-xlsx")
         assert len(b1.sheet_names()) == 1
         assert b1['Sheet1'].to_array() == self.content['Sheet1']
 
     def test_load_a_single_sheet2(self):
-        b1 = pyexcel.get_book(file_name=self.testfile, sheet_index=1, library="openpyxl")
+        b1 = pyexcel.get_book(file_name=self.testfile, sheet_index=1, library="pyexcel-xlsx")
         assert len(b1.sheet_names()) == 1
         assert b1['Sheet2'].to_array() == self.content['Sheet2']
 
@@ -80,7 +80,7 @@ def test_load_a_single_sheet3(self):
 
     @raises(KeyError)
     def test_load_a_single_sheet4(self):
-        pyexcel.get_book(file_name=self.testfile, sheet_name="Not exist", library="openpyxl")
+        pyexcel.get_book(file_name=self.testfile, sheet_name="Not exist", library="pyexcel-xlsx")
 
     def test_delete_sheets(self):
         b1 = pyexcel.load_book(self.testfile)