added returned type to read_XXX() functions (issue #864)

Author: alixdamman

larray/inout/csv.py

@@ -18,7 +18,7 @@
 
 @deprecate_kwarg('nb_index', 'nb_axes', arg_converter=lambda x: x + 1)
 def read_csv(filepath_or_buffer, nb_axes=None, index_col=None, sep=',', headersep=None, fill_value=nan,
-             na=nan, sort_rows=False, sort_columns=False, wide=True, dialect='larray', **kwargs):
+             na=nan, sort_rows=False, sort_columns=False, wide=True, dialect='larray', **kwargs) -> Array:
     r"""
     Reads csv file and returns an array with the contents.
 
@@ -228,11 +228,11 @@ def read_csv(filepath_or_buffer, nb_axes=None, index_col=None, sep=',', headerse
     return df_asarray(df, sort_rows=sort_rows, sort_columns=sort_columns, fill_value=fill_value, raw=raw, wide=wide)
 
 
-def read_tsv(filepath_or_buffer, **kwargs):
+def read_tsv(filepath_or_buffer, **kwargs) -> Array:
     return read_csv(filepath_or_buffer, sep='\t', **kwargs)
 
 
-def read_eurostat(filepath_or_buffer, **kwargs):
+def read_eurostat(filepath_or_buffer, **kwargs) -> Array:
     r"""Reads EUROSTAT TSV (tab-separated) file into an array.
 
     EUROSTAT TSV files are special because they use tabs as data separators but comas to separate headers.

larray/inout/excel.py

@@ -31,7 +31,7 @@
 @deprecate_kwarg('sheetname', 'sheet')
 # We use "# doctest: +SKIP" for all tests because they work only if openpyxl (an *optional* dependency) is installed
 def read_excel(filepath, sheet=0, nb_axes=None, index_col=None, fill_value=nan, na=nan,
-               sort_rows=False, sort_columns=False, wide=True, engine=None, range=slice(None), **kwargs):
+               sort_rows=False, sort_columns=False, wide=True, engine=None, range=slice(None), **kwargs) -> Array:
     r"""
     Reads excel file from sheet name and returns an Array with the contents
 

larray/inout/hdf.py

@@ -23,7 +23,7 @@ def _get_type_from_attrs(attrs):
 
 
 def read_hdf(filepath_or_buffer, key, fill_value=nan, na=nan, sort_rows=False, sort_columns=False,
-             name=None, **kwargs):
+             name=None, **kwargs) -> Array:
     r"""Reads a scalar or an axis or group or array named key from a HDF5 file in filepath (path+name)
 
     Parameters

larray/inout/misc.py

@@ -2,6 +2,7 @@
 
 from pandas import DataFrame, Index
 
+from larray.core.array import Array
 from larray.core.constants import nan
 from larray.util.misc import deprecate_kwarg
 from larray.inout.common import _get_index_col
@@ -10,7 +11,8 @@
 
 
 @deprecate_kwarg('nb_index', 'nb_axes', arg_converter=lambda x: x + 1)
-def from_lists(data, nb_axes=None, index_col=None, fill_value=nan, sort_rows=False, sort_columns=False, wide=True):
+def from_lists(data, nb_axes=None, index_col=None, fill_value=nan, sort_rows=False, sort_columns=False,
+               wide=True) -> Array:
     r"""
     initialize array from a list of lists (lines)
 
@@ -123,7 +125,7 @@ def from_lists(data, nb_axes=None, index_col=None, fill_value=nan, sort_rows=Fal
 
 
 @deprecate_kwarg('nb_index', 'nb_axes', arg_converter=lambda x: x + 1)
-def from_string(s, nb_axes=None, index_col=None, sep=' ', wide=True, **kwargs):
+def from_string(s, nb_axes=None, index_col=None, sep=' ', wide=True, **kwargs) -> Array:
     r"""Create an array from a multi-line string.
 
     Parameters

larray/inout/pandas.py

@@ -76,7 +76,7 @@ def cartesian_product_df(df, sort_rows=False, sort_columns=False, fill_value=nan
     return df.reindex(index=new_index, columns=columns, fill_value=fill_value, **kwargs), labels
 
 
-def from_series(s, sort_rows=False, fill_value=nan, meta=None, **kwargs):
+def from_series(s, sort_rows=False, fill_value=nan, meta=None, **kwargs) -> Array:
     r"""
     Converts Pandas Series into Array.
 
@@ -145,7 +145,7 @@ def from_series(s, sort_rows=False, fill_value=nan, meta=None, **kwargs):
 
 
 def from_frame(df, sort_rows=False, sort_columns=False, parse_header=False, unfold_last_axis_name=False,
-               fill_value=nan, meta=None, cartesian_prod=True, **kwargs):
+               fill_value=nan, meta=None, cartesian_prod=True, **kwargs) -> Array:
     r"""
     Converts Pandas DataFrame into Array.
 
@@ -275,7 +275,7 @@ def set_dataframe_index_by_position(df, index_col_indices):
 
 
 def df_asarray(df, sort_rows=False, sort_columns=False, raw=False, parse_header=True, wide=True, cartesian_prod=True,
-               **kwargs):
+               **kwargs) -> Array:
     r"""
     Prepare Pandas DataFrame and then convert it into Array.
 

larray/inout/sas.py

@@ -3,14 +3,15 @@
 import numpy as np
 import pandas as pd
 
+from larray.core.array import Array
 from larray.core.constants import nan
 from larray.inout.pandas import df_asarray
 from larray.util.misc import deprecate_kwarg
 
 
 @deprecate_kwarg('nb_index', 'nb_axes', arg_converter=lambda x: x + 1)
 def read_sas(filepath, nb_axes=None, index_col=None, fill_value=nan, na=nan, sort_rows=False, sort_columns=False,
-             **kwargs):
+             **kwargs) -> Array:
     r"""
     Reads sas file and returns an Array with the contents
         nb_axes: number of axes of the output array

larray/inout/stata.py

@@ -1,11 +1,12 @@
 import pandas as pd
 
+from larray.core.array import Array
 from larray.inout.pandas import from_frame
 
 __all__ = ['read_stata']
 
 
-def read_stata(filepath_or_buffer, index_col=None, sort_rows=False, sort_columns=False, **kwargs):
+def read_stata(filepath_or_buffer, index_col=None, sort_rows=False, sort_columns=False, **kwargs) -> Array:
     r"""
     Reads Stata .dta file and returns an Array with the contents