gac 0.15.1__py3-none-any.whl → 0.15.2__py3-none-any.whl

gac/prompt.py

@@ -0,0 +1,355 @@
+# flake8: noqa: E501
+"""Prompt creation for gac.
+
+This module handles the creation of prompts for AI models, including template loading,
+formatting, and integration with diff preprocessing.
+"""
+
+import logging
+import re
+
+logger = logging.getLogger(__name__)
+
+# Default template to use when no template file is found
+DEFAULT_TEMPLATE = """<role>
+You are an expert git commit message generator. Your task is to analyze code changes and create a concise, meaningful git commit message. You will receive git status and diff information. Your entire response will be used directly as a git commit message.
+</role>
+
+<format>
+  <one_liner>
+  Create a single-line commit message (50-72 characters if possible).
+  Your message should be clear, concise, and descriptive of the core change.
+  Use present tense ("Add feature" not "Added feature").
+  </one_liner><multi_line>
+  Create a commit message with:
+  - First line: A concise summary (50-72 characters) that could stand alone
+  - Blank line after the summary
+  - Detailed body with multiple bullet points explaining the key changes
+  - Focus on WHY changes were made, not just WHAT was changed
+  - Order points from most important to least important
+  </multi_line>
+</format>
+
+<conventions_no_scope>
+You MUST start your commit message with the most appropriate conventional commit prefix:
+- feat: A new feature or functionality addition
+- fix: A bug fix or error correction
+- docs: Documentation changes only
+- style: Changes to code style/formatting without logic changes
+- refactor: Code restructuring without behavior changes
+- perf: Performance improvements
+- test: Adding/modifying tests
+- build: Changes to build system/dependencies
+- ci: Changes to CI configuration
+- chore: Miscellaneous changes not affecting src/test files
+
+Select ONE prefix that best matches the primary purpose of the changes.
+If multiple prefixes apply, choose the one that represents the most significant change.
+If you cannot confidently determine a type, use 'chore'.
+
+Do NOT include a scope in your commit prefix.
+</conventions_no_scope>
+
+<conventions_scope_provided>
+You MUST write a conventional commit message with EXACTLY ONE type and the REQUIRED scope '{scope}'.
+
+FORMAT: type({scope}): description
+
+Select ONE type from this list that best matches the primary purpose of the changes:
+- feat: A new feature or functionality addition
+- fix: A bug fix or error correction
+- docs: Documentation changes only
+- style: Changes to code style/formatting without logic changes
+- refactor: Code restructuring without behavior changes
+- perf: Performance improvements
+- test: Adding/modifying tests
+- build: Changes to build system/dependencies
+- ci: Changes to CI configuration
+- chore: Miscellaneous changes not affecting src/test files
+
+CORRECT EXAMPLES (these formats are correct):
+✅ feat({scope}): add new feature
+✅ fix({scope}): resolve bug
+✅ refactor({scope}): improve code structure
+✅ chore({scope}): update dependencies
+
+INCORRECT EXAMPLES (these formats are wrong and must NOT be used):
+❌ chore: feat({scope}): description
+❌ fix: refactor({scope}): description
+❌ feat: feat({scope}): description
+❌ chore: chore({scope}): description
+
+You MUST NOT prefix the type({scope}) with another type. Use EXACTLY ONE type, which MUST include the scope in parentheses.
+</conventions_scope_provided>
+
+<conventions_scope_inferred>
+You MUST write a conventional commit message with EXACTLY ONE type and an inferred scope.
+
+FORMAT: type(scope): description
+
+Select ONE type from this list that best matches the primary purpose of the changes:
+- feat: A new feature or functionality addition
+- fix: A bug fix or error correction
+- docs: Documentation changes only
+- style: Changes to code style/formatting without logic changes
+- refactor: Code restructuring without behavior changes
+- perf: Performance improvements
+- test: Adding/modifying tests
+- build: Changes to build system/dependencies
+- ci: Changes to CI configuration
+- chore: Miscellaneous changes not affecting src/test files
+
+You MUST infer an appropriate scope from the changes. A good scope is concise (usually one word) and indicates the component or area that was changed.
+Examples of good scopes: api, auth, ui, core, docs, build, prompt, config
+
+CORRECT EXAMPLES (these formats are correct):
+✅ feat(auth): add login functionality
+✅ fix(api): resolve null response issue
+✅ refactor(core): improve data processing
+✅ docs(readme): update installation instructions
+
+INCORRECT EXAMPLES (these formats are wrong and must NOT be used):
+❌ chore: feat(component): description
+❌ fix: refactor(component): description
+❌ feat: feat(component): description
+❌ chore: chore(component): description
+
+You MUST NOT prefix the type(scope) with another type. Use EXACTLY ONE type, which MUST include the scope in parentheses.
+</conventions_scope_inferred>
+
+<hint>
+Additional context provided by the user: <hint_text></hint_text>
+</hint>
+
+<git_status>
+<status></status>
+</git_status>
+
+<git_diff_stat>
+<diff_stat></diff_stat>
+</git_diff_stat>
+
+<git_diff>
+<diff></diff>
+</git_diff>
+
+<instructions>
+IMMEDIATELY AFTER ANALYZING THE CHANGES, RESPOND WITH ONLY THE COMMIT MESSAGE.
+DO NOT include any preamble, reasoning, explanations or anything other than the commit message itself.
+DO NOT use markdown formatting, headers, or code blocks.
+The entire response will be passed directly to 'git commit -m'.
+</instructions>"""
+
+
+def load_prompt_template() -> str:
+    """Load the prompt template from the embedded default template.
+
+    Returns:
+        Template content as string
+    """
+    logger.debug("Using default template")
+    return DEFAULT_TEMPLATE
+
+
+def build_prompt(
+    status: str,
+    processed_diff: str,
+    diff_stat: str = "",
+    one_liner: bool = False,
+    hint: str = "",
+    scope: str | None = None,
+) -> str:
+    """Build a prompt for the AI model using the provided template and git information.
+
+    Args:
+        status: Git status output
+        processed_diff: Git diff output, already preprocessed and ready to use
+        diff_stat: Git diff stat output showing file changes summary
+        one_liner: Whether to request a one-line commit message
+        hint: Optional hint to guide the AI
+        scope: Optional scope parameter. None = no scope, "infer" = infer scope, any other string = use as scope
+
+    Returns:
+        Formatted prompt string ready to be sent to an AI model
+    """
+    template = load_prompt_template()
+
+    # Select the appropriate conventions section based on scope parameter
+    try:
+        logger.debug(f"Processing scope parameter: {scope}")
+        if scope is None:
+            # No scope - use the plain conventions section
+            logger.debug("Using no-scope conventions")
+            template = re.sub(
+                r"<conventions_scope_provided>.*?</conventions_scope_provided>\n", "", template, flags=re.DOTALL
+            )
+            template = re.sub(
+                r"<conventions_scope_inferred>.*?</conventions_scope_inferred>\n", "", template, flags=re.DOTALL
+            )
+            template = template.replace("<conventions_no_scope>", "<conventions>")
+            template = template.replace("</conventions_no_scope>", "</conventions>")
+        elif scope == "infer" or scope == "":
+            # User wants to infer a scope from changes (either with "infer" or empty string)
+            logger.debug(f"Using inferred-scope conventions (scope={scope})")
+            template = re.sub(
+                r"<conventions_scope_provided>.*?</conventions_scope_provided>\n", "", template, flags=re.DOTALL
+            )
+            template = re.sub(r"<conventions_no_scope>.*?</conventions_no_scope>\n", "", template, flags=re.DOTALL)
+            template = template.replace("<conventions_scope_inferred>", "<conventions>")
+            template = template.replace("</conventions_scope_inferred>", "</conventions>")
+        else:
+            # User provided a specific scope
+            logger.debug(f"Using provided-scope conventions with scope '{scope}'")
+            template = re.sub(
+                r"<conventions_scope_inferred>.*?</conventions_scope_inferred>\n", "", template, flags=re.DOTALL
+            )
+            template = re.sub(r"<conventions_no_scope>.*?</conventions_no_scope>\n", "", template, flags=re.DOTALL)
+            template = template.replace("<conventions_scope_provided>", "<conventions>")
+            template = template.replace("</conventions_scope_provided>", "</conventions>")
+            template = template.replace("{scope}", scope)
+    except Exception as e:
+        logger.error(f"Error processing scope parameter: {e}")
+        # Fallback to no scope if there's an error
+        template = re.sub(
+            r"<conventions_scope_provided>.*?</conventions_scope_provided>\n", "", template, flags=re.DOTALL
+        )
+        template = re.sub(
+            r"<conventions_scope_inferred>.*?</conventions_scope_inferred>\n", "", template, flags=re.DOTALL
+        )
+        template = template.replace("<conventions_no_scope>", "<conventions>")
+        template = template.replace("</conventions_no_scope>", "</conventions>")
+
+    template = template.replace("<status></status>", status)
+    template = template.replace("<diff_stat></diff_stat>", diff_stat)
+    template = template.replace("<diff></diff>", processed_diff)
+
+    # Add hint if present
+    if hint:
+        template = template.replace("<hint_text></hint_text>", hint)
+        logger.debug(f"Added hint ({len(hint)} characters)")
+    else:
+        template = re.sub(r"<hint>.*?</hint>", "", template, flags=re.DOTALL)
+        logger.debug("No hint provided")
+
+    # Process format options (one-liner vs multi-line)
+    if one_liner:
+        template = re.sub(r"<multi_line>.*?</multi_line>", "", template, flags=re.DOTALL)
+    else:
+        template = re.sub(r"<one_liner>.*?</one_liner>", "", template, flags=re.DOTALL)
+
+    # Clean up extra whitespace, collapsing blank lines that may contain spaces
+    template = re.sub(r"\n(?:[ \t]*\n){2,}", "\n\n", template)
+
+    return template.strip()
+
+
+def clean_commit_message(message: str) -> str:
+    """Clean up a commit message generated by an AI model.
+
+    This function:
+    1. Removes any preamble or reasoning text
+    2. Removes code block markers and formatting
+    3. Removes XML tags that might have leaked into the response
+    4. Ensures the message starts with a conventional commit prefix
+    5. Fixes double type prefix issues (e.g., "chore: feat(scope):")
+
+    Args:
+        message: Raw commit message from AI
+
+    Returns:
+        Cleaned commit message ready for use
+    """
+    message = message.strip()
+
+    # Remove any markdown code blocks
+    message = re.sub(r"```[\w]*\n|```", "", message)
+
+    # Extract the actual commit message if it follows our reasoning pattern
+    # Look for different indicators of where the actual commit message starts
+    commit_indicators = [
+        "# Your commit message:",
+        "Your commit message:",
+        "The commit message is:",
+        "Here's the commit message:",
+        "Commit message:",
+        "Final commit message:",
+        "# Commit Message",
+    ]
+
+    for indicator in commit_indicators:
+        if indicator.lower() in message.lower():
+            # Extract everything after the indicator
+            message = message.split(indicator, 1)[1].strip()
+            break
+
+    # If message starts with any kind of explanation text, try to locate a conventional prefix
+    lines = message.split("\n")
+    for i, line in enumerate(lines):
+        if any(
+            line.strip().startswith(prefix)
+            for prefix in ["feat:", "fix:", "docs:", "style:", "refactor:", "perf:", "test:", "build:", "ci:", "chore:"]
+        ):
+            message = "\n".join(lines[i:])
+            break
+
+    # Remove any XML tags that might have leaked into the response
+    for tag in [
+        "<git-status>",
+        "</git-status>",
+        "<git_status>",
+        "</git_status>",
+        "<git-diff>",
+        "</git-diff>",
+        "<git_diff>",
+        "</git_diff>",
+        "<repository_context>",
+        "</repository_context>",
+        "<instructions>",
+        "</instructions>",
+        "<format>",
+        "</format>",
+        "<conventions>",
+        "</conventions>",
+    ]:
+        message = message.replace(tag, "")
+
+    # Fix double type prefix issues (e.g., "chore: feat(scope):") to just "feat(scope):")
+    conventional_prefixes = [
+        "feat",
+        "fix",
+        "docs",
+        "style",
+        "refactor",
+        "perf",
+        "test",
+        "build",
+        "ci",
+        "chore",
+    ]
+
+    # Look for double prefix pattern like "chore: feat(scope):" and fix it
+    # This regex looks for a conventional prefix followed by another conventional prefix with a scope
+    double_prefix_pattern = re.compile(
+        r"^(" + r"|\s*".join(conventional_prefixes) + r"):\s*(" + r"|\s*".join(conventional_prefixes) + r")\(([^)]+)\):"
+    )
+    match = double_prefix_pattern.match(message)
+
+    if match:
+        # Extract the second type and scope, which is what we want to keep
+        second_type = match.group(2)
+        scope = match.group(3)
+        description = message[match.end() :].strip()
+        message = f"{second_type}({scope}): {description}"
+
+    # Ensure message starts with a conventional commit prefix
+    if not any(
+        message.strip().startswith(prefix + ":") or message.strip().startswith(prefix + "(")
+        for prefix in conventional_prefixes
+    ):
+        message = f"chore: {message.strip()}"
+
+    # Final cleanup: trim extra whitespace and ensure no more than one blank line
+    # Handle blank lines that may include spaces or tabs
+    message = re.sub(r"\n(?:[ \t]*\n){2,}", "\n\n", message).strip()
+
+    return message

