Skip to content

gitea.cli.utils.errors

errors

Errors raised by the CLI itself rather than by the HTTP layer.

Classes

gitea.cli.utils.errors.CommandError

Bases: Exception

A command failed for a reason the user can act on.

execute_api_command reports these without a traceback, so the message is the whole error the user sees: state what went wrong and what to do next.

Functions:

gitea.cli.utils.errors.unreachable_message 

unreachable_message(
    error: Exception, base_url: str | None = None
) -> str

Build the error message for a request that never reached the instance.

A connection or timeout failure says nothing about the account, the repository or the issue, so the message points at the instance and the network instead of at whatever the command was trying to do.

Parameters:

Name Type Description Default
error Exception

The connection or timeout error raised by the HTTP layer.

 required
base_url str | None

The base URL the call was made against, when it is known.

 None

Returns:

Type Description
str

The message describing the failure and how to act on it.
Source code in src/gitea/cli/utils/errors.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
def unreachable_message(error: Exception, base_url: str | None = None) -> str:
    """Build the error message for a request that never reached the instance.

    A connection or timeout failure says nothing about the account, the
    repository or the issue, so the message points at the instance and the
    network instead of at whatever the command was trying to do.

    Args:
        error: The connection or timeout error raised by the HTTP layer.
        base_url: The base URL the call was made against, when it is known.

    Returns:
        The message describing the failure and how to act on it.

    """
    where = f" at {base_url}" if base_url else ""
    return (
        f"Could not reach the Gitea API{where}: {error}. "
        f"Check that the instance is up, that the base URL is right and that the network allows the connection."
    )

gitea.cli.utils.errors.request_failed_message 

request_failed_message(
    error: Exception, base_url: str | None = None
) -> str

Build the error message for a request that failed without reaching a response.

A malformed base URL, a rejected redirect or a response body that could not be read is not the instance being unreachable, so the message claims only that the request did not complete. It names the error's type, since there is no traceback to read it from.

Parameters:

Name Type Description Default
error Exception

The request error raised by the HTTP layer.

 required
base_url str | None

The base URL the call was made against, when it is known.

 None

Returns:

Type Description
str

The message describing the failure and how to act on it.
Source code in src/gitea/cli/utils/errors.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
def request_failed_message(error: Exception, base_url: str | None = None) -> str:
    """Build the error message for a request that failed without reaching a response.

    A malformed base URL, a rejected redirect or a response body that could not
    be read is not the instance being unreachable, so the message claims only
    that the request did not complete. It names the error's type, since there is
    no traceback to read it from.

    Args:
        error: The request error raised by the HTTP layer.
        base_url: The base URL the call was made against, when it is known.

    Returns:
        The message describing the failure and how to act on it.

    """
    where = f" at {base_url}" if base_url else ""
    return (
        f"Could not complete the request to the Gitea API{where}: {type(error).__name__}: {error}. "
        f"Check that the base URL is a well-formed URL of a Gitea instance."
    )