Changeset 7f75a3f in sasview for src/sas/sascalc

Timestamp:

Apr 5, 2017 11:08:59 AM (8 years ago)

Author:

krzywon

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

278ddee

Parents:

69400ec

git-author:

Jeff Krzywon <krzywon@…> (04/05/17 11:08:59)

git-committer:

krzywon <krzywon@…> (04/05/17 11:08:59)

Message:

More explicit error messages when file loading fails. see #889

Location:

src/sas/sascalc

Files:

• data_util/registry.py (modified) (4 diffs)
• dataloader/loader.py (modified) (2 diffs)
• dataloader/readers/ascii_reader.py (modified) (2 diffs)
• dataloader/readers/cansas_reader.py (modified) (2 diffs)
• dataloader/readers/cansas_reader_HDF5.py (modified) (2 diffs)
• dataloader/readers/xml_reader.py (modified) (1 diff)

src/sas/sascalc/data_util/registry.py

@@ -94 +94 @@
         Return the loader associated with the file type of path.
         
-        Raises ValueError if file type is not known.
+        :param path: Data file path
+        :raises ValueError: When no loaders are found for the file.
+        :return: List of available readers for the file extension
         """        
         # Find matching extensions
@@ -113 +115 @@
         if len(loaders) == 0:
             raise ValueError("Unknown file type for "+path)
-        # All done
         return loaders
 
@@ -120 +121 @@
         Call the loader for the file type of path.
 
-        Raises ValueError if no loader is available.
-        Raises KeyError if format is not available.
-        May raise a loader-defined exception if loader fails.        
+        :raise ValueError: if no loader is available.
+        :raise KeyError: if format is not available.
+        May raise a loader-defined exception if loader fails.
         """
+        loaders = []
         if format is None:
             try:
@@ -141 +143 @@
         # If we get here it is because all loaders failed
         raise NoKnownLoaderException(e.message)  # raise generic exception
-
-
-# TODO: Move this to the unit test folder
-def test():
-    reg = ExtensionRegistry()
-    class CxError(Exception): pass
-    def cx(file): return 'cx'
-    def new_cx(file): return 'new_cx'
-    def fail_cx(file): raise CxError
-    def cat(file): return 'cat'
-    def gunzip(file): return 'gunzip'
-    reg['.cx'] = cx
-    reg['.cx1'] = cx
-    reg['.cx'] = new_cx
-    reg['.gz'] = gunzip
-    reg['.cx.gz'] = new_cx
-    reg['.cx1.gz'] = fail_cx
-    reg['.cx1'] = fail_cx
-    reg['.cx2'] = fail_cx
-    reg['new_cx'] = new_cx
-
-    # Two loaders associated with .cx
-    assert reg.lookup('hello.cx') == [new_cx,cx]
-    # Make sure the last loader applies first
-    assert reg.load('hello.cx') == 'new_cx'
-    # Make sure the next loader applies if the first fails
-    assert reg.load('hello.cx1') == 'cx'
-    # Make sure the format override works
-    assert reg.load('hello.cx1',format='.cx.gz') == 'new_cx'
-    # Make sure the format override works
-    assert reg.load('hello.cx1',format='new_cx') == 'new_cx'
-    # Make sure the case of all loaders failing is correct
-    try:  reg.load('hello.cx2')
-    except CxError: pass # correct failure
-    else: raise AssertError,"Incorrect error on load failure"
-    # Make sure the case of no loaders fails correctly
-    try: reg.load('hello.missing')
-    except ValueError,msg:
-        assert str(msg)=="Unknown file type for hello.missing",\
-            'Message: <%s>'%(msg)
-    else: raise AssertError,"No error raised for missing extension"
-    assert reg.formats() == ['new_cx']
-    assert reg.extensions() == ['.cx','.cx.gz','.cx1','.cx1.gz','.cx2','.gz']
-    # make sure that it supports multiple '.' in filename
-    assert reg.load('hello.extra.cx1') == 'cx'
-    assert reg.load('hello.gz') == 'gunzip'
-    assert reg.load('hello.cx1.gz') == 'gunzip' # Since .cx1.gz fails
-
-if __name__ == "__main__": test()

