NOGH: finally upgrade pylint and fix tests

Author: lcombs15

.gitignore

@@ -173,4 +173,6 @@ fabric.properties
 
 # Android studio 3.1+ serialized cache file
 .idea/caches/build_file_checksums.ser
-test_repo
+test_repo
+
+*.zip

requirements.txt

@@ -1,5 +1,5 @@
 PyInstaller==5.7.0
 pytest==7.2.1
-pylint==2.7.4
+pylint==2.15.10
 codecov==2.1.12
 pytest-cov==4.0.0

scripts/lint.py

@@ -6,9 +6,6 @@
 
 DOCSTRING_REQUIREMENT = 'C0111'
 
-# This can create a problem when we don't use self.assert() in a unit test (Mocking, ext..)
-METHOD_COULD_BE_FUNCTION = 'R0201'
-
 TOO_FEW_PUBLIC_METHODS = 'R0903'
 
 
@@ -36,5 +33,5 @@ def lint(ignore_rules: list, directories: list):
          'scripts'
      ])
 
-lint([DOCSTRING_REQUIREMENT, METHOD_COULD_BE_FUNCTION, TOO_FEW_PUBLIC_METHODS],
+lint([DOCSTRING_REQUIREMENT, TOO_FEW_PUBLIC_METHODS],
      ['src.test', 'src.integration'])

scripts/os_specific_requirements.py

@@ -8,7 +8,7 @@
     OS_PREFIX: str = platform.system().lower()
 
     print("Running OS setup")
-    print("OS: %s" % OS_PREFIX)
+    print(f"OS: {OS_PREFIX}")
 
     if OS_PREFIX == "darwin":
         os.system("brew install upx")

scripts/package.py

@@ -26,8 +26,8 @@
     PyInstaller.__main__.run([
         "--onefile",
         "--hidden-import=_cffi_backend",
-        "--distpath=%s" % EXE_FILE_FOLDER,
-        "--name=%s" % EXE_NAME,
+        f"--distpath={EXE_FILE_FOLDER}",
+        f"--name={EXE_NAME}",
         os.path.join("src", "main", "commit_msg_hook.py"),
     ])
 
@@ -52,4 +52,4 @@
     # in the current working directory
     zip_file_name = OS_ALIAS.capitalize()
     shutil.make_archive(zip_file_name, 'zip', EXE_FILE_FOLDER)
-    print("Wrote zip file: %s" % zip_file_name)
+    print(f"Wrote zip file: {zip_file_name}")

src/integration/test_integration.py

@@ -57,9 +57,8 @@ def setUp(self):
 
     def test_commit_message_is_edited(self):
         file_to_commit_path = "example.txt"
-        file_to_commit = open(file_to_commit_path, 'w')
-        file_to_commit.write("content here")
-        file_to_commit.close()
+        with open(file_to_commit_path, 'w', encoding="utf8") as file_to_commit:
+            file_to_commit.write("content here")
 
         # stage file
         os.system("git add " + file_to_commit_path)
@@ -74,13 +73,13 @@ def test_commit_message_is_edited(self):
         # Give git a moment to switch branches
         time.sleep(2)
 
-        os.system('git commit -m "%s"' % commit_message)
+        os.system(f"git commit -m \"{commit_message}\"")
 
         # Give the hook N seconds to run
         time.sleep(5)
 
         # Save commit message after hook should have run
         commit_message_after_hook: str = os.popen("git log -n 1 --format=\"%s\"").read()
 
-        self.assertEqual(commit_message_after_hook.strip(), "GH-123: %s" % commit_message,
+        self.assertEqual(commit_message_after_hook.strip(), f"GH-123: {commit_message}",
                          "Commit message was not edited correctly")

src/main/commit_msg_hook.py

@@ -31,7 +31,7 @@ def get_config() -> CommitHookConfig:
         return CommitHookConfigINIImpl(
             open(
                 config_file_path,
-                'r')
+                'r', encoding="utf8")
         )
 
     logging.info(

src/main/config/commit_hook_config_base_impl.py

@@ -10,7 +10,7 @@ class CommitHookConfigDefaultImpl(CommitHookConfig):
     """
 
     def get_issue_url_format(self, ticket: str = "") -> str:
-        return 'https://github.com/unthreaded/git-hooks/issues/%s' % ticket
+        return f"https://github.com/unthreaded/git-hooks/issues/{ticket}"
 
     def get_issue_pattern(self) -> str:
         return "GH-[0-9]+"

src/main/hook/commit_msg_hook_runner.py

@@ -72,12 +72,17 @@ def run(self) -> ExitCode:
         """
         issue_pattern: str = self.hook_config.get_issue_pattern()
         issue_or_no_issue_pattern: str = \
-            "%s|%s" % (issue_pattern, self.hook_config.get_no_issue_phrase())
+            f"{issue_pattern}|{self.hook_config.get_no_issue_phrase()}"
 
         branch_name: str = self.get_current_branch_name()
 
         commit_msg_file_path: str = os.path.join(self.git_repo_path, self.git_commit_message_path)
-        raw_commit_msg_text: str = open(commit_msg_file_path, 'r').read()
+
+        raw_commit_msg_text: str
+
+        with open(commit_msg_file_path, 'r', encoding="utf8") as commit_msg_file:
+            raw_commit_msg_text = commit_msg_file.read()
+
         commit_msg_text: str = raw_commit_msg_text.splitlines()[0]
 
         issue_in_branch: str = get_left_most_issue_in_string(issue_pattern, branch_name)
@@ -117,10 +122,9 @@ def run(self) -> ExitCode:
                 issue_in_branch,
                 branch_name)
 
-        commit_msg_text = "%s: %s" % (issue_in_branch, raw_commit_msg_text)
+        commit_msg_text = f"{issue_in_branch}: {raw_commit_msg_text}"
 
         # Open file for write, which will empty the file contents
-        commit_msg_file = open(commit_msg_file_path, 'w')
-        commit_msg_file.write(commit_msg_text)
-        commit_msg_file.close()
+        with open(commit_msg_file_path, 'w', encoding="utf8") as commit_msg_file:
+            commit_msg_file.write(commit_msg_text)
         return ExitCode.SUCCESS

src/test/config/test_commit_hook_config.py

@@ -36,7 +36,9 @@ class TestINIImplCommitHookConfig(unittest.TestCase):
     def setUp(self):
         super().setUp()
         self.sut = CommitHookConfigINIImpl(
-            open(os.path.join("src", "main", CommitHookConfigINIImpl.CONFIG_FILE_NAME), 'r')
+            # pylint: disable=consider-using-with
+            open(os.path.join("src", "main", CommitHookConfigINIImpl.CONFIG_FILE_NAME),
+                 'r', encoding="utf8")
         )
 
     def test_protected_branch_prefixes(self):

src/test/hook/test_commit_msg_hook_runner.py

@@ -30,7 +30,7 @@ def setUp(self):
         def write_to_commit_file(value: str):
             self.message_written_to_commit_file = value
 
-        self.mock_commit_file.write = Mock(side_effect=write_to_commit_file)
+        self.mock_commit_file.__enter__.return_value.write = Mock(side_effect=write_to_commit_file)
 
         self.mock_open = self.create_patch('builtins.open')
         self.mock_open.return_value = self.mock_commit_file
@@ -52,7 +52,7 @@ def write_to_commit_file(value: str):
         """)
 
     def set_commit_message(self, message: str):
-        self.mock_commit_file.read.return_value = message
+        self.mock_commit_file.__enter__.return_value.read.return_value = message
 
     def set_branch_name(self, branch: str):
         self.mock_branch_name.return_value = bytes(branch, encoding="utf-8")
@@ -68,7 +68,7 @@ def test_no_action_taken_on_merge_or_revert(self):
                                      "MERGE changes from release/V1.2"]
 
         for no_action_commit in no_action_commit_messages:
-            print("Testing this commit message: %s" % no_action_commit)
+            print(f"Testing this commit message: {no_action_commit}")
 
             self.set_commit_message(no_action_commit)