[pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Author: pre-commit-ci[bot]

src/pre_commit_terraform/_cli.py

@@ -4,13 +4,12 @@
 from typing import cast as cast_to
 
 from ._cli_parsing import initialize_argument_parser
-from ._errors import (
-    PreCommitTerraformBaseError,
-    PreCommitTerraformExit,
-    PreCommitTerraformRuntimeError,
-)
+from ._errors import PreCommitTerraformBaseError
+from ._errors import PreCommitTerraformExit
+from ._errors import PreCommitTerraformRuntimeError
 from ._structs import ReturnCode
-from ._types import CLIAppEntryPointCallableType, ReturnCodeType
+from ._types import CLIAppEntryPointCallableType
+from ._types import ReturnCodeType
 
 
 def invoke_cli_app(cli_args: list[str]) -> ReturnCodeType:
@@ -34,8 +33,7 @@ def invoke_cli_app(cli_args: list[str]) -> ReturnCodeType:
         raise
     except PreCommitTerraformRuntimeError as unhandled_exc:
         print(
-            f'App execution took an unexpected turn: {unhandled_exc !s}. '
-            'Exiting...',
+            f'App execution took an unexpected turn: {unhandled_exc !s}. ' 'Exiting...',
             file=sys.stderr,
         )
         return ReturnCode.ERROR

src/pre_commit_terraform/_types.py

@@ -1,12 +1,13 @@
 """Composite types for annotating in-project code."""
 
-from argparse import ArgumentParser, Namespace
+from argparse import ArgumentParser
+from argparse import Namespace
 from collections.abc import Callable
-from typing import Protocol, Union
+from typing import Protocol
+from typing import Union
 
 from pre_commit_terraform._structs import ReturnCode
 
-
 ReturnCodeType = Union[ReturnCode, int]  # Union instead of pipe for Python 3.9
 CLIAppEntryPointCallableType = Callable[[Namespace], ReturnCodeType]
 

src/pre_commit_terraform/terraform_docs_replace.py

@@ -3,7 +3,8 @@
 import os
 import subprocess
 import warnings
-from argparse import ArgumentParser, Namespace
+from argparse import ArgumentParser
+from argparse import Namespace
 from typing import Final
 from typing import cast as cast_to
 
@@ -71,8 +72,9 @@ def invoke_cli_app(parsed_cli_args: Namespace) -> ReturnCodeType:
 
     dirs = []
     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"))):
+        if os.path.realpath(filename) not in dirs and (
+            filename.endswith('.tf') or filename.endswith('.tfvars')
+        ):
             dirs.append(os.path.dirname(filename))
 
     retval = ReturnCode.OK
@@ -84,13 +86,12 @@ def invoke_cli_app(parsed_cli_args: Namespace) -> ReturnCodeType:
             if cast_to(bool, parsed_cli_args.sort):
                 procArgs.append('--sort-by-required')
             procArgs.append('md')
-            procArgs.append("./{dir}".format(dir=dir))
+            procArgs.append('./{dir}'.format(dir=dir))
             procArgs.append('>')
             procArgs.append(
-                './{dir}/{dest}'.
-                format(dir=dir, dest=cast_to(bool, parsed_cli_args.dest)),
+                './{dir}/{dest}'.format(dir=dir, dest=cast_to(bool, parsed_cli_args.dest)),
             )
-            subprocess.check_call(" ".join(procArgs), shell=True)
+            subprocess.check_call(' '.join(procArgs), shell=True)
         except subprocess.CalledProcessError as e:
             print(e)
             retval = ReturnCode.ERROR

tests/pytest/_cli_test.py

@@ -1,19 +1,18 @@
 """Tests for the high-level CLI entry point."""
 
-from argparse import ArgumentParser, Namespace
+from argparse import ArgumentParser
+from argparse import Namespace
+
 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,
-    PreCommitTerraformRuntimeError,
-)
+from pre_commit_terraform._errors import PreCommitTerraformBaseError
+from pre_commit_terraform._errors import PreCommitTerraformExit
+from pre_commit_terraform._errors import PreCommitTerraformRuntimeError
 from pre_commit_terraform._structs import ReturnCode
 from pre_commit_terraform._types import ReturnCodeType
 
-
 pytestmark = pytest.mark.filterwarnings(
     'ignore:`terraform_docs_replace` hook is DEPRECATED.:UserWarning:'
     'pre_commit_terraform.terraform_docs_replace',
@@ -42,17 +41,19 @@
     ),
 )
 def test_known_interrupts(
-        capsys: pytest.CaptureFixture[str],
-        expected_stderr: str,
-        monkeypatch: pytest.MonkeyPatch,
-        raised_error: BaseException,
+    capsys: pytest.CaptureFixture[str],
+    expected_stderr: str,
+    monkeypatch: pytest.MonkeyPatch,
+    raised_error: BaseException,
 ) -> None:
     """Check that known interrupts are turned into return code 1."""
