ai-cr 0.5.0__tar.gz → 1.0.0__tar.gz

{ai_cr-0.5.0 → ai_cr-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ai-cr
-Version: 0.5.0
+Version: 1.0.0
 Summary: LLM-agnostic GitHub AI Code Review Tool with integration to GitHub actions
 License: MIT
 Keywords: static code analysis,code review,code quality,ai,coding,assistant,llm,github,automation,devops,developer tools,github actions,workflows,git
@@ -15,13 +15,12 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development
-Requires-Dist: GitPython (==3.1.44)
-Requires-Dist: ai-microcore (==4.0.0.dev18)
-Requires-Dist: anthropic (==0.52.2)
-Requires-Dist: async-typer (==0.1.8)
-Requires-Dist: google-generativeai (==0.8.5)
-Requires-Dist: typer (==0.9.4)
-Requires-Dist: unidiff (==0.7.5)
+Requires-Dist: GitPython (>=3.1.44,<4.0.0)
+Requires-Dist: ai-microcore (==4.0.0.dev19)
+Requires-Dist: anthropic (>=0.52.2,<0.53.0)
+Requires-Dist: google-generativeai (>=0.8.5,<0.9.0)
+Requires-Dist: typer (>=0.16.0,<0.17.0)
+Requires-Dist: unidiff (>=0.7.5,<0.8.0)
 Project-URL: Homepage, https://github.com/Nayjest/github-ai-code-review
 Project-URL: Repository, https://github.com/Nayjest/github-ai-code-review
 Description-Content-Type: text/markdown
@@ -30,6 +29,7 @@ Description-Content-Type: text/markdown
 <a href="https://pypi.org/project/ai-code-review/" target="_blank"><img src="https://badge.fury.io/py/ai-code-review.svg" alt="PYPI Release"></a>
 <a href="https://github.com/Nayjest/ai-code-review/actions/workflows/code-style.yml" target="_blank"><img src="https://github.com/Nayjest/ai-code-review/actions/workflows/code-style.yml/badge.svg" alt="Pylint"></a>
 <a href="https://github.com/Nayjest/ai-code-review/actions/workflows/tests.yml" target="_blank"><img src="https://github.com/Nayjest/ai-code-review/actions/workflows/tests.yml/badge.svg" alt="Tests"></a>
+<img src="https://github.com/Nayjest/ai-code-review/blob/main/coverage.svg" alt="Code Coverage">
 <a href="https://github.com/Nayjest/ai-code-review/blob/main/LICENSE" target="_blank"><img src="https://img.shields.io/static/v1?label=license&message=MIT&color=d08aff" alt="License"></a>
 </p>
 
@@ -70,7 +70,7 @@ jobs:
       uses: actions/setup-python@v5
       with: { python-version: "3.13" }
     - name: Install AI Code Review tool
-      run: pip install ai-code-review==0.5.0
+      run: pip install ai-code-review~=1.0
     - name: Run AI code analysis
       env:
         LLM_API_KEY: ${{ secrets.LLM_API_KEY }}
@@ -84,34 +84,66 @@ jobs:
       with:
         name: ai-code-review-results
         path: |
-          code-review-report.txt
+          code-review-report.md
           code-review-report.json
 ```
 
 > ⚠️ Make sure to add `LLM_API_KEY` to your repository’s GitHub secrets.
 
 💪 Done!  
-PRs to your repository will now receive AI code reviews automatically. ✨
+PRs to your repository will now receive AI code reviews automatically. ✨  
+See [GitHub Setup Guide](https://github.com/Nayjest/ai-code-review/blob/main/documentation/github_setup.md) for more details.
 
-### 2. Run Code Analysis Locally
+### 2. Running Code Analysis Locally
 
-Install and run:
+#### Initial Local Setup
 
+**Prerequisites:** [Python](https://www.python.org/downloads/) 3.11 / 3.12 / 3.13  
+
+**Step1:** Install [ai-code-review](https://github.com/Nayjest/ai-code-review) using [pip](https://en.wikipedia.org/wiki/Pip_(package_manager)).
 ```bash
-# Prerequisites: Python 3.11+
 pip install ai-code-review
+```
+
+> **Troubleshooting:**  
+> pip may be also available via cli as `pip3` depending on your Python installation.
+
+**Step2:** Perform initial setup
 
-# One-time setup using interactive wizard (saves configuration in ~/.env.ai-code-review)
+The following command will perform one-time setup using an interactive wizard.
+You will be prompted to enter LLM configuration details (API type, API key, etc).
+Configuration will be saved to ~/.env.ai-code-review.
+
+```bash
 ai-code-review setup
+```
+
+> **Troubleshooting:**  
+> On some systems, `ai-code-review` command may not became available immediately after installation.  
+> Try restarting your terminal or running `python -m ai_code_review` instead.
 
-# Run review on committed changes in current branch vs main
+
+#### Perform your first AI code review locally
+
+**Step1:** Navigate to your repository root directory.  
+**Step2:** Switch to the branch you want to review.  
+**Step3:** Run following command
+```bash
 ai-code-review
 ```
 
-To review a remote repository:
+> **Note:** This will analyze the current branch against the repository main branch by default.  
+> Files that are not staged for commit will be ignored.  
+> See `ai-code-review --help` for more options.
+
+**Reviewing remote repository**
 
 ```bash
-ai-code-review remote --url https://github.com/owner/repo --branch feature-branch
+ai-code-review remote git@github.com:owner/repo.git <FEATURE_BRANCH>..<MAIN_BRANCH>
+```
+Use interactive help for details:
+```bash
+ai-code-review remote --help
 ```
 
 ## 🔧 Configuration
@@ -128,6 +160,8 @@ You can override the default config by placing `.ai-code-review.toml` in your re
 
 See default configuration [here](https://github.com/Nayjest/ai-code-review/blob/main/ai_code_review/.ai-code-review.toml).
 
+More details can be found in [📖 Configuration Cookbook](https://github.com/Nayjest/ai-code-review/blob/main/documentation/config_cookbook.md)
+
 ## 💻 Development Setup
 
 Install dependencies:

{ai_cr-0.5.0 → ai_cr-1.0.0}/README.md

@@ -2,6 +2,7 @@
 <a href="https://pypi.org/project/ai-code-review/" target="_blank"><img src="https://badge.fury.io/py/ai-code-review.svg" alt="PYPI Release"></a>
 <a href="https://github.com/Nayjest/ai-code-review/actions/workflows/code-style.yml" target="_blank"><img src="https://github.com/Nayjest/ai-code-review/actions/workflows/code-style.yml/badge.svg" alt="Pylint"></a>
 <a href="https://github.com/Nayjest/ai-code-review/actions/workflows/tests.yml" target="_blank"><img src="https://github.com/Nayjest/ai-code-review/actions/workflows/tests.yml/badge.svg" alt="Tests"></a>
+<img src="https://github.com/Nayjest/ai-code-review/blob/main/coverage.svg" alt="Code Coverage">
 <a href="https://github.com/Nayjest/ai-code-review/blob/main/LICENSE" target="_blank"><img src="https://img.shields.io/static/v1?label=license&message=MIT&color=d08aff" alt="License"></a>
 </p>
 
@@ -42,7 +43,7 @@ jobs:
       uses: actions/setup-python@v5
       with: { python-version: "3.13" }
     - name: Install AI Code Review tool
-      run: pip install ai-code-review==0.5.0
+      run: pip install ai-code-review~=1.0
     - name: Run AI code analysis
       env:
         LLM_API_KEY: ${{ secrets.LLM_API_KEY }}
@@ -56,34 +57,66 @@ jobs:
       with:
         name: ai-code-review-results
         path: |
-          code-review-report.txt
+          code-review-report.md
           code-review-report.json
 ```
 
 > ⚠️ Make sure to add `LLM_API_KEY` to your repository’s GitHub secrets.
 
 💪 Done!  
-PRs to your repository will now receive AI code reviews automatically. ✨
+PRs to your repository will now receive AI code reviews automatically. ✨  
+See [GitHub Setup Guide](https://github.com/Nayjest/ai-code-review/blob/main/documentation/github_setup.md) for more details.
 
-### 2. Run Code Analysis Locally
+### 2. Running Code Analysis Locally
 
-Install and run:
+#### Initial Local Setup
 
+**Prerequisites:** [Python](https://www.python.org/downloads/) 3.11 / 3.12 / 3.13  
+
+**Step1:** Install [ai-code-review](https://github.com/Nayjest/ai-code-review) using [pip](https://en.wikipedia.org/wiki/Pip_(package_manager)).
 ```bash
-# Prerequisites: Python 3.11+
 pip install ai-code-review
+```
+
+> **Troubleshooting:**  
+> pip may be also available via cli as `pip3` depending on your Python installation.
+
+**Step2:** Perform initial setup
 
-# One-time setup using interactive wizard (saves configuration in ~/.env.ai-code-review)
+The following command will perform one-time setup using an interactive wizard.
+You will be prompted to enter LLM configuration details (API type, API key, etc).
+Configuration will be saved to ~/.env.ai-code-review.
+
+```bash
 ai-code-review setup
+```
+
+> **Troubleshooting:**  
+> On some systems, `ai-code-review` command may not became available immediately after installation.  
+> Try restarting your terminal or running `python -m ai_code_review` instead.
 
-# Run review on committed changes in current branch vs main
+
+#### Perform your first AI code review locally
+
+**Step1:** Navigate to your repository root directory.  
+**Step2:** Switch to the branch you want to review.  
+**Step3:** Run following command
+```bash
 ai-code-review
 ```
 
-To review a remote repository:
+> **Note:** This will analyze the current branch against the repository main branch by default.  
+> Files that are not staged for commit will be ignored.  
+> See `ai-code-review --help` for more options.
+
+**Reviewing remote repository**
 
 ```bash
-ai-code-review remote --url https://github.com/owner/repo --branch feature-branch
+ai-code-review remote git@github.com:owner/repo.git <FEATURE_BRANCH>..<MAIN_BRANCH>
+```
+Use interactive help for details:
+```bash
+ai-code-review remote --help
 ```
 
 ## 🔧 Configuration
@@ -100,6 +133,8 @@ You can override the default config by placing `.ai-code-review.toml` in your re
 
 See default configuration [here](https://github.com/Nayjest/ai-code-review/blob/main/ai_code_review/.ai-code-review.toml).
 
+More details can be found in [📖 Configuration Cookbook](https://github.com/Nayjest/ai-code-review/blob/main/documentation/config_cookbook.md)
+
 ## 💻 Development Setup
 
 Install dependencies:

{ai_cr-0.5.0 → ai_cr-1.0.0}/ai_code_review/.ai-code-review.toml

@@ -38,21 +38,23 @@ prompt = """
 ----TASK----
 Review the provided code diff carefully and identify *only* highly confident issues which are relevant to any code context.
 
-----CODE----
+----CODEBASE CHANGES TO REVIEW----
 {{ input }}
 --------
 
 {% if file_lines -%}
-----ADDITIONAL CONTEXT----
+----ADDITIONAL CONTEXT: FULL FILE CONTENT AFTER APPLYING REVIEWED CHANGES----
 {{ file_lines }}
 {%- endif %}
 
 ----TASK GUIDELINES----
 - Only report issues you are **100% confident** are relevant to any context.
+- Never report issues about using software versions that have not yet been released.
 - Only include issues that are **significantly valuable** to the maintainers (e.g., bugs, security flaws, or clear maintainability concerns).
 - Do **not** report vague, theoretical, or overly generic advice.
 - Do **not** report anything with medium or lower confidence.
-- Typographical errors have highest severity
+- Typographical errors have highest severity.
+{{ requirements -}}
 {{ json_requirements }}
 
 Respond with a valid JSON array of issues in the following format:
@@ -124,8 +126,9 @@ If code changes contains exceptional achievements, you may additionally present
 --Available Awards--
 {{ awards }}
 ---
-Your response will be parsed programmatically, so do not include any additional text.
-Use Markdown formatting in your response.
+- Your response will be parsed programmatically, so do not include any additional text.
+- Use Markdown formatting in your response.
+{{ summary_requirements -}}
 """
 
 [prompt_vars]
@@ -303,4 +306,6 @@ restored lost knowledge and now bestow it upon a new generation."
 decorators add depth and texture, and observer masterfully completes the composition.
 The Gang of Four gives a standing ovation from the stalls."
 ```
-"""
+"""
+requirements = ""
+summary_requirements = ""

{ai_cr-0.5.0 → ai_cr-1.0.0}/ai_code_review/__main__.py

@@ -1,4 +1,4 @@
-from .cli import main
-
-if __name__ == "__main__":
-    main()
+from .cli import main
+
+if __name__ == "__main__":
+    main()

{ai_cr-0.5.0 → ai_cr-1.0.0}/ai_code_review/bootstrap.py

@@ -59,4 +59,4 @@ def bootstrap():
     except Exception as e:
         logging.error(f"Unexpected configuration error: {e}")
         raise SystemExit(3)
-    mc.logging.LoggingConfig.STRIP_REQUEST_LINES = [100, 15]
+    mc.logging.LoggingConfig.STRIP_REQUEST_LINES = [300, 15]

ai_cr-1.0.0/ai_code_review/cli.py

@@ -0,0 +1,238 @@
+import asyncio
+import logging
+import sys
+import os
+import textwrap
+import tempfile
+import requests
+
+import microcore as mc
+import typer
+from git import Repo
+
+from .core import review, get_diff, filter_diff
+from .report_struct import Report
+from .constants import ENV_CONFIG_FILE
+from .bootstrap import bootstrap
+from .project_config import ProjectConfig
+from .utils import no_subcommand, parse_refs_pair
+
+app = typer.Typer(pretty_exceptions_show_locals=False)
+app_no_subcommand = typer.Typer(pretty_exceptions_show_locals=False)
+
+
+def main():
+    if sys.platform == "win32":
+        asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
+    if no_subcommand(app):
+        bootstrap()
+        app_no_subcommand()
+    else:
+        app()
+
+
+@app.callback(invoke_without_command=True)
+def cli(ctx: typer.Context, verbose: bool = typer.Option(default=False)):
+    if verbose:
+        mc.logging.LoggingConfig.STRIP_REQUEST_LINES = None
+    if ctx.invoked_subcommand != "setup":
+        bootstrap()
+
+
+def args_to_target(refs, what, against) -> tuple[str | None, str | None]:
+    _what, _against = parse_refs_pair(refs)
+    if _what:
+        if what:
+            raise typer.BadParameter(
+                "You cannot specify both 'refs' <WHAT>..<AGAINST> and '--what'. Use one of them."
+            )
+    else:
+        _what = what
+    if _against:
+        if against:
+            raise typer.BadParameter(
+                "You cannot specify both 'refs' <WHAT>..<AGAINST> and '--against'. Use one of them."
+            )
+    else:
+        _against = against
+    return _what, _against
+
+
+def arg_refs() -> typer.Argument:
+    return typer.Argument(
+        default=None,
+        help="Git refs to review, [what]..[against] e.g. 'HEAD..HEAD~1'"
+    )
+
+
+def arg_what() -> typer.Option:
+    return typer.Option(None, "--what", "-w", help="Git ref to review")
+
+
+def arg_filters() -> typer.Option:
+    return typer.Option(
+        "", "--filter", "-f", "--filters",
+        help="""
+            filter reviewed files by glob / fnmatch pattern(s),
+            e.g. 'src/**/*.py', may be comma-separated
+            """,
+    )
+
+
+def arg_out() -> typer.Option:
+    return typer.Option(
+        None,
+        "--out", "-o", "--output",
+        help="Output folder for the code review report"
+    )
+
+
+def arg_against() -> typer.Option:
+    return typer.Option(
+        None,
+        "--against", "-vs", "--vs",
+        help="Git ref to compare against"
+    )
+
+
+@app_no_subcommand.command(name="review", help="Perform code review")
+@app.command(name="review", help="Perform code review")
+def cmd_review(
+    refs: str = arg_refs(),
+    what: str = arg_what(),
+    against: str = arg_against(),
+    filters: str = arg_filters(),
+    merge_base: bool = typer.Option(default=True, help="Use merge base for comparison"),
+    out: str = arg_out()
+):
+    _what, _against = args_to_target(refs, what, against)
+    asyncio.run(review(
+        what=_what,
+        against=_against,
+        filters=filters,
+        use_merge_base=merge_base,
+        out_folder=out,
+    ))
+
+
+@app.command(help="Configure LLM for local usage interactively")
+def setup():
+    mc.interactive_setup(ENV_CONFIG_FILE)
+
+
+@app.command()
+def render(format: str = Report.Format.MARKDOWN):
+    print(Report.load().render(format=format))
+
+
+@app.command(help="Review remote code")
+def remote(
+    url: str = typer.Argument(..., help="Git repository URL"),
+    refs: str = arg_refs(),
+    what: str = arg_what(),
+    against: str = arg_against(),
+    filters: str = arg_filters(),
+    merge_base: bool = typer.Option(default=True, help="Use merge base for comparison"),
+    out: str = arg_out()
+):
+    _what, _against = args_to_target(refs, what, against)
+    with tempfile.TemporaryDirectory() as temp_dir:
+        logging.info(f"Cloning [{mc.ui.green(url)}] to {mc.utils.file_link(temp_dir)} ...")
+        repo = Repo.clone_from(url, branch=_what, to_path=temp_dir)
+        asyncio.run(review(
+            repo=repo,
+            what=_what,
+            against=_against,
+            filters=filters,
+            use_merge_base=merge_base,
+            out_folder=out or '.',
+        ))
+        repo.close()
+
+
+@app.command(help="Leave a GitHub PR comment with the review.")
+def github_comment(
+    token: str = typer.Option(
+        os.environ.get("GITHUB_TOKEN", ""), help="GitHub token (or set GITHUB_TOKEN env var)"
+    ),
+):
+    """
+    Leaves a comment with the review on the current GitHub pull request.
+    """
+    file = "code-review-report.md"
+    if not os.path.exists(file):
+        print(f"Review file not found: {file}")
+        raise typer.Exit(4)
+
+    with open(file, "r", encoding="utf-8") as f:
+        body = f.read()
+
+    if not token:
+        print("GitHub token is required (--token or GITHUB_TOKEN env var).")
+        raise typer.Exit(1)
+
+    github_env = ProjectConfig.load().prompt_vars["github_env"]
+    repo = github_env.get("github_repo", "")
+    pr_env_val = github_env.get("github_pr_number", "")
+    logging.info(f"github_pr_number = {pr_env_val}")
+
+    # e.g. could be "refs/pull/123/merge" or a direct number
+    if "/" in pr_env_val and "pull" in pr_env_val:
+        # refs/pull/123/merge
+        try:
+            pr_num_candidate = pr_env_val.strip("/").split("/")
+            idx = pr_num_candidate.index("pull")
+            pr = int(pr_num_candidate[idx + 1])
+        except Exception:
+            pr = 0
+    else:
+        try:
+            pr = int(pr_env_val)
+        except Exception:
+            pr = 0
+
+    api_url = f"https://api.github.com/repos/{repo}/issues/{pr}/comments"
+    headers = {
+        "Authorization": f"token {token}",
+        "Accept": "application/vnd.github+json",
+    }
+    data = {"body": body}
+
+    resp = requests.post(api_url, headers=headers, json=data)
+    if 200 <= resp.status_code < 300:
+        logging.info(f"Posted review comment to PR #{pr} in {repo}")
+    else:
+        logging.error(f"Failed to post comment: {resp.status_code} {resp.reason}\n{resp.text}")
+        raise typer.Exit(5)
+
+
+@app.command(help="List files in the diff. Might be useful to check what will be reviewed.")
+def files(
+    refs: str = arg_refs(),
+    what: str = arg_what(),
+    against: str = arg_against(),
+    filters: str = arg_filters(),
+    merge_base: bool = typer.Option(default=True, help="Use merge base for comparison"),
+    diff: bool = typer.Option(default=False, help="Show diff content")
+):
+    _what, _against = args_to_target(refs, what, against)
+    repo = Repo(".")
+    patch_set = get_diff(repo=repo, what=_what, against=_against, use_merge_base=merge_base)
+    patch_set = filter_diff(patch_set, filters)
+    print(
+        f"Changed files: "
+        f"{mc.ui.green(_what or 'INDEX')} vs "
+        f"{mc.ui.yellow(_against or repo.remotes.origin.refs.HEAD.reference.name)}"
+        f"{' filtered by '+mc.ui.cyan(filters) if filters else ''}"
+    )
+
+    for patch in patch_set:
+        if patch.is_added_file:
+            color = mc.ui.green
+        elif patch.is_removed_file:
+            color = mc.ui.red
+        else:
+            color = mc.ui.blue
+        print(f"- {color(patch.path)}")
+        if diff:
+            print(mc.ui.gray(textwrap.indent(str(patch), "  ")))

ai_cr-1.0.0/ai_code_review/commands/repl.py

@@ -0,0 +1,22 @@
+"""
+Python REPL
+"""
+# flake8: noqa: F401
+import code
+from ema.cli import app
+
+# Imports for usage in REPL
+import os
+import sys
+from dataclasses import dataclass
+from datetime import datetime
+from enum import Enum
+from time import time
+from rich.pretty import pprint
+
+import microcore as mc
+from microcore import ui
+
+@app.command(help="python REPL")
+def repl():
+    code.interact(local=globals())

ai_cr-1.0.0/ai_code_review/core.py

@@ -0,0 +1,191 @@
+import fnmatch
+import logging
+from os import PathLike
+from typing import Iterable
+from pathlib import Path
+
+import microcore as mc
+from git import Repo
+from unidiff import PatchSet, PatchedFile
+from unidiff.constants import DEV_NULL
+
+from .project_config import ProjectConfig
+from .report_struct import Report
+from .constants import JSON_REPORT_FILE_NAME
+
+
+def is_binary_file(repo: Repo, file_path: str) -> bool:
+    """
+    Check if a file is binary by attempting to read it as text.
+    Returns True if the file is binary, False otherwise.
+    """
+    try:
+        # Attempt to read the file content from the repository tree
+        content = repo.tree()[file_path].data_stream.read()
+        # Try decoding as UTF-8; if it fails, it's likely binary
+        content.decode("utf-8")
+        return False
+    except (UnicodeDecodeError, KeyError):
+        return True
+    except Exception as e:
+        logging.warning(f"Error checking if file {file_path} is binary: {e}")
+        return True  # Conservatively treat errors as binary to avoid issues
+
+
+def get_diff(
+    repo: Repo = None,
+    what: str = None,
+    against: str = None,
+    use_merge_base: bool = True,
+) -> PatchSet | list[PatchedFile]:
+    repo = repo or Repo(".")
+    if not against:
+        against = repo.remotes.origin.refs.HEAD.reference.name  # origin/main
+    if not what:
+        what = None  # working copy
+    if use_merge_base:
+        if what is None:
+            try:
+                current_ref = repo.active_branch.name
+            except TypeError:
+                # In detached HEAD state, use HEAD directly
+                current_ref = "HEAD"
+                logging.info(
+                    "Detected detached HEAD state, using HEAD as current reference"
+                )
+        else:
+            current_ref = what
+        merge_base = repo.merge_base(current_ref or repo.active_branch.name, against)[0]
+        against = merge_base.hexsha
+        logging.info(
+            f"Using merge base: {mc.ui.cyan(merge_base.hexsha[:8])} ({merge_base.summary})"
+        )
+    logging.info(
+        f"Making diff: {mc.ui.green(what or 'INDEX')} vs {mc.ui.yellow(against)}"
+    )
+    diff_content = repo.git.diff(against, what)
+    diff = PatchSet.from_string(diff_content)
+    diff = PatchSet.from_string(diff_content)
+
+    # Filter out binary files
+    non_binary_diff = PatchSet([])
+    for patched_file in diff:
+        # Check if the file is binary using the source or target file path
+        file_path = (
+            patched_file.target_file
+            if patched_file.target_file != DEV_NULL
+            else patched_file.source_file
+        )
+        if file_path == DEV_NULL or is_binary_file(repo, file_path.lstrip("b/")):
+            logging.info(f"Skipping binary file: {patched_file.path}")
+            continue
+        non_binary_diff.append(patched_file)
+    return non_binary_diff
+
+
+def filter_diff(
+    patch_set: PatchSet | Iterable[PatchedFile], filters: str | list[str]
+) -> PatchSet | Iterable[PatchedFile]:
+    """
+    Filter the diff files by the given fnmatch filters.
+    """
+    assert isinstance(filters, (list, str))
+    if not isinstance(filters, list):
+        filters = [f.strip() for f in filters.split(",") if f.strip()]
+    if not filters:
+        return patch_set
+    files = [
+        file
+        for file in patch_set
+        if any(fnmatch.fnmatch(file.path, pattern) for pattern in filters)
+    ]
+    return files
+
+
+def file_lines(repo: Repo, file: str, max_tokens: int = None) -> str:
+    text = repo.tree()[file].data_stream.read().decode()
+    lines = [f"{i + 1}: {line}\n" for i, line in enumerate(text.splitlines())]
+    if max_tokens:
+        lines, removed_qty = mc.tokenizing.fit_to_token_size(lines, max_tokens)
+        if removed_qty:
+            lines.append(
+                f"(!) DISPLAYING ONLY FIRST {len(lines)} LINES DUE TO LARGE FILE SIZE\n"
+            )
+    return "".join(lines)
+
+
+def make_cr_summary(cfg: ProjectConfig, report: Report, diff):
+    return (
+        mc.prompt(
+            cfg.summary_prompt,
+            diff=mc.tokenizing.fit_to_token_size(diff, cfg.max_code_tokens)[0],
+            issues=report.issues,
+            **cfg.prompt_vars,
+        ).to_llm()
+        if cfg.summary_prompt
+        else ""
+    )
+
+
+async def review(
+    repo: Repo = None,
+    what: str = None,
+    against: str = None,
+    filters: str | list[str] = "",
+    use_merge_base: bool = True,
+    out_folder: str | PathLike | None = None,
+):
+    cfg = ProjectConfig.load()
+    repo = repo or Repo(".")
+    out_folder = Path(out_folder or repo.working_tree_dir)
+    diff = get_diff(
+        repo=repo, what=what, against=against, use_merge_base=use_merge_base
+    )
+    diff = filter_diff(diff, filters)
+    if not diff:
+        logging.error("Nothing to review")
+        return
+    lines = {
+        file_diff.path: (
+            file_lines(
+                repo,
+                file_diff.path,
+                cfg.max_code_tokens
+                - mc.tokenizing.num_tokens_from_string(str(file_diff)),
+            )
+            if file_diff.target_file != DEV_NULL and not file_diff.is_added_file
+            else ""
+        )
+        for file_diff in diff
+    }
+    responses = await mc.llm_parallel(
+        [
+            mc.prompt(
+                cfg.prompt,
+                input=file_diff,
+                file_lines=lines[file_diff.path],
+                **cfg.prompt_vars,
+            )
+            for file_diff in diff
+        ],
+        retries=cfg.retries,
+        parse_json=True,
+    )
+    issues = {file.path: issues for file, issues in zip(diff, responses) if issues}
+    for file, file_issues in issues.items():
+        for issue in file_issues:
+            for i in issue.get("affected_lines", []):
+                if lines[file]:
+                    f_lines = [""] + lines[file].splitlines()
+                    i["affected_code"] = "\n".join(
+                        f_lines[i["start_line"]: i["end_line"] + 1]
+                    )
+    exec(cfg.post_process, {"mc": mc, **locals()})
+    out_folder.mkdir(parents=True, exist_ok=True)
+    report = Report(issues=issues, number_of_processed_files=len(diff))
+    report.summary = make_cr_summary(cfg, report, diff)
+    report.save(file_name=out_folder / JSON_REPORT_FILE_NAME)
+    report_text = report.render(cfg, Report.Format.MARKDOWN)
+    print(mc.ui.yellow(report_text))
+    text_report_path = out_folder / "code-review-report.md"
+    text_report_path.write_text(report_text, encoding="utf-8")

{ai_cr-0.5.0 → ai_cr-1.0.0}/ai_code_review/utils.py

@@ -92,11 +92,11 @@ def is_running_in_github_action():
     return os.getenv("GITHUB_ACTIONS") == "true"
 
 
-def is_app_command_invocation(app: typer.Typer) -> bool:
+def no_subcommand(app: typer.Typer) -> bool:
     """
     Checks if the current script is being invoked as a command in a target Typer application.
     """
-    return (
+    return not (
         (first_arg := next((a for a in sys.argv[1:] if not a.startswith('-')), None))
         and first_arg in (
             cmd.name or cmd.callback.__name__.replace('_', '-')
@@ -106,7 +106,7 @@ def is_app_command_invocation(app: typer.Typer) -> bool:
     )
 
 
-def parse_refs_pair(refs: str):
+def parse_refs_pair(refs: str) -> tuple[str | None, str | None]:
     SEPARATOR = '..'
     if not refs:
         return None, None

{ai_cr-0.5.0 → ai_cr-1.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ai-cr"
-version = "0.5.0"
+version = "1.0.0"
 description = "LLM-agnostic GitHub AI Code Review Tool with integration to GitHub actions"
 authors = ["Nayjest <mail@vitaliy.in>"]
 readme = "README.md"
@@ -21,13 +21,12 @@ packages = [
 
 [tool.poetry.dependencies]
 python = "^3.11"
-ai-microcore = "4.0.0.dev18"
-GitPython = "3.1.44"
-unidiff = "0.7.5"
-google-generativeai = "0.8.5"
-anthropic = "0.52.2"
-typer = "0.9.4"
-async-typer = "0.1.8"
+ai-microcore = "4.0.0.dev19"
+GitPython = "^3.1.44"
+unidiff = "^0.7.5"
+google-generativeai = "^0.8.5"
+anthropic = "^0.52.2"
+typer = "^0.16.0"
 
 [tool.poetry.group.dev.dependencies]
 flake8 = "*"

ai_cr-0.5.0/ai_code_review/cli.py

@@ -1,157 +0,0 @@
-import asyncio
-import logging
-import sys
-import os
-import shutil
-import requests
-
-import microcore as mc
-import async_typer
-import typer
-from ai_code_review.utils import parse_refs_pair
-from git import Repo
-
-from .core import review
-from .report_struct import Report
-from .constants import ENV_CONFIG_FILE
-from .bootstrap import bootstrap
-from .project_config import ProjectConfig
-from .utils import is_app_command_invocation
-
-
-app = async_typer.AsyncTyper(pretty_exceptions_show_locals=False)
-default_command_app = async_typer.AsyncTyper(pretty_exceptions_show_locals=False)
-if sys.platform == "win32":
-    asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
-
-
-def main():
-    if is_app_command_invocation(app):
-        app()
-    else:
-        bootstrap()
-        default_command_app()
-
-
-@app.callback(invoke_without_command=True)
-def cli(ctx: typer.Context):
-    if ctx.invoked_subcommand != "setup":
-        bootstrap()
-
-
-@default_command_app.async_command(name="review", help="Perform code review")
-@app.async_command(name="review", help="Perform code review")
-async def cmd_review(
-    refs: str = typer.Argument(
-        default=None,
-        help="Git refs to review, [what]..[against] e.g. 'HEAD..HEAD~1'"
-    ),
-    what: str = typer.Option(None, "--what", "-w", help="Git ref to review"),
-    against: str = typer.Option(
-        None,
-        "--against", "-vs", "--vs",
-        help="Git ref to compare against"
-    ),
-    filters: str = typer.Option(
-        "", "--filter", "-f", "--filters",
-        help="""
-        filter reviewed files by glob / fnmatch pattern(s),
-        e.g. 'src/**/*.py', may be comma-separated
-        """,
-    )
-):
-    _what, _against = parse_refs_pair(refs)
-    if _what:
-        if what:
-            raise typer.BadParameter(
-                "You cannot specify both 'refs' <WHAT>..<AGAINST> and '--what'. Use one of them."
-            )
-    else:
-        _what = what
-    if _against:
-        if against:
-            raise typer.BadParameter(
-                "You cannot specify both 'refs' <WHAT>..<AGAINST> and '--against'. Use one of them."
-            )
-    else:
-        _against = against
-    await review(what=_what, against=_against, filters=filters)
-
-
-@app.async_command(help="Configure LLM for local usage interactively")
-async def setup():
-    mc.interactive_setup(ENV_CONFIG_FILE)
-
-
-@app.async_command()
-async def render(format: str = Report.Format.MARKDOWN):
-    print(Report.load().render(format=format))
-
-
-@app.async_command(help="Review remote code")
-async def remote(url=typer.Option(), branch=typer.Option()):
-    if os.path.exists("reviewed-repo"):
-        shutil.rmtree("reviewed-repo")
-    Repo.clone_from(url, branch=branch, to_path="reviewed-repo")
-    prev_dir = os.getcwd()
-    try:
-        os.chdir("reviewed-repo")
-        await review()
-    finally:
-        os.chdir(prev_dir)
-
-
-@app.async_command(help="Leave a GitHub PR comment with the review.")
-async def github_comment(
-    token: str = typer.Option(
-        os.environ.get("GITHUB_TOKEN", ""), help="GitHub token (or set GITHUB_TOKEN env var)"
-    ),
-):
-    """
-    Leaves a comment with the review on the current GitHub pull request.
-    """
-    file = "code-review-report.txt"
-    if not os.path.exists(file):
-        print(f"Review file not found: {file}")
-        raise typer.Exit(4)
-
-    with open(file, "r", encoding="utf-8") as f:
-        body = f.read()
-
-    if not token:
-        print("GitHub token is required (--token or GITHUB_TOKEN env var).")
-        raise typer.Exit(1)
-
-    github_env = ProjectConfig.load().prompt_vars["github_env"]
-    repo = github_env.get("github_repo", "")
-    pr_env_val = github_env.get("github_pr_number", "")
-    logging.info(f"github_pr_number = {pr_env_val}")
-
-    # e.g. could be "refs/pull/123/merge" or a direct number
-    if "/" in pr_env_val and "pull" in pr_env_val:
-        # refs/pull/123/merge
-        try:
-            pr_num_candidate = pr_env_val.strip("/").split("/")
-            idx = pr_num_candidate.index("pull")
-            pr = int(pr_num_candidate[idx + 1])
-        except Exception:
-            pr = 0
-    else:
-        try:
-            pr = int(pr_env_val)
-        except Exception:
-            pr = 0
-
-    api_url = f"https://api.github.com/repos/{repo}/issues/{pr}/comments"
-    headers = {
-        "Authorization": f"token {token}",
-        "Accept": "application/vnd.github+json",
-    }
-    data = {"body": body}
-
-    resp = requests.post(api_url, headers=headers, json=data)
-    if 200 <= resp.status_code < 300:
-        logging.info(f"Posted review comment to PR #{pr} in {repo}")
-    else:
-        logging.error(f"Failed to post comment: {resp.status_code} {resp.reason}\n{resp.text}")
-        raise typer.Exit(5)

ai_cr-0.5.0/ai_code_review/core.py

@@ -1,125 +0,0 @@
-import fnmatch
-import logging
-from typing import Iterable
-
-import microcore as mc
-from git import Repo
-from unidiff import PatchSet, PatchedFile
-from unidiff.constants import DEV_NULL
-
-from .project_config import ProjectConfig
-from .report_struct import Report
-
-
-def get_diff(
-    repo: Repo = None,
-    what: str = None,
-    against: str = None
-) -> PatchSet | list[PatchedFile]:
-    repo = repo or Repo(".")
-    if not against:
-        against = repo.remotes.origin.refs.HEAD.reference.name  # origin/main
-    if not what:
-        what = None  # working copy
-    logging.info(f"Reviewing {mc.ui.green(what or 'working copy')} vs {mc.ui.yellow(against)}")
-    diff_content = repo.git.diff(against, what)
-    diff = PatchSet.from_string(diff_content)
-    return diff
-
-
-def filter_diff(
-    patch_set: PatchSet | Iterable[PatchedFile], filters: str | list[str]
-) -> PatchSet | Iterable[PatchedFile]:
-    """
-    Filter the diff files by the given fnmatch filters.
-    """
-    print([f.path for f in patch_set])
-    assert isinstance(filters, (list, str))
-    if not isinstance(filters, list):
-        filters = [f.strip() for f in filters.split(",") if f.strip()]
-    if not filters:
-        return patch_set
-    files = [
-        file
-        for file in patch_set
-        if any(fnmatch.fnmatch(file.path, pattern) for pattern in filters)
-    ]
-    print([f.path for f in files])
-    return files
-
-
-def file_lines(repo: Repo, file: str, max_tokens: int = None) -> str:
-    text = repo.tree()[file].data_stream.read().decode()
-    lines = [f"{i + 1}: {line}\n" for i, line in enumerate(text.splitlines())]
-    if max_tokens:
-        lines, removed_qty = mc.tokenizing.fit_to_token_size(lines, max_tokens)
-        if removed_qty:
-            lines.append(
-                f"(!) DISPLAYING ONLY FIRST {len(lines)} LINES DUE TO LARGE FILE SIZE\n"
-            )
-    return "".join(lines)
-
-
-def make_cr_summary(cfg: ProjectConfig, report: Report, diff):
-    return mc.prompt(
-        cfg.summary_prompt,
-        diff=mc.tokenizing.fit_to_token_size(diff, cfg.max_code_tokens)[0],
-        issues=report.issues,
-        **cfg.prompt_vars,
-    ).to_llm() if cfg.summary_prompt else ""
-
-
-async def review(
-    what: str = None,
-    against: str = None,
-    filters: str | list[str] = ""
-):
-    cfg = ProjectConfig.load()
-    repo = Repo(".")
-    diff = get_diff(repo=repo, what=what, against=against)
-    diff = filter_diff(diff, filters)
-    if not diff:
-        logging.error("Nothing to review")
-        return
-    lines = {
-        file_diff.path: (
-            file_lines(
-                repo,
-                file_diff.path,
-                cfg.max_code_tokens
-                - mc.tokenizing.num_tokens_from_string(str(file_diff)),
-            )
-            if file_diff.target_file != DEV_NULL and not file_diff.is_added_file
-            else ""
-        )
-        for file_diff in diff
-    }
-    responses = await mc.llm_parallel(
-        [
-            mc.prompt(
-                cfg.prompt,
-                input=file_diff,
-                file_lines=lines[file_diff.path],
-                **cfg.prompt_vars,
-            )
-            for file_diff in diff
-        ],
-        retries=cfg.retries,
-        parse_json=True,
-    )
-    issues = {file.path: issues for file, issues in zip(diff, responses) if issues}
-    for file, file_issues in issues.items():
-        for issue in file_issues:
-            for i in issue.get("affected_lines", []):
-                if lines[file]:
-                    f_lines = [""] + lines[file].splitlines()
-                    i["affected_code"] = "\n".join(
-                        f_lines[i["start_line"]: i["end_line"]+1]
-                    )
-    exec(cfg.post_process, {"mc": mc, **locals()})
-    report = Report(issues=issues, number_of_processed_files=len(diff))
-    report.summary = make_cr_summary(cfg, report, diff)
-    report.save()
-    report_text = report.render(cfg, Report.Format.MARKDOWN)
-    print(mc.ui.yellow(report_text))
-    open("code-review-report.txt", "w", encoding="utf-8").write(report_text)