fix: don't exit with code 1 when there is nothing to review (#154)

Author: scastlara

scripts/evaluate_review_quality.py

@@ -111,7 +111,7 @@ def perform_review(
             technologies=("Python", "Django", "FastAPI"),
         ),
     )
-    review = code_reviewer.review_pull_request(target=url)
+    review = code_reviewer.review(target=url)
     write_review_to_dir(model, output_dir, pr_name, sample, review)
 
 

src/lgtm_ai/__main__.py

@@ -15,6 +15,7 @@
 )
 from lgtm_ai.ai.schemas import AgentSettings, CommentCategory, SupportedAIModelsList
 from lgtm_ai.base.constants import DEFAULT_HTTPX_TIMEOUT
+from lgtm_ai.base.exceptions import NothingToReviewError
 from lgtm_ai.base.schemas import IssuesPlatform, LocalRepository, OutputFormat, PRUrl
 from lgtm_ai.base.utils import git_source_supports_multiline_suggestions
 from lgtm_ai.config.constants import DEFAULT_INPUT_TOKEN_LIMIT
@@ -200,12 +201,18 @@ def review(target: PRUrl | LocalRepository, config: str | None, verbose: int, **
         git_client=git_client,
         config=resolved_config,
     )
-    review = code_reviewer.review_pull_request(target=target)
-    logger.info("Review completed, total comments: %d", len(review.review_response.comments))
 
+    formatter, printer = _get_formatter_and_printer(resolved_config.output_format)
+    try:
+        review = code_reviewer.review(target=target)
+    except NothingToReviewError:
+        if not resolved_config.silent:
+            printer(formatter.empty_review_message())
+        return
+
+    logger.info("Review completed, total comments: %d", len(review.review_response.comments))
     if not resolved_config.silent:
         logger.info("Printing review to console")
-        formatter, printer = _get_formatter_and_printer(resolved_config.output_format)
         printer(formatter.format_review_summary_section(review))
         if review.review_response.comments:
             printer(formatter.format_review_comments_section(review.review_response.comments))
@@ -253,11 +260,18 @@ def guide(
         git_client=git_client,
         config=resolved_config,
     )
-    guide = review_guide.generate_review_guide(pr_url=target)
+
+    formatter, printer = _get_formatter_and_printer(resolved_config.output_format)
+
+    try:
+        guide = review_guide.generate_review_guide(pr_url=target)
+    except NothingToReviewError:
+        if not resolved_config.silent:
+            printer(formatter.empty_guide_message())
+        return
 
     if not resolved_config.silent:
         logger.info("Printing review to console")
-        formatter, printer = _get_formatter_and_printer(resolved_config.output_format)
         printer(formatter.format_guide(guide))
 
     if resolved_config.publish and git_client:

src/lgtm_ai/config/handler.py

@@ -69,14 +69,9 @@ class CliOptions(BaseModel):
 class ResolvedConfig(
     BaseSettings,
 ):
-    """Resolved configuration class to hold the final configuration.
+    """Resolved configuration class to hold the final configuration used throghought the cli app.
 
