fix TestClass name, make module level variable all capital and other code cleanup

.github/workflows/lint.yml

@@ -9,7 +9,7 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.x"
 
@@ -26,5 +26,4 @@ jobs:
       - name: mypy
         run: |
           mypy --version
-          rm -rf .mypy_cache
           mypy src

.pre-commit-config.yaml

@@ -1,4 +1,4 @@
-exclude: ^(docs|tests/files|cmd_line|tasks.py)
+exclude: ^(docs|tests/test_files|tasks.py)
 
 ci:
   autoupdate_schedule: monthly
@@ -8,7 +8,7 @@ ci:
 
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.5.0
+    rev: v0.5.5
     hooks:
       - id: ruff
         args: [--fix]
@@ -24,7 +24,7 @@ repos:
         exclude: ^tests
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.10.1
+    rev: v1.11.0
     hooks:
       - id: mypy
 

pyproject.toml

@@ -38,7 +38,9 @@ ci = [
     "orjson",
     "types-orjson",
     "types-requests",
-    "torch"
+    "torch",
+    "ipython",
+    "pydantic",
 ]
 docs = [
     "sphinx",

src/monty/io.py

@@ -9,18 +9,18 @@
 import errno
 import gzip
 import io
-
-try:
-    import lzma
-except ImportError:
-    lzma = None  # type: ignore[assignment]
 import mmap
 import os
 import subprocess
 import time
 from pathlib import Path
 from typing import TYPE_CHECKING
 
+try:
+    import lzma
+except ImportError:
+    lzma = None  # type: ignore[assignment]
+
 if TYPE_CHECKING:
     from typing import IO, Generator, Union
 

src/monty/json.py

@@ -51,7 +51,6 @@
 except ImportError:
     orjson = None
 
-
 try:
     import torch
 except ImportError:

src/monty/serialization.py

@@ -9,15 +9,15 @@
 import os
 from typing import TYPE_CHECKING
 
+from monty.io import zopen
+from monty.json import MontyDecoder, MontyEncoder
+from monty.msgpack import default, object_hook
+
 try:
     from ruamel.yaml import YAML
 except ImportError:
     YAML = None  # type: ignore[arg-type]
 
-from monty.io import zopen
-from monty.json import MontyDecoder, MontyEncoder
-from monty.msgpack import default, object_hook
-
 try:
     import msgpack
 except ImportError:

src/monty/subprocess.py

@@ -74,11 +74,9 @@ def run(self, timeout: Optional[float] = None, **kwargs) -> Self:
 
         def target(**kw):
             try:
-                # print('Thread started')
                 with Popen(self.command, **kw) as self.process:
                     self.output, self.error = self.process.communicate()
                     self.retcode = self.process.returncode
-                # print('Thread stopped')
             except Exception:
                 self.error = traceback.format_exc()
                 self.retcode = -1
@@ -96,7 +94,6 @@ def target(**kw):
         thread.join(timeout)
 
         if thread.is_alive() and self.process is not None:
-            # print("Terminating process")
             self.process.terminate()
             self.killed = True
             thread.join()

src/monty/termcolor.py

@@ -128,12 +128,7 @@ def cprint(
 
     It accepts arguments of print function.
     """
-    try:
-        print((colored(text, color, on_color, attrs)), **kwargs)
-    except TypeError:
-        # flush is not supported by py2.7
-        kwargs.pop("flush", None)
-        print((colored(text, color, on_color, attrs)), **kwargs)
+    print((colored(text, color, on_color, attrs)), **kwargs)
 
 
 def colored_map(text: str, cmap: dict) -> str:
@@ -162,12 +157,7 @@ def cprint_map(text: str, cmap: dict, **kwargs) -> None:
     Examples:
         cprint_map("Hello world", {"Hello": "red"})
     """
-    try:
-        print(colored_map(text, cmap), **kwargs)
-    except TypeError:
-        # flush is not supported by py2.7
-        kwargs.pop("flush", None)
-        print(colored_map(text, cmap), **kwargs)
+    print(colored_map(text, cmap), **kwargs)
 
 
 def get_terminal_size():

tests/test_design_patterns.py

@@ -52,32 +52,32 @@ def test_pickle(self):
 
 
 @cached_class
-class TestClass:
+class ClassForTest:
     def __init__(self, value: Any) -> None:
         self.value = value
 
 
 def test_caching():
     # Test that instances are cached
-    inst1 = TestClass(1)
-    inst2 = TestClass(1)
+    inst1 = ClassForTest(1)
+    inst2 = ClassForTest(1)
     assert inst1 is inst2
 
-    inst3 = TestClass(2)
+    inst3 = ClassForTest(2)
     assert inst1 is not inst3
 
 
 def test_picklability():
     # Test that instances can be pickled and unpickled
-    original = TestClass(42)
+    original = ClassForTest(42)
     pickled = pickle.dumps(original)
     unpickled = pickle.loads(pickled)
 
     # Check that the unpickled instance has the same value
     assert original.value == unpickled.value
 
     # Check that the unpickled instance is the same as a newly created instance
-    new_instance = TestClass(42)
+    new_instance = ClassForTest(42)
     assert unpickled is new_instance
 
 
@@ -97,8 +97,8 @@ def __init__(self):
 
 def test_class_identity():
     # Ensure the decorated class is still recognized as the original class
-    assert isinstance(TestClass(1), TestClass)
-    assert type(TestClass(1)) is TestClass
+    assert isinstance(ClassForTest(1), ClassForTest)
+    assert type(ClassForTest(1)) is ClassForTest
 
 
 def test_multiple_arguments():

tests/test_dev.py

@@ -142,7 +142,7 @@ class TestClassNew:
             """A dummy class for tests."""
 
             def __post_init__(self):
-                print("Hello.")
+                pass
 
             def method_a(self):
                 pass
@@ -155,7 +155,7 @@ class TestClassOld:
             class_attrib_old = "OLD_ATTRIB"
 
             def __post_init__(self):
-                print("Hello.")
+                pass
 
             def method_b(self):
                 """This is method_b."""
@@ -245,7 +245,7 @@ def test_requires(self):
 
         @requires(fictitious_mod is not None, err_msg)
         def use_fictitious_mod():
-            print("success")
+            pass
 
         with pytest.raises(RuntimeError, match=err_msg):
             use_fictitious_mod()

tests/test_io.py

@@ -110,7 +110,7 @@ def test_reverse_readfile_gz(self):
         Make sure a file containing line numbers is read in reverse order,
         i.e. the first line that is read corresponds to the last line number.
         """
-        fname = os.path.join(TEST_DIR, "3000_lines.txt.gz")
+        fname = os.path.join(TEST_DIR, "3000_lines_gz.txt.gz")
         for idx, line in enumerate(reverse_readfile(fname)):
             assert int(line) == self.NUMLINES - idx
 

tests/test_json.py

@@ -8,6 +8,18 @@
 from enum import Enum
 from typing import Union
 
+import pytest
+from monty.json import (
+    MontyDecoder,
+    MontyEncoder,
+    MSONable,
+    _load_redirect,
+    jsanitize,
+    load,
+)
+
+from . import __version__ as TESTS_VERSION
+
 try:
     import numpy as np
 except ImportError:
@@ -38,18 +50,6 @@
 except ImportError:
     ObjectId = None
 
-import pytest
-from monty.json import (
-    MontyDecoder,
-    MontyEncoder,
-    MSONable,
-    _load_redirect,
-    jsanitize,
-    load,
-)
-
-from . import __version__ as tests_version
-
 TEST_DIR = os.path.join(os.path.dirname(os.path.abspath(__file__)), "test_files")
 
 
@@ -320,7 +320,7 @@ def test_unsafe_hash(self):
     def test_version(self):
         obj = self.good_cls("Hello", "World", "Python")
         d = obj.as_dict()
-        assert d["@version"] == tests_version
+        assert d["@version"] == TESTS_VERSION
 
     def test_nested_to_from_dict(self):
         GMC = GoodMSONClass
@@ -682,7 +682,7 @@ def test_pint_quantity(self):
         cls = ClassContainingQuantity(qty=pint.Quantity("9.81 m/s**2"))
 
         d = json.loads(MontyEncoder().encode(cls))
-        print(d)
+        assert isinstance(d, dict)
 
         assert d["qty"]["@module"] == "pint"
         assert d["qty"]["@class"] == "Quantity"
@@ -873,7 +873,7 @@ def test_jsanitize_pandas(self):
         assert clean == s.to_dict()
 
     @pytest.mark.skipif(
-        np is None or ObjectId is None, reason="numpy and bson not present"
+        np is None or ObjectId is None, reason="numpy or bson not present"
     )
     def test_jsanitize_numpy_bson(self):
         d = {

tests/test_pprint.py

@@ -34,4 +34,4 @@ def __str__(self):
             ],
         )
 
-        print(draw_tree(root))
+        assert draw_tree(root)

tests/test_serialization.py

@@ -6,15 +6,14 @@
 import unittest
 
 import pytest
+from monty.serialization import dumpfn, loadfn
+from monty.tempfile import ScratchDir
 
 try:
     import msgpack
 except ImportError:
     msgpack = None
 
-from monty.serialization import dumpfn, loadfn
-from monty.tempfile import ScratchDir
-
 
 class TestSerial:
     @classmethod

tests/test_subprocess.py

@@ -8,8 +8,9 @@ def test_command():
     sleep05 = Command("sleep 0.5")
 
     sleep05.run(timeout=1)
-    print(sleep05)
-    assert sleep05.retcode == 0
+    # DEBUG: this unit test fail in Win CI sometimes
+    full_msg = f"{sleep05=}\n{sleep05.error=}\n{sleep05.output}"
+    assert sleep05.retcode == 0, full_msg
     assert not sleep05.killed
 
     sleep05.run(timeout=0.1)

tests/test_tempfile.py

@@ -49,7 +49,7 @@ def test_with_copy_gzip(self):
         # We write a pre-scratch file.
         with open("pre_scratch_text", "w") as f:
             f.write("write")
-        init_gz = [f for f in os.listdir(os.getcwd()) if f.endswith(".gz")]
+        init_gz_files = [f for f in os.listdir(os.getcwd()) if f.endswith(".gz")]
         with (
             ScratchDir(
                 self.scratch_root,
@@ -62,10 +62,10 @@ def test_with_copy_gzip(self):
             f.write("write")
         files = os.listdir(os.getcwd())
 
-        # Make sure the stratch_text.gz exists
+        # Make sure the scratch_text.gz exists
         assert "scratch_text.gz" in files
         for f in files:
-            if f.endswith(".gz") and f not in init_gz:
+            if f.endswith(".gz") and f not in init_gz_files:
                 os.remove(f)
         os.remove("pre_scratch_text")