Add InvalidInputError, add better error message for invalid ref in /gh search files

Author: object-Object

bot/src/ghutils/cogs/app_commands/github.py

@@ -13,14 +13,14 @@
 from discord.ext.commands import GroupCog
 from discord.ui import Button, View
 from githubkit import GitHub
-from githubkit.exception import GitHubException
+from githubkit.exception import GitHubException, RequestFailed
 from githubkit.rest import Issue, IssuePropPullRequest, PullRequest, SimpleUser
 from more_itertools import consecutive_groups, ilen
 from yarl import URL
 
 from ghutils.common.__version__ import VERSION
 from ghutils.core.cog import GHUtilsCog, SubGroup
-from ghutils.core.types import LoginState, NotLoggedInError
+from ghutils.core.types import InvalidInputError, LoginState, NotLoggedInError
 from ghutils.db.models import (
     UserGitHubTokens,
     UserLogin,
@@ -297,14 +297,22 @@ async def files(
                 if ref is None:
                     ref = repo.default_branch
 
-                tree = await gh_request(
-                    github.rest.git.async_get_tree(
-                        repo.owner.login,
-                        repo.name,
-                        ref,
-                        recursive="1",
+                try:
+                    tree = await gh_request(
+                        github.rest.git.async_get_tree(
+                            repo.owner.login,
+                            repo.name,
+                            ref,
+                            recursive="1",
+                        )
                     )
-                )
+                except RequestFailed as e:
+                    if e.response.status_code == 404:  # pyright: ignore[reportUnknownMemberType]
+                        raise InvalidInputError(
+                            value=ref,
+                            message=f"Ref does not exist in `{repo.full_name}`.",
+                        )
+                    raise
 
                 sha = tree.sha[:12]
                 tree_dict = {item.path: item for item in tree.tree if item.path}

bot/src/ghutils/core/tree.py

@@ -10,7 +10,7 @@
     TransformerError,
 )
 
-from .types import NotLoggedInError, SilentError
+from .types import InvalidInputError, NotLoggedInError, SilentError
 
 
 class GHUtilsCommandTree(CommandTree):
@@ -40,6 +40,14 @@ async def on_error(self, interaction: Interaction, error: AppCommandError):
                     value=str(value),
                     inline=False,
                 )
+            case InvalidInputError(value=value, message=message):
+                embed.title = "Invalid input!"
+                embed.description = message
+                embed.add_field(
+                    name="Value",
+                    value=str(value),
+                    inline=False,
+                )
             case NotLoggedInError():
                 embed.title = "Not logged in!"
                 embed.description = "You must be logged in with GitHub to use this command. Use `/gh login` to log in, then try again."

bot/src/ghutils/core/types.py

@@ -1,4 +1,5 @@
 from enum import Enum, auto
+from typing import Any
 
 from discord.app_commands import AppCommandError
 
@@ -20,3 +21,15 @@ class NotLoggedInError(AppCommandError):
 
 class SilentError(AppCommandError):
     """Base class for exceptions that should be silently caught and ignored."""
+
+
+class InvalidInputError(AppCommandError):
+    """An exception raised within command handlers when an input value is invalid.
+
+    Displays a similar error message as `TransformerError`.
+    """
+
+    def __init__(self, value: Any, message: str):
+        self.value = value
+        self.message = message
+        super().__init__(f"{message} (value: {value})")