-    All intrinsic values are non-nullable and have appropriate defaults. Optional settings passed toward pydantic-ai Agents are nullable, as they have their own defaults in the library.
-
-    This class uses Pydantic Settings to automatically load configuration from multiple sources:
-    1. CLI arguments (highest priority)
-    2. Configuration files (lgtm.toml, pyproject.toml)
-    3. Environment variables (lowest priority)
+    It will hold the merged configuration from all sources (CLI args, config files, env vars, defaults).
     """
 
     model_config = SettingsConfigDict(
@@ -135,6 +130,7 @@ class ResolvedConfig(
     """If reviewing a local repository, what to compare against (branch, commit, or HEAD for working dir)."""
 
     # Secrets - these will be loaded from environment variables with LGTM_ prefix
+    # They are not displayed on logs or reprs.
     git_api_key: str = Field(repr=False)
     """API key to interact with the git service (GitLab, GitHub, etc.)."""
 
@@ -270,7 +266,7 @@ def resolve_config(self, target: PRUrl | LocalRepository) -> ResolvedConfig:
 
     @classmethod
     def _create_dynamic_settings_class(cls, config_file_path: str | None) -> type[ResolvedConfig]:
-        """Dynamically create a ResolvedConfig subclass with custom settings sources if needed."""
+        """Dynamically create a ResolvedConfig subclass that uses a custom config file path if given."""
 
         class DynamicResolvedConfig(ResolvedConfig):
             @override
@@ -284,6 +280,7 @@ def settings_customise_sources(
                 file_secret_settings: PydanticBaseSettingsSource,
             ) -> tuple[PydanticBaseSettingsSource, ...]:
                 if not config_file_path:
+                    # No custom config file path provided, use default behavior
                     return super().settings_customise_sources(
                         settings_cls,
                         init_settings,

src/lgtm_ai/formatters/base.py

@@ -30,3 +30,9 @@ def format_review_comments_section(self, comments: list[ReviewComment]) -> _T: .
     def format_review_comment(self, comment: ReviewComment, *, with_footer: bool = True) -> _T: ...
 
     def format_guide(self, guide: ReviewGuide) -> _T: ...
+
+    def empty_review_message(self) -> str:
+        """Message to display when nothing was reviewed."""
+
+    def empty_guide_message(self) -> str:
+        """Message to display when no guide was generated."""

src/lgtm_ai/formatters/json.py

@@ -1,3 +1,5 @@
+import json
+
 from lgtm_ai.ai.schemas import Review, ReviewComment, ReviewGuide
 from lgtm_ai.formatters.base import Formatter
 
@@ -26,3 +28,9 @@ def format_review_comment(self, comment: ReviewComment, *, with_footer: bool = T
     def format_guide(self, guide: ReviewGuide) -> str:
         """Format the review guide as JSON."""
         return guide.model_dump_json(indent=2, exclude={"pr_diff"})
+
+    def empty_review_message(self) -> str:
+        return json.dumps({"review_response": None, "metadata": None}, indent=2)
+
+    def empty_guide_message(self) -> str:
+        return json.dumps({"guide_response": None, "metadata": None}, indent=2)

src/lgtm_ai/formatters/markdown.py

@@ -75,6 +75,12 @@ def format_guide(self, guide: ReviewGuide) -> str:
             metadata=metadata,
         )
 
+    def empty_review_message(self) -> str:
+        return "> ⚠️ No files to review (all files excluded by provided configuration)."
+
+    def empty_guide_message(self) -> str:
+        return "> ⚠️ No files to generate a guide for (all files excluded by provided configuration)."
+
     def _format_snippet(self, comment: ReviewComment) -> str:
         template = self._template_env.get_template(self.SNIPPET_TEMPLATE)
         return template.render(language=comment.programming_language.lower(), snippet=comment.quote_snippet)

src/lgtm_ai/formatters/pretty.py

@@ -103,3 +103,9 @@ def format_guide(self, guide: ReviewGuide) -> Layout:
             *references,
         )
         return layout
+
+    def empty_review_message(self) -> str:
+        return "✔ No files to review (all files excluded by provided configuration)."
+
+    def empty_guide_message(self) -> str:
+        return "✔ No files to generate a guide for (all files excluded by provided configuration)."

src/lgtm_ai/git/parser.py

@@ -33,6 +33,7 @@ class DiffResult(BaseModel):
 
 
 def parse_diff_patch(metadata: DiffFileMetadata, diff_text: object) -> DiffResult:
+    """Parse a unified diff patch and return the modified lines with their metadata."""
     if not isinstance(diff_text, str):
         raise GitDiffParseError("Diff text is not a string")
 

src/lgtm_ai/git_client/gitlab.py

@@ -230,7 +230,7 @@ def _attempt_comment_at_positions(
             except gitlab.exceptions.GitlabError:
                 comment_create_success = False
                 logger.debug(
-                    "Failed to post the comment anywhere specific, it will go to general decription (hopefully)"
+                    "Failed to post the comment anywhere specific, it will go to general description (hopefully)"
                 )
 
         return comment_create_success

src/lgtm_ai/jira/jira.py

@@ -17,6 +17,10 @@ def __init__(self, issues_user: str, issues_api_key: str, httpx_client: httpx.Cl
         self._httpx_client = httpx_client
 
     def get_issue_content(self, issues_url: HttpUrl, issue_id: str) -> IssueContent | None:
+        """Fetch the content of an issue from the base URL of the issues page.
+
+        Returns None if the issue cannot be fetched or parsed.
+        """
         api_url = f"https://{issues_url.host}/rest/api/{self.API_VERSION}/issue/{issue_id}"
 
         try: