Xtao-Labs/MTPyroger
3
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Documentation fixes

Browse Source
This commit is contained in:
Dan 2019-03-27 14:46:02 +01:00
parent ef5dd96bdc
commit b4da453ef3
2 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/source/resources/ErrorHandling.rst
View File

@ -4,18 +4,18 @@ Error Handling
Errors are inevitable when working with the API, and they must be correctly handled with ``try..except`` blocks. Errors are inevitable when working with the API, and they must be correctly handled with ``try..except`` blocks.
There are many errors that Telegram could return, but they all fall in one of these categories There are many errors that Telegram could return, but they all fall in one of these categories
(which are in turn children of the :obj:`pyrogram.Error` superclass) (which are in turn children of the :obj:`RPCError <pyrogram.RPCError>` superclass)
- :obj:`303 - See Other <pyrogram.api.errors.SeeOther>` - :obj:`303 - See Other <pyrogram.errors.SeeOther>`
- :obj:`400 - Bad Request <pyrogram.api.errors.BadRequest>` - :obj:`400 - Bad Request <pyrogram.errors.BadRequest>`
- :obj:`401 - Unauthorized <pyrogram.api.errors.Unauthorized>` - :obj:`401 - Unauthorized <pyrogram.errors.Unauthorized>`
- :obj:`403 - Forbidden <pyrogram.api.errors.Forbidden>` - :obj:`403 - Forbidden <pyrogram.errors.Forbidden>`
- :obj:`406 - Not Acceptable <pyrogram.api.errors.NotAcceptable>` - :obj:`406 - Not Acceptable <pyrogram.errors.NotAcceptable>`
- :obj:`420 - Flood <pyrogram.api.errors.Flood>` - :obj:`420 - Flood <pyrogram.errors.Flood>`
- :obj:`500 - Internal Server Error <pyrogram.api.errors.InternalServerError>` - :obj:`500 - Internal Server Error <pyrogram.errors.InternalServerError>`
As stated above, there are really many (too many) errors, and in case Pyrogram does not know anything yet about a As stated above, there are really many (too many) errors, and in case Pyrogram does not know anything yet about a
specific one, it raises a special :obj:`520 Unknown Error <pyrogram.api.errors.UnknownError>` exception and logs it specific one, it raises a special :obj:`520 Unknown Error <pyrogram.errors.UnknownError>` exception and logs it
in the ``unknown_errors.txt`` file. Users are invited to report these unknown errors; in later versions of Pyrogram in the ``unknown_errors.txt`` file. Users are invited to report these unknown errors; in later versions of Pyrogram
some kind of automatic error reporting module might be implemented. some kind of automatic error reporting module might be implemented.
@ -24,7 +24,7 @@ Examples
.. code-block:: python .. code-block:: python
from pyrogram.api.errors import ( from pyrogram.errors import (
BadRequest, Flood, InternalServerError, BadRequest, Flood, InternalServerError,
SeeOther, Unauthorized, UnknownError SeeOther, Unauthorized, UnknownError
) )
@ -45,13 +45,13 @@ Examples
pass pass
Exception objects may also contain some informative values. Exception objects may also contain some informative values.
E.g.: :obj:`FloodWait <pyrogram.api.errors.exceptions.flood_420.FloodWait>` holds the amount of seconds you have to wait E.g.: :obj:`FloodWait <pyrogram.errors.exceptions.flood_420.FloodWait>` holds the amount of seconds you have to wait
before you can try again. The value is always stored in the ``x`` field of the returned exception object: before you can try again. The value is always stored in the ``x`` field of the returned exception object:
.. code-block:: python .. code-block:: python
import time import time
from pyrogram.api.errors import FloodWait from pyrogram.errors import FloodWait
try: try:
... ...

1
pyrogram/client/types/messages_and_media/poll_option.py
View File

@ -29,6 +29,7 @@ class PollOption(PyrogramType):
voters (``int``): voters (``int``):
The number of users who voted this option. The number of users who voted this option.
It will be 0 until you vote for the poll.
data (``bytes``): data (``bytes``):
Unique data that identifies this option among all the other options in a poll. Unique data that identifies this option among all the other options in a poll.