tanjun.errors#

Initialise a command error.

Parameters:

• content (UndefinedOr[Any], default: UNDEFINED ) –

  If provided, the message content to respond with.

  If this is a hikari.Embed and no embed nor embeds kwarg is provided, then this will instead be treated as an embed. This allows for simpler syntax when sending an embed alone.

  Likewise, if this is a hikari.Resource, then the content is instead treated as an attachment if no attachment and no attachments kwargs are provided.

• delete_after (Union[timedelta, float, int, None], default: None ) –

  If provided, the seconds after which the response message should be deleted.

  Slash command responses can only be deleted within 15 minutes of the command being received.

• attachment (UndefinedOr[Resourceish], default: UNDEFINED ) –

  A singular attachment to respond with.

• attachments (UndefinedOr[Sequence[Resourceish]], default: UNDEFINED ) –

  A sequence of attachments to respond with.

• component (UndefinedOr[ComponentBuilder], default: UNDEFINED ) –

  If provided, builder object of the component to include in this response.

• components (UndefinedOr[Sequence[ComponentBuilder]], default: UNDEFINED ) –

  If provided, a sequence of the component builder objects to include in this response.

• embed (UndefinedOr[Embed], default: UNDEFINED ) –

  An embed to respond with.

• embeds (UndefinedOr[Sequence[Embed]], default: UNDEFINED ) –

  A sequence of embeds to respond with.

• mentions_everyone (UndefinedOr[bool], default: UNDEFINED ) –

  If provided, whether the message should parse @everyone/@here mentions.

• user_mentions (Union[SnowflakeishSequence[PartialUser], bool, UndefinedType], default: UNDEFINED ) –

  If provided, and True, all mentions will be parsed. If provided, and False, no mentions will be parsed.

  Alternatively this may be a collection of hikari.Snowflake, or hikari.PartialUser derivatives to enforce mentioning specific users.

• role_mentions (Union[SnowflakeishSequence[PartialRole], bool, UndefinedType], default: UNDEFINED ) –

  If provided, and True, all mentions will be parsed. If provided, and False, no mentions will be parsed.

  Alternatively this may be a collection of hikari.Snowflake, or hikari.PartialRole derivatives to enforce mentioning specific roles.

Raises:

• ValueError –

  Raised for any of the following reasons:

  • When both attachment and attachments are provided.
  • When both component and components are passed.
  • When both embed and embeds are passed.
  • If more than 100 entries are passed for role_mentions.
  • If more than 100 entries are passed for user_mentions.

Send this error as a command response.

Parameters:

• ctx (Context) –

  The command call context to respond to.

• ensure_result (bool, default: False ) –

  Ensure that this call will always return a message object.

  If True then this will always return hikari.Message, otherwise this will return hikari.Message | None.

  It's worth noting that, under certain scenarios within the slash command flow, this may lead to an extre request being made.

Raises:

• ValueError –

  If delete_after would be more than 15 minutes after the slash command was called.

• BadRequestError –

  This may be raised in several discrete situations, such as messages being empty with no attachments or embeds; messages with more than 2000 characters in them, embeds that exceed one of the many embed limits; too many attachments; attachments that are too large; invalid image URLs in embeds; too many components.

• UnauthorizedError –

  If you are unauthorized to make the request (invalid/missing token).

• ForbiddenError –

  If you are missing the SEND_MESSAGES in the channel or the person you are trying to message has the DM's disabled.

• NotFoundError –

  If the channel is not found.

• RateLimitTooLongError –

  Raised in the event that a rate limit occurs that is longer than max_rate_limit when making a request.

• InternalServerError –

  If an internal error occurs on Discord while handling the request.

Initialise a conversion error.

Parameters:

• parameter (str) –

  The parameter this was raised by.

• errors (Iterable[ValueError], default: () ) –

  An iterable of the source value errors which were raised during conversion.

Initialise a not enough arguments error.

Parameters:

• message (str) –

  The error message.

• parameter (str) –

  The parameter this error was raised for.

Initialise a parser error.

Parameters:

• message (str) –

  String message for this error.

• parameter (Optional[str]) –

  Name of the parameter which caused this error, should be None if not applicable.

Initialise a too many arguments error.

Parameters:

• message (str) –

  The error message.

• parameter (str) –

  The parameter this error was raised for.