Merge pull request #9 from zmx27/fix-flake8-tools

style: fix flake8 error for tools.py

Author: sbillinge

src/diffpy/srxconfutils/__init__.py

@@ -12,9 +12,6 @@
 #
 ##############################################################################
 
-# some convenience imports
-from diffpy.srxconfutils.config import ConfigBase
-
 # package version
 from diffpy.srxconfutils.version import __version__
 
@@ -30,4 +27,7 @@ def test():
     return test()
 
 
+# silence the pyflakes syntax checker
+assert __version__ or True
+
 # End of file

src/diffpy/srxconfutils/tools.py

@@ -59,9 +59,9 @@ def _configPropertyRW(name):
     read and write
     """
     rv = property(
-        fget=lambda self: getattr(self.config, nm),
-        fset=lambda self, value: setattr(self.config, nm, value),
-        fdel=lambda self: delattr(self, nm),
+        fget=lambda self: getattr(self.config, name),
+        fset=lambda self, value: setattr(self.config, name, value),
+        fdel=lambda self: delattr(self, name),
         doc="attribute forwarded to self.config, read/write",
     )
     return rv
@@ -119,7 +119,7 @@ def str2Opt(opttype, optvalue):
     # base converter
     conv = StrConv(opttype)
     if opttype.endswith("list"):
-        temp = re.split("\s*,\s*", optvalue)
+        temp = re.split(r"\s*,\s*", optvalue)
         rv = list(map(conv, temp)) if len(temp) > 0 else []
     else:
         rv = conv(optvalue)
@@ -163,41 +163,39 @@ def __next__(self):
         return line
 
 
-def checkCRC32(filename):
+def get_crc32(filename):
     """Calculate the crc32 value of file.
 
     :param filename: path to the file
     :return: crc32 value of file
     """
     try:
-        fd = open(filename, "rb")
-    except:
-        return "Read error"
-    eachLine = fd.readline()
-    prev = 0
-    while eachLine:
-        prev = zlib.crc32(eachLine, prev)
-        eachLine = fd.readline()
-    fd.close()
+        with open(filename, "rb") as fd:
+            eachLine = fd.readline()
+            prev = 0
+            while eachLine:
+                prev = zlib.crc32(eachLine, prev)
+                eachLine = fd.readline()
+    except OSError as e:
+        raise RuntimeError(f"Failed to read file {filename}") from e
     return prev
 
 
-def checkMD5(filename, blocksize=65536):
+def get_md5(filename, blocksize=65536):
     """Calculate the MD5 value of file.
 
     :param filename: path to the file
     :return: md5 value of file
     """
     try:
-        fd = open(filename, "rb")
-    except:
-        return "Read error"
-    buf = fd.read(blocksize)
-    md5 = hashlib.md5()
-    while len(buf) > 0:
-        md5.update(buf)
-        buf = fd.read(blocksize)
-    fd.close()
+        with open(filename, "rb") as fd:
+            buf = fd.read(blocksize)
+            md5 = hashlib.md5()
+            while len(buf) > 0:
+                md5.update(buf)
+                buf = fd.read(blocksize)
+    except OSError as e:
+        raise RuntimeError(f"Failed to read file {filename}") from e
     return md5.hexdigest()
 
 
@@ -209,16 +207,16 @@ def checkFileVal(filename):
     :param filename: path to the file
     """
     valflag = False
-    lastcrc = checkCRC32(filename)
+    lastcrc = get_crc32(filename)
     while not valflag:
-        currcrc = checkCRC32(filename)
+        currcrc = get_crc32(filename)
         if currcrc == lastcrc:
-            lastmd5 = checkMD5(filename)
+            lastmd5 = get_md5(filename)
             time.sleep(0.01)
-            currmd5 = checkMD5(filename)
+            currmd5 = get_md5(filename)
             if lastmd5 == currmd5:
                 valflag = True
         else:
             time.sleep(0.5)
-            lastcrc = checkCRC32(filename)
+            lastcrc = get_crc32(filename)
     return

tests/conftest.py

@@ -0,0 +1,10 @@
+import pytest
+
+
+@pytest.fixture
+def temp_file(tmp_path):
+    """Create a temporary file with known content."""
+    file_path = tmp_path / "testfile.txt"
+    content = b"Hello world!\nThis is a test.\n"
+    file_path.write_bytes(content)
+    return file_path, content

tests/test_tools.py

@@ -0,0 +1,19 @@
+import hashlib
+import zlib
+
+from diffpy.srxconfutils import tools
+
+
+def test_get_md5(temp_file):
+    file_path, content = temp_file
+    expected_md5 = hashlib.md5(content).hexdigest()
+    result = tools.get_md5(file_path)
+    assert result == expected_md5
+
+
+def test_get_crc32(temp_file):
+    """Test the get_crc32 function."""
+    file_path, content = temp_file
+    val = tools.get_crc32(file_path)
+    expected = zlib.crc32(content)
+    assert val == expected