Fix typos and cleaner code

Author: ben-grande

usr/lib/python3/dist-packages/stdisplay/tests/__init__.py

@@ -21,6 +21,14 @@
 class TestSTBase(unittest.TestCase):
     """
     Base class for testing safe terminal utilities.
+
+    Assign "self.module" to the module you want to try on the "setup()" using
+    "super()":
+
+    >>> class TestSTCat(stdisplay.tests.TestSTBase):
+    >>>     def setUp(self) -> None:
+    >>>         self.module = "stcat"
+    >>>         super().setUp()
     """
 
     def __init__(self, *args: Any, **kwargs: Any) -> None:
@@ -31,9 +39,8 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
     def setUp(self) -> None:
         self.tmpfiles_list = []
         contents = ["a b\n", "c d"]
-        i = 0
         self.tmpdir = tempfile.mkdtemp()
-        while i < 6:
+        for i in range(0, 6):
             self.tmpfiles_list.append(os.path.join(self.tmpdir, str(i)))
             with open(self.tmpfiles_list[i], "w", encoding="utf-8") as file:
                 if i == 0:
@@ -48,7 +55,6 @@ def setUp(self) -> None:
                     pass
                 file.flush()
                 file.close()
-            i += 1
         self.tmpfiles = {
             "empty": self.tmpfiles_list[0],
             "raw": self.tmpfiles_list[1],
@@ -91,11 +97,3 @@ def _test_util(
             module.main()
         result = str(stdout.getvalue())  # pylint: disable=no-member
         return result
-
-    def _get_file(self, file: str) -> str:
-        """
-        Helper function get contents of a file.
-        """
-        with open(file, mode="r", encoding="utf-8") as fileobj:
-            text = fileobj.read()
-        return text

usr/lib/python3/dist-packages/stdisplay/tests/stcatn.py

@@ -10,7 +10,7 @@
 import stdisplay.tests
 
 
-class TestSTCat(stdisplay.tests.TestSTBase):
+class TestSTCatn(stdisplay.tests.TestSTBase):
     """
     Test stcatn.
     """

usr/lib/python3/dist-packages/stdisplay/tests/stprint.py

@@ -17,7 +17,7 @@
 
 class TestSTPrint(stdisplay.tests.TestSTBase):
     """
-    Test stecho.
+    Test stprint.
     """
 
     def setUp(self) -> None:

usr/lib/python3/dist-packages/stdisplay/tests/stsponge.py

@@ -7,6 +7,7 @@
 ## SPDX-License-Identifier: AGPL-3.0-or-later
 
 import unittest
+from pathlib import Path
 import stdisplay.tests
 
 
@@ -26,13 +27,13 @@ def test_stsponge(self) -> None:
         self.assertEqual("", self._test_util())
         self.assertEqual("", self._test_util(stdin=""))
         self.assertEqual("stdin", self._test_util(stdin="stdin"))
-        # Empty stdin with file argument.
+        # Empty stdin with file argument produces empty stdout and file.
         self.assertEqual("", self._test_util(argv=[self.tmpfiles["fill"]]))
         self.assertEqual(
             "",
-            self._get_file(file=self.tmpfiles["fill"]),
+            Path(self.tmpfiles["fill"]).read_text(encoding="utf-8"),
         )
-        # Empty stdin when writing to file and file sanitization.
+        # Empty stdout when writing to file and file sanitization.
         self.assertEqual(
             "",
             self._test_util(
@@ -41,9 +42,9 @@ def test_stsponge(self) -> None:
         )
         self.assertEqual(
             self.text_dirty_sanitized,
-            self._get_file(file=self.tmpfiles["fill"]),
+            Path(self.tmpfiles["fill"]).read_text(encoding="utf-8"),
         )
-        # Empty stdin when writing to multiple files and its sanitization.
+        # Empty stdout when writing to multiple files and its sanitization.
         self.assertEqual(
             "",
             self._test_util(
@@ -53,11 +54,11 @@ def test_stsponge(self) -> None:
         )
         self.assertEqual(
             self.text_dirty_sanitized,
-            self._get_file(file=self.tmpfiles["fill"]),
+            Path(self.tmpfiles["fill"]).read_text(encoding="utf-8"),
         )
         self.assertEqual(
             self.text_dirty_sanitized,
-            self._get_file(file=self.tmpfiles["fill2"]),
+            Path(self.tmpfiles["fill2"]).read_text(encoding="utf-8"),
         )
 
 

usr/lib/python3/dist-packages/stdisplay/tests/sttee.py

@@ -7,6 +7,7 @@
 ## SPDX-License-Identifier: AGPL-3.0-or-later
 
 import unittest
+from pathlib import Path
 import stdisplay.tests
 
 
@@ -30,7 +31,7 @@ def test_sttee(self) -> None:
         self.assertEqual("", self._test_util(argv=[self.tmpfiles["fill"]]))
         self.assertEqual(
             "",
-            self._get_file(file=self.tmpfiles["fill"]),
+            Path(self.tmpfiles["fill"]).read_text(encoding="utf-8"),
         )
         # Stdin sanitization and writing to file.
         self.assertEqual(
@@ -41,7 +42,7 @@ def test_sttee(self) -> None:
         )
         self.assertEqual(
             self.text_dirty_sanitized,
-            self._get_file(file=self.tmpfiles["fill"]),
+            Path(self.tmpfiles["fill"]).read_text(encoding="utf-8"),
         )
         # Stdin sanitization and writing to multiple files.
         self.assertEqual(
@@ -53,11 +54,11 @@ def test_sttee(self) -> None:
         )
         self.assertEqual(
             self.text_dirty_sanitized,
-            self._get_file(file=self.tmpfiles["fill"]),
+            Path(self.tmpfiles["fill"]).read_text(encoding="utf-8"),
         )
         self.assertEqual(
             self.text_dirty_sanitized,
-            self._get_file(file=self.tmpfiles["fill2"]),
+            Path(self.tmpfiles["fill2"]).read_text(encoding="utf-8"),
         )