Made read method convenient to use directly from the core package

Author: zbarge

qtpandas/__init__.py

@@ -1,10 +1,8 @@
 # -*- coding: utf-8 -*-
 # __import__('pkg_resources').declare_namespace(__name__)
 __version__ = '1.0.2'
-from qtpandas.models.DataFrameModel import DataFrameModel
+from qtpandas.models.DataFrameModel import DataFrameModel, read
 from qtpandas.models.ColumnDtypeModel import ColumnDtypeModel
 from qtpandas.models.DataSearch import DataSearch
-from qtpandas.utils import superReadFile, superReadCSV, superReadText
 from qtpandas.views.CSVDialogs import CSVExportDialog, CSVImportDialog
 from qtpandas.views.EditDialogs import AddAttributesDialog, RemoveAttributesDialog
-

qtpandas/models/DataFrameModel.py

@@ -21,6 +21,20 @@
 DATAFRAME_ROLE = Qt.UserRole + 2
 
 
+def read(filepath, **kwargs):
+    """
+    Read a data file into a DataFrameModel.
+
+    :param filepath: The rows/columns filepath to read.
+    :param kwargs:
+            xls/x files - see pandas.read_excel(**kwargs)
+            .csv/.txt/etc - see pandas.read_csv(**kwargs)
+    :return:
+    """
+    return DataFrameModel(dataFrame=superReadFile(filepath, **kwargs),
+                          filePath=filepath)
+
+
 class DataFrameModel(QtCore.QAbstractTableModel):
     """data model for use in QTableView, QListView, QComboBox, etc.
 
@@ -223,6 +237,7 @@ def rename(self, index=None, columns=None, **kwargs):
     def applyFunction(self, func):
         """
         Applies a function to the dataFrame with appropriate signals.
+        The function must return a dataframe.
         :param func: A function (or partial function) that accepts a dataframe as the first argument.
         :return: None
         :raise:

qtpandas/utils.py

@@ -170,16 +170,18 @@ def superReadFile(filepath, **kwargs):
     if isinstance(filepath, pd.DataFrame):
         return filepath
 
-    excels = ['.xlsx', '.xls']
-    texts = ['.txt', '.tsv', '.csv']
     ext = os.path.splitext(filepath)[1].lower()
 
-    if ext in excels:
-        return pd.read_excel(filepath, **kwargs)
-    elif ext in texts:
-        return superReadText(filepath, **kwargs)
+    if ext in ['.xlsx', '.xls']:
+        df = pd.read_excel(filepath, **kwargs)
     else:
-        raise Exception("Unsupported filetype: {}\n Supported filetypes: {}".format(ext, excels + texts))
+        # Assume it's a text-like file and try to read it.
+        try:
+            df = superReadText(filepath, **kwargs)
+        except Exception as e:
+            # TODO: Make this trace back better? Custom Exception? Raise original?
+            raise Exception("Error reading file: {}".format(e))
+    return df
 
 
 def dedupe_cols(frame):