chore(linters): Apply ruff linter semi-automatic linting fixes (#863)

* I001 - Import block is un-sorted or un-formatted

* B028 - No explicit `stacklevel` keyword argument found

* COM812 - Trailing comma missing

* EM101 - Exception must not use a string literal, assign to variable first

* FURB113 - Use `procArgs.extend(...)` instead of repeatedly calling `procArgs.append()`

* PIE810 - Call `endswith` once with a `tuple`

* SIM300 - Yoda condition detected

* TC006 - Add quotes to type expression in `typing.cast()`

* UP032 - Use f-string instead of `format` call

* Fix few ruff fixes

---------

Co-authored-by: 🇺🇦 Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>

Author: MaxymVlasov

src/pre_commit_terraform/__main__.py

@@ -1,6 +1,7 @@
 """A runpy-style CLI entry-point module."""
 
-from sys import argv, exit as exit_with_return_code
+from sys import argv
+from sys import exit as exit_with_return_code
 
 from ._cli import invoke_cli_app
 

src/pre_commit_terraform/_cli.py

@@ -23,7 +23,7 @@ def invoke_cli_app(cli_args: list[str]) -> ReturnCodeType:
     parsed_cli_args = root_cli_parser.parse_args(cli_args)
     invoke_cli_app = cast_to(
         # FIXME: attempt typing per https://stackoverflow.com/a/75666611/595220
-        CLIAppEntryPointCallableType,
+        'CLIAppEntryPointCallableType',
         parsed_cli_args.invoke_cli_app,
     )
 

src/pre_commit_terraform/_cli_parsing.py

@@ -23,7 +23,7 @@ def attach_subcommand_parsers_to(root_cli_parser: ArgumentParser, /) -> None:
     )
     for subcommand_module in SUBCOMMAND_MODULES:
         subcommand_parser = subcommand_parsers.add_parser(
-            subcommand_module.CLI_SUBCOMMAND_NAME
+            subcommand_module.CLI_SUBCOMMAND_NAME,
         )
         subcommand_parser.set_defaults(
             invoke_cli_app=subcommand_module.invoke_cli_app,

src/pre_commit_terraform/terraform_docs_replace.py

@@ -53,12 +53,13 @@ def invoke_cli_app(parsed_cli_args: Namespace) -> ReturnCodeType:
         'https://github.com/antonbabenko/pre-commit-terraform/issues/248'
         '#issuecomment-1290829226',
         category=UserWarning,
+        stacklevel=1,  # It's should be 2, but tests are failing w/ values >1. As it's deprecated hook, it's safe to leave it as is w/o fixing it later.
     )
 
     dirs: list[str] = []
-    for filename in cast_to(list[str], parsed_cli_args.filenames):
+    for filename in cast_to('list[str]', parsed_cli_args.filenames):
         if os.path.realpath(filename) not in dirs and (
-            filename.endswith('.tf') or filename.endswith('.tfvars')
+            filename.endswith(('.tf', '.tfvars'))
         ):
             dirs.append(os.path.dirname(filename))
 
@@ -68,14 +69,17 @@ def invoke_cli_app(parsed_cli_args: Namespace) -> ReturnCodeType:
         try:
             procArgs = []
             procArgs.append('terraform-docs')
-            if cast_to(bool, parsed_cli_args.sort):
+            if cast_to('bool', parsed_cli_args.sort):
                 procArgs.append('--sort-by-required')
-            procArgs.append('md')
-            procArgs.append('./{dir}'.format(dir=dir))
-            procArgs.append('>')
-            procArgs.append(
-                './{dir}/{dest}'.format(
-                    dir=dir, dest=cast_to(bool, parsed_cli_args.dest)
+            procArgs.extend(
+                (
+                    'md',
+                    f'./{dir}',
+                    '>',
+                    './{dir}/{dest}'.format(
+                        dir=dir,
+                        dest=cast_to('bool', parsed_cli_args.dest),
+                    ),
                 ),
             )
             subprocess.check_call(' '.join(procArgs), shell=True)

tests/pytest/_cli_test.py

@@ -1,13 +1,13 @@
 """Tests for the high-level CLI entry point."""
 
 from argparse import ArgumentParser, Namespace
-import pytest
 
+import pytest
 from pre_commit_terraform import _cli_parsing as _cli_parsing_mod
 from pre_commit_terraform._cli import invoke_cli_app
 from pre_commit_terraform._errors import (
-    PreCommitTerraformExit,
     PreCommitTerraformBaseError,
+    PreCommitTerraformExit,
     PreCommitTerraformRuntimeError,
 )
 from pre_commit_terraform._structs import ReturnCode
@@ -67,7 +67,7 @@ def invoke_cli_app(self, parsed_cli_args: Namespace) -> ReturnCodeType:
         [CustomCmdStub()],
     )
 
-    assert ReturnCode.ERROR == invoke_cli_app(['sentinel'])
+    assert invoke_cli_app(['sentinel']) == ReturnCode.ERROR
 
     captured_outputs = capsys.readouterr()
     assert captured_outputs.err == f'{expected_stderr !s}\n'
@@ -89,7 +89,7 @@ def populate_argument_parser(
             return None
 
         def invoke_cli_app(self, parsed_cli_args: Namespace) -> ReturnCodeType:
-            raise PreCommitTerraformExit('sentinel')
+            raise PreCommitTerraformExit(self.CLI_SUBCOMMAND_NAME)
 
     monkeypatch.setattr(
         _cli_parsing_mod,

tests/pytest/terraform_docs_replace_test.py

@@ -3,13 +3,15 @@
 from argparse import ArgumentParser, Namespace
 from subprocess import CalledProcessError
 
-import pytest
 import pytest_mock
 
+import pytest
 from pre_commit_terraform._structs import ReturnCode
 from pre_commit_terraform.terraform_docs_replace import (
     invoke_cli_app,
     populate_argument_parser,
+)
+from pre_commit_terraform.terraform_docs_replace import (
     subprocess as replace_docs_subprocess_mod,
 )
 
@@ -82,7 +84,7 @@ def test_control_flow_positive(
         check_call_mock,
     )
 
-    assert ReturnCode.OK == invoke_cli_app(parsed_cli_args)
+    assert invoke_cli_app(parsed_cli_args) == ReturnCode.OK
 
     executed_commands = [
         cmd for ((cmd,), _shell) in check_call_mock.call_args_list
@@ -117,6 +119,6 @@ def test_control_flow_negative(
         check_call_mock,
     )
 
-    assert ReturnCode.ERROR == invoke_cli_app(parsed_cli_args)
+    assert invoke_cli_app(parsed_cli_args) == ReturnCode.ERROR
 
     check_call_mock.assert_called_once_with(expected_cmd, shell=True)