gac/utils.py

@@ -0,0 +1,133 @@
+"""Utility functions for gac."""
+
+import logging
+import subprocess
+
+from rich.console import Console
+from rich.theme import Theme
+
+from gac.constants import Logging
+from gac.errors import GacError
+
+
+def setup_logging(
+    log_level: int | str = Logging.DEFAULT_LEVEL,
+    quiet: bool = False,
+    force: bool = False,
+    suppress_noisy: bool = False,
+) -> None:
+    """Configure logging for the application.
+
+    Args:
+        log_level: Log level to use (DEBUG, INFO, WARNING, ERROR)
+        quiet: If True, suppress all output except errors
+        force: If True, force reconfiguration of logging
+        suppress_noisy: If True, suppress noisy third-party loggers
+    """
+    if isinstance(log_level, str):
+        log_level = getattr(logging, log_level.upper(), logging.WARNING)
+
+    if quiet:
+        log_level = logging.ERROR
+
+    kwargs = {"force": force} if force else {}
+
+    logging.basicConfig(
+        level=log_level,
+        format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
+        datefmt="%Y-%m-%d %H:%M:%S",
+        **kwargs,
+    )
+
+    if suppress_noisy:
+        for noisy_logger in ["requests", "urllib3"]:
+            logging.getLogger(noisy_logger).setLevel(logging.WARNING)
+
+    logger.info(f"Logging initialized with level: {logging.getLevelName(log_level)}")
+
+
+theme = Theme(
+    {
+        "success": "green bold",
+        "info": "blue",
+        "warning": "yellow",
+        "error": "red bold",
+        "header": "magenta",
+        "notification": "bright_cyan bold",
+    }
+)
+console = Console(theme=theme)
+logger = logging.getLogger(__name__)
+
+
+def print_message(message: str, level: str = "info") -> None:
+    """Print a styled message with the specified level."""
+    console.print(message, style=level)
+
+
+def run_subprocess(
+    command: list[str],
+    silent: bool = False,
+    timeout: int = 60,
+    check: bool = True,
+    strip_output: bool = True,
+    raise_on_error: bool = True,
+) -> str:
+    """Run a subprocess command safely and return the output.
+
+    Args:
+        command: List of command arguments
+        silent: If True, suppress debug logging
+        timeout: Command timeout in seconds
+        check: Whether to check return code (for compatibility)
+        strip_output: Whether to strip whitespace from output
+        raise_on_error: Whether to raise an exception on error
+
+    Returns:
+        Command output as string
+
+    Raises:
+        GacError: If the command times out
+        subprocess.CalledProcessError: If the command fails and raise_on_error is True
+    """
+    if not silent:
+        logger.debug(f"Running command: {' '.join(command)}")
+
+    try:
+        result = subprocess.run(
+            command,
+            capture_output=True,
+            text=True,
+            check=False,
+            timeout=timeout,
+        )
+
+        if result.returncode != 0 and (check or raise_on_error):
+            if not silent:
+                logger.debug(f"Command stderr: {result.stderr}")
+
+            error = subprocess.CalledProcessError(result.returncode, command, result.stdout, result.stderr)
+            raise error
+
+        output = result.stdout
+        if strip_output:
+            output = output.strip()
+
+        return output
+    except subprocess.TimeoutExpired as e:
+        logger.error(f"Command timed out after {timeout} seconds: {' '.join(command)}")
+        raise GacError(f"Command timed out: {' '.join(command)}") from e
+    except subprocess.CalledProcessError as e:
+        if not silent:
+            logger.error(f"Command failed: {e.stderr.strip() if hasattr(e, 'stderr') else str(e)}")
+        if raise_on_error:
+            raise
+        return ""
+    except Exception as e:
+        if not silent:
+            logger.debug(f"Command error: {e}")
+        if raise_on_error:
+            # Convert generic exceptions to CalledProcessError for consistency
+            error = subprocess.CalledProcessError(1, command, "", str(e))
+            raise error from e
+        return ""

