fix #587 : renamed argument 'sheetname' of read_excel function as 'sheet'

alixdamman · alixdamman · commit d26aa9c3f0a0 · 2018-02-21T15:33:16.000+01:00
diff --git a/doc/source/changes/version_0_28.rst.inc b/doc/source/changes/version_0_28.rst.inc
@@ -305,6 +305,8 @@ Miscellaneous improvements
 
   Closes :issue:`549`.
 
+* renamed argument `sheetname` of `read_excel` function as `sheet` (closes :issue:`587`).
+
 
 Fixes
 -----
diff --git a/doc/source/tutorial/tutorial.ipyml b/doc/source/tutorial/tutorial.ipyml
@@ -200,7 +200,7 @@ cells:
     or Excel sheets
     
     ```python
-    # loads array from the first sheet if no sheetname is given
+    # loads array from the first sheet if no sheet is given
     pop = read_excel('demography.xlsx', 'pop')
     ```
 
diff --git a/doc/source/tutorial/tutorial.ipynb b/doc/source/tutorial/tutorial.ipynb
@@ -315,7 +315,7 @@
     "or Excel sheets\n",
     "\n",
     "```python\n",
-    "# loads array from the first sheet if no sheetname is given\n",
+    "# loads array from the first sheet if no sheet is given\n",
     "pop = read_excel('demography.xlsx', 'pop')\n",
     "```"
    ]
diff --git a/larray/inout/array.py b/larray/inout/array.py
@@ -428,7 +428,8 @@ def read_hdf(filepath_or_buffer, key, fill_value=np.nan, na=np.nan, sort_rows=Fa
 
 
 @deprecate_kwarg('nb_index', 'nb_axes', arg_converter=lambda x: x + 1)
-def read_excel(filepath, sheetname=0, nb_axes=None, index_col=None, fill_value=np.nan, na=np.nan,
+@deprecate_kwarg('sheetname', 'sheet')
+def read_excel(filepath, sheet=0, nb_axes=None, index_col=None, fill_value=np.nan, na=np.nan,
                sort_rows=False, sort_columns=False, engine=None, **kwargs):
     """
     Reads excel file from sheet name and returns an LArray with the contents
@@ -437,7 +438,7 @@ def read_excel(filepath, sheetname=0, nb_axes=None, index_col=None, fill_value=n
     ----------
     filepath : str
         Path where the Excel file has to be read.
-    sheetname : str, Group or int, optional
+    sheet : str, Group or int, optional
         Name or index of the Excel sheet containing the array to be read.
         By default the array is read from the first sheet.
     nb_axes : int, optional
@@ -465,7 +466,7 @@ def read_excel(filepath, sheetname=0, nb_axes=None, index_col=None, fill_value=n
         warnings.warn("read_excel `na` argument has been renamed to `fill_value`. Please use that instead.",
                       FutureWarning, stacklevel=2)
 
-    sheetname = _translate_sheet_name(sheetname)
+    sheet = _translate_sheet_name(sheet)
 
     if engine is None:
         engine = 'xlwings' if xw is not None else None
@@ -483,10 +484,10 @@ def read_excel(filepath, sheetname=0, nb_axes=None, index_col=None, fill_value=n
                             .format(list(kwargs.keys())[0]))
         from larray.inout.excel import open_excel
         with open_excel(filepath) as wb:
-            return wb[sheetname].load(index_col=index_col, fill_value=fill_value, sort_rows=sort_rows,
-                                      sort_columns=sort_columns)
+            return wb[sheet].load(index_col=index_col, fill_value=fill_value, sort_rows=sort_rows,
+                                  sort_columns=sort_columns)
     else:
-        df = pd.read_excel(filepath, sheetname, index_col=index_col, engine=engine, **kwargs)
+        df = pd.read_excel(filepath, sheet, index_col=index_col, engine=engine, **kwargs)
         return df_aslarray(df, sort_rows=sort_rows, sort_columns=sort_columns, raw=index_col is None,
                            fill_value=fill_value)
 
diff --git a/larray/tests/test_array.py b/larray/tests/test_array.py
@@ -2675,7 +2675,7 @@ def test_read_excel_xlwings(self):
         self.assertEqual(la.axes.names, ['age', None])
         assert_array_equal(la[0, :], [3722, 3395, 3347])
 
-        # passing a Group as sheetname arg
+        # passing a Group as sheet arg
         axis = Axis('dim=1d,2d,3d,5d')
 
         la = read_excel(inputpath('test.xlsx'), axis['1d'])
@@ -2764,7 +2764,7 @@ def test_read_excel_pandas(self):
         self.assertEqual(la.axes.names, ['age', None])
         assert_array_equal(la[0, :], [3722, 3395, 3347])
 
-        # passing a Group as sheetname arg
+        # passing a Group as sheet arg
         axis = Axis('dim=1d,2d,3d,5d')
 
         la = read_excel(inputpath('test.xlsx'), axis['1d'], engine='xlrd')

Original file line number	Diff line number	Diff line change
`@@ -315,7 +315,7 @@`
`315`	`315`	`"or Excel sheets\n",`
`316`	`316`	`"\n",`
`317`	`317`	"```python\n",
`318`		`- "# loads array from the first sheet if no sheetname is given\n",`
	`318`	`+ "# loads array from the first sheet if no sheet is given\n",`
`319`	`319`	`"pop = read_excel('demography.xlsx', 'pop')\n",`
`320`	`320`	"```"
`321`	`321`	`]`