Fix: Fix news message and rename to comply PEP-8 standard.

Author: stevenhua0320

news/load-image-fix.rst

@@ -16,7 +16,7 @@
 
 **Fixed:**
 
-* Fixed `loadimage` function in any directory.
+* `load_image()` function correctly finds files when passed a relative path.
 
 **Security:**
 

src/diffpy/srxplanar/loadimage.py

@@ -25,14 +25,14 @@
 try:
     import fabio
 
-    def openImage(im):
+    def open_image(im):
         rv = fabio.openimage.openimage(im)
         return rv.data
 
 except ImportError:
     import tifffile
 
-    def openImage(im):
+    def open_image(im):
         rv = tifffile.imread(im)
         return rv
 
@@ -54,7 +54,7 @@ def __init__(self, p):
         self.config = p
         return
 
-    def flipImage(self, pic):
+    def flip_image(self, pic):
         """Flip image if configured in config.
 
         :param pic: 2d array, image array
@@ -66,9 +66,9 @@ def flipImage(self, pic):
             pic = np.array(pic[::-1, :])
         return pic
 
-    def loadImage(self, filename):
-        """Load image file using pathlib. If loading fails (e.g.
-        incomplete file), retry for 5 seconds (10×0.5s).
+    def load_image(self, filename):
+        """Load image file. If loading fails (e.g. incomplete file),
+        retry for 5 seconds (10×0.5s).
 
         :param filename: str or Path, image file name or path
         :return: 2D ndarray, flipped image array
@@ -95,14 +95,14 @@ def loadImage(self, filename):
                 if filenamefull.suffix == ".npy":
                     image = np.load(filenamefull)
                 else:
-                    image = openImage(
+                    image = open_image(
                         str(filenamefull)
                     )  # openImage expects str
                 break
             except FileNotFoundError:
                 time.sleep(0.5)
 
-        image = self.flipImage(image)
+        image = self.flip_image(image)
         image[image < 0] = 0
         return image
 

src/diffpy/srxplanar/srxplanar.py

@@ -155,7 +155,7 @@ def _getPic(self, image, flip=None, correction=None):
                 rv += self._getPic(imagefile)
             rv /= len(image)
         elif isinstance(image, str):
-            rv = self.loadimage.loadImage(image)
+            rv = self.loadimage.load_image(image)
             if correction is None or correction is True:
                 ce = self.config.cropedges
                 rv[ce[2] : -ce[3], ce[0] : -ce[1]] = (
@@ -165,7 +165,7 @@ def _getPic(self, image, flip=None, correction=None):
         else:
             rv = image
             if flip is True:
-                rv = self.loadimage.flipImage(rv)
+                rv = self.loadimage.flip_image(rv)
             if correction is True:
                 # rv *= self.correction
                 ce = self.config.cropedges
@@ -339,13 +339,13 @@ def createMask(self, filename=None, pic=None, addmask=None):
                     pic = self.pic
                 else:
                     pic = (
-                        self.loadimage.loadImage(filelist[0])
+                        self.loadimage.load_image(filelist[0])
                         if len(filelist) > 0
                         else None
                     )
             else:
                 pic = (
-                    self.loadimage.loadImage(filelist[0])
+                    self.loadimage.load_image(filelist[0])
                     if len(filelist) > 0
                     else None
                 )

tests/test_load_image.py

@@ -24,8 +24,8 @@
 ]
 
 
-@pytest.mark.parametrize("input_path, expected", load_image_param)
-def test_load_image(input_path, expected, user_filesystem):
+@pytest.mark.parametrize("file_name, expected", load_image_param)
+def test_load_image(file_name, expected, user_filesystem):
     home_dir = user_filesystem["home"]
     cwd_dir = user_filesystem["cwd"]
     os.chdir(cwd_dir)
@@ -40,8 +40,8 @@ def test_load_image(input_path, expected, user_filesystem):
             "Cfg", (), {"fliphorizontal": True, "flipvertical": False}
         )()
         loader = LoadImage(cfg)
-        actual = loader.loadImage(input_path)
-        expected = loader.loadImage(source_file)
+        actual = loader.load_image(file_name)
+        expected = loader.load_image(source_file)
         assert np.array_equal(actual, expected)
     except FileNotFoundError:
         pytest.raises(