src/sas/sascalc/dataloader/loader.py

@@ -70 +70 @@
         except NoKnownLoaderException as e:
             pass  # try the ASCII reader
-        except FileContentsException as e:
-            pass
         try:
             ascii_loader = ascii_reader.Reader()
@@ -86 +84 @@
             return cansas_nexus_loader.read(path)
         except FileContentsException:
+            logging.errors("No default loader can load the data")
             # No known reader available. Give up and throw an error
             msg = "\n\tUnknown data format: %s.\n\tThe file is not a " % path
-            msg += "known format that can be loaded by SasView."
-            raise NoKnownLoaderException(msg)
+            msg += "known format that can be loaded by SasView.\n"
+            msg += "Traceback:\n%s" % e.message
+            raise NoKnownLoaderException, msg
 
     def find_plugins(self, dir):

src/sas/sascalc/dataloader/readers/ascii_reader.py

@@ -17 +17 @@
 import os
 from sas.sascalc.dataloader.data_info import Data1D
+from sas.sascalc.dataloader.loader_exceptions import FileContentsException
 
 # Check whether we have a converter available
@@ -173 +174 @@
                 if not is_data:
                     msg = "ascii_reader: x has no data"
-                    raise RuntimeError, msg
+                    raise FileContentsException, msg
                 # Sanity check
                 if has_error_dy == True and not len(ty) == len(tdy):
                     msg = "ascii_reader: y and dy have different length"
-                    raise RuntimeError, msg
+                    raise FileContentsException, msg
                 if has_error_dx == True and not len(tx) == len(tdx):
                     msg = "ascii_reader: y and dy have different length"
-                    raise RuntimeError, msg
+                    raise FileContentsException, msg
                 # If the data length is zero, consider this as
                 # though we were not able to read the file.
                 if len(tx) == 0:
-                    raise RuntimeError, "ascii_reader: could not load file"
+                    raise FileContentsException, "ascii_reader: could not load file"
 
                 #Let's re-order the data to make cal.

src/sas/sascalc/dataloader/readers/cansas_reader.py

@@ -29 +29 @@
 from sas.sascalc.dataloader.readers.xml_reader import XMLreader
 from sas.sascalc.dataloader.readers.cansas_constants import CansasConstants, CurrentLevel
+from sas.sascalc.dataloader.loader_exceptions import FileContentsException
 
 # The following 2 imports *ARE* used. Do not remove either.
@@ -534 +535 @@
 
         # Load in xml file and get the cansas version from the header
-        self.set_xml_file(xml_file)
+        from lxml import etree
+        try:
+            self.set_xml_file(xml_file)
+        except etree.XMLSyntaxError:
+            msg = "Cansas cannot load this file"
+            raise FileContentsException, msg
         self.cansas_version = self.xmlroot.get("version", "1.0")
 

src/sas/sascalc/dataloader/readers/cansas_reader_HDF5.py

@@ -13 +13 @@
     TransmissionSpectrum, Detector
 from sas.sascalc.dataloader.data_info import combine_data_info_with_plottable
+from sas.sascalc.dataloader.loader_exceptions import FileContentsException
 
 
@@ -75 +76 @@
             if extension in self.ext or self.allow_all:
                 # Load the data file
-                self.raw_data = h5py.File(filename, 'r')
+                try:
+                    self.raw_data = h5py.File(filename, 'r')
+                except Exception as e:
+                    raise FileContentsException, e
                 # Read in all child elements of top level SASroot
                 self.read_children(self.raw_data, [])

src/sas/sascalc/dataloader/readers/xml_reader.py

@@ -70 +70 @@
             self.xmldoc = etree.parse(self.xml, parser=PARSER)
             self.xmlroot = self.xmldoc.getroot()
-        except etree.XMLSyntaxError as xml_error:
-            logging.info(xml_error)
+        except etree.XMLSyntaxError:
+            raise
         except Exception:
             self.xml = None