{gac-0.15.1.dist-info → gac-0.15.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gac
-Version: 0.15.1
+Version: 0.15.2
 Summary: AI-powered Git commit message generator with multi-provider support
 Project-URL: Homepage, https://github.com/cellwebb/gac
 Project-URL: Documentation, https://github.com/cellwebb/gac#readme

gac-0.15.2.dist-info/RECORD

@@ -0,0 +1,20 @@
+gac/__init__.py,sha256=z9yGInqtycFIT3g1ca24r-A3699hKVaRqGUI79wsmMc,415
+gac/__version__.py,sha256=_F5sPfbH3qFakn-iGVTon_XI7JINqZymKVSAHN_lSp8,67
+gac/ai.py,sha256=Ijpgcp1L_SJy37Q3p3leSFMXST6RNWruUEsYlkoz-XM,5549
+gac/cli.py,sha256=UCGaKpGrm8B603V04yMYGkfv9S5-CksSy7zzeqwp13s,4280
+gac/config.py,sha256=9-llgaRMzL2qtH5nmoRGtgpUw7IJg143jWDcppmYcSA,1128
+gac/config_cli.py,sha256=v9nFHZO1RvK9fzHyuUS6SG-BCLHMsdOMDwWamBhVVh4,1608
+gac/constants.py,sha256=gcygNGl4I48vYtuhpdCFKnYRjhxcRWMQYCerxPq0wCY,4731
+gac/diff_cli.py,sha256=GVegRNB1a4D-wUOtVlb6Q_6sXbj4kD2Yt-H4r2sRHxc,5659
+gac/errors.py,sha256=3vIRMQ2QF3sP9_rPfXAFuu5ZSjIVX4FxM-FAuiR8N-8,7416
+gac/git.py,sha256=ZdEvq5ssJw-EncQi_PnAevF9WZoVz7or4AwSJHbMFMs,5181
+gac/init_cli.py,sha256=s6nB4k__6Da7Ljq4MB9-rlrcTxB6Nt82OMDKk0pZP-M,1778
+gac/main.py,sha256=yll8TzauryYLkQHiVuu3Bfh0nb3tzbPrLmtvQo2FkPM,9492
+gac/preprocess.py,sha256=UwcijCKjfuqGeeMRR1yd3FWLdX-uHjb8UIwxjxpbEpo,15339
+gac/prompt.py,sha256=mgKcSuhs0VKXznkcEbPXGia_Mgz66NtYMlJPLVLH6jg,13779
+gac/utils.py,sha256=koJNQ4FXUTitnKQ7hC_9sPudLi_BSOpcryYsz5n_z-Q,3973
+gac-0.15.2.dist-info/METADATA,sha256=_7behv0mEe0E5ef4Q-mlKigvEO30uIMhbvhrKUkUzwo,7326
+gac-0.15.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+gac-0.15.2.dist-info/entry_points.txt,sha256=tdjN-XMmcWfL92swuRAjT62bFLOAwk9bTMRLGP5Z4aI,36
+gac-0.15.2.dist-info/licenses/LICENSE,sha256=s11puNmYfzwoSwG96nhOJe268Y1QFckr8-Hmzo3_eJE,1087
+gac-0.15.2.dist-info/RECORD,,

gac-0.15.1.dist-info/RECORD

@@ -1,5 +0,0 @@
-gac-0.15.1.dist-info/METADATA,sha256=PKZN0bM652cM0YE48l0lDvNehkNxia2hhibIXzpZoWk,7326
-gac-0.15.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-gac-0.15.1.dist-info/entry_points.txt,sha256=tdjN-XMmcWfL92swuRAjT62bFLOAwk9bTMRLGP5Z4aI,36
-gac-0.15.1.dist-info/licenses/LICENSE,sha256=s11puNmYfzwoSwG96nhOJe268Y1QFckr8-Hmzo3_eJE,1087
-gac-0.15.1.dist-info/RECORD,,