From 9059a15781acf59e91d918de12306e9a3b9398c0 Mon Sep 17 00:00:00 2001
From: Ulugbek Abdullaev <ulugbekna@gmail.com>
Date: Sat, 7 Dec 2019 23:55:31 +0100
Subject: [PATCH] add a check that filename passed to nd2reader has an
 extension .nd2 because the current implementation raises InvalidVersionError
 if the passed file is non-nd2 type, which is misleading

add an exception InvalidFileType

add a test for the new behavior of ND2Reader constructor
---
 nd2reader/exceptions.py | 8 ++++++++
 nd2reader/reader.py     | 6 +++++-
 tests/test_reader.py    | 5 ++++-
 3 files changed, 17 insertions(+), 2 deletions(-)

diff --git a/nd2reader/exceptions.py b/nd2reader/exceptions.py
index cb1b1fb..fd31708 100644
--- a/nd2reader/exceptions.py
+++ b/nd2reader/exceptions.py
@@ -1,3 +1,11 @@
+class InvalidFileType(Exception):
+    """Non .nd2 extension file.
+
+    File does not have an extension .nd2.
+
+    """
+    pass
+
 class InvalidVersionError(Exception):
     """Unknown version.
 
diff --git a/nd2reader/reader.py b/nd2reader/reader.py
index 34c6386..0eeea16 100644
--- a/nd2reader/reader.py
+++ b/nd2reader/reader.py
@@ -1,7 +1,7 @@
 from pims import Frame
 from pims.base_frames import FramesSequenceND
 
-from nd2reader.exceptions import EmptyFileError
+from nd2reader.exceptions import EmptyFileError, InvalidFileType
 from nd2reader.parser import Parser
 import numpy as np
 
@@ -15,6 +15,10 @@ class ND2Reader(FramesSequenceND):
 
     def __init__(self, filename):
         super(ND2Reader, self).__init__()
+
+        if not filename.endswith(".nd2"):
+            raise InvalidFileType(f"The file {filename} you want to read with nd2reader does not have extension .nd2.")
+
         self.filename = filename
 
         # first use the parser to parse the file
diff --git a/tests/test_reader.py b/tests/test_reader.py
index 91f96e5..cf0f22c 100644
--- a/tests/test_reader.py
+++ b/tests/test_reader.py
@@ -4,12 +4,15 @@ import struct
 
 from pims import Frame
 from nd2reader.artificial import ArtificialND2
-from nd2reader.exceptions import EmptyFileError
+from nd2reader.exceptions import EmptyFileError, InvalidFileType
 from nd2reader.reader import ND2Reader
 from nd2reader.parser import Parser
 
 
 class TestReader(unittest.TestCase):
+    def test_invalid_file_extension(self):
+        self.assertRaises(InvalidFileType, lambda: ND2Reader('test_data/invalid_extension_file.inv'))
+
     def test_extension(self):
         self.assertTrue('nd2' in ND2Reader.class_exts())