+
     class CustomCmdStub:
         CLI_SUBCOMMAND_NAME = 'sentinel'
 
         def populate_argument_parser(
-                self, subcommand_parser: ArgumentParser,
+            self,
+            subcommand_parser: ArgumentParser,
         ) -> None:
             return None
 
@@ -72,15 +73,17 @@ def invoke_cli_app(self, parsed_cli_args: Namespace) -> ReturnCodeType:
 
 
 def test_app_exit(
-        capsys: pytest.CaptureFixture[str],
-        monkeypatch: pytest.MonkeyPatch,
+    capsys: pytest.CaptureFixture[str],
+    monkeypatch: pytest.MonkeyPatch,
 ) -> None:
     """Check that an exit exception is re-raised."""
+
     class CustomCmdStub:
         CLI_SUBCOMMAND_NAME = 'sentinel'
 
         def populate_argument_parser(
-                self, subcommand_parser: ArgumentParser,
+            self,
+            subcommand_parser: ArgumentParser,
         ) -> None:
             return None
 

tests/pytest/terraform_docs_replace_test.py

@@ -1,16 +1,17 @@
 """Tests for the `replace-docs` subcommand."""
 
-from argparse import ArgumentParser, Namespace
+from argparse import ArgumentParser
+from argparse import Namespace
 from subprocess import CalledProcessError
 
 import pytest
 import pytest_mock
 
 from pre_commit_terraform._structs import ReturnCode
+from pre_commit_terraform.terraform_docs_replace import invoke_cli_app
+from pre_commit_terraform.terraform_docs_replace import populate_argument_parser
 from pre_commit_terraform.terraform_docs_replace import (
-    invoke_cli_app,
-    populate_argument_parser,
-    subprocess as replace_docs_subprocess_mod,
+  subprocess as replace_docs_subprocess_mod,
 )
 
 
@@ -23,10 +24,7 @@ def test_arg_parser_populated() -> None:
 
 def test_check_is_deprecated() -> None:
     """Verify that `replace-docs` shows a deprecation warning."""
-    deprecation_msg_regex = (
-        r'^`terraform_docs_replace` hook is DEPRECATED\.'
-        'For migration.*$'
-    )
+    deprecation_msg_regex = r'^`terraform_docs_replace` hook is DEPRECATED\.' 'For migration.*$'
     with pytest.warns(UserWarning, match=deprecation_msg_regex):
         # not `pytest.deprecated_call()` due to this being a user warning
         invoke_cli_app(Namespace(filenames=[]))
@@ -53,8 +51,7 @@ def test_check_is_deprecated() -> None:
             ),
             [
                 'terraform-docs --sort-by-required md ./ > .//SENTINEL.md',
-                'terraform-docs --sort-by-required md ./thing '
-                '> ./thing/SENTINEL.md',
+                'terraform-docs --sort-by-required md ./thing ' '> ./thing/SENTINEL.md',
             ],
             id='two-sorted-files',
         ),
@@ -70,10 +67,10 @@ def test_check_is_deprecated() -> None:
     'pre_commit_terraform.terraform_docs_replace',
 )
 def test_control_flow_positive(
-        expected_cmds: list[str],
-        mocker: pytest_mock.MockerFixture,
-        monkeypatch: pytest.MonkeyPatch,
-        parsed_cli_args: Namespace,
+    expected_cmds: list[str],
+    mocker: pytest_mock.MockerFixture,
+    monkeypatch: pytest.MonkeyPatch,
+    parsed_cli_args: Namespace,
 ) -> None:
     """Check that the subcommand's happy path works."""
     check_call_mock = mocker.Mock()
@@ -85,9 +82,7 @@ def test_control_flow_positive(
 
     assert ReturnCode.OK == invoke_cli_app(parsed_cli_args)
 
-    executed_commands = [
-        cmd for ((cmd, ), _shell) in check_call_mock.call_args_list
-    ]
+    executed_commands = [cmd for ((cmd,), _shell) in check_call_mock.call_args_list]
 
     assert len(expected_cmds) == check_call_mock.call_count
     assert expected_cmds == executed_commands
@@ -98,8 +93,8 @@ def test_control_flow_positive(
     'pre_commit_terraform.terraform_docs_replace',
 )
 def test_control_flow_negative(
-        mocker: pytest_mock.MockerFixture,
-        monkeypatch: pytest.MonkeyPatch,
+    mocker: pytest_mock.MockerFixture,
+    monkeypatch: pytest.MonkeyPatch,
 ) -> None:
     """Check that the subcommand's error processing works."""
     parsed_cli_args = Namespace(