Error Handling

Errors are inevitable when working with the API, and they must be correctly handled with try..except blocks in order to control the behaviour of your application. Pyrogram errors all live inside the errors package:

from pyrogram import errors

RPCError

The father of all errors is named RPCError. This error exists in form of a Python exception which is directly subclass-ed from Python’s main Exception and is able to catch all Telegram API related errors. This error is raised every time a method call against Telegram’s API was unsuccessful.

from pyrogram.errors import RPCError

Warning

It must be noted that catching this error is bad practice, especially when no feedback is given (i.e. by logging/printing the full error traceback), because it makes it impossible to understand what went wrong.

Error Categories

The RPCError packs together all the possible errors Telegram could raise, but to make things tidier, Pyrogram provides categories of errors, which are named after the common HTTP errors and are subclass-ed from the RPCError:

from pyrogram.errors import BadRequest, Forbidden, ...

Single Errors

For a fine-grained control over every single error, Pyrogram does also expose errors that deal each with a specific issue. For example:

from pyrogram.errors import FloodWait

These errors subclass directly from the category of errors they belong to, which in turn subclass from the father RPCError, thus building a class of error hierarchy such as this:

  • RPCError
    • BadRequest
      • MessageEmpty

      • UsernameOccupied

      • ...

    • InternalServerError
      • RpcCallFail

      • InterDcCallError

      • ...

    • ...

Unknown Errors

In case Pyrogram does not know anything about a specific error yet, it raises a generic error from its known category, for example, an unknown error with error code 400, will be raised as a BadRequest. This way you can catch the whole category of errors and be sure to also handle these unknown errors.

In case a whole class of errors is unknown (that is, an error code that is unknown), Pyrogram will raise a special 520 UnknownError exception.

In both cases, Pyrogram will log them in the unknown_errors.txt file. Users are invited to report these unknown errors in the discussion group.

Errors with Values

Exception objects may also contain some informative values. For example, FloodWait holds the amount of seconds you have to wait before you can try again, some other errors contain the DC number on which the request must be repeated on. The value is stored in the x attribute of the exception object:

import time
from pyrogram.errors import FloodWait

try:
    ...
except FloodWait as e:
    time.sleep(e.x)  # Wait "x" seconds before continuing