git-commit-msg-ai 1.4.2__tar.gz → 1.5.1__tar.gz

{git_commit_msg_ai-1.4.2 → git_commit_msg_ai-1.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-commit-msg-ai
-Version: 1.4.2
+Version: 1.5.1
 Summary: AI-powered git commit message generator following Conventional Commits
 License-Expression: MIT
 Requires-Python: >=3.10
@@ -113,3 +113,25 @@ BREAKING CHANGE: /v1/legacy is no longer available
 ```
 
 Supported types: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`
+
+## Debugging
+
+By default the tool produces no diagnostic output. To enable logging, set the `GIT_COMMIT_AI_LOG_LEVEL` environment variable before running the command. Logs are written to **stderr** and do not interfere with the generated commit message on **stdout**.
+
+Valid values: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`
+
+```sh
+# macOS/Linux - show all internal diagnostic messages
+GIT_COMMIT_AI_LOG_LEVEL=DEBUG git-commit-msg-ai
+
+# Windows PowerShell
+$env:GIT_COMMIT_AI_LOG_LEVEL = 'DEBUG'
+git-commit-msg-ai
+```
+
+| Level | What you see |
+|---|---|
+| `DEBUG` | git commands run, API model/token params, temp file paths, char counts |
+| `INFO` | commit message generated, commit created |
+| `WARNING` | no staged changes found |
+| `ERROR` | git not found, API failures, editor errors |

{git_commit_msg_ai-1.4.2 → git_commit_msg_ai-1.5.1}/README.md

@@ -97,3 +97,25 @@ BREAKING CHANGE: /v1/legacy is no longer available
 ```
 
 Supported types: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`
+
+## Debugging
+
+By default the tool produces no diagnostic output. To enable logging, set the `GIT_COMMIT_AI_LOG_LEVEL` environment variable before running the command. Logs are written to **stderr** and do not interfere with the generated commit message on **stdout**.
+
+Valid values: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`
+
+```sh
+# macOS/Linux - show all internal diagnostic messages
+GIT_COMMIT_AI_LOG_LEVEL=DEBUG git-commit-msg-ai
+
+# Windows PowerShell
+$env:GIT_COMMIT_AI_LOG_LEVEL = 'DEBUG'
+git-commit-msg-ai
+```
+
+| Level | What you see |
+|---|---|
+| `DEBUG` | git commands run, API model/token params, temp file paths, char counts |
+| `INFO` | commit message generated, commit created |
+| `WARNING` | no staged changes found |
+| `ERROR` | git not found, API failures, editor errors |

{git_commit_msg_ai-1.4.2 → git_commit_msg_ai-1.5.1}/git_commit_msg_ai/ai_client.py

@@ -1,3 +1,4 @@
+import logging
 import textwrap
 from typing import Final, cast
 
@@ -5,6 +6,8 @@ import anthropic
 
 from git_commit_msg_ai.exceptions import AIError
 
+logger = logging.getLogger(__name__)
+
 SYSTEM_PROMPT: Final[str] = textwrap.dedent("""\
     You are a Git commit message generator. Output only the commit message, nothing else. Follow the Conventional Commits specification:
     - First line: <type>(<optional scope>)<!>: <short subject> (50 chars max); append ! before the colon if the commit introduces a breaking change
@@ -13,7 +16,7 @@ SYSTEM_PROMPT: Final[str] = textwrap.dedent("""\
     - If there is a breaking change, add a blank line after the body followed by "BREAKING CHANGE: <description of what breaks and why>
     Types: feat, fix, docs, style, refactor, test, chore""")
 
-MODEL: Final[str] = 'claude-haiku-4-5-20251001'
+MODEL: Final[str] = "claude-haiku-4-5-20251001"
 MAX_TOKENS: Final[int] = 1024
 
 
@@ -21,22 +24,29 @@ def generate_commit_message(diff: str) -> str:
     try:
         anthropic_client = anthropic.Anthropic()
 
+        logger.debug("Calling Anthropic API: model=%s max_tokens=%d", MODEL, MAX_TOKENS)
         anthropic_api_response = anthropic_client.messages.create(
             model=MODEL,
             max_tokens=MAX_TOKENS,
             system=SYSTEM_PROMPT,
-            messages=[{'role': 'user', 'content': diff}],
+            messages=[{"role": "user", "content": diff}],
         )
     except anthropic.AuthenticationError:
-        raise AIError('Anthropic API key is missing or invalid. Set the ANTHROPIC_API_KEY environment variable.')
+        logger.error("Anthropic authentication error")
+        raise AIError("Anthropic API key is missing or invalid. Set the ANTHROPIC_API_KEY environment variable.")
     except anthropic.RateLimitError:
-        raise AIError('Anthropic API rate limit reached. Wait a moment and try again.')
+        logger.error("Anthropic rate limit error")
+        raise AIError("Anthropic API rate limit reached. Wait a moment and try again.")
     except anthropic.APIConnectionError:
-        raise AIError('Could not reach the Anthropic API. Check your network connection.')
+        logger.error("Anthropic API connection error")
+        raise AIError("Could not reach the Anthropic API. Check your network connection.")
     except anthropic.APIStatusError as error:
-        raise AIError(f'Anthropic API returned an error: {error.status_code}.')
+        logger.error("Anthropic API status error: %s", error.status_code)
+        raise AIError(f"Anthropic API returned an error: {error.status_code}.")
 
     anthropic_api_response_message = anthropic_api_response.content[0]
     commit_message = cast(anthropic.types.TextBlock, anthropic_api_response_message).text.strip()
 
+    logger.info("Commit message generated: %d chars", len(commit_message))
+
     return commit_message

git_commit_msg_ai-1.5.1/git_commit_msg_ai/cli.py

@@ -0,0 +1,51 @@
+import logging
+import os
+import sys
+from typing import Final
+
+from git_commit_msg_ai import ai_client, editor, git_ops
+from git_commit_msg_ai.exceptions import GitCommitAIError
+
+LOG_LEVEL_ENV_VAR: Final[str] = "GIT_COMMIT_AI_LOG_LEVEL"
+
+
+def main() -> None:
+    log_level_name = os.environ.get(LOG_LEVEL_ENV_VAR, "WARNING").upper()
+    numeric_log_level = getattr(logging, log_level_name, None)
+
+    if not isinstance(numeric_log_level, int):
+        numeric_log_level = logging.WARNING
+
+    logging.basicConfig(level=numeric_log_level, format="%(levelname)s:%(name)s:%(message)s", stream=sys.stderr)
+
+    if not isinstance(getattr(logging, log_level_name, None), int):
+        logging.warning("Invalid %s value %r, defaulting to WARNING", LOG_LEVEL_ENV_VAR, log_level_name)
+
+    try:
+        diff = git_ops.get_staged_diff()
+        commit_message = ai_client.generate_commit_message(diff)
+        print(commit_message)
+
+        print()
+        user_selection = input("[a]ccept / [e]dit / [r]eject: ").strip().lower()
+
+        if user_selection == "a":
+            git_ops.commit(commit_message)
+        elif user_selection == "e":
+            updated_commit_message = editor.open_in_editor(commit_message)
+            git_ops.commit(updated_commit_message)
+        elif user_selection == "r":
+            print("User rejected the generated commit message. No commit made.")
+        else:
+            print("Invalid selection.")
+            sys.exit(1)
+    except GitCommitAIError as error:
+        print(str(error))
+        sys.exit(1)
+    except (KeyboardInterrupt, EOFError):
+        print("Aborted.")
+        sys.exit(1)
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

{git_commit_msg_ai-1.4.2 → git_commit_msg_ai-1.5.1}/git_commit_msg_ai/editor.py

@@ -1,3 +1,4 @@
+import logging
 import os
 import platform
 import subprocess
@@ -5,39 +6,54 @@ import tempfile
 
 from git_commit_msg_ai.exceptions import EditorError
 
+logger = logging.getLogger(__name__)
+
 
 def get_default_editor() -> str:
     current_platform = platform.system()
-    is_windows = current_platform == 'Windows'
+    is_windows = current_platform == "Windows"
 
-    return 'notepad' if is_windows else 'vi'
+    return "notepad" if is_windows else "vi"
 
 
 def open_in_editor(initial_text: str) -> str:
     try:
-        with tempfile.NamedTemporaryFile(suffix='.txt', mode='w', delete=False) as temp_file:
+        with tempfile.NamedTemporaryFile(suffix=".txt", mode="w", delete=False) as temp_file:
             temp_file.write(initial_text)
             temp_file_path = temp_file.name
     except OSError:
-        raise EditorError('Could not create a temporary file.')
+        logger.error("Could not create temporary file")
+        raise EditorError("Could not create a temporary file.")
+
+    logger.debug("Temporary file created: %s", temp_file_path)
 
     platform_default_editor = get_default_editor()
-    editor_command = os.environ.get('EDITOR', platform_default_editor)
+    editor_command = os.environ.get("EDITOR", platform_default_editor)
+
+    logger.debug("Selected editor: %s", editor_command)
 
     try:
         try:
+            logger.debug("Opening editor: %s %s", editor_command, temp_file_path)
             subprocess.run([editor_command, temp_file_path], check=True)
         except FileNotFoundError:
+            logger.error("Editor not found: %s", editor_command)
             raise EditorError(f'Editor "{editor_command}" was not found. Set the EDITOR environment variable to a valid editor.')
         except subprocess.CalledProcessError:
+            logger.error("Editor exited with error: %s", editor_command)
             raise EditorError(f'Editor "{editor_command}" exited with an error.')
 
+        logger.debug("Editor closed, reading edited content")
+
         try:
             with open(temp_file_path) as temp_file:
                 edited_text = temp_file.read().strip()
         except OSError:
-            raise EditorError('Could not read the edited commit message from the temporary file.')
+            logger.error("Could not read temporary file: %s", temp_file_path)
+            raise EditorError("Could not read the edited commit message from the temporary file.")
     finally:
         os.unlink(temp_file_path)
 
+    logger.debug("Edited text read: %d chars", len(edited_text))
+
     return edited_text

git_commit_msg_ai-1.5.1/git_commit_msg_ai/git_ops.py

@@ -0,0 +1,52 @@
+import logging
+import subprocess
+from typing import Final
+
+from git_commit_msg_ai.exceptions import GitError
+
+GIT_COMMAND: Final[str] = "git"
+DIFF_SUBCOMMAND: Final[str] = "diff"
+CACHED_FLAG: Final[str] = "--cached"
+COMMIT_SUBCOMMAND: Final[str] = "commit"
+MESSAGE_FLAG: Final[str] = "-m"
+UTF8_ENCODING: Final[str] = "utf-8"
+
+logger = logging.getLogger(__name__)
+
+
+def get_staged_diff() -> str:
+    try:
+        logger.debug("Running: %s %s %s", GIT_COMMAND, DIFF_SUBCOMMAND, CACHED_FLAG)
+        raw_diff_bytes = subprocess.check_output([GIT_COMMAND, DIFF_SUBCOMMAND, CACHED_FLAG])
+        staged_diff = raw_diff_bytes.decode(UTF8_ENCODING)
+    except FileNotFoundError:
+        logger.error("git not found on PATH")
+        raise GitError("git is not installed or not on PATH.")
+    except subprocess.CalledProcessError:
+        logger.error("git diff --cached exited non-zero")
+        raise GitError("Failed to get staged diff. Are you inside a git repository?")
+    except UnicodeDecodeError:
+        logger.error("Staged diff could not be decoded as UTF-8")
+        raise GitError("Staged diff contains bytes that could not be decoded as UTF-8.")
+
+    logger.debug("Staged diff received: %d chars", len(staged_diff))
+
+    if not staged_diff:
+        logger.warning("No staged changes found")
+        raise GitError("No staged changes found. Stage files with git add before running.")
+
+    return staged_diff
+
+
+def commit(message: str) -> None:
+    try:
+        logger.debug("Running: %s %s %s <message>", GIT_COMMAND, COMMIT_SUBCOMMAND, MESSAGE_FLAG)
+        subprocess.run([GIT_COMMAND, COMMIT_SUBCOMMAND, MESSAGE_FLAG, message], check=True)
+    except FileNotFoundError:
+        logger.error("git not found on PATH")
+        raise GitError("git is not installed or not on PATH.")
+    except subprocess.CalledProcessError:
+        logger.error("git commit exited non-zero")
+        raise GitError("git commit failed.")
+
+    logger.info("Commit created successfully")

{git_commit_msg_ai-1.4.2 → git_commit_msg_ai-1.5.1}/git_commit_msg_ai.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-commit-msg-ai
-Version: 1.4.2
+Version: 1.5.1
 Summary: AI-powered git commit message generator following Conventional Commits
 License-Expression: MIT
 Requires-Python: >=3.10
@@ -113,3 +113,25 @@ BREAKING CHANGE: /v1/legacy is no longer available
 ```
 
 Supported types: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`
+
+## Debugging
+
+By default the tool produces no diagnostic output. To enable logging, set the `GIT_COMMIT_AI_LOG_LEVEL` environment variable before running the command. Logs are written to **stderr** and do not interfere with the generated commit message on **stdout**.
+
+Valid values: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`
+
+```sh
+# macOS/Linux - show all internal diagnostic messages
+GIT_COMMIT_AI_LOG_LEVEL=DEBUG git-commit-msg-ai
+
+# Windows PowerShell
+$env:GIT_COMMIT_AI_LOG_LEVEL = 'DEBUG'
+git-commit-msg-ai
+```
+
+| Level | What you see |
+|---|---|
+| `DEBUG` | git commands run, API model/token params, temp file paths, char counts |
+| `INFO` | commit message generated, commit created |
+| `WARNING` | no staged changes found |
+| `ERROR` | git not found, API failures, editor errors |

{git_commit_msg_ai-1.4.2 → git_commit_msg_ai-1.5.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "git-commit-msg-ai"
-version = "1.4.2"
+version = "1.5.1"
 description = "AI-powered git commit message generator following Conventional Commits"
 readme = "README.md"
 license = "MIT"
@@ -30,7 +30,7 @@ strict = true
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
-addopts = "--cov --cov-report=term-missing"
+addopts = "--cov --cov-report=term-missing --cov-report=html --cov-fail-under=80"
 
 [tool.coverage.run]
 source = ["git_commit_msg_ai"]

git_commit_msg_ai-1.5.1/tests/test_ai_client.py

@@ -0,0 +1,158 @@
+import logging
+from contextlib import ExitStack
+from unittest.mock import MagicMock, patch
+
+import anthropic
+import pytest
+
+from git_commit_msg_ai.ai_client import MAX_TOKENS, MODEL, generate_commit_message
+from git_commit_msg_ai.exceptions import AIError
+
+
+def _make_api_response(text: str) -> MagicMock:
+    mock_text_block = MagicMock(spec=anthropic.types.TextBlock)
+    mock_text_block.text = text
+
+    mock_response = MagicMock(spec=anthropic.types.Message)
+    mock_response.content = [mock_text_block]
+
+    return mock_response
+
+
+def _make_status_error(exception_class: type[anthropic.APIStatusError], status_code: int) -> anthropic.APIStatusError:
+    mock_response = MagicMock()
+    mock_response.status_code = status_code
+
+    return exception_class("error", response=mock_response, body={})
+
+
+class TestGenerateCommitMessage:
+    def test_returns_stripped_commit_message(self) -> None:
+        with ExitStack() as stack:
+            mock_anthropic_class = stack.enter_context(patch("git_commit_msg_ai.ai_client.anthropic.Anthropic"))
+            mock_client = MagicMock()
+            mock_client.messages.create.return_value = _make_api_response("  feat: add feature  ")
+            mock_anthropic_class.return_value = mock_client
+
+            result = generate_commit_message("diff content")
+
+        assert result == "feat: add feature"
+
+    def test_raises_ai_error_on_authentication_error(self) -> None:
+        with ExitStack() as stack:
+            mock_anthropic_class = stack.enter_context(patch("git_commit_msg_ai.ai_client.anthropic.Anthropic"))
+            mock_client = MagicMock()
+            mock_client.messages.create.side_effect = _make_status_error(anthropic.AuthenticationError, 401)
+            mock_anthropic_class.return_value = mock_client
+
+            with pytest.raises(AIError, match="ANTHROPIC_API_KEY"):
+                generate_commit_message("diff content")
+
+    def test_raises_ai_error_on_rate_limit_error(self) -> None:
+        with ExitStack() as stack:
+            mock_anthropic_class = stack.enter_context(patch("git_commit_msg_ai.ai_client.anthropic.Anthropic"))
+            mock_client = MagicMock()
+            mock_client.messages.create.side_effect = _make_status_error(anthropic.RateLimitError, 429)
+            mock_anthropic_class.return_value = mock_client
+
+            with pytest.raises(AIError, match="rate limit"):
+                generate_commit_message("diff content")
+
+    def test_raises_ai_error_on_api_connection_error(self) -> None:
+        mock_request = MagicMock()
+
+        with ExitStack() as stack:
+            mock_anthropic_class = stack.enter_context(patch("git_commit_msg_ai.ai_client.anthropic.Anthropic"))
+            mock_client = MagicMock()
+            mock_client.messages.create.side_effect = anthropic.APIConnectionError(request=mock_request)
+            mock_anthropic_class.return_value = mock_client
+
+            with pytest.raises(AIError, match="network"):
+                generate_commit_message("diff content")
+
+    def test_raises_ai_error_on_api_status_error_with_status_code(self) -> None:
+        with ExitStack() as stack:
+            mock_anthropic_class = stack.enter_context(patch("git_commit_msg_ai.ai_client.anthropic.Anthropic"))
+            mock_client = MagicMock()
+            mock_client.messages.create.side_effect = _make_status_error(anthropic.APIStatusError, 500)
+            mock_anthropic_class.return_value = mock_client
+
+            with pytest.raises(AIError, match="500"):
+                generate_commit_message("diff content")
+
+    def test_logs_debug_before_api_call(self, caplog: pytest.LogCaptureFixture) -> None:
+        with caplog.at_level(logging.DEBUG, logger="git_commit_msg_ai.ai_client"):
+            with ExitStack() as stack:
+                mock_anthropic_class = stack.enter_context(patch("git_commit_msg_ai.ai_client.anthropic.Anthropic"))
+                mock_client = MagicMock()
+                mock_client.messages.create.return_value = _make_api_response("feat: add feature")
+                mock_anthropic_class.return_value = mock_client
+                generate_commit_message("diff content")
+
+        messages = [r.message for r in caplog.records]
+        assert any(MODEL in m and str(MAX_TOKENS) in m for m in messages)
+
+    def test_logs_info_after_message_generated(self, caplog: pytest.LogCaptureFixture) -> None:
+        with caplog.at_level(logging.INFO, logger="git_commit_msg_ai.ai_client"):
+            with ExitStack() as stack:
+                mock_anthropic_class = stack.enter_context(patch("git_commit_msg_ai.ai_client.anthropic.Anthropic"))
+                mock_client = MagicMock()
+                mock_client.messages.create.return_value = _make_api_response("feat: add feature")
+                mock_anthropic_class.return_value = mock_client
+                generate_commit_message("diff content")
+
+        assert any(r.levelno == logging.INFO and "Commit message generated" in r.message for r in caplog.records)
+
+    def test_logs_error_on_authentication_error(self, caplog: pytest.LogCaptureFixture) -> None:
+        with caplog.at_level(logging.ERROR, logger="git_commit_msg_ai.ai_client"):
+            with ExitStack() as stack:
+                mock_anthropic_class = stack.enter_context(patch("git_commit_msg_ai.ai_client.anthropic.Anthropic"))
+                mock_client = MagicMock()
+                mock_client.messages.create.side_effect = _make_status_error(anthropic.AuthenticationError, 401)
+                mock_anthropic_class.return_value = mock_client
+
+                with pytest.raises(AIError):
+                    generate_commit_message("diff content")
+
+        assert any(r.levelno == logging.ERROR for r in caplog.records)
+
+    def test_logs_error_on_rate_limit_error(self, caplog: pytest.LogCaptureFixture) -> None:
+        with caplog.at_level(logging.ERROR, logger="git_commit_msg_ai.ai_client"):
+            with ExitStack() as stack:
+                mock_anthropic_class = stack.enter_context(patch("git_commit_msg_ai.ai_client.anthropic.Anthropic"))
+                mock_client = MagicMock()
+                mock_client.messages.create.side_effect = _make_status_error(anthropic.RateLimitError, 429)
+                mock_anthropic_class.return_value = mock_client
+
+                with pytest.raises(AIError):
+                    generate_commit_message("diff content")
+
+        assert any(r.levelno == logging.ERROR for r in caplog.records)
+
+    def test_logs_error_on_api_connection_error(self, caplog: pytest.LogCaptureFixture) -> None:
+        mock_request = MagicMock()
+
+        with caplog.at_level(logging.ERROR, logger="git_commit_msg_ai.ai_client"):
+            with ExitStack() as stack:
+                mock_anthropic_class = stack.enter_context(patch("git_commit_msg_ai.ai_client.anthropic.Anthropic"))
+                mock_client = MagicMock()
+                mock_client.messages.create.side_effect = anthropic.APIConnectionError(request=mock_request)
+                mock_anthropic_class.return_value = mock_client
+
+                with pytest.raises(AIError):
+                    generate_commit_message("diff content")
+
+        assert any(r.levelno == logging.ERROR for r in caplog.records)
+
+    def test_logs_error_on_api_status_error(self, caplog: pytest.LogCaptureFixture) -> None:
+        with caplog.at_level(logging.ERROR, logger="git_commit_msg_ai.ai_client"):
+            with ExitStack() as stack:
+                mock_anthropic_class = stack.enter_context(patch("git_commit_msg_ai.ai_client.anthropic.Anthropic"))
+                mock_client = MagicMock()
+                mock_client.messages.create.side_effect = _make_status_error(anthropic.APIStatusError, 500)
+                mock_anthropic_class.return_value = mock_client
+
+                with pytest.raises(AIError):
+                    generate_commit_message("diff content")
+
+        assert any(r.levelno == logging.ERROR and "500" in r.message for r in caplog.records)