diff --git a/README.rst b/README.rst
index 50e848db..dfb03abc 100644
--- a/README.rst
+++ b/README.rst
@@ -32,7 +32,7 @@ Features
- **Fast**: Crypto parts are boosted up by TgCrypto_, a high-performance library written in pure C.
- **Documented**: Pyrogram API methods, types and public interfaces are well documented.
- **Type-hinted**: Exposed Pyrogram types and method parameters are all type-hinted.
-- **Updated**, to the latest Telegram API version, currently Layer 91 on top of `MTProto 2.0`_.
+- **Updated**, to the latest Telegram API version, currently Layer 97 on top of `MTProto 2.0`_.
- **Pluggable**: The Smart Plugin system allows to write components with minimal boilerplate code.
- **Comprehensive**: Execute any advanced action an official client is able to do, and even more.
@@ -107,7 +107,7 @@ Copyright & License
- 
@@ -122,7 +122,7 @@ Copyright & License
.. |description| replace:: **Telegram MTProto API Framework for Python**
-.. |schema| image:: https://img.shields.io/badge/schema-layer%2091-eda738.svg?longCache=true&colorA=262b30
+.. |schema| image:: https://img.shields.io/badge/schema-layer%2097-eda738.svg?longCache=true&colorA=262b30
:target: compiler/api/source/main_api.tl
:alt: Schema Layer
diff --git a/compiler/api/compiler.py b/compiler/api/compiler.py
index 9e671e80..6be16ba5 100644
--- a/compiler/api/compiler.py
+++ b/compiler/api/compiler.py
@@ -171,8 +171,8 @@ def start():
shutil.rmtree("{}/functions".format(DESTINATION), ignore_errors=True)
with open("{}/source/auth_key.tl".format(HOME), encoding="utf-8") as auth, \
- open("{}/source/sys_msgs.tl".format(HOME), encoding="utf-8") as system, \
- open("{}/source/main_api.tl".format(HOME), encoding="utf-8") as api:
+ open("{}/source/sys_msgs.tl".format(HOME), encoding="utf-8") as system, \
+ open("{}/source/main_api.tl".format(HOME), encoding="utf-8") as api:
schema = (auth.read() + system.read() + api.read()).splitlines()
with open("{}/template/mtproto.txt".format(HOME), encoding="utf-8") as f:
@@ -287,9 +287,11 @@ def start():
sorted_args = sort_args(c.args)
- arguments = ", " + ", ".join(
- [get_argument_type(i) for i in sorted_args if i != ("flags", "#")]
- ) if c.args else ""
+ arguments = (
+ ", "
+ + ("*, " if c.args else "")
+ + (", ".join([get_argument_type(i) for i in sorted_args if i != ("flags", "#")]) if c.args else "")
+ )
fields = "\n ".join(
["self.{0} = {0} # {1}".format(i[0], i[1]) for i in c.args if i != ("flags", "#")]
@@ -333,7 +335,7 @@ def start():
docstring_args = "Attributes:\n ID: ``{}``\n\n ".format(c.id) + docstring_args
if c.section == "functions":
- docstring_args += "\n\n Raises:\n :obj:`Error `"
+ docstring_args += "\n\n Raises:\n :obj:`RPCError `"
docstring_args += "\n\n Returns:\n " + get_docstring_arg_type(c.return_type)
else:
references = get_references(".".join(filter(None, [c.namespace, c.name])))
@@ -456,7 +458,11 @@ def start():
fields=fields,
read_types=read_types,
write_types=write_types,
- return_arguments=", ".join([i[0] for i in sorted_args if i != ("flags", "#")])
+ return_arguments=", ".join(
+ ["{0}={0}".format(i[0]) for i in sorted_args if i != ("flags", "#")]
+ ),
+ slots=", ".join(['"{}"'.format(i[0]) for i in sorted_args if i != ("flags", "#")]),
+ qualname="{}{}".format("{}.".format(c.namespace) if c.namespace else "", c.name)
)
)
diff --git a/compiler/api/source/main_api.tl b/compiler/api/source/main_api.tl
index 61bd1a41..581427b5 100644
--- a/compiler/api/source/main_api.tl
+++ b/compiler/api/source/main_api.tl
@@ -83,7 +83,7 @@ fileLocationUnavailable#7c596b46 volume_id:long local_id:int secret:long = FileL
fileLocation#91d11eb dc_id:int volume_id:long local_id:int secret:long file_reference:bytes = FileLocation;
userEmpty#200250ba id:int = User;
-user#2e13f4c3 flags:# self:flags.10?true contact:flags.11?true mutual_contact:flags.12?true deleted:flags.13?true bot:flags.14?true bot_chat_history:flags.15?true bot_nochats:flags.16?true verified:flags.17?true restricted:flags.18?true min:flags.20?true bot_inline_geo:flags.21?true id:int access_hash:flags.0?long first_name:flags.1?string last_name:flags.2?string username:flags.3?string phone:flags.4?string photo:flags.5?UserProfilePhoto status:flags.6?UserStatus bot_info_version:flags.14?int restriction_reason:flags.18?string bot_inline_placeholder:flags.19?string lang_code:flags.22?string = User;
+user#2e13f4c3 flags:# self:flags.10?true contact:flags.11?true mutual_contact:flags.12?true deleted:flags.13?true bot:flags.14?true bot_chat_history:flags.15?true bot_nochats:flags.16?true verified:flags.17?true restricted:flags.18?true min:flags.20?true bot_inline_geo:flags.21?true support:flags.23?true id:int access_hash:flags.0?long first_name:flags.1?string last_name:flags.2?string username:flags.3?string phone:flags.4?string photo:flags.5?UserProfilePhoto status:flags.6?UserStatus bot_info_version:flags.14?int restriction_reason:flags.18?string bot_inline_placeholder:flags.19?string lang_code:flags.22?string = User;
userProfilePhotoEmpty#4f11bae1 = UserProfilePhoto;
userProfilePhoto#d559d8c8 photo_id:long photo_small:FileLocation photo_big:FileLocation = UserProfilePhoto;
@@ -96,12 +96,12 @@ userStatusLastWeek#7bf09fc = UserStatus;
userStatusLastMonth#77ebc742 = UserStatus;
chatEmpty#9ba2d800 id:int = Chat;
-chat#d91cdd54 flags:# creator:flags.0?true kicked:flags.1?true left:flags.2?true admins_enabled:flags.3?true admin:flags.4?true deactivated:flags.5?true id:int title:string photo:ChatPhoto participants_count:int date:int version:int migrated_to:flags.6?InputChannel = Chat;
+chat#3bda1bde flags:# creator:flags.0?true kicked:flags.1?true left:flags.2?true deactivated:flags.5?true id:int title:string photo:ChatPhoto participants_count:int date:int version:int migrated_to:flags.6?InputChannel admin_rights:flags.14?ChatAdminRights default_banned_rights:flags.18?ChatBannedRights = Chat;
chatForbidden#7328bdb id:int title:string = Chat;
-channel#c88974ac flags:# creator:flags.0?true left:flags.2?true editor:flags.3?true broadcast:flags.5?true verified:flags.7?true megagroup:flags.8?true restricted:flags.9?true democracy:flags.10?true signatures:flags.11?true min:flags.12?true id:int access_hash:flags.13?long title:string username:flags.6?string photo:ChatPhoto date:int version:int restriction_reason:flags.9?string admin_rights:flags.14?ChannelAdminRights banned_rights:flags.15?ChannelBannedRights participants_count:flags.17?int = Chat;
+channel#4df30834 flags:# creator:flags.0?true left:flags.2?true broadcast:flags.5?true verified:flags.7?true megagroup:flags.8?true restricted:flags.9?true signatures:flags.11?true min:flags.12?true id:int access_hash:flags.13?long title:string username:flags.6?string photo:ChatPhoto date:int version:int restriction_reason:flags.9?string admin_rights:flags.14?ChatAdminRights banned_rights:flags.15?ChatBannedRights default_banned_rights:flags.18?ChatBannedRights participants_count:flags.17?int = Chat;
channelForbidden#289da732 flags:# broadcast:flags.5?true megagroup:flags.8?true id:int access_hash:long title:string until_date:flags.16?int = Chat;
-chatFull#edd2a791 flags:# id:int participants:ChatParticipants chat_photo:flags.2?Photo notify_settings:PeerNotifySettings exported_invite:ExportedChatInvite bot_info:flags.3?Vector pinned_msg_id:flags.6?int = ChatFull;
+chatFull#22a235da flags:# can_set_username:flags.7?true id:int about:string participants:ChatParticipants chat_photo:flags.2?Photo notify_settings:PeerNotifySettings exported_invite:ExportedChatInvite bot_info:flags.3?Vector pinned_msg_id:flags.6?int = ChatFull;
channelFull#1c87a71a flags:# can_view_participants:flags.3?true can_set_username:flags.6?true can_set_stickers:flags.7?true hidden_prehistory:flags.10?true can_view_stats:flags.12?true id:int about:string participants_count:flags.0?int admins_count:flags.1?int kicked_count:flags.2?int banned_count:flags.2?int online_count:flags.13?int read_inbox_max_id:int read_outbox_max_id:int unread_count:int chat_photo:Photo notify_settings:PeerNotifySettings exported_invite:ExportedChatInvite bot_info:Vector migrated_from_chat_id:flags.4?int migrated_from_max_id:flags.4?int pinned_msg_id:flags.5?int stickerset:flags.8?StickerSet available_min_id:flags.9?int = ChatFull;
chatParticipant#c8d7493e user_id:int inviter_id:int date:int = ChatParticipant;
@@ -163,6 +163,7 @@ photo#9c477dd8 flags:# has_stickers:flags.0?true id:long access_hash:long file_r
photoSizeEmpty#e17e23c type:string = PhotoSize;
photoSize#77bfb61b type:string location:FileLocation w:int h:int size:int = PhotoSize;
photoCachedSize#e9a734fa type:string location:FileLocation w:int h:int bytes:bytes = PhotoSize;
+photoStrippedSize#e0b0bc2e type:string bytes:bytes = PhotoSize;
geoPointEmpty#1117dd5f = GeoPoint;
geoPoint#296f104 long:double lat:double access_hash:long = GeoPoint;
@@ -186,8 +187,7 @@ peerNotifySettings#af509d20 flags:# show_previews:flags.0?Bool silent:flags.1?Bo
peerSettings#818426cd flags:# report_spam:flags.0?true = PeerSettings;
-wallPaper#ccb03657 id:int title:string sizes:Vector color:int = WallPaper;
-wallPaperSolid#63117f24 id:int title:string bg_color:int color:int = WallPaper;
+wallPaper#a437c3ed id:long flags:# creator:flags.0?true default:flags.1?true pattern:flags.3?true dark:flags.4?true access_hash:long slug:string document:Document settings:flags.2?WallPaperSettings = WallPaper;
inputReportReasonSpam#58dbcab8 = ReportReason;
inputReportReasonViolence#1e22c78d = ReportReason;
@@ -221,7 +221,7 @@ messages.dialogsSlice#71e094f3 count:int dialogs:Vector
-
@@ -67,7 +67,7 @@ Features
- **Fast**: Crypto parts are boosted up by TgCrypto_, a high-performance library written in pure C.
- **Documented**: Pyrogram API methods, types and public interfaces are well documented.
- **Type-hinted**: Exposed Pyrogram types and method parameters are all type-hinted.
-- **Updated**, to the latest Telegram API version, currently Layer 91 on top of `MTProto 2.0`_.
+- **Updated**, to the latest Telegram API version, currently Layer 97 on top of `MTProto 2.0`_.
- **Pluggable**: The Smart Plugin system allows to write components with minimal boilerplate code.
- **Comprehensive**: Execute any advanced action an official client is able to do, and even more.
@@ -115,7 +115,7 @@ To get started, press the Next button.
functions/index
types/index
-.. _`Telegram`: https://telegram.org/
-.. _TgCrypto: https://docs.pyrogram.ml/resources/TgCrypto/
+.. _`Telegram`: https://telegram.org
+.. _TgCrypto: https://docs.pyrogram.ml/resources/TgCrypto
.. _`MTProto API`: https://core.telegram.org/api#telegram-api
-.. _`MTProto 2.0`: https://core.telegram.org/mtproto
\ No newline at end of file
+.. _`MTProto 2.0`: https://core.telegram.org/mtproto
diff --git a/docs/source/pyrogram/Client.rst b/docs/source/pyrogram/Client.rst
index 548f1c5b..dcf8bb79 100644
--- a/docs/source/pyrogram/Client.rst
+++ b/docs/source/pyrogram/Client.rst
@@ -31,6 +31,7 @@ Decorators
on_message
on_callback_query
+ on_inline_query
on_deleted_messages
on_user_status
on_disconnect
@@ -56,6 +57,7 @@ Messages
send_location
send_venue
send_contact
+ send_cached_media
send_chat_action
edit_message_text
edit_message_caption
@@ -67,6 +69,7 @@ Messages
iter_history
send_poll
vote_poll
+ close_poll
retract_vote
download_media
@@ -97,6 +100,8 @@ Chats
iter_chat_members
get_dialogs
iter_dialogs
+ restrict_chat
+ update_chat_username
Users
-----
@@ -109,6 +114,7 @@ Users
get_user_profile_photos
set_user_profile_photo
delete_user_profile_photos
+ update_username
Contacts
--------
@@ -139,10 +145,12 @@ Bots
get_inline_bot_results
send_inline_bot_result
answer_callback_query
+ answer_inline_query
request_callback_answer
send_game
set_game_score
get_game_high_scores
+ answer_inline_query
.. autoclass:: pyrogram.Client
diff --git a/docs/source/pyrogram/Handlers.rst b/docs/source/pyrogram/Handlers.rst
index 3b748e9d..1bb16ece 100644
--- a/docs/source/pyrogram/Handlers.rst
+++ b/docs/source/pyrogram/Handlers.rst
@@ -9,6 +9,7 @@ Handlers
MessageHandler
DeletedMessagesHandler
CallbackQueryHandler
+ InlineQueryHandler
UserStatusHandler
DisconnectHandler
RawUpdateHandler
@@ -22,6 +23,9 @@ Handlers
.. autoclass:: CallbackQueryHandler
:members:
+.. autoclass:: InlineQueryHandler
+ :members:
+
.. autoclass:: UserStatusHandler
:members:
diff --git a/docs/source/pyrogram/Error.rst b/docs/source/pyrogram/RPCError.rst
similarity index 77%
rename from docs/source/pyrogram/Error.rst
rename to docs/source/pyrogram/RPCError.rst
index 2ec1159d..a47c9b9c 100644
--- a/docs/source/pyrogram/Error.rst
+++ b/docs/source/pyrogram/RPCError.rst
@@ -1,9 +1,8 @@
-Error
-=====
+RPCError
+========
-.. autoexception:: pyrogram.Error
+.. autoexception:: pyrogram.RPCError
:members:
- :show-inheritance:
.. toctree::
../errors/SeeOther
diff --git a/docs/source/pyrogram/Types.rst b/docs/source/pyrogram/Types.rst
index 6e0a14db..5deb58b2 100644
--- a/docs/source/pyrogram/Types.rst
+++ b/docs/source/pyrogram/Types.rst
@@ -16,6 +16,7 @@ Users & Chats
ChatPhoto
ChatMember
ChatMembers
+ ChatPermissions
Dialog
Dialogs
@@ -65,6 +66,7 @@ Input Media
.. autosummary::
:nosignatures:
+ InputMedia
InputMediaPhoto
InputMediaVideo
InputMediaAudio
@@ -72,6 +74,25 @@ Input Media
InputMediaDocument
InputPhoneContact
+Inline Mode
+------------
+
+.. autosummary::
+ :nosignatures:
+
+ InlineQuery
+ InlineQueryResult
+ InlineQueryResultArticle
+
+InputMessageContent
+-------------------
+
+.. autosummary::
+ :nosignatures:
+
+ InputMessageContent
+ InputTextMessageContent
+
.. User & Chats
------------
@@ -96,6 +117,9 @@ Input Media
.. autoclass:: ChatMembers
:members:
+.. autoclass:: ChatPermissions
+ :members:
+
.. autoclass:: Dialog
:members:
@@ -195,6 +219,9 @@ Input Media
.. Input Media
-----------
+.. autoclass:: InputMedia
+ :members:
+
.. autoclass:: InputMediaPhoto
:members:
@@ -212,3 +239,25 @@ Input Media
.. autoclass:: InputPhoneContact
:members:
+
+
+.. Inline Mode
+ -----------
+
+.. autoclass:: InlineQuery
+ :members:
+
+.. autoclass:: InlineQueryResult
+ :members:
+
+.. autoclass:: InlineQueryResultArticle
+ :members:
+
+.. InputMessageContent
+ -------------------
+
+.. autoclass:: InputMessageContent
+ :members:
+
+.. autoclass:: InputTextMessageContent
+ :members:
diff --git a/docs/source/pyrogram/index.rst b/docs/source/pyrogram/index.rst
index 20e7c918..286b5db1 100644
--- a/docs/source/pyrogram/index.rst
+++ b/docs/source/pyrogram/index.rst
@@ -15,6 +15,6 @@ after the well established `Telegram Bot API`_ methods, thus offering a familiar
Filters
ChatAction
ParseMode
- Error
+ RPCError
.. _Telegram Bot API: https://core.telegram.org/bots/api#available-methods
diff --git a/docs/source/resources/AdvancedUsage.rst b/docs/source/resources/AdvancedUsage.rst
index 02395f26..8b722b2a 100644
--- a/docs/source/resources/AdvancedUsage.rst
+++ b/docs/source/resources/AdvancedUsage.rst
@@ -1,40 +1,102 @@
Advanced Usage
==============
-In this section, you'll be shown the alternative way of communicating with Telegram using Pyrogram: the main Telegram
-API with its raw functions and types.
+Pyrogram's API, which consists of well documented convenience methods_ and facade types_, exists to provide a much
+easier interface to the undocumented and often confusing Telegram API.
+
+In this section, you'll be shown the alternative way of communicating with Telegram using Pyrogram: the main "raw"
+Telegram API with its functions and types.
Telegram Raw API
----------------
If you can't find a high-level method for your needs or if you want complete, low-level access to the whole
-Telegram API, you have to use the raw :mod:`functions ` and :mod:`types `
-exposed by the ``pyrogram.api`` package and call any Telegram API method you wish using the
-:meth:`send() ` method provided by the Client class.
+Telegram API, you have to use the raw :mod:`functions ` and :mod:`types `.
+
+As already hinted, raw functions and types can be really confusing, mainly because people don't realize soon enough they
+accept *only* the right types and that all required parameters must be filled in. This section will therefore explain
+some pitfalls to take into consideration when working with the raw API.
.. hint::
- Every available high-level method mentioned in the previous page is built on top of these raw functions.
+ Every available high-level methods in Pyrogram is built on top of these raw functions.
Nothing stops you from using the raw functions only, but they are rather complex and `plenty of them`_ are already
- re-implemented by providing a much simpler and cleaner interface which is very similar to the Bot API.
+ re-implemented by providing a much simpler and cleaner interface which is very similar to the Bot API (yet much more
+ powerful).
If you think a raw function should be wrapped and added as a high-level method, feel free to ask in our Community_!
-Caveats
--------
+Invoking Functions
+^^^^^^^^^^^^^^^^^^
-As hinted before, raw functions and types can be confusing, mainly because people don't realize they must accept
-*exactly* the right values, but also because most of them don't have enough Python experience to fully grasp how things
-work.
+Unlike the methods_ found in Pyrogram's API, which can be called in the usual simple way, functions to be invoked from
+the raw Telegram API have a different way of usage and are more complex.
-This section will therefore explain some pitfalls to take into consideration when working with the raw API.
+First of all, both `raw functions`_ and `raw types`_ live in their respective packages (and sub-packages):
+``pyrogram.api.functions``, ``pyrogram.api.types``. They all exist as Python classes, meaning you need to create an
+instance of each every time you need them and fill them in with the correct values using named arguments.
+
+Next, to actually invoke the raw function you have to use the :meth:`send() ` method provided by
+the Client class and pass the function object you created.
+
+Here's some examples:
+
+- Update first name, last name and bio:
+
+ .. code-block:: python
+
+ from pyrogram import Client
+ from pyrogram.api import functions
+
+ with Client("my_account") as app:
+ app.send(
+ functions.account.UpdateProfile(
+ first_name="Dan", last_name="Tès",
+ about="Bio written from Pyrogram"
+ )
+ )
+
+- Disable links to your account when someone forwards your messages:
+
+ .. code-block:: python
+
+ from pyrogram import Client
+ from pyrogram.api import functions, types
+
+ with Client("my_account") as app:
+ app.send(
+ functions.account.SetPrivacy(
+ key=types.PrivacyKeyForwards(),
+ rules=[types.InputPrivacyValueDisallowAll()]
+ )
+ )
+
+- Invite users to your channel/supergroup:
+
+ .. code-block:: python
+
+ from pyrogram import Client
+ from pyrogram.api import functions, types
+
+ with Client("my_account") as app:
+ app.send(
+ functions.channels.InviteToChannel(
+ channel=app.resolve_peer(123456789), # ID or Username
+ users=[ # The users you want to invite
+ app.resolve_peer(23456789), # By ID
+ app.resolve_peer("username"), # By username
+ app.resolve_peer("+393281234567"), # By phone number
+ ]
+ )
+ )
Chat IDs
^^^^^^^^
The way Telegram works makes it impossible to directly send a message to a user or a chat by using their IDs only.
-Instead, a pair of ``id`` and ``access_hash`` wrapped in a so called ``InputPeer`` is always needed.
+Instead, a pair of ``id`` and ``access_hash`` wrapped in a so called ``InputPeer`` is always needed. Pyrogram allows
+sending messages with IDs only thanks to cached access hashes.
There are three different InputPeer types, one for each kind of Telegram entity.
Whenever an InputPeer is needed you must pass one of these:
@@ -56,66 +118,19 @@ kind of ID.
For example, given the ID *123456789*, here's how Pyrogram can tell entities apart:
- - ``+ID`` - User: *123456789*
- - ``-ID`` - Chat: *-123456789*
- - ``-100ID`` - Channel (and Supergroup): *-100123456789*
+ - ``+ID`` User: *123456789*
+ - ``-ID`` Chat: *-123456789*
+ - ``-100ID`` Channel (and Supergroup): *-100123456789*
So, every time you take a raw ID, make sure to translate it into the correct ID when you want to use it with an
high-level method.
-Examples
---------
-
-- Update first name, last name and bio:
-
- .. code-block:: python
-
- from pyrogram import Client
- from pyrogram.api import functions
-
- with Client("my_account") as app:
- app.send(
- functions.account.UpdateProfile(
- first_name="Dan", last_name="Tès",
- about="Bio written from Pyrogram"
- )
- )
-
-- Share your Last Seen time only with your contacts:
-
- .. code-block:: python
-
- from pyrogram import Client
- from pyrogram.api import functions, types
-
- with Client("my_account") as app:
- app.send(
- functions.account.SetPrivacy(
- key=types.InputPrivacyKeyStatusTimestamp(),
- rules=[types.InputPrivacyValueAllowContacts()]
- )
- )
-
-- Invite users to your channel/supergroup:
-
- .. code-block:: python
-
- from pyrogram import Client
- from pyrogram.api import functions, types
-
- with Client("my_account") as app:
- app.send(
- functions.channels.InviteToChannel(
- channel=app.resolve_peer(123456789), # ID or Username
- users=[ # The users you want to invite
- app.resolve_peer(23456789), # By ID
- app.resolve_peer("username"), # By username
- app.resolve_peer("393281234567"), # By phone number
- ]
- )
- )
+
+.. _methods: ../pyrogram/Client.html#messages
+.. _types: ../pyrogram/Types.html
.. _plenty of them: ../pyrogram/Client.html#messages
-.. _Raw Functions: Usage.html#using-raw-functions
+.. _raw functions: ../pyrogram/functions
+.. _raw types: ../pyrogram/types
.. _Community: https://t.me/PyrogramChat
\ No newline at end of file
diff --git a/docs/source/resources/ConfigurationFile.rst b/docs/source/resources/ConfigurationFile.rst
index 759bfd9f..2a50277f 100644
--- a/docs/source/resources/ConfigurationFile.rst
+++ b/docs/source/resources/ConfigurationFile.rst
@@ -1,13 +1,13 @@
Configuration File
==================
-As already mentioned in previous sections, Pyrogram can also be configured by the use of an INI file.
+As already mentioned in previous sections, Pyrogram can be configured by the use of an INI file.
This page explains how this file is structured in Pyrogram, how to use it and why.
Introduction
------------
-The idea behind using a configuration file is to help keeping your code free of settings (private) information such as
+The idea behind using a configuration file is to help keeping your code free of private settings information such as
the API Key and Proxy without having you to even deal with how to load such settings. The configuration file, usually
referred as ``config.ini`` file, is automatically loaded from the root of your working directory; all you need to do is
fill in the necessary parts.
@@ -46,7 +46,7 @@ These are all the sections Pyrogram uses in its configuration file:
Pyrogram
^^^^^^^^
-The ``[pyrogram]`` section contains your Telegram API credentials *api_id* and *api_hash*.
+The ``[pyrogram]`` section contains your Telegram API credentials: *api_id* and *api_hash*.
.. code-block:: ini
diff --git a/docs/source/resources/CustomizeSessions.rst b/docs/source/resources/CustomizeSessions.rst
index e98792b7..77765287 100644
--- a/docs/source/resources/CustomizeSessions.rst
+++ b/docs/source/resources/CustomizeSessions.rst
@@ -1,19 +1,19 @@
Customize Sessions
==================
-As you may probably know, Telegram allows Users (and Bots) having more than one session (authorizations) registered
+As you may probably know, Telegram allows users (and bots) having more than one session (authorizations) registered
in the system at the same time.
Briefly explaining, sessions are simply new logins in your account. They can be reviewed in the settings of an official
-app (or by invoking `GetAuthorizations <../functions/account/GetAuthorizations.html>`_ with Pyrogram) and store some useful
-information about the client who generated them.
+app (or by invoking `GetAuthorizations <../functions/account/GetAuthorizations.html>`_ with Pyrogram). They store some
+useful information such as the client who's using them and from which country and IP address.
.. figure:: https://i.imgur.com/lzGPCdZ.png
:width: 70%
:align: center
- A Pyrogram session running on Linux, Python 3.6.
+ **A Pyrogram session running on Linux, Python 3.6.**
That's how a session looks like on the Android app, showing the three main pieces of information.
diff --git a/docs/source/resources/ErrorHandling.rst b/docs/source/resources/ErrorHandling.rst
index 1f08c165..7e87b94a 100644
--- a/docs/source/resources/ErrorHandling.rst
+++ b/docs/source/resources/ErrorHandling.rst
@@ -4,18 +4,18 @@ Error Handling
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
-(which are in turn children of the :obj:`pyrogram.Error` superclass)
+(which are in turn children of the :obj:`RPCError ` superclass):
-- :obj:`303 - See Other `
-- :obj:`400 - Bad Request `
-- :obj:`401 - Unauthorized `
-- :obj:`403 - Forbidden `
-- :obj:`406 - Not Acceptable `
-- :obj:`420 - Flood `
-- :obj:`500 - Internal Server Error `
+- :obj:`303 - See Other `
+- :obj:`400 - Bad Request `
+- :obj:`401 - Unauthorized `
+- :obj:`403 - Forbidden `
+- :obj:`406 - Not Acceptable `
+- :obj:`420 - Flood `
+- :obj:`500 - Internal Server Error `
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 ` exception and logs it
+specific one, it raises a special :obj:`520 Unknown Error ` exception and logs it
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.
@@ -24,7 +24,7 @@ Examples
.. code-block:: python
- from pyrogram.api.errors import (
+ from pyrogram.errors import (
BadRequest, Flood, InternalServerError,
SeeOther, Unauthorized, UnknownError
)
@@ -45,13 +45,13 @@ Examples
pass
Exception objects may also contain some informative values.
-E.g.: :obj:`FloodWait ` holds the amount of seconds you have to wait
+E.g.: :obj:`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:
.. code-block:: python
import time
- from pyrogram.api.errors import FloodWait
+ from pyrogram.errors import FloodWait
try:
...
diff --git a/docs/source/resources/MoreOnUpdates.rst b/docs/source/resources/MoreOnUpdates.rst
index 9712a5d2..f3658c6e 100644
--- a/docs/source/resources/MoreOnUpdates.rst
+++ b/docs/source/resources/MoreOnUpdates.rst
@@ -1,24 +1,22 @@
More on Updates
===============
-Here we'll show some advanced usages when working with updates.
-
-.. note::
- This page makes use of Handlers and Filters to show you how to handle updates.
- Learn more at `Update Handling `_ and `Using Filters `_.
+Here we'll show some advanced usages when working with `update handlers`_ and `filters`_.
Handler Groups
--------------
-If you register handlers with overlapping filters, only the first one is executed and any other handler will be ignored.
+If you register handlers with overlapping (conflicting) filters, only the first one is executed and any other handler
+will be ignored. This is intended by design.
-In order to process the same update more than once, you can register your handler in a different group.
-Groups are identified by a number (number 0 being the default) and are sorted, that is, a lower group number has a
-higher priority.
+In order to handle the very same update more than once, you have to register your handler in a different dispatching
+group. Dispatching groups hold one or more handlers and are processed sequentially, they are identified by a number
+(number 0 being the default) and sorted, that is, a lower group number has a higher priority:
-For example, in:
+For example, take these two handlers:
.. code-block:: python
+ :emphasize-lines: 1, 6
@app.on_message(Filters.text | Filters.sticker)
def text_or_sticker(client, message):
@@ -29,8 +27,8 @@ For example, in:
def just_text(client, message):
print("Just Text")
-``just_text`` is never executed because ``text_or_sticker`` already handles texts. To enable it, simply register the
-function using a different group:
+Here, ``just_text`` is never executed because ``text_or_sticker``, which has been registered first, already handles
+texts (``Filters.text`` is shared and conflicting). To enable it, register the function using a different group:
.. code-block:: python
@@ -69,7 +67,7 @@ continue to propagate the same update to the next groups until all the handlers
@app.on_message(Filters.private, group=1)
def _(client, message):
- print(1 / 0) # Unhandled exception: ZeroDivisionError
+ raise Exception("Unhandled exception!") # Simulate an unhandled exception
@app.on_message(Filters.private, group=2)
@@ -82,7 +80,7 @@ The output for each incoming update will therefore be:
.. code-block:: text
0
- ZeroDivisionError: division by zero
+ Exception: Unhandled exception!
2
Stop Propagation
@@ -153,9 +151,9 @@ Continue Propagation
As opposed to `stopping the update propagation <#stop-propagation>`_ and also as an alternative to the
`handler groups <#handler-groups>`_, you can signal the internal dispatcher to continue the update propagation within
-the group regardless of the next handler's filters. This allows you to register multiple handlers with overlapping
-filters in the same group; to let the dispatcher process the next handler you can do *one* of the following in each
-handler you want to grant permission to continue:
+**the same group** regardless of the next handler's filters. This allows you to register multiple handlers with
+overlapping filters in the same group; to let the dispatcher process the next handler you can do *one* of the following
+in each handler you want to grant permission to continue:
- Call the update's bound-method ``.continue_propagation()`` (preferred way).
- Manually ``raise ContinuePropagation`` exception (more suitable for raw updates only).
@@ -218,4 +216,7 @@ The output of both (equivalent) examples will be:
0
1
- 2
\ No newline at end of file
+ 2
+
+.. _`update handlers`: UpdateHandling.html
+.. _`filters`: UsingFilters.html
\ No newline at end of file
diff --git a/docs/source/resources/SmartPlugins.rst b/docs/source/resources/SmartPlugins.rst
index 972efdd8..6f266590 100644
--- a/docs/source/resources/SmartPlugins.rst
+++ b/docs/source/resources/SmartPlugins.rst
@@ -13,8 +13,8 @@ Introduction
------------
Prior to the Smart Plugin system, pluggable handlers were already possible. For example, if you wanted to modularize
-your applications, you had to put your function definitions in separate files and register them inside your main script,
-like this:
+your applications, you had to put your function definitions in separate files and register them inside your main script
+after importing your modules, like this:
.. note::
@@ -72,7 +72,7 @@ functions. So, what if you could? Smart Plugins solve this issue by taking care
Using Smart Plugins
-------------------
-Setting up your Pyrogram project to accommodate Smart Plugins is straightforward:
+Setting up your Pyrogram project to accommodate Smart Plugins is pretty straightforward:
#. Create a new folder to store all the plugins (e.g.: "plugins", "handlers", ...).
#. Put your python files full of plugins inside. Organize them as you wish.
@@ -129,18 +129,17 @@ Setting up your Pyrogram project to accommodate Smart Plugins is straightforward
from pyrogram import Client
- plugins = dict(
- root="plugins"
- )
+ plugins = dict(root="plugins")
Client("my_account", plugins=plugins).run()
+
The first important thing to note is the new ``plugins`` folder. You can put *any python file* in *any subfolder* and
each file can contain *any decorated function* (handlers) with one limitation: within a single module (file) you must
use different names for each decorated function.
The second thing is telling Pyrogram where to look for your plugins: you can either use the *config.ini* file or
-the Client parameter "plugins"; the *root* value must match the name of your plugins folder. Your Pyrogram Client
+the Client parameter "plugins"; the *root* value must match the name of your plugins root folder. Your Pyrogram Client
instance will **automatically** scan the folder upon starting to search for valid handlers and register them for you.
Then you'll notice you can now use decorators. That's right, you can apply the usual decorators to your callback
@@ -161,7 +160,7 @@ found inside each module will be, instead, loaded in the order they are defined,
This default loading behaviour is usually enough, but sometimes you want to have more control on what to include (or
exclude) and in which exact order to load plugins. The way to do this is to make use of ``include`` and ``exclude``
-keys, either in the *config.ini* file or in the dictionary passed as Client argument. Here's how they work:
+directives, either in the *config.ini* file or in the dictionary passed as Client argument. Here's how they work:
- If both ``include`` and ``exclude`` are omitted, all plugins are loaded as described above.
- If ``include`` is given, only the specified plugins will be loaded, in the order they are passed.
@@ -214,9 +213,7 @@ also organized in subfolders:
.. code-block:: python
- plugins = dict(
- root="plugins"
- )
+ plugins = dict(root="plugins")
Client("my_account", plugins=plugins).run()
@@ -293,7 +290,7 @@ Load/Unload Plugins at Runtime
In the `previous section <#specifying-the-plugins-to-include>`_ we've explained how to specify which plugins to load and
which to ignore before your Client starts. Here we'll show, instead, how to unload and load again a previously
-registered plugins at runtime.
+registered plugin at runtime.
Each function decorated with the usual ``on_message`` decorator (or any other decorator that deals with Telegram updates
) will be modified in such a way that, when you reference them later on, they will be actually pointing to a tuple of
@@ -314,14 +311,14 @@ attribute. Here's an example:
- Printing ``echo`` will show something like ``(, 0)``.
-- Printing ``echo[0].callback``, that is, the *callback* attribute of the first eleent of the tuple, which is an
+- Printing ``echo[0].callback``, that is, the *callback* attribute of the first element of the tuple, which is an
Handler, will reveal the actual callback ````.
Unloading
^^^^^^^^^
-In order to unload a plugin, or any other handler, all you need to do is obtain a reference to it (by importing the
-relevant module) and call :meth:`remove_handler ` Client's method with your function
+In order to unload a plugin, or any other handler, all you need to do is obtain a reference to it by importing the
+relevant module and call :meth:`remove_handler() ` Client's method with your function
name preceded by the star ``*`` operator as argument. Example:
- ``main.py``
@@ -346,7 +343,7 @@ Loading
^^^^^^^
Similarly to the unloading process, in order to load again a previously unloaded plugin you do the same, but this time
-using :meth:`add_handler ` instead. Example:
+using :meth:`add_handler() ` instead. Example:
- ``main.py``
diff --git a/docs/source/resources/UpdateHandling.rst b/docs/source/resources/UpdateHandling.rst
index 12afe324..ed0ad909 100644
--- a/docs/source/resources/UpdateHandling.rst
+++ b/docs/source/resources/UpdateHandling.rst
@@ -1,11 +1,13 @@
Update Handling
===============
-Updates are events that happen in your Telegram account (incoming messages, new channel posts, new members join, ...)
-and can be handled by registering one or more callback functions in your app by using `Handlers <../pyrogram/Handlers.html>`_.
+Let's now dive right into the core of the framework.
-To put it simply, whenever an update is received from Telegram it will be dispatched and your previously defined callback
-function(s) matching it will be called back with the update itself as argument.
+Updates are events that happen in your Telegram account (incoming messages, new channel posts, new members join, ...)
+and are handled by registering one or more callback functions in your app using `Handlers <../pyrogram/Handlers.html>`_.
+
+Each handler deals with a specific event and once a matching update arrives from Telegram, your registered callback
+function will be called.
Registering an Handler
----------------------
@@ -15,13 +17,34 @@ To explain how handlers work let's have a look at the most used one, the
updates coming from all around your chats. Every other handler shares the same setup logic; you should not have troubles
settings them up once you learn from this section.
+Using add_handler()
+-------------------
+
+The :meth:`add_handler() ` method takes any handler instance that wraps around your defined
+callback function and registers it in your Client. Here's a full example that prints out the content of a message as
+soon as it arrives:
+
+.. code-block:: python
+
+ from pyrogram import Client, MessageHandler
+
+
+ def my_function(client, message):
+ print(message)
+
+
+ app = Client("my_account")
+
+ my_handler = MessageHandler(my_function)
+ app.add_handler(my_handler)
+
+ app.run()
Using Decorators
----------------
-The easiest and nicest way to register a MessageHandler is by decorating your function with the
-:meth:`on_message() ` decorator. Here's a full example that prints out the content
-of a message as soon as it arrives.
+A much nicer way to register a MessageHandler is by decorating your callback function with the
+:meth:`on_message() ` decorator, which will still make use of add_handler() under the hood.
.. code-block:: python
@@ -37,23 +60,13 @@ of a message as soon as it arrives.
app.run()
-Using add_handler()
--------------------
-If you prefer not to use decorators for any reason, there is an alternative way for registering Handlers.
-This is useful, for example, when you want to keep your callback functions in separate files.
+.. note::
-.. code-block:: python
+ Due to how these decorators work in Pyrogram, they will wrap your defined callback function in a tuple consisting of
+ ``(handler, group)``; this will be the value held by your function identifier (e.g.: *my_function* from the example
+ above).
- from pyrogram import Client, MessageHandler
-
-
- def my_handler(client, message):
- print(message)
-
-
- app = Client("my_account")
-
- app.add_handler(MessageHandler(my_handler))
-
- app.run()
+ In case, for some reason, you want to get your own function back after it has been decorated, you need to access
+ ``my_function[0].callback``, that is, the *callback* field of the *handler* object which is the first element in the
+ tuple.
\ No newline at end of file
diff --git a/docs/source/resources/UsingFilters.rst b/docs/source/resources/UsingFilters.rst
index 3fe87b8a..ec3e2e10 100644
--- a/docs/source/resources/UsingFilters.rst
+++ b/docs/source/resources/UsingFilters.rst
@@ -1,17 +1,19 @@
Using Filters
=============
-For a finer grained control over what kind of messages will be allowed or not in your callback functions, you can use
-:class:`Filters `.
+So far we've seen how to register a callback function that executes every time a specific update comes from the server,
+but there's much more than that to come.
-.. note::
- This page makes use of Handlers to show you how to handle updates.
- Learn more at `Update Handling `_.
+Here we'll discuss about :class:`Filters `. Filters enable a fine-grain control over what kind of
+updates are allowed or not to be passed in your callback functions, based on their inner details.
+
+Let's start right away with a simple example:
- This example will show you how to **only** handle messages containing an :obj:`Audio ` object and
- ignore any other message:
+ ignore any other message. Filters are passed as the first argument of the decorator:
.. code-block:: python
+ :emphasize-lines: 4
from pyrogram import Filters
@@ -20,9 +22,10 @@ For a finer grained control over what kind of messages will be allowed or not in
def my_handler(client, message):
print(message)
-- or, without decorators:
+- or, without decorators. Here filters are passed as the second argument of the handler constructor:
.. code-block:: python
+ :emphasize-lines: 8
from pyrogram import Filters, MessageHandler
@@ -37,7 +40,7 @@ Combining Filters
-----------------
Filters can also be used in a more advanced way by inverting and combining more filters together using bitwise
-operators:
+operators ``~``, ``&`` and ``|``:
- Use ``~`` to invert a filter (behaves like the ``not`` operator).
- Use ``&`` and ``|`` to merge two filters (behave like ``and``, ``or`` operators respectively).
@@ -74,7 +77,7 @@ can also accept arguments:
def my_handler(client, message):
print(message)
-- Message is a **text** message matching the given **regex** pattern.
+- Message is a **text** message or a media **caption** matching the given **regex** pattern.
.. code-block:: python
@@ -104,17 +107,17 @@ Custom Filters
--------------
Pyrogram already provides lots of built-in :class:`Filters ` to work with, but in case you can't find
-a specific one for your needs or want to build a custom filter by yourself (to be used in a different handler, for
-example) you can use :meth:`Filters.create() `.
+a specific one for your needs or want to build a custom filter by yourself (to be used in a different kind of handler,
+for example) you can use :meth:`Filters.create() `.
.. note::
At the moment, the built-in filters are intended to be used with the :obj:`MessageHandler `
only.
An example to demonstrate how custom filters work is to show how to create and use one for the
-:obj:`CallbackQueryHandler `. Note that callback queries updates are only received by Bots;
-create and `authorize your bot <../start/Setup.html#bot-authorization>`_, then send a message with an inline keyboard to
-yourself. This allows you to test your filter by pressing the inline button:
+:obj:`CallbackQueryHandler `. Note that callback queries updates are only received by
+bots; create and `authorize your bot <../start/Setup.html#bot-authorization>`_, then send a message with an inline
+keyboard to yourself. This allows you to test your filter by pressing the inline button:
.. code-block:: python
@@ -133,26 +136,27 @@ Basic Filters
For this basic filter we will be using only the first two parameters of :meth:`Filters.create() `.
-The code below creates a simple filter for hardcoded callback data. This filter will only allow callback queries
-containing "pyrogram" as data:
+The code below creates a simple filter for hardcoded, static callback data. This filter will only allow callback queries
+containing "Pyrogram" as data, that is, the function *func* you pass returns True in case the callback query data
+equals to ``b"Pyrogram"``.
.. code-block:: python
- hardcoded_data = Filters.create(
- name="HardcodedData",
- func=lambda filter, callback_query: callback_query.data == b"pyrogram"
+ static_data = Filters.create(
+ name="StaticdData",
+ func=lambda flt, callback_query: callback_query.data == b"Pyrogram"
)
The ``lambda`` operator in python is used to create small anonymous functions and is perfect for this example, the same
-could be achieved with a normal function, but we don't really need it as it makes sense only inside the filter itself:
+could be achieved with a normal function, but we don't really need it as it makes sense only inside the filter's scope:
.. code-block:: python
- def func(filter, callback_query):
- return callback_query.data == b"pyrogram"
+ def func(flt, callback_query):
+ return callback_query.data == b"Pyrogram"
- hardcoded_data = Filters.create(
- name="HardcodedData",
+ static_data = Filters.create(
+ name="StaticData",
func=func
)
@@ -160,14 +164,14 @@ The filter usage remains the same:
.. code-block:: python
- @app.on_callback_query(hardcoded_data)
+ @app.on_callback_query(static_data)
def pyrogram_data(client, callback_query):
client.answer_callback_query(callback_query.id, "it works!")
Filters with Arguments
^^^^^^^^^^^^^^^^^^^^^^
-A much cooler filter would be one that accepts "pyrogram" or any other data as argument at usage time.
+A much cooler filter would be one that accepts "Pyrogram" or any other data as argument at usage time.
A dynamic filter like this will make use of the third parameter of :meth:`Filters.create() `.
This is how a dynamic custom filter looks like:
@@ -177,7 +181,7 @@ This is how a dynamic custom filter looks like:
def dynamic_data(data):
return Filters.create(
name="DynamicData",
- func=lambda filter, callback_query: filter.data == callback_query.data,
+ func=lambda flt, callback_query: flt.data == callback_query.data,
data=data # "data" kwarg is accessed with "filter.data"
)
@@ -185,6 +189,6 @@ And its usage:
.. code-block:: python
- @app.on_callback_query(dynamic_data(b"pyrogram"))
+ @app.on_callback_query(dynamic_data(b"Pyrogram"))
def pyrogram_data(client, callback_query):
client.answer_callback_query(callback_query.id, "it works!")
\ No newline at end of file
diff --git a/docs/source/start/Installation.rst b/docs/source/start/Installation.rst
index c5c6cb31..079e1b1f 100644
--- a/docs/source/start/Installation.rst
+++ b/docs/source/start/Installation.rst
@@ -1,11 +1,11 @@
Installation
============
-Being a Python library, Pyrogram requires Python to be installed in your system.
+Being a Python library, **Pyrogram** requires Python to be installed in your system.
We recommend using the latest version of Python 3 and pip.
-Get Python 3 from https://www.python.org/downloads/ (or with your package manager) and pip
-by following the instructions at https://pip.pypa.io/en/latest/installing/.
+- Get **Python 3** from https://www.python.org/downloads/ (or with your package manager)
+- Get **pip** by following the instructions at https://pip.pypa.io/en/latest/installing/.
.. important::
@@ -29,8 +29,12 @@ Install Pyrogram
Bleeding Edge
-------------
-If you want the latest development version of Pyrogram, you can install it straight from the develop_
-branch using this command (note "develop.zip" in the link):
+Things are constantly evolving in Pyrogram, although new releases are published only when enough changes are added,
+but this doesn't mean you can't try new features right now!
+
+In case you would like to try out the latest Pyrogram features and additions, the `GitHub repo`_ is always kept updated
+with new changes; you can install the development version straight from the ``develop`` branch using this command
+(note "develop.zip" in the link):
.. code-block:: text
@@ -39,10 +43,10 @@ branch using this command (note "develop.zip" in the link):
Asynchronous
------------
-Pyrogram heavily depends on IO-bound network code (it's a cloud-based messaging client library after all), and here's
+Pyrogram heavily depends on IO-bound network code (it's a cloud-based messaging framework after all), and here's
where asyncio shines the most by providing extra performance while running on a single OS-level thread only.
-**A fully asynchronous variant of Pyrogram is therefore available** (Python 3.5+ required).
+**A fully asynchronous variant of Pyrogram is therefore available** (Python 3.5.3+ required).
Use this command to install (note "asyncio.zip" in the link):
.. code-block:: text
@@ -82,7 +86,7 @@ If no error shows up you are good to go.
>>> import pyrogram
>>> pyrogram.__version__
- '0.11.0'
+ '0.12.0'
.. _TgCrypto: https://docs.pyrogram.ml/resources/TgCrypto
-.. _develop: http://github.com/pyrogram/pyrogram
+.. _`Github repo`: http://github.com/pyrogram/pyrogram
diff --git a/docs/source/start/Setup.rst b/docs/source/start/Setup.rst
index 24caa1f4..45a40d16 100644
--- a/docs/source/start/Setup.rst
+++ b/docs/source/start/Setup.rst
@@ -15,23 +15,22 @@ If you already have one you can skip this step, otherwise:
#. Fill out the form to register a new Telegram application.
#. Done. The API key consists of two parts: **App api_id** and **App api_hash**.
-
.. important::
- This API key is personal and should be kept secret.
+ This API key is personal and must be kept secret.
Configuration
-------------
The API key obtained in the `previous step <#api-keys>`_ defines a token for your application allowing you to access
-the Telegram database using the MTProto API — **it is therefore required for all authorizations of both Users and Bots**.
+the Telegram database using the MTProto API — **it is therefore required for all authorizations of both users and bots**.
Having it handy, it's time to configure your Pyrogram project. There are two ways to do so, and you can choose what
fits better for you:
- Create a new ``config.ini`` file at the root of your working directory, copy-paste the following and replace the
- **api_id** and **api_hash** values with your own. This is the preferred method because allows you
- to keep your credentials out of your code without having to deal with how to load them:
+ **api_id** and **api_hash** values with your own. This is the preferred method because allows you to keep your
+ credentials out of your code without having to deal with how to load them:
.. code-block:: ini
@@ -39,8 +38,8 @@ fits better for you:
api_id = 12345
api_hash = 0123456789abcdef0123456789abcdef
-- Alternatively, you can pass your API key to Pyrogram by simply using the *api_id* and *api_hash*
- parameters of the Client class. This way you can have full control on how to store and load your credentials:
+- Alternatively, you can pass your API key to Pyrogram by simply using the *api_id* and *api_hash* parameters of the
+ Client class. This way you can have full control on how to store and load your credentials:
.. code-block:: python
@@ -54,16 +53,16 @@ fits better for you:
.. note::
- The examples below assume you have created a ``config.ini`` file, thus they won't show the *api_id*
- and *api_hash* parameters usage.
+ From now on, the code snippets assume you are using the ``config.ini`` file, thus they won't show the *api_id* and
+ *api_hash* parameters usage to keep them as clean as possible.
User Authorization
------------------
-In order to use the API, Telegram requires that Users be authorized via their phone numbers.
-Pyrogram automatically manages this access, all you need to do is create an instance of
-the :class:`Client ` class by passing to it a ``session_name`` of your choice
-(e.g.: "my_account") and call the :meth:`run() ` method:
+In order to use the API, Telegram requires that users be authorized via their phone numbers.
+Pyrogram automatically manages this access, all you need to do is create an instance of the
+:class:`Client ` class by passing to it a ``session_name`` of your choice (e.g.: "my_account") and call
+the :meth:`run() ` method:
.. code-block:: python
@@ -80,30 +79,40 @@ and the **phone code** you will receive:
Enter phone number: +39**********
Is "+39**********" correct? (y/n): y
Enter phone code: 32768
+ Logged in successfully as Dan
-After successfully authorizing yourself, a new file called ``my_account.session`` will be created allowing
-Pyrogram executing API calls with your identity. This file will be loaded again when you restart your app,
-and as long as you keep the session alive, Pyrogram won't ask you again to enter your phone number.
+After successfully authorizing yourself, a new file called ``my_account.session`` will be created allowing Pyrogram
+executing API calls with your identity. This file will be loaded again when you restart your app, and as long as you
+keep the session alive, Pyrogram won't ask you again to enter your phone number.
.. important::
Your ``*.session`` files are personal and must be kept secret.
+.. note::
+
+ The code above does nothing except asking for credentials and keeping the client online, hit ``CTRL+C`` now to stop
+ your application and keep reading.
+
Bot Authorization
-----------------
-Bots are a special kind of users and are authorized via their tokens (instead of phone numbers), which are created by
-BotFather_. Bot tokens replace the Users' phone numbers only — you still need to
-`configure a Telegram API key <#configuration>`_ with Pyrogram, even when using Bots.
+Bots are a special kind of users that are authorized via their tokens (instead of phone numbers), which are created by
+BotFather_. Bot tokens replace the users' phone numbers only — you still need to
+`configure a Telegram API key <#configuration>`_ with Pyrogram, even when using bots.
-The authorization process is automatically managed. All you need to do is pass the bot token as ``session_name``.
-The session file will be named after the Bot user_id, which is ``123456.session`` for the example below.
+The authorization process is automatically managed. All you need to do is choose a ``session_name`` (can be anything,
+usually your bot username) and pass your bot token using the ``bot_token`` parameter. The session file will be named
+after the session name, which will be ``pyrogrambot.session`` for the example below.
.. code-block:: python
from pyrogram import Client
- app = Client("123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11")
+ app = Client(
+ "pyrogrambot",
+ bot_token="123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11"
+ )
app.run()
.. _installed Pyrogram: Installation.html
diff --git a/docs/source/start/Usage.rst b/docs/source/start/Usage.rst
index 8bb197ab..35ae79a0 100644
--- a/docs/source/start/Usage.rst
+++ b/docs/source/start/Usage.rst
@@ -1,7 +1,7 @@
Usage
=====
-Having your `project set up`_ and your account authorized_, it's time to play with the API. Let's start!
+Having your `project set up`_ and your account authorized_, it's time to start playing with the API. Let's start!
High-level API
--------------
@@ -11,34 +11,36 @@ named after the `Telegram Bot API`_.
Here's a simple example:
- .. code-block:: python
+.. code-block:: python
- from pyrogram import Client
+ from pyrogram import Client
- app = Client("my_account")
+ app = Client("my_account")
- app.start()
+ app.start()
- print(app.get_me())
- app.send_message("me", "Hi there! I'm using **Pyrogram**")
- app.send_location("me", 51.500729, -0.124583)
+ print(app.get_me())
+ app.send_message("me", "Hi there! I'm using **Pyrogram**")
+ app.send_location("me", 51.500729, -0.124583)
+ app.send_sticker("me", "CAADBAADyg4AAvLQYAEYD4F7vcZ43AI")
- app.stop()
+ app.stop()
You can also use Pyrogram in a context manager with the ``with`` statement. The Client will automatically
:meth:`start ` and :meth:`stop ` gracefully, even in case of unhandled
exceptions in your code:
- .. code-block:: python
+.. code-block:: python
- from pyrogram import Client
+ from pyrogram import Client
- app = Client("my_account")
+ app = Client("my_account")
- with app:
- print(app.get_me())
- app.send_message("me", "Hi there! I'm using **Pyrogram**")
- app.send_location("me", 51.500729, -0.124583)
+ with app:
+ print(app.get_me())
+ app.send_message("me", "Hi there! I'm using **Pyrogram**")
+ app.send_location("me", 51.500729, -0.124583)
+ app.send_sticker("me", "CAADBAADyg4AAvLQYAEYD4F7vcZ43AI")
More examples on `GitHub `_.
@@ -46,4 +48,4 @@ More examples on `GitHub str:
- return dumps(self, cls=Encoder, indent=4)
-
- def __bool__(self) -> bool:
- return True
-
- def __eq__(self, other) -> bool:
- return self.__dict__ == other.__dict__
+ return dumps(self, indent=4, default=default, ensure_ascii=False)
def __len__(self) -> int:
return len(self.write())
- def __call__(self):
- pass
-
def __getitem__(self, item):
return getattr(self, item)
@@ -62,29 +55,18 @@ def remove_none(obj):
return obj
-class Encoder(JSONEncoder):
- def default(self, o: Object):
- try:
- content = o.__dict__
- except AttributeError:
- if isinstance(o, datetime):
- return o.strftime("%d-%b-%Y %H:%M:%S")
- else:
- return repr(o)
+def default(o: "Object"):
+ try:
+ content = {i: getattr(o, i) for i in o.__slots__}
- name = o.__class__.__name__
- o = objects.get(getattr(o, "ID", None), None)
-
- if o is not None:
- if o.startswith("pyrogram.client"):
- r = remove_none(OrderedDict([("_", "pyrogram:" + name)] + [i for i in content.items()]))
- r.pop("_client", None)
-
- return r
- else:
- return OrderedDict(
- [("_", o.replace("pyrogram.api.types.", "telegram:"))]
- + [i for i in content.items()]
- )
+ return remove_none(
+ OrderedDict(
+ [("_", o.QUALNAME)]
+ + [i for i in content.items()]
+ )
+ )
+ except AttributeError:
+ if isinstance(o, datetime):
+ return o.strftime("%d-%b-%Y %H:%M:%S")
else:
- return None
+ return repr(o)
diff --git a/pyrogram/client/__init__.py b/pyrogram/client/__init__.py
index 2719d82e..d43511d2 100644
--- a/pyrogram/client/__init__.py
+++ b/pyrogram/client/__init__.py
@@ -19,8 +19,7 @@
from .client import Client
from .ext import BaseClient, ChatAction, Emoji, ParseMode
from .filters import Filters
-from .handlers import (
- MessageHandler, DeletedMessagesHandler,
- CallbackQueryHandler, RawUpdateHandler,
- DisconnectHandler, UserStatusHandler
-)
+
+__all__ = [
+ "Client", "BaseClient", "ChatAction", "Emoji", "ParseMode", "Filters",
+]
diff --git a/pyrogram/client/client.py b/pyrogram/client/client.py
index 33b3f137..7ea06b3e 100644
--- a/pyrogram/client/client.py
+++ b/pyrogram/client/client.py
@@ -39,7 +39,11 @@ from typing import Union, List, Type
from pyrogram.api import functions, types
from pyrogram.api.core import Object
-from pyrogram.api.errors import (
+from pyrogram.client.handlers import DisconnectHandler
+from pyrogram.client.handlers.handler import Handler
+from pyrogram.client.methods.password.utils import compute_check
+from pyrogram.crypto import AES
+from pyrogram.errors import (
PhoneMigrate, NetworkMigrate, PhoneNumberInvalid,
PhoneNumberUnoccupied, PhoneCodeInvalid, PhoneCodeHashEmpty,
PhoneCodeExpired, PhoneCodeEmpty, SessionPasswordNeeded,
@@ -47,13 +51,8 @@ from pyrogram.api.errors import (
VolumeLocNotFound, UserMigrate, FileIdInvalid, ChannelPrivate, PhoneNumberOccupied,
PasswordRecoveryNa, PasswordEmpty
)
-from pyrogram.client.handlers import DisconnectHandler
-from pyrogram.client.handlers.handler import Handler
-from pyrogram.client.methods.password.utils import compute_check
-from pyrogram.crypto import AES
from pyrogram.session import Auth, Session
-from .dispatcher import Dispatcher
-from .ext import utils, Syncer, BaseClient
+from .ext import utils, Syncer, BaseClient, Dispatcher
from .methods import Methods
from .session_storage import (
SessionDoesNotExist, SessionStorage, MemorySessionStorage, JsonSessionStorage,
@@ -70,9 +69,10 @@ class Client(Methods, BaseClient):
Args:
session_name (``str``):
- Name to uniquely identify a session of either a User or a Bot, e.g.: "my_main_account".
- You still can use bot token here, but it will be deprecated in next release.
- Note: as long as a valid User session file exists, Pyrogram won't ask you again to input your phone number.
+ Name to uniquely identify a session of either a User or a Bot, e.g.: "my_account". This name will be used
+ to save a file to disk that stores details needed for reconnecting without asking again for credentials.
+ Note for bots: You can pass a bot token here, but this usage will be deprecated in next releases.
+ Use *bot_token* instead.
api_id (``int``, *optional*):
The *api_id* part of your Telegram API Key, as integer. E.g.: 12345
@@ -182,31 +182,35 @@ class Client(Methods, BaseClient):
Defaults to False (normal session).
"""
- def __init__(self,
- session_name: Union[str, SessionStorage],
- api_id: Union[int, str] = None,
- api_hash: str = None,
- app_version: str = None,
- device_model: str = None,
- system_version: str = None,
- lang_code: str = None,
- ipv6: bool = False,
- proxy: dict = None,
- test_mode: bool = False,
- phone_number: str = None,
- phone_code: Union[str, callable] = None,
- password: str = None,
- recovery_code: callable = None,
- force_sms: bool = False,
- bot_token: str = None,
- first_name: str = None,
- last_name: str = None,
- workers: int = BaseClient.WORKERS,
- workdir: str = BaseClient.WORKDIR,
- config_file: str = BaseClient.CONFIG_FILE,
- plugins: dict = None,
- no_updates: bool = None,
- takeout: bool = None):
+ terms_of_service_displayed = False
+
+ def __init__(
+ self,
+ session_name: str,
+ api_id: Union[int, str] = None,
+ api_hash: str = None,
+ app_version: str = None,
+ device_model: str = None,
+ system_version: str = None,
+ lang_code: str = None,
+ ipv6: bool = False,
+ proxy: dict = None,
+ test_mode: bool = False,
+ phone_number: str = None,
+ phone_code: Union[str, callable] = None,
+ password: str = None,
+ recovery_code: callable = None,
+ force_sms: bool = False,
+ bot_token: str = None,
+ first_name: str = None,
+ last_name: str = None,
+ workers: int = BaseClient.WORKERS,
+ workdir: str = BaseClient.WORKDIR,
+ config_file: str = BaseClient.CONFIG_FILE,
+ plugins: dict = None,
+ no_updates: bool = None,
+ takeout: bool = None
+ ):
if isinstance(session_name, str):
if session_name == ':memory:':
@@ -222,6 +226,8 @@ class Client(Methods, BaseClient):
super().__init__(session_storage)
+ super().__init__(session_storage)
+
self.session_name = str(session_name) # TODO: build correct session name
self.api_id = int(api_id) if api_id else None
self.api_hash = api_hash
@@ -277,7 +283,7 @@ class Client(Methods, BaseClient):
Requires no parameters.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
``ConnectionError`` in case you try to start an already started Client.
"""
if self.is_started:
@@ -288,10 +294,10 @@ class Client(Methods, BaseClient):
self.session_storage.is_bot = True
self.bot_token = self.session_storage._session_name
self.session_storage._session_name = self.session_storage._session_name.split(":")[0]
- warnings.warn('\nYou are using a bot token as session name.\n'
- 'It will be deprecated in next update, please use session file name to load '
- 'existing sessions and bot_token argument to create new sessions.',
- DeprecationWarning, stacklevel=2)
+ warnings.warn('\nWARNING: You are using a bot token as session name!\n'
+ 'This usage will be deprecated soon. Please use a session file name to load '
+ 'an existing session and the bot_token argument to create new sessions.\n'
+ 'More info: https://docs.pyrogram.ml/start/Setup#bot-authorization\n')
self.load_config()
self.load_session()
@@ -309,6 +315,7 @@ class Client(Methods, BaseClient):
try:
if self.session_storage.user_id is None:
if self.bot_token is None:
+ self.is_bot = False
self.authorize_user()
else:
self.session_storage.is_bot = True
@@ -446,7 +453,7 @@ class Client(Methods, BaseClient):
Requires no parameters.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
self.start()
self.idle()
@@ -558,9 +565,10 @@ class Client(Methods, BaseClient):
try:
r = self.send(
functions.auth.SendCode(
- self.phone_number,
- self.api_id,
- self.api_hash
+ phone_number=self.phone_number,
+ api_id=self.api_id,
+ api_hash=self.api_hash,
+ settings=types.CodeSettings()
)
)
except (PhoneMigrate, NetworkMigrate) as e:
@@ -604,8 +612,9 @@ class Client(Methods, BaseClient):
phone_code_hash = r.phone_code_hash
terms_of_service = r.terms_of_service
- if terms_of_service:
+ if terms_of_service and not Client.terms_of_service_displayed:
print("\n" + terms_of_service.text + "\n")
+ Client.terms_of_service_displayed = True
if self.force_sms:
self.send(
@@ -640,9 +649,9 @@ class Client(Methods, BaseClient):
try:
r = self.send(
functions.auth.SignIn(
- self.phone_number,
- phone_code_hash,
- self.phone_code
+ phone_number=self.phone_number,
+ phone_code_hash=phone_code_hash,
+ phone_code=self.phone_code
)
)
except PhoneNumberUnoccupied:
@@ -653,11 +662,11 @@ class Client(Methods, BaseClient):
try:
r = self.send(
functions.auth.SignUp(
- self.phone_number,
- phone_code_hash,
- self.phone_code,
- self.first_name,
- self.last_name
+ phone_number=self.phone_number,
+ phone_code_hash=phone_code_hash,
+ phone_code=self.phone_code,
+ first_name=self.first_name,
+ last_name=self.last_name
)
)
except PhoneNumberOccupied:
@@ -751,7 +760,11 @@ class Client(Methods, BaseClient):
break
if terms_of_service:
- assert self.send(functions.help.AcceptTermsOfService(terms_of_service.id))
+ assert self.send(
+ functions.help.AcceptTermsOfService(
+ id=terms_of_service.id
+ )
+ )
self.password = None
self.session_storage.user_id = r.user.id
@@ -992,16 +1005,16 @@ class Client(Methods, BaseClient):
Timeout in seconds.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
if not self.is_started:
raise ConnectionError("Client has not been started")
if self.no_updates:
- data = functions.InvokeWithoutUpdates(data)
+ data = functions.InvokeWithoutUpdates(query=data)
if self.takeout_id:
- data = functions.InvokeWithTakeout(self.takeout_id, data)
+ data = functions.InvokeWithTakeout(takeout_id=self.takeout_id, query=data)
r = self.session.send(data, retries, timeout)
@@ -1118,7 +1131,7 @@ class Client(Methods, BaseClient):
try:
module = import_module(module_path)
- except ModuleNotFoundError:
+ except ImportError:
log.warning('[LOAD] Ignoring non-existent module "{}"'.format(module_path))
continue
@@ -1154,7 +1167,7 @@ class Client(Methods, BaseClient):
try:
module = import_module(module_path)
- except ModuleNotFoundError:
+ except ImportError:
log.warning('[UNLOAD] Ignoring non-existent module "{}"'.format(module_path))
continue
@@ -1241,7 +1254,7 @@ class Client(Methods, BaseClient):
On success, the resolved peer id is returned in form of an InputPeer object.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
``KeyError`` in case the peer doesn't exist in the internal database.
"""
try:
@@ -1276,7 +1289,7 @@ class Client(Methods, BaseClient):
self.fetch_peers(
self.send(
functions.users.GetUsers(
- id=[types.InputUser(peer_id, 0)]
+ id=[types.InputUser(user_id=peer_id, access_hash=0)]
)
)
)
@@ -1284,7 +1297,7 @@ class Client(Methods, BaseClient):
if str(peer_id).startswith("-100"):
self.send(
functions.channels.GetChannels(
- id=[types.InputChannel(int(str(peer_id)[4:]), 0)]
+ id=[types.InputChannel(channel_id=int(str(peer_id)[4:]), access_hash=0)]
)
)
else:
@@ -1348,7 +1361,7 @@ class Client(Methods, BaseClient):
On success, the uploaded file is returned in form of an InputFile object.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
part_size = 512 * 1024
file_size = os.path.getsize(path)
@@ -1591,8 +1604,8 @@ class Client(Methods, BaseClient):
hashes = session.send(
functions.upload.GetCdnFileHashes(
- r.file_token,
- offset
+ file_token=r.file_token,
+ offset=offset
)
)
diff --git a/pyrogram/client/ext/__init__.py b/pyrogram/client/ext/__init__.py
index ce80958a..18c28ac3 100644
--- a/pyrogram/client/ext/__init__.py
+++ b/pyrogram/client/ext/__init__.py
@@ -18,6 +18,7 @@
from .base_client import BaseClient
from .chat_action import ChatAction
+from .dispatcher import Dispatcher
from .emoji import Emoji
from .parse_mode import ParseMode
from .syncer import Syncer
diff --git a/pyrogram/client/ext/base_client.py b/pyrogram/client/ext/base_client.py
index 1ec65c93..a8922846 100644
--- a/pyrogram/client/ext/base_client.py
+++ b/pyrogram/client/ext/base_client.py
@@ -74,8 +74,8 @@ class BaseClient:
self.rnd_id = MsgId
self.channels_pts = {}
- self.markdown = Markdown(self.session_storage)
- self.html = HTML(self.session_storage)
+ self.markdown = Markdown(self.session_storage, self)
+ self.html = HTML(self.session_storage, self)
self.session = None
self.media_sessions = {}
@@ -122,3 +122,6 @@ class BaseClient:
def get_chat_members_count(self, *args, **kwargs):
pass
+
+ def answer_inline_query(self, *args, **kwargs):
+ pass
diff --git a/pyrogram/client/dispatcher/dispatcher.py b/pyrogram/client/ext/dispatcher.py
similarity index 94%
rename from pyrogram/client/dispatcher/dispatcher.py
rename to pyrogram/client/ext/dispatcher.py
index 5a463077..7552b034 100644
--- a/pyrogram/client/dispatcher/dispatcher.py
+++ b/pyrogram/client/ext/dispatcher.py
@@ -24,7 +24,10 @@ from threading import Thread
import pyrogram
from pyrogram.api import types
-from ..handlers import CallbackQueryHandler, MessageHandler, RawUpdateHandler, UserStatusHandler, DeletedMessagesHandler
+from ..handlers import (
+ CallbackQueryHandler, MessageHandler, DeletedMessagesHandler,
+ UserStatusHandler, RawUpdateHandler, InlineQueryHandler
+)
log = logging.getLogger(__name__)
@@ -73,7 +76,10 @@ class Dispatcher:
(types.UpdateUserStatus,):
lambda upd, usr, cht: (
pyrogram.UserStatus._parse(self.client, upd.status, upd.user_id), UserStatusHandler
- )
+ ),
+
+ (types.UpdateBotInlineQuery,):
+ lambda upd, usr, cht: (pyrogram.InlineQuery._parse(self.client, upd, usr), InlineQueryHandler)
}
self.update_parsers = {key: value for key_tuple, value in self.update_parsers.items() for key in key_tuple}
diff --git a/pyrogram/client/ext/utils.py b/pyrogram/client/ext/utils.py
index 087773f4..981752fa 100644
--- a/pyrogram/client/ext/utils.py
+++ b/pyrogram/client/ext/utils.py
@@ -67,10 +67,10 @@ def get_peer_id(input_peer) -> int:
def get_input_peer(peer_id: int, access_hash: int):
return (
- types.InputPeerUser(peer_id, access_hash) if peer_id > 0
- else types.InputPeerChannel(int(str(peer_id)[4:]), access_hash)
+ types.InputPeerUser(user_id=peer_id, access_hash=access_hash) if peer_id > 0
+ else types.InputPeerChannel(channel_id=int(str(peer_id)[4:]), access_hash=access_hash)
if (str(peer_id).startswith("-100") and access_hash)
- else types.InputPeerChat(-peer_id)
+ else types.InputPeerChat(chat_id=-peer_id)
)
diff --git a/pyrogram/client/filters/filters.py b/pyrogram/client/filters/filters.py
index f5bcd5b5..4c6f0ce3 100644
--- a/pyrogram/client/filters/filters.py
+++ b/pyrogram/client/filters/filters.py
@@ -115,7 +115,7 @@ class Filters:
voice = create("Voice", lambda _, m: bool(m.voice))
"""Filter messages that contain :obj:`Voice ` note objects."""
- video_note = create("Voice", lambda _, m: bool(m.video_note))
+ video_note = create("VideoNote", lambda _, m: bool(m.video_note))
"""Filter messages that contain :obj:`VideoNote ` objects."""
contact = create("Contact", lambda _, m: bool(m.contact))
@@ -222,14 +222,16 @@ class Filters:
- poll"""
@staticmethod
- def command(command: str or list,
- prefix: str or list = "/",
- separator: str = " ",
- case_sensitive: bool = False):
+ def command(
+ commands: str or list,
+ prefix: str or list = "/",
+ separator: str = " ",
+ case_sensitive: bool = False
+ ):
"""Filter commands, i.e.: text messages starting with "/" or any other custom prefix.
Args:
- command (``str`` | ``list``):
+ commands (``str`` | ``list``):
The command or list of commands as string the filter should look for.
Examples: "start", ["start", "help", "settings"]. When a message text containing
a command arrives, the command itself and its arguments will be stored in the *command*
@@ -249,31 +251,25 @@ class Filters:
Examples: when True, command="Start" would trigger /Start but not /start.
"""
- def f(_, m):
- if m.text:
- for i in _.p:
- if m.text.startswith(i):
- t = m.text.split(_.s)
- c, a = t[0][len(i):], t[1:]
- c = c if _.cs else c.lower()
- m.command = ([c] + a) if c in _.c else None
+ def func(flt, message):
+ text = message.text or message.caption
+
+ if text:
+ for p in flt.p:
+ if text.startswith(p):
+ s = text.split(flt.s)
+ c, a = s[0][len(p):], s[1:]
+ c = c if flt.cs else c.lower()
+ message.command = ([c] + a) if c in flt.c else None
break
- return bool(m.command)
+ return bool(message.command)
- return create(
- "Command",
- f,
- c={command if case_sensitive
- else command.lower()}
- if not isinstance(command, list)
- else {c if case_sensitive
- else c.lower()
- for c in command},
- p=set(prefix) if prefix else {""},
- s=separator,
- cs=case_sensitive
- )
+ commands = commands if type(commands) is list else [commands]
+ commands = {c if case_sensitive else c.lower() for c in commands}
+ prefixes = set(prefix) if prefix else {""}
+
+ return create("Command", func=func, c=commands, p=prefixes, s=separator, cs=case_sensitive)
@staticmethod
def regex(pattern, flags: int = 0):
@@ -311,21 +307,20 @@ class Filters:
def __init__(self, users: int or str or list = None):
users = [] if users is None else users if type(users) is list else [users]
+
super().__init__(
- {"me" if i in ["me", "self"] else i.lower().strip("@") if type(i) is str else i for i in users}
- if type(users) is list else
- {"me" if users in ["me", "self"] else users.lower().strip("@") if type(users) is str else users}
+ "me" if u in ["me", "self"]
+ else u.lower().strip("@") if type(u) is str
+ else u for u in users
)
def __call__(self, message):
- return bool(
- message.from_user
- and (message.from_user.id in self
- or (message.from_user.username
- and message.from_user.username.lower() in self)
- or ("me" in self
- and message.from_user.is_self))
- )
+ return (message.from_user
+ and (message.from_user.id in self
+ or (message.from_user.username
+ and message.from_user.username.lower() in self)
+ or ("me" in self
+ and message.from_user.is_self)))
# noinspection PyPep8Naming
class chat(Filter, set):
@@ -343,21 +338,21 @@ class Filters:
def __init__(self, chats: int or str or list = None):
chats = [] if chats is None else chats if type(chats) is list else [chats]
+
super().__init__(
- {"me" if i in ["me", "self"] else i.lower().strip("@") if type(i) is str else i for i in chats}
- if type(chats) is list else
- {"me" if chats in ["me", "self"] else chats.lower().strip("@") if type(chats) is str else chats}
+ "me" if c in ["me", "self"]
+ else c.lower().strip("@") if type(c) is str
+ else c for c in chats
)
def __call__(self, message):
- return bool(
- message.chat
- and (message.chat.id in self
- or (message.chat.username
- and message.chat.username.lower() in self)
- or ("me" in self and message.from_user
- and message.from_user.is_self
- and not message.outgoing))
- )
+ return (message.chat
+ and (message.chat.id in self
+ or (message.chat.username
+ and message.chat.username.lower() in self)
+ or ("me" in self
+ and message.from_user
+ and message.from_user.is_self
+ and not message.outgoing)))
dan = create("Dan", lambda _, m: bool(m.from_user and m.from_user.id == 23122162))
diff --git a/pyrogram/client/handlers/__init__.py b/pyrogram/client/handlers/__init__.py
index 499ed007..5e392949 100644
--- a/pyrogram/client/handlers/__init__.py
+++ b/pyrogram/client/handlers/__init__.py
@@ -19,6 +19,12 @@
from .callback_query_handler import CallbackQueryHandler
from .deleted_messages_handler import DeletedMessagesHandler
from .disconnect_handler import DisconnectHandler
+from .inline_query_handler import InlineQueryHandler
from .message_handler import MessageHandler
from .raw_update_handler import RawUpdateHandler
from .user_status_handler import UserStatusHandler
+
+__all__ = [
+ "MessageHandler", "DeletedMessagesHandler", "CallbackQueryHandler", "RawUpdateHandler", "DisconnectHandler",
+ "UserStatusHandler", "InlineQueryHandler"
+]
diff --git a/pyrogram/client/handlers/inline_query_handler.py b/pyrogram/client/handlers/inline_query_handler.py
new file mode 100644
index 00000000..e59514c0
--- /dev/null
+++ b/pyrogram/client/handlers/inline_query_handler.py
@@ -0,0 +1,54 @@
+# Pyrogram - Telegram MTProto API Client Library for Python
+# Copyright (C) 2017-2018 Dan Tès
+#
+# This file is part of Pyrogram.
+#
+# Pyrogram is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Pyrogram is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Pyrogram. If not, see .
+
+from .handler import Handler
+
+
+class InlineQueryHandler(Handler):
+ """The InlineQuery handler class. Used to handle inline queries.
+ It is intended to be used with :meth:`add_handler() `
+
+ For a nicer way to register this handler, have a look at the
+ :meth:`on_inline_query() ` decorator.
+
+ Args:
+ callback (``callable``):
+ Pass a function that will be called when a new InlineQuery arrives. It takes *(client, inline_query)*
+ as positional arguments (look at the section below for a detailed description).
+
+ filters (:obj:`Filters `):
+ Pass one or more filters to allow only a subset of inline queries to be passed
+ in your callback function.
+
+ Other parameters:
+ client (:obj:`Client `):
+ The Client itself, useful when you want to call other API methods inside the inline query handler.
+
+ inline_query (:obj:`InlineQuery `):
+ The received inline query.
+ """
+
+ def __init__(self, callback: callable, filters=None):
+ super().__init__(callback, filters)
+
+ def check(self, callback_query):
+ return (
+ self.filters(callback_query)
+ if callable(self.filters)
+ else True
+ )
diff --git a/pyrogram/client/methods/bots/__init__.py b/pyrogram/client/methods/bots/__init__.py
index 65d132a0..916a62dc 100644
--- a/pyrogram/client/methods/bots/__init__.py
+++ b/pyrogram/client/methods/bots/__init__.py
@@ -17,6 +17,7 @@
# along with Pyrogram. If not, see .
from .answer_callback_query import AnswerCallbackQuery
+from .answer_inline_query import AnswerInlineQuery
from .get_game_high_scores import GetGameHighScores
from .get_inline_bot_results import GetInlineBotResults
from .request_callback_answer import RequestCallbackAnswer
@@ -27,6 +28,7 @@ from .set_game_score import SetGameScore
class Bots(
AnswerCallbackQuery,
+ AnswerInlineQuery,
GetInlineBotResults,
RequestCallbackAnswer,
SendInlineBotResult,
diff --git a/pyrogram/client/methods/bots/answer_callback_query.py b/pyrogram/client/methods/bots/answer_callback_query.py
index 5e8468e5..33458db9 100644
--- a/pyrogram/client/methods/bots/answer_callback_query.py
+++ b/pyrogram/client/methods/bots/answer_callback_query.py
@@ -21,12 +21,14 @@ from pyrogram.client.ext import BaseClient
class AnswerCallbackQuery(BaseClient):
- def answer_callback_query(self,
- callback_query_id: str,
- text: str = None,
- show_alert: bool = None,
- url: str = None,
- cache_time: int = 0):
+ def answer_callback_query(
+ self,
+ callback_query_id: str,
+ text: str = None,
+ show_alert: bool = None,
+ url: str = None,
+ cache_time: int = 0
+ ):
"""Use this method to send answers to callback queries sent from inline keyboards.
The answer will be displayed to the user as a notification at the top of the chat screen or as an alert.
@@ -55,7 +57,7 @@ class AnswerCallbackQuery(BaseClient):
True, on success.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
return self.send(
functions.messages.SetBotCallbackAnswer(
diff --git a/pyrogram/client/methods/bots/answer_inline_query.py b/pyrogram/client/methods/bots/answer_inline_query.py
new file mode 100644
index 00000000..7b3524b2
--- /dev/null
+++ b/pyrogram/client/methods/bots/answer_inline_query.py
@@ -0,0 +1,91 @@
+# Pyrogram - Telegram MTProto API Client Library for Python
+# Copyright (C) 2017-2018 Dan Tès
+#
+# This file is part of Pyrogram.
+#
+# Pyrogram is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Pyrogram is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Pyrogram. If not, see .
+
+from typing import List
+
+from pyrogram.api import functions, types
+from pyrogram.client.ext import BaseClient
+from ...types.inline_mode import InlineQueryResult
+
+
+class AnswerInlineQuery(BaseClient):
+ def answer_inline_query(
+ self,
+ inline_query_id: str,
+ results: List[InlineQueryResult],
+ cache_time: int = 300,
+ is_personal: bool = None,
+ next_offset: str = "",
+ switch_pm_text: str = "",
+ switch_pm_parameter: str = ""
+ ):
+ """Use this method to send answers to an inline query.
+ No more than 50 results per query are allowed.
+
+ Args:
+ inline_query_id (``str``):
+ Unique identifier for the answered query.
+
+ results (List of :obj:`InlineQueryResult `):
+ A list of results for the inline query.
+
+ cache_time (``int``, *optional*):
+ The maximum amount of time in seconds that the result of the inline query may be cached on the server.
+ Defaults to 300.
+
+ is_personal (``bool``, *optional*):
+ Pass True, if results may be cached on the server side only for the user that sent the query.
+ By default, results may be returned to any user who sends the same query.
+
+ next_offset (``str``, *optional*):
+ Pass the offset that a client should send in the next query with the same text to receive more results.
+ Pass an empty string if there are no more results or if you don‘t support pagination.
+ Offset length can’t exceed 64 bytes.
+
+ switch_pm_text (``str``, *optional*):
+ If passed, clients will display a button with specified text that switches the user to a private chat
+ with the bot and sends the bot a start message with the parameter switch_pm_parameter
+
+ switch_pm_parameter (``str``, *optional*):
+ `Deep-linking `_ parameter for the /start message sent to
+ the bot when user presses the switch button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed.
+
+ Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube
+ account to adapt search results accordingly. To do this, it displays a "Connect your YouTube account"
+ button above the results, or even before showing any. The user presses the button, switches to a private
+ chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an oauth
+ link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat
+ where they wanted to use the bot's inline capabilities.
+
+ Returns:
+ On success, True is returned.
+ """
+ return self.send(
+ functions.messages.SetInlineBotResults(
+ query_id=int(inline_query_id),
+ results=[r.write() for r in results],
+ cache_time=cache_time,
+ gallery=None,
+ private=is_personal or None,
+ next_offset=next_offset or None,
+ switch_pm=types.InlineBotSwitchPM(
+ text=switch_pm_text,
+ start_param=switch_pm_parameter
+ ) if switch_pm_text else None
+ )
+ )
diff --git a/pyrogram/client/methods/bots/get_game_high_scores.py b/pyrogram/client/methods/bots/get_game_high_scores.py
index ad4f8b4a..bb2e99db 100644
--- a/pyrogram/client/methods/bots/get_game_high_scores.py
+++ b/pyrogram/client/methods/bots/get_game_high_scores.py
@@ -24,10 +24,12 @@ from pyrogram.client.ext import BaseClient
class GetGameHighScores(BaseClient):
- def get_game_high_scores(self,
- user_id: Union[int, str],
- chat_id: Union[int, str],
- message_id: int = None):
+ def get_game_high_scores(
+ self,
+ user_id: Union[int, str],
+ chat_id: Union[int, str],
+ message_id: int = None
+ ):
"""Use this method to get data for high score tables.
Args:
@@ -50,7 +52,7 @@ class GetGameHighScores(BaseClient):
On success, a :obj:`GameHighScores ` object is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
# TODO: inline_message_id
diff --git a/pyrogram/client/methods/bots/get_inline_bot_results.py b/pyrogram/client/methods/bots/get_inline_bot_results.py
index e76a0d1d..b12c0439 100644
--- a/pyrogram/client/methods/bots/get_inline_bot_results.py
+++ b/pyrogram/client/methods/bots/get_inline_bot_results.py
@@ -19,17 +19,19 @@
from typing import Union
from pyrogram.api import functions, types
-from pyrogram.api.errors import UnknownError
+from pyrogram.errors import UnknownError
from pyrogram.client.ext import BaseClient
class GetInlineBotResults(BaseClient):
- def get_inline_bot_results(self,
- bot: Union[int, str],
- query: str,
- offset: str = "",
- latitude: float = None,
- longitude: float = None):
+ def get_inline_bot_results(
+ self,
+ bot: Union[int, str],
+ query: str,
+ offset: str = "",
+ latitude: float = None,
+ longitude: float = None
+ ):
"""Use this method to get bot results via inline queries.
You can then send a result using :obj:`send_inline_bot_result `
@@ -56,7 +58,7 @@ class GetInlineBotResults(BaseClient):
On Success, :obj:`BotResults ` is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
``TimeoutError`` if the bot fails to answer within 10 seconds
"""
# TODO: Don't return the raw type
diff --git a/pyrogram/client/methods/bots/request_callback_answer.py b/pyrogram/client/methods/bots/request_callback_answer.py
index 74e2d26d..7b37f51a 100644
--- a/pyrogram/client/methods/bots/request_callback_answer.py
+++ b/pyrogram/client/methods/bots/request_callback_answer.py
@@ -23,12 +23,14 @@ from pyrogram.client.ext import BaseClient
class RequestCallbackAnswer(BaseClient):
- def request_callback_answer(self,
- chat_id: Union[int, str],
- message_id: int,
- callback_data: bytes):
- """Use this method to request a callback answer from bots. This is the equivalent of clicking an
- inline button containing callback data.
+ def request_callback_answer(
+ self,
+ chat_id: Union[int, str],
+ message_id: int,
+ callback_data: bytes
+ ):
+ """Use this method to request a callback answer from bots.
+ This is the equivalent of clicking an inline button containing callback data.
Args:
chat_id (``int`` | ``str``):
@@ -47,7 +49,7 @@ class RequestCallbackAnswer(BaseClient):
or as an alert.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
``TimeoutError`` if the bot fails to answer within 10 seconds.
"""
return self.send(
diff --git a/pyrogram/client/methods/bots/send_game.py b/pyrogram/client/methods/bots/send_game.py
index 401a5aa6..a690c960 100644
--- a/pyrogram/client/methods/bots/send_game.py
+++ b/pyrogram/client/methods/bots/send_game.py
@@ -24,15 +24,19 @@ from pyrogram.client.ext import BaseClient
class SendGame(BaseClient):
- def send_game(self,
- chat_id: Union[int, str],
- game_short_name: str,
- disable_notification: bool = None,
- reply_to_message_id: int = None,
- reply_markup: Union["pyrogram.InlineKeyboardMarkup",
- "pyrogram.ReplyKeyboardMarkup",
- "pyrogram.ReplyKeyboardRemove",
- "pyrogram.ForceReply"] = None) -> "pyrogram.Message":
+ def send_game(
+ self,
+ chat_id: Union[int, str],
+ game_short_name: str,
+ disable_notification: bool = None,
+ reply_to_message_id: int = None,
+ reply_markup: Union[
+ "pyrogram.InlineKeyboardMarkup",
+ "pyrogram.ReplyKeyboardMarkup",
+ "pyrogram.ReplyKeyboardRemove",
+ "pyrogram.ForceReply"
+ ] = None
+ ) -> "pyrogram.Message":
"""Use this method to send a game.
Args:
@@ -59,7 +63,7 @@ class SendGame(BaseClient):
On success, the sent :obj:`Message` is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
r = self.send(
functions.messages.SendMedia(
diff --git a/pyrogram/client/methods/bots/send_inline_bot_result.py b/pyrogram/client/methods/bots/send_inline_bot_result.py
index 66caab16..9b375a0a 100644
--- a/pyrogram/client/methods/bots/send_inline_bot_result.py
+++ b/pyrogram/client/methods/bots/send_inline_bot_result.py
@@ -23,13 +23,15 @@ from pyrogram.client.ext import BaseClient
class SendInlineBotResult(BaseClient):
- def send_inline_bot_result(self,
- chat_id: Union[int, str],
- query_id: int,
- result_id: str,
- disable_notification: bool = None,
- reply_to_message_id: int = None,
- hide_via: bool = None):
+ def send_inline_bot_result(
+ self,
+ chat_id: Union[int, str],
+ query_id: int,
+ result_id: str,
+ disable_notification: bool = None,
+ reply_to_message_id: int = None,
+ hide_via: bool = None
+ ):
"""Use this method to send an inline bot result.
Bot results can be retrieved using :obj:`get_inline_bot_results `
@@ -59,7 +61,7 @@ class SendInlineBotResult(BaseClient):
On success, the sent Message is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
return self.send(
functions.messages.SendInlineBotResult(
diff --git a/pyrogram/client/methods/bots/set_game_score.py b/pyrogram/client/methods/bots/set_game_score.py
index e9d20844..434720c6 100644
--- a/pyrogram/client/methods/bots/set_game_score.py
+++ b/pyrogram/client/methods/bots/set_game_score.py
@@ -24,13 +24,15 @@ from pyrogram.client.ext import BaseClient
class SetGameScore(BaseClient):
- def set_game_score(self,
- user_id: Union[int, str],
- score: int,
- force: bool = None,
- disable_edit_message: bool = None,
- chat_id: Union[int, str] = None,
- message_id: int = None):
+ def set_game_score(
+ self,
+ user_id: Union[int, str],
+ score: int,
+ force: bool = None,
+ disable_edit_message: bool = None,
+ chat_id: Union[int, str] = None,
+ message_id: int = None
+ ):
# inline_message_id: str = None): TODO Add inline_message_id
"""Use this method to set the score of the specified user in a game.
@@ -65,7 +67,7 @@ class SetGameScore(BaseClient):
otherwise returns True.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
:class:`BotScoreNotModified` if the new score is not greater than the user's current score in the chat and force is False.
"""
r = self.send(
diff --git a/pyrogram/client/methods/chats/__init__.py b/pyrogram/client/methods/chats/__init__.py
index 6cc034e4..c708453f 100644
--- a/pyrogram/client/methods/chats/__init__.py
+++ b/pyrogram/client/methods/chats/__init__.py
@@ -31,12 +31,14 @@ from .kick_chat_member import KickChatMember
from .leave_chat import LeaveChat
from .pin_chat_message import PinChatMessage
from .promote_chat_member import PromoteChatMember
+from .restrict_chat import RestrictChat
from .restrict_chat_member import RestrictChatMember
from .set_chat_description import SetChatDescription
from .set_chat_photo import SetChatPhoto
from .set_chat_title import SetChatTitle
from .unban_chat_member import UnbanChatMember
from .unpin_chat_message import UnpinChatMessage
+from .update_chat_username import UpdateChatUsername
class Chats(
@@ -60,6 +62,8 @@ class Chats(
GetChatMembersCount,
GetChatPreview,
IterDialogs,
- IterChatMembers
+ IterChatMembers,
+ UpdateChatUsername,
+ RestrictChat
):
pass
diff --git a/pyrogram/client/methods/chats/delete_chat_photo.py b/pyrogram/client/methods/chats/delete_chat_photo.py
index 0164ff43..c11a0d13 100644
--- a/pyrogram/client/methods/chats/delete_chat_photo.py
+++ b/pyrogram/client/methods/chats/delete_chat_photo.py
@@ -23,8 +23,10 @@ from ...ext import BaseClient
class DeleteChatPhoto(BaseClient):
- def delete_chat_photo(self,
- chat_id: Union[int, str]) -> bool:
+ def delete_chat_photo(
+ self,
+ chat_id: Union[int, str]
+ ) -> bool:
"""Use this method to delete a chat photo.
Photos can't be changed for private chats.
You must be an administrator in the chat for this to work and must have the appropriate admin rights.
@@ -41,7 +43,7 @@ class DeleteChatPhoto(BaseClient):
True on success.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
``ValueError`` if a chat_id belongs to user.
"""
peer = self.resolve_peer(chat_id)
diff --git a/pyrogram/client/methods/chats/export_chat_invite_link.py b/pyrogram/client/methods/chats/export_chat_invite_link.py
index 9ff8c9c0..b84b1d3c 100644
--- a/pyrogram/client/methods/chats/export_chat_invite_link.py
+++ b/pyrogram/client/methods/chats/export_chat_invite_link.py
@@ -23,8 +23,10 @@ from ...ext import BaseClient
class ExportChatInviteLink(BaseClient):
- def export_chat_invite_link(self,
- chat_id: Union[int, str]) -> str:
+ def export_chat_invite_link(
+ self,
+ chat_id: Union[int, str]
+ ) -> str:
"""Use this method to generate a new invite link for a chat; any previously generated link is revoked.
You must be an administrator in the chat for this to work and have the appropriate admin rights.
@@ -38,14 +40,14 @@ class ExportChatInviteLink(BaseClient):
On success, the exported invite link as string is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
peer = self.resolve_peer(chat_id)
if isinstance(peer, types.InputPeerChat):
return self.send(
functions.messages.ExportChatInvite(
- chat_id=peer.chat_id
+ peer=peer.chat_id
)
).link
elif isinstance(peer, types.InputPeerChannel):
diff --git a/pyrogram/client/methods/chats/get_chat.py b/pyrogram/client/methods/chats/get_chat.py
index d30fd9bb..38653459 100644
--- a/pyrogram/client/methods/chats/get_chat.py
+++ b/pyrogram/client/methods/chats/get_chat.py
@@ -24,10 +24,13 @@ from ...ext import BaseClient
class GetChat(BaseClient):
- def get_chat(self,
- chat_id: Union[int, str]) -> "pyrogram.Chat":
- """Use this method to get up to date information about the chat (current name of the user for
- one-on-one conversations, current username of a user, group or channel, etc.)
+ def get_chat(
+ self,
+ chat_id: Union[int, str]
+ ) -> "pyrogram.Chat":
+ """Use this method to get up to date information about the chat.
+ Information include current name of the user for one-on-one conversations, current username of a user, group or
+ channel, etc.
Args:
chat_id (``int`` | ``str``):
@@ -39,7 +42,7 @@ class GetChat(BaseClient):
On success, a :obj:`Chat ` object is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
``ValueError`` in case the chat invite link refers to a chat you haven't joined yet.
"""
match = self.INVITE_LINK_RE.match(str(chat_id))
@@ -67,10 +70,10 @@ class GetChat(BaseClient):
peer = self.resolve_peer(chat_id)
if isinstance(peer, types.InputPeerChannel):
- r = self.send(functions.channels.GetFullChannel(peer))
+ r = self.send(functions.channels.GetFullChannel(channel=peer))
elif isinstance(peer, (types.InputPeerUser, types.InputPeerSelf)):
- r = self.send(functions.users.GetFullUser(peer))
+ r = self.send(functions.users.GetFullUser(id=peer))
else:
- r = self.send(functions.messages.GetFullChat(peer.chat_id))
+ r = self.send(functions.messages.GetFullChat(chat_id=peer.chat_id))
return pyrogram.Chat._parse_full(self, r)
diff --git a/pyrogram/client/methods/chats/get_chat_member.py b/pyrogram/client/methods/chats/get_chat_member.py
index faf0c33b..aec4d233 100644
--- a/pyrogram/client/methods/chats/get_chat_member.py
+++ b/pyrogram/client/methods/chats/get_chat_member.py
@@ -19,14 +19,17 @@
from typing import Union
import pyrogram
-from pyrogram.api import functions, types, errors
+from pyrogram.api import functions, types
+from pyrogram.errors import UserNotParticipant
from ...ext import BaseClient
class GetChatMember(BaseClient):
- def get_chat_member(self,
- chat_id: Union[int, str],
- user_id: Union[int, str]) -> "pyrogram.ChatMember":
+ def get_chat_member(
+ self,
+ chat_id: Union[int, str],
+ user_id: Union[int, str]
+ ) -> "pyrogram.ChatMember":
"""Use this method to get information about one member of a chat.
Args:
@@ -42,7 +45,7 @@ class GetChatMember(BaseClient):
On success, a :obj:`ChatMember ` object is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
chat_id = self.resolve_peer(chat_id)
user_id = self.resolve_peer(user_id)
@@ -55,10 +58,10 @@ class GetChatMember(BaseClient):
)
for member in pyrogram.ChatMembers._parse(self, full_chat).chat_members:
- if member.user.id == user_id.user_id:
+ if member.user.is_self:
return member
else:
- raise errors.UserNotParticipant
+ raise UserNotParticipant
elif isinstance(chat_id, types.InputPeerChannel):
r = self.send(
functions.channels.GetParticipant(
diff --git a/pyrogram/client/methods/chats/get_chat_members.py b/pyrogram/client/methods/chats/get_chat_members.py
index 382d7f0f..726fd14b 100644
--- a/pyrogram/client/methods/chats/get_chat_members.py
+++ b/pyrogram/client/methods/chats/get_chat_members.py
@@ -16,12 +16,17 @@
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see .
+import logging
+import time
from typing import Union
import pyrogram
from pyrogram.api import functions, types
+from pyrogram.errors import FloodWait
from ...ext import BaseClient
+log = logging.getLogger(__name__)
+
class Filters:
ALL = "all"
@@ -33,12 +38,14 @@ class Filters:
class GetChatMembers(BaseClient):
- def get_chat_members(self,
- chat_id: Union[int, str],
- offset: int = 0,
- limit: int = 200,
- query: str = "",
- filter: str = Filters.ALL) -> "pyrogram.ChatMembers":
+ def get_chat_members(
+ self,
+ chat_id: Union[int, str],
+ offset: int = 0,
+ limit: int = 200,
+ query: str = "",
+ filter: str = Filters.ALL
+ ) -> "pyrogram.ChatMembers":
"""Use this method to get a chunk of the members list of a chat.
You can get up to 200 chat members at once.
@@ -82,7 +89,7 @@ class GetChatMembers(BaseClient):
On success, a :obj:`ChatMembers` object is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
``ValueError`` if you used an invalid filter or a chat_id that belongs to a user.
"""
peer = self.resolve_peer(chat_id)
@@ -92,7 +99,7 @@ class GetChatMembers(BaseClient):
self,
self.send(
functions.messages.GetFullChat(
- peer.chat_id
+ chat_id=peer.chat_id
)
)
)
@@ -114,17 +121,22 @@ class GetChatMembers(BaseClient):
else:
raise ValueError("Invalid filter \"{}\"".format(filter))
- return pyrogram.ChatMembers._parse(
- self,
- self.send(
- functions.channels.GetParticipants(
- channel=peer,
- filter=filter,
- offset=offset,
- limit=limit,
- hash=0
+ while True:
+ try:
+ return pyrogram.ChatMembers._parse(
+ self,
+ self.send(
+ functions.channels.GetParticipants(
+ channel=peer,
+ filter=filter,
+ offset=offset,
+ limit=limit,
+ hash=0
+ )
+ )
)
- )
- )
+ except FloodWait as e:
+ log.warning("Sleeping for {}s".format(e.x))
+ time.sleep(e.x)
else:
raise ValueError("The chat_id \"{}\" belongs to a user".format(chat_id))
diff --git a/pyrogram/client/methods/chats/get_chat_members_count.py b/pyrogram/client/methods/chats/get_chat_members_count.py
index 9360b64f..fc13ac39 100644
--- a/pyrogram/client/methods/chats/get_chat_members_count.py
+++ b/pyrogram/client/methods/chats/get_chat_members_count.py
@@ -23,8 +23,10 @@ from ...ext import BaseClient
class GetChatMembersCount(BaseClient):
- def get_chat_members_count(self,
- chat_id: Union[int, str]) -> int:
+ def get_chat_members_count(
+ self,
+ chat_id: Union[int, str]
+ ) -> int:
"""Use this method to get the number of members in a chat.
Args:
@@ -35,7 +37,7 @@ class GetChatMembersCount(BaseClient):
On success, an integer is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
``ValueError`` if a chat_id belongs to user.
"""
peer = self.resolve_peer(chat_id)
diff --git a/pyrogram/client/methods/chats/get_chat_preview.py b/pyrogram/client/methods/chats/get_chat_preview.py
index 434c385b..9b6c6955 100644
--- a/pyrogram/client/methods/chats/get_chat_preview.py
+++ b/pyrogram/client/methods/chats/get_chat_preview.py
@@ -22,8 +22,10 @@ from ...ext import BaseClient
class GetChatPreview(BaseClient):
- def get_chat_preview(self,
- invite_link: str):
+ def get_chat_preview(
+ self,
+ invite_link: str
+ ):
"""Use this method to get the preview of a chat using the invite link.
This method only returns a chat preview, if you want to join a chat use :meth:`join_chat`
@@ -36,7 +38,7 @@ class GetChatPreview(BaseClient):
Either :obj:`Chat` or :obj:`ChatPreview`, depending on whether you already joined the chat or not.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
``ValueError`` in case of an invalid invite_link.
"""
match = self.INVITE_LINK_RE.match(invite_link)
diff --git a/pyrogram/client/methods/chats/get_dialogs.py b/pyrogram/client/methods/chats/get_dialogs.py
index c5fe6cfb..3bcf223f 100644
--- a/pyrogram/client/methods/chats/get_dialogs.py
+++ b/pyrogram/client/methods/chats/get_dialogs.py
@@ -21,18 +21,20 @@ import time
import pyrogram
from pyrogram.api import functions, types
-from pyrogram.api.errors import FloodWait
+from pyrogram.errors import FloodWait
from ...ext import BaseClient
log = logging.getLogger(__name__)
class GetDialogs(BaseClient):
- def get_dialogs(self,
- offset_date: int = 0,
- limit: int = 100,
- pinned_only: bool = False) -> "pyrogram.Dialogs":
- """Use this method to get a chunk of the user's dialogs
+ def get_dialogs(
+ self,
+ offset_date: int = 0,
+ limit: int = 100,
+ pinned_only: bool = False
+ ) -> "pyrogram.Dialogs":
+ """Use this method to get a chunk of the user's dialogs.
You can get up to 100 dialogs at once.
For a more convenient way of getting a user's dialogs see :meth:`iter_dialogs`.
@@ -54,7 +56,7 @@ class GetDialogs(BaseClient):
On success, a :obj:`Dialogs` object is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
while True:
diff --git a/pyrogram/client/methods/chats/iter_chat_members.py b/pyrogram/client/methods/chats/iter_chat_members.py
index 5d0fa911..2f41763e 100644
--- a/pyrogram/client/methods/chats/iter_chat_members.py
+++ b/pyrogram/client/methods/chats/iter_chat_members.py
@@ -20,6 +20,7 @@ from string import ascii_lowercase
from typing import Union, Generator
import pyrogram
+from pyrogram.api import types
from ...ext import BaseClient
@@ -37,11 +38,13 @@ QUERYABLE_FILTERS = (Filters.ALL, Filters.KICKED, Filters.RESTRICTED)
class IterChatMembers(BaseClient):
- def iter_chat_members(self,
- chat_id: Union[int, str],
- limit: int = 0,
- query: str = "",
- filter: str = Filters.ALL) -> Generator["pyrogram.ChatMember", None, None]:
+ def iter_chat_members(
+ self,
+ chat_id: Union[int, str],
+ limit: int = 0,
+ query: str = "",
+ filter: str = Filters.ALL
+ ) -> Generator["pyrogram.ChatMember", None, None]:
"""Use this method to iterate through the members of a chat sequentially.
This convenience method does the same as repeatedly calling :meth:`get_chat_members` in a loop, thus saving you
@@ -75,13 +78,14 @@ class IterChatMembers(BaseClient):
A generator yielding :obj:`ChatMember ` objects.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
current = 0
yielded = set()
queries = [query] if query else QUERIES
total = limit or (1 << 31) - 1
limit = min(200, total)
+ resolved_chat_id = self.resolve_peer(chat_id)
filter = (
Filters.RECENT
@@ -107,6 +111,9 @@ class IterChatMembers(BaseClient):
if not chat_members:
break
+ if isinstance(resolved_chat_id, types.InputPeerChat):
+ total = len(chat_members)
+
offset += len(chat_members)
for chat_member in chat_members:
diff --git a/pyrogram/client/methods/chats/iter_dialogs.py b/pyrogram/client/methods/chats/iter_dialogs.py
index 6058cd17..99437cb4 100644
--- a/pyrogram/client/methods/chats/iter_dialogs.py
+++ b/pyrogram/client/methods/chats/iter_dialogs.py
@@ -23,9 +23,11 @@ from ...ext import BaseClient
class IterDialogs(BaseClient):
- def iter_dialogs(self,
- offset_date: int = 0,
- limit: int = 0) -> Generator["pyrogram.Dialog", None, None]:
+ def iter_dialogs(
+ self,
+ offset_date: int = 0,
+ limit: int = 0
+ ) -> Generator["pyrogram.Dialog", None, None]:
"""Use this method to iterate through a user's dialogs sequentially.
This convenience method does the same as repeatedly calling :meth:`get_dialogs` in a loop, thus saving you from
@@ -44,7 +46,7 @@ class IterDialogs(BaseClient):
A generator yielding :obj:`Dialog ` objects.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
current = 0
total = limit or (1 << 31) - 1
diff --git a/pyrogram/client/methods/chats/join_chat.py b/pyrogram/client/methods/chats/join_chat.py
index f5b632fc..a7933bea 100644
--- a/pyrogram/client/methods/chats/join_chat.py
+++ b/pyrogram/client/methods/chats/join_chat.py
@@ -16,13 +16,16 @@
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see .
+import pyrogram
from pyrogram.api import functions, types
from ...ext import BaseClient
class JoinChat(BaseClient):
- def join_chat(self,
- chat_id: str):
+ def join_chat(
+ self,
+ chat_id: str
+ ):
"""Use this method to join a group chat or channel.
Args:
@@ -30,17 +33,24 @@ class JoinChat(BaseClient):
Unique identifier for the target chat in form of a *t.me/joinchat/* link or username of the target
channel/supergroup (in the format @username).
+ Returns:
+ On success, a :obj:`Chat ` object is returned.
+
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
match = self.INVITE_LINK_RE.match(chat_id)
if match:
- return self.send(
+ chat = self.send(
functions.messages.ImportChatInvite(
hash=match.group(1)
)
)
+ if isinstance(chat.chats[0], types.Chat):
+ return pyrogram.Chat._parse_chat_chat(self, chat.chats[0])
+ elif isinstance(chat.chats[0], types.Channel):
+ return pyrogram.Chat._parse_channel_chat(self, chat.chats[0])
else:
resolved_peer = self.send(
functions.contacts.ResolveUsername(
@@ -53,8 +63,10 @@ class JoinChat(BaseClient):
access_hash=resolved_peer.chats[0].access_hash
)
- return self.send(
+ chat = self.send(
functions.channels.JoinChannel(
channel=channel
)
)
+
+ return pyrogram.Chat._parse_channel_chat(self, chat.chats[0])
diff --git a/pyrogram/client/methods/chats/kick_chat_member.py b/pyrogram/client/methods/chats/kick_chat_member.py
index 4cd66ec4..7b10ddea 100644
--- a/pyrogram/client/methods/chats/kick_chat_member.py
+++ b/pyrogram/client/methods/chats/kick_chat_member.py
@@ -24,10 +24,12 @@ from ...ext import BaseClient
class KickChatMember(BaseClient):
- def kick_chat_member(self,
- chat_id: Union[int, str],
- user_id: Union[int, str],
- until_date: int = 0) -> Union["pyrogram.Message", bool]:
+ def kick_chat_member(
+ self,
+ chat_id: Union[int, str],
+ user_id: Union[int, str],
+ until_date: int = 0
+ ) -> Union["pyrogram.Message", bool]:
"""Use this method to kick a user from a group, a supergroup or a channel.
In the case of supergroups and channels, the user will not be able to return to the group on their own using
invite links, etc., unless unbanned first. You must be an administrator in the chat for this to work and must
@@ -55,7 +57,7 @@ class KickChatMember(BaseClient):
On success, either True or a service :obj:`Message ` will be returned (when applicable).
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
chat_peer = self.resolve_peer(chat_id)
user_peer = self.resolve_peer(user_id)
@@ -65,7 +67,7 @@ class KickChatMember(BaseClient):
functions.channels.EditBanned(
channel=chat_peer,
user_id=user_peer,
- banned_rights=types.ChannelBannedRights(
+ banned_rights=types.ChatBannedRights(
until_date=until_date,
view_messages=True,
send_messages=True,
diff --git a/pyrogram/client/methods/chats/leave_chat.py b/pyrogram/client/methods/chats/leave_chat.py
index 5b765ac0..8ba3a3d1 100644
--- a/pyrogram/client/methods/chats/leave_chat.py
+++ b/pyrogram/client/methods/chats/leave_chat.py
@@ -23,9 +23,11 @@ from ...ext import BaseClient
class LeaveChat(BaseClient):
- def leave_chat(self,
- chat_id: Union[int, str],
- delete: bool = False):
+ def leave_chat(
+ self,
+ chat_id: Union[int, str],
+ delete: bool = False
+ ):
"""Use this method to leave a group chat or channel.
Args:
@@ -37,7 +39,7 @@ class LeaveChat(BaseClient):
Deletes the group chat dialog after leaving (for simple group chats, not supergroups).
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
peer = self.resolve_peer(chat_id)
diff --git a/pyrogram/client/methods/chats/pin_chat_message.py b/pyrogram/client/methods/chats/pin_chat_message.py
index bb70f9e8..1d5466ba 100644
--- a/pyrogram/client/methods/chats/pin_chat_message.py
+++ b/pyrogram/client/methods/chats/pin_chat_message.py
@@ -23,10 +23,12 @@ from ...ext import BaseClient
class PinChatMessage(BaseClient):
- def pin_chat_message(self,
- chat_id: Union[int, str],
- message_id: int,
- disable_notification: bool = None) -> bool:
+ def pin_chat_message(
+ self,
+ chat_id: Union[int, str],
+ message_id: int,
+ disable_notification: bool = None
+ ) -> bool:
"""Use this method to pin a message in a group, channel or your own chat.
You must be an administrator in the chat for this to work and must have the "can_pin_messages" admin right in
the supergroup or "can_edit_messages" admin right in the channel.
@@ -46,7 +48,7 @@ class PinChatMessage(BaseClient):
True on success.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
self.send(
functions.messages.UpdatePinnedMessage(
@@ -55,3 +57,5 @@ class PinChatMessage(BaseClient):
silent=disable_notification or None
)
)
+
+ return True
diff --git a/pyrogram/client/methods/chats/promote_chat_member.py b/pyrogram/client/methods/chats/promote_chat_member.py
index 9f2260f0..26d49516 100644
--- a/pyrogram/client/methods/chats/promote_chat_member.py
+++ b/pyrogram/client/methods/chats/promote_chat_member.py
@@ -23,18 +23,21 @@ from ...ext import BaseClient
class PromoteChatMember(BaseClient):
- def promote_chat_member(self,
- chat_id: Union[int, str],
- user_id: Union[int, str],
- can_change_info: bool = True,
- can_post_messages: bool = False,
- can_edit_messages: bool = False,
- can_delete_messages: bool = True,
- can_invite_users: bool = True,
- can_restrict_members: bool = True,
- can_pin_messages: bool = False,
- can_promote_members: bool = False) -> bool:
+ def promote_chat_member(
+ self,
+ chat_id: Union[int, str],
+ user_id: Union[int, str],
+ can_change_info: bool = True,
+ can_post_messages: bool = False,
+ can_edit_messages: bool = False,
+ can_delete_messages: bool = True,
+ can_restrict_members: bool = True,
+ can_invite_users: bool = True,
+ can_pin_messages: bool = False,
+ can_promote_members: bool = False
+ ) -> bool:
"""Use this method to promote or demote a user in a supergroup or a channel.
+
You must be an administrator in the chat for this to work and must have the appropriate admin rights.
Pass False for all boolean parameters to demote a user.
@@ -58,12 +61,12 @@ class PromoteChatMember(BaseClient):
can_delete_messages (``bool``, *optional*):
Pass True, if the administrator can delete messages of other users.
- can_invite_users (``bool``, *optional*):
- Pass True, if the administrator can invite new users to the chat.
-
can_restrict_members (``bool``, *optional*):
Pass True, if the administrator can restrict, ban or unban chat members.
+ can_invite_users (``bool``, *optional*):
+ Pass True, if the administrator can invite new users to the chat.
+
can_pin_messages (``bool``, *optional*):
Pass True, if the administrator can pin messages, supergroups only.
@@ -76,23 +79,21 @@ class PromoteChatMember(BaseClient):
True on success.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
self.send(
functions.channels.EditAdmin(
channel=self.resolve_peer(chat_id),
user_id=self.resolve_peer(user_id),
- admin_rights=types.ChannelAdminRights(
+ admin_rights=types.ChatAdminRights(
change_info=can_change_info or None,
post_messages=can_post_messages or None,
edit_messages=can_edit_messages or None,
delete_messages=can_delete_messages or None,
ban_users=can_restrict_members or None,
invite_users=can_invite_users or None,
- invite_link=can_invite_users or None,
pin_messages=can_pin_messages or None,
add_admins=can_promote_members or None,
- manage_call=None
)
)
)
diff --git a/pyrogram/client/methods/chats/restrict_chat.py b/pyrogram/client/methods/chats/restrict_chat.py
new file mode 100644
index 00000000..40d46d34
--- /dev/null
+++ b/pyrogram/client/methods/chats/restrict_chat.py
@@ -0,0 +1,143 @@
+# Pyrogram - Telegram MTProto API Client Library for Python
+# Copyright (C) 2017-2019 Dan Tès
+#
+# This file is part of Pyrogram.
+#
+# Pyrogram is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Pyrogram is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Pyrogram. If not, see .
+
+from typing import Union
+
+from pyrogram.api import functions, types
+from ...ext import BaseClient
+from ...types.user_and_chats import Chat
+
+
+class RestrictChat(BaseClient):
+ def restrict_chat(
+ self,
+ chat_id: Union[int, str],
+ can_send_messages: bool = False,
+ can_send_media_messages: bool = False,
+ can_send_other_messages: bool = False,
+ can_add_web_page_previews: bool = False,
+ can_send_polls: bool = False,
+ can_change_info: bool = False,
+ can_invite_users: bool = False,
+ can_pin_messages: bool = False
+ ) -> Chat:
+ """Use this method to restrict a chat.
+ Pass True for all boolean parameters to lift restrictions from a chat.
+
+ Args:
+ chat_id (``int`` | ``str``):
+ Unique identifier (int) or username (str) of the target chat.
+
+ can_send_messages (``bool``, *optional*):
+ Pass True, if the user can send text messages, contacts, locations and venues.
+
+ can_send_media_messages (``bool``, *optional*):
+ Pass True, if the user can send audios, documents, photos, videos, video notes and voice notes,
+ implies can_send_messages.
+
+ can_send_other_messages (``bool``, *optional*):
+ Pass True, if the user can send animations, games, stickers and use inline bots,
+ implies can_send_media_messages.
+
+ can_add_web_page_previews (``bool``, *optional*):
+ Pass True, if the user may add web page previews to their messages, implies can_send_media_messages.
+
+ can_send_polls (``bool``, *optional*):
+ Pass True, if the user can send polls, implies can_send_media_messages.
+
+ can_change_info (``bool``, *optional*):
+ Pass True, if the user can change the chat title, photo and other settings.
+
+ can_invite_users (``bool``, *optional*):
+ Pass True, if the user can invite new users to the chat.
+
+ can_pin_messages (``bool``, *optional*):
+ Pass True, if the user can pin messages.
+
+ Returns:
+ On success, a :obj:`Chat ` object is returned.
+
+ Raises:
+ :class:`RPCError ` in case of a Telegram RPC error.
+ """
+ send_messages = True
+ send_media = True
+ send_stickers = True
+ send_gifs = True
+ send_games = True
+ send_inline = True
+ embed_links = True
+ send_polls = True
+ change_info = True
+ invite_users = True
+ pin_messages = True
+
+ if can_send_messages:
+ send_messages = None
+
+ if can_send_media_messages:
+ send_messages = None
+ send_media = None
+
+ if can_send_other_messages:
+ send_messages = None
+ send_media = None
+ send_stickers = None
+ send_gifs = None
+ send_games = None
+ send_inline = None
+
+ if can_add_web_page_previews:
+ send_messages = None
+ send_media = None
+ embed_links = None
+
+ if can_send_polls:
+ send_messages = None
+ send_polls = None
+
+ if can_change_info:
+ change_info = None
+
+ if can_invite_users:
+ invite_users = None
+
+ if can_pin_messages:
+ pin_messages = None
+
+ r = self.send(
+ functions.messages.EditChatDefaultBannedRights(
+ peer=self.resolve_peer(chat_id),
+ banned_rights=types.ChatBannedRights(
+ until_date=0,
+ send_messages=send_messages,
+ send_media=send_media,
+ send_stickers=send_stickers,
+ send_gifs=send_gifs,
+ send_games=send_games,
+ send_inline=send_inline,
+ embed_links=embed_links,
+ send_polls=send_polls,
+ change_info=change_info,
+ invite_users=invite_users,
+ pin_messages=pin_messages
+ )
+ )
+ )
+
+ return Chat._parse_chat(self, r.chats[0])
diff --git a/pyrogram/client/methods/chats/restrict_chat_member.py b/pyrogram/client/methods/chats/restrict_chat_member.py
index dbe0054b..8688ecca 100644
--- a/pyrogram/client/methods/chats/restrict_chat_member.py
+++ b/pyrogram/client/methods/chats/restrict_chat_member.py
@@ -20,20 +20,28 @@ from typing import Union
from pyrogram.api import functions, types
from ...ext import BaseClient
+from ...types.user_and_chats import Chat
class RestrictChatMember(BaseClient):
- def restrict_chat_member(self,
- chat_id: Union[int, str],
- user_id: Union[int, str],
- until_date: int = 0,
- can_send_messages: bool = False,
- can_send_media_messages: bool = False,
- can_send_other_messages: bool = False,
- can_add_web_page_previews: bool = False) -> bool:
- """Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for
- this to work and must have the appropriate admin rights. Pass True for all boolean parameters to lift
- restrictions from a user.
+ def restrict_chat_member(
+ self,
+ chat_id: Union[int, str],
+ user_id: Union[int, str],
+ until_date: int = 0,
+ can_send_messages: bool = False,
+ can_send_media_messages: bool = False,
+ can_send_other_messages: bool = False,
+ can_add_web_page_previews: bool = False,
+ can_send_polls: bool = False,
+ can_change_info: bool = False,
+ can_invite_users: bool = False,
+ can_pin_messages: bool = False
+ ) -> Chat:
+ """Use this method to restrict a user in a supergroup.
+
+ The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights.
+ Pass True for all boolean parameters to lift restrictions from a user.
Args:
chat_id (``int`` | ``str``):
@@ -60,13 +68,25 @@ class RestrictChatMember(BaseClient):
implies can_send_media_messages.
can_add_web_page_previews (``bool``, *optional*):
- Pass True, if the user may add web page previews to their messages, implies can_send_media_messages
+ Pass True, if the user may add web page previews to their messages, implies can_send_media_messages.
+
+ can_send_polls (``bool``, *optional*):
+ Pass True, if the user can send polls, implies can_send_media_messages.
+
+ can_change_info (``bool``, *optional*):
+ Pass True, if the user can change the chat title, photo and other settings.
+
+ can_invite_users (``bool``, *optional*):
+ Pass True, if the user can invite new users to the chat.
+
+ can_pin_messages (``bool``, *optional*):
+ Pass True, if the user can pin messages.
Returns:
- True on success.
+ On success, a :obj:`Chat ` object is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
send_messages = True
send_media = True
@@ -75,6 +95,10 @@ class RestrictChatMember(BaseClient):
send_games = True
send_inline = True
embed_links = True
+ send_polls = True
+ change_info = True
+ invite_users = True
+ pin_messages = True
if can_send_messages:
send_messages = None
@@ -84,6 +108,7 @@ class RestrictChatMember(BaseClient):
send_media = None
if can_send_other_messages:
+ send_messages = None
send_media = None
send_stickers = None
send_gifs = None
@@ -91,14 +116,28 @@ class RestrictChatMember(BaseClient):
send_inline = None
if can_add_web_page_previews:
+ send_messages = None
send_media = None
embed_links = None
- self.send(
+ if can_send_polls:
+ send_messages = None
+ send_polls = None
+
+ if can_change_info:
+ change_info = None
+
+ if can_invite_users:
+ invite_users = None
+
+ if can_pin_messages:
+ pin_messages = None
+
+ r = self.send(
functions.channels.EditBanned(
channel=self.resolve_peer(chat_id),
user_id=self.resolve_peer(user_id),
- banned_rights=types.ChannelBannedRights(
+ banned_rights=types.ChatBannedRights(
until_date=until_date,
send_messages=send_messages,
send_media=send_media,
@@ -106,9 +145,13 @@ class RestrictChatMember(BaseClient):
send_gifs=send_gifs,
send_games=send_games,
send_inline=send_inline,
- embed_links=embed_links
+ embed_links=embed_links,
+ send_polls=send_polls,
+ change_info=change_info,
+ invite_users=invite_users,
+ pin_messages=pin_messages
)
)
)
- return True
+ return Chat._parse_chat(self, r.chats[0])
diff --git a/pyrogram/client/methods/chats/set_chat_description.py b/pyrogram/client/methods/chats/set_chat_description.py
index e6c5bba1..9d4e130b 100644
--- a/pyrogram/client/methods/chats/set_chat_description.py
+++ b/pyrogram/client/methods/chats/set_chat_description.py
@@ -23,9 +23,11 @@ from ...ext import BaseClient
class SetChatDescription(BaseClient):
- def set_chat_description(self,
- chat_id: Union[int, str],
- description: str) -> bool:
+ def set_chat_description(
+ self,
+ chat_id: Union[int, str],
+ description: str
+ ) -> bool:
"""Use this method to change the description of a supergroup or a channel.
You must be an administrator in the chat for this to work and must have the appropriate admin rights.
@@ -40,20 +42,18 @@ class SetChatDescription(BaseClient):
True on success.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
``ValueError`` if a chat_id doesn't belong to a supergroup or a channel.
"""
peer = self.resolve_peer(chat_id)
- if isinstance(peer, types.InputPeerChannel):
+ if isinstance(peer, (types.InputPeerChannel, types.InputPeerChat)):
self.send(
- functions.channels.EditAbout(
- channel=peer,
+ functions.messages.EditChatAbout(
+ peer=peer,
about=description
)
)
- elif isinstance(peer, types.InputPeerChat):
- raise ValueError("The chat_id \"{}\" belongs to a basic group".format(chat_id))
else:
raise ValueError("The chat_id \"{}\" belongs to a user".format(chat_id))
diff --git a/pyrogram/client/methods/chats/set_chat_photo.py b/pyrogram/client/methods/chats/set_chat_photo.py
index cc5c776a..87fe1b72 100644
--- a/pyrogram/client/methods/chats/set_chat_photo.py
+++ b/pyrogram/client/methods/chats/set_chat_photo.py
@@ -26,9 +26,11 @@ from ...ext import BaseClient
class SetChatPhoto(BaseClient):
- def set_chat_photo(self,
- chat_id: Union[int, str],
- photo: str) -> bool:
+ def set_chat_photo(
+ self,
+ chat_id: Union[int, str],
+ photo: str
+ ) -> bool:
"""Use this method to set a new profile photo for the chat.
Photos can't be changed for private chats.
You must be an administrator in the chat for this to work and must have the appropriate admin rights.
@@ -48,7 +50,7 @@ class SetChatPhoto(BaseClient):
True on success.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
``ValueError`` if a chat_id belongs to user.
"""
peer = self.resolve_peer(chat_id)
diff --git a/pyrogram/client/methods/chats/set_chat_title.py b/pyrogram/client/methods/chats/set_chat_title.py
index fff330ee..e94f16a8 100644
--- a/pyrogram/client/methods/chats/set_chat_title.py
+++ b/pyrogram/client/methods/chats/set_chat_title.py
@@ -23,9 +23,11 @@ from ...ext import BaseClient
class SetChatTitle(BaseClient):
- def set_chat_title(self,
- chat_id: Union[int, str],
- title: str) -> bool:
+ def set_chat_title(
+ self,
+ chat_id: Union[int, str],
+ title: str
+ ) -> bool:
"""Use this method to change the title of a chat.
Titles can't be changed for private chats.
You must be an administrator in the chat for this to work and must have the appropriate admin rights.
@@ -45,7 +47,7 @@ class SetChatTitle(BaseClient):
True on success.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
``ValueError`` if a chat_id belongs to user.
"""
peer = self.resolve_peer(chat_id)
diff --git a/pyrogram/client/methods/chats/unban_chat_member.py b/pyrogram/client/methods/chats/unban_chat_member.py
index da706a1f..0576c028 100644
--- a/pyrogram/client/methods/chats/unban_chat_member.py
+++ b/pyrogram/client/methods/chats/unban_chat_member.py
@@ -23,9 +23,11 @@ from ...ext import BaseClient
class UnbanChatMember(BaseClient):
- def unban_chat_member(self,
- chat_id: Union[int, str],
- user_id: Union[int, str]) -> bool:
+ def unban_chat_member(
+ self,
+ chat_id: Union[int, str],
+ user_id: Union[int, str]
+ ) -> bool:
"""Use this method to unban a previously kicked user in a supergroup or channel.
The user will **not** return to the group or channel automatically, but will be able to join via link, etc.
You must be an administrator for this to work.
@@ -42,13 +44,13 @@ class UnbanChatMember(BaseClient):
True on success.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
self.send(
functions.channels.EditBanned(
channel=self.resolve_peer(chat_id),
user_id=self.resolve_peer(user_id),
- banned_rights=types.ChannelBannedRights(
+ banned_rights=types.ChatBannedRights(
until_date=0
)
)
diff --git a/pyrogram/client/methods/chats/unpin_chat_message.py b/pyrogram/client/methods/chats/unpin_chat_message.py
index 4355010d..9753d656 100644
--- a/pyrogram/client/methods/chats/unpin_chat_message.py
+++ b/pyrogram/client/methods/chats/unpin_chat_message.py
@@ -23,8 +23,10 @@ from ...ext import BaseClient
class UnpinChatMessage(BaseClient):
- def unpin_chat_message(self,
- chat_id: Union[int, str]) -> bool:
+ def unpin_chat_message(
+ self,
+ chat_id: Union[int, str]
+ ) -> bool:
"""Use this method to unpin a message in a group, channel or your own chat.
You must be an administrator in the chat for this to work and must have the "can_pin_messages" admin
right in the supergroup or "can_edit_messages" admin right in the channel.
@@ -37,7 +39,7 @@ class UnpinChatMessage(BaseClient):
True on success.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
self.send(
functions.messages.UpdatePinnedMessage(
diff --git a/pyrogram/client/methods/chats/update_chat_username.py b/pyrogram/client/methods/chats/update_chat_username.py
new file mode 100644
index 00000000..39cdfaeb
--- /dev/null
+++ b/pyrogram/client/methods/chats/update_chat_username.py
@@ -0,0 +1,61 @@
+# Pyrogram - Telegram MTProto API Client Library for Python
+# Copyright (C) 2017-2019 Dan Tès
+#
+# This file is part of Pyrogram.
+#
+# Pyrogram is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Pyrogram is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Pyrogram. If not, see .
+
+from typing import Union
+
+from pyrogram.api import functions, types
+from ...ext import BaseClient
+
+
+class UpdateChatUsername(BaseClient):
+ def update_chat_username(
+ self,
+ chat_id: Union[int, str],
+ username: Union[str, None]
+ ) -> bool:
+ """Use this method to update a channel or a supergroup username.
+
+ To update your own username (for users only, not bots) you can use :meth:`update_username`.
+
+ Args:
+ chat_id (``int`` | ``str``)
+ Unique identifier (int) or username (str) of the target chat.
+ username (``str`` | ``None``):
+ Username to set. Pass "" (empty string) or None to remove the username.
+
+ Returns:
+ True on success.
+
+ Raises:
+ :class:`RPCError ` in case of a Telegram RPC error.
+ ``ValueError`` if a chat_id belongs to a user or chat.
+ """
+
+ peer = self.resolve_peer(chat_id)
+
+ if isinstance(peer, types.InputPeerChannel):
+ return bool(
+ self.send(
+ functions.channels.UpdateUsername(
+ channel=peer,
+ username=username or ""
+ )
+ )
+ )
+ else:
+ raise ValueError("The chat_id \"{}\" belongs to a user or chat".format(chat_id))
diff --git a/pyrogram/client/methods/contacts/add_contacts.py b/pyrogram/client/methods/contacts/add_contacts.py
index 48575a78..d1a97c99 100644
--- a/pyrogram/client/methods/contacts/add_contacts.py
+++ b/pyrogram/client/methods/contacts/add_contacts.py
@@ -24,8 +24,10 @@ from ...ext import BaseClient
class AddContacts(BaseClient):
- def add_contacts(self,
- contacts: List["pyrogram.InputPhoneContact"]):
+ def add_contacts(
+ self,
+ contacts: List["pyrogram.InputPhoneContact"]
+ ):
"""Use this method to add contacts to your Telegram address book.
Args:
@@ -36,7 +38,7 @@ class AddContacts(BaseClient):
On success, the added contacts are returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
imported_contacts = self.send(
functions.contacts.ImportContacts(
diff --git a/pyrogram/client/methods/contacts/delete_contacts.py b/pyrogram/client/methods/contacts/delete_contacts.py
index dba2581d..af8f453e 100644
--- a/pyrogram/client/methods/contacts/delete_contacts.py
+++ b/pyrogram/client/methods/contacts/delete_contacts.py
@@ -19,14 +19,16 @@
from typing import List
from pyrogram.api import functions, types
-from pyrogram.api.errors import PeerIdInvalid
+from pyrogram.errors import PeerIdInvalid
from ...ext import BaseClient
class DeleteContacts(BaseClient):
- def delete_contacts(self,
- ids: List[int]):
- """Use this method to delete contacts from your Telegram address book
+ def delete_contacts(
+ self,
+ ids: List[int]
+ ):
+ """Use this method to delete contacts from your Telegram address book.
Args:
ids (List of ``int``):
@@ -37,7 +39,7 @@ class DeleteContacts(BaseClient):
True on success.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
contacts = []
diff --git a/pyrogram/client/methods/contacts/get_contacts.py b/pyrogram/client/methods/contacts/get_contacts.py
index 12419106..7eaf6906 100644
--- a/pyrogram/client/methods/contacts/get_contacts.py
+++ b/pyrogram/client/methods/contacts/get_contacts.py
@@ -21,7 +21,7 @@ import time
import pyrogram
from pyrogram.api import functions
-from pyrogram.api.errors import FloodWait
+from pyrogram.errors import FloodWait
from ...ext import BaseClient
log = logging.getLogger(__name__)
@@ -35,11 +35,11 @@ class GetContacts(BaseClient):
On success, a list of :obj:`User` objects is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
while True:
try:
- contacts = self.send(functions.contacts.GetContacts(0))
+ contacts = self.send(functions.contacts.GetContacts(hash=0))
except FloodWait as e:
log.warning("get_contacts flood: waiting {} seconds".format(e.x))
time.sleep(e.x)
diff --git a/pyrogram/client/methods/decorators/__init__.py b/pyrogram/client/methods/decorators/__init__.py
index 07f84b54..33f55a3d 100644
--- a/pyrogram/client/methods/decorators/__init__.py
+++ b/pyrogram/client/methods/decorators/__init__.py
@@ -19,6 +19,7 @@
from .on_callback_query import OnCallbackQuery
from .on_deleted_messages import OnDeletedMessages
from .on_disconnect import OnDisconnect
+from .on_inline_query import OnInlineQuery
from .on_message import OnMessage
from .on_raw_update import OnRawUpdate
from .on_user_status import OnUserStatus
@@ -30,6 +31,7 @@ class Decorators(
OnCallbackQuery,
OnRawUpdate,
OnDisconnect,
- OnUserStatus
+ OnUserStatus,
+ OnInlineQuery
):
pass
diff --git a/pyrogram/client/methods/decorators/on_callback_query.py b/pyrogram/client/methods/decorators/on_callback_query.py
index bf0a823a..3c747c5f 100644
--- a/pyrogram/client/methods/decorators/on_callback_query.py
+++ b/pyrogram/client/methods/decorators/on_callback_query.py
@@ -25,19 +25,13 @@ from ...ext import BaseClient
class OnCallbackQuery(BaseClient):
- def on_callback_query(self=None,
- filters=None,
- group: int = 0) -> callable:
- """Use this decorator to automatically register a function for handling
- callback queries. This does the same thing as :meth:`add_handler` using the
- :class:`CallbackQueryHandler`.
-
- .. note::
- This decorator will wrap your defined function in a tuple consisting of *(Handler, group)*.
-
- To reference your own function after it has been decorated, you need to access
- *my_function[0].callback*, that is, the *callback* field of Handler object which is the the
- first element in the tuple.
+ def on_callback_query(
+ self=None,
+ filters=None,
+ group: int = 0
+ ) -> callable:
+ """Use this decorator to automatically register a function for handling callback queries.
+ This does the same thing as :meth:`add_handler` using the :class:`CallbackQueryHandler`.
Args:
filters (:obj:`Filters `):
diff --git a/pyrogram/client/methods/decorators/on_deleted_messages.py b/pyrogram/client/methods/decorators/on_deleted_messages.py
index 1b1a602b..cf8f9cf2 100644
--- a/pyrogram/client/methods/decorators/on_deleted_messages.py
+++ b/pyrogram/client/methods/decorators/on_deleted_messages.py
@@ -25,19 +25,13 @@ from ...ext import BaseClient
class OnDeletedMessages(BaseClient):
- def on_deleted_messages(self=None,
- filters=None,
- group: int = 0) -> callable:
- """Use this decorator to automatically register a function for handling
- deleted messages. This does the same thing as :meth:`add_handler` using the
- :class:`DeletedMessagesHandler`.
-
- .. note::
- This decorator will wrap your defined function in a tuple consisting of *(Handler, group)*.
-
- To reference your own function after it has been decorated, you need to access
- *my_function[0].callback*, that is, the *callback* field of Handler object which is the the
- first element in the tuple.
+ def on_deleted_messages(
+ self=None,
+ filters=None,
+ group: int = 0
+ ) -> callable:
+ """Use this decorator to automatically register a function for handling deleted messages.
+ This does the same thing as :meth:`add_handler` using the :class:`DeletedMessagesHandler`.
Args:
filters (:obj:`Filters `):
diff --git a/pyrogram/client/methods/decorators/on_disconnect.py b/pyrogram/client/methods/decorators/on_disconnect.py
index 4657af3b..515a28c1 100644
--- a/pyrogram/client/methods/decorators/on_disconnect.py
+++ b/pyrogram/client/methods/decorators/on_disconnect.py
@@ -23,9 +23,8 @@ from ...ext import BaseClient
class OnDisconnect(BaseClient):
def on_disconnect(self=None) -> callable:
- """Use this decorator to automatically register a function for handling
- disconnections. This does the same thing as :meth:`add_handler` using the
- :class:`DisconnectHandler`.
+ """Use this decorator to automatically register a function for handling disconnections.
+ This does the same thing as :meth:`add_handler` using the :class:`DisconnectHandler`.
"""
def decorator(func: callable) -> Handler:
diff --git a/pyrogram/client/methods/decorators/on_inline_query.py b/pyrogram/client/methods/decorators/on_inline_query.py
new file mode 100644
index 00000000..81f0f676
--- /dev/null
+++ b/pyrogram/client/methods/decorators/on_inline_query.py
@@ -0,0 +1,59 @@
+# Pyrogram - Telegram MTProto API Client Library for Python
+# Copyright (C) 2017-2018 Dan Tès
+#
+# This file is part of Pyrogram.
+#
+# Pyrogram is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Pyrogram is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Pyrogram. If not, see .
+
+from typing import Tuple
+
+import pyrogram
+from pyrogram.client.filters.filter import Filter
+from pyrogram.client.handlers.handler import Handler
+from ...ext import BaseClient
+
+
+class OnInlineQuery(BaseClient):
+ def on_inline_query(
+ self=None,
+ filters=None,
+ group: int = 0
+ ) -> callable:
+ """Use this decorator to automatically register a function for handling inline queries.
+ This does the same thing as :meth:`add_handler` using the :class:`InlineQueryHandler`.
+
+ Args:
+ filters (:obj:`Filters `):
+ Pass one or more filters to allow only a subset of inline queries to be passed
+ in your function.
+
+ group (``int``, *optional*):
+ The group identifier, defaults to 0.
+ """
+
+ def decorator(func: callable) -> Tuple[Handler, int]:
+ if isinstance(func, tuple):
+ func = func[0].callback
+
+ handler = pyrogram.InlineQueryHandler(func, filters)
+
+ if isinstance(self, Filter):
+ return pyrogram.InlineQueryHandler(func, self), group if filters is None else filters
+
+ if self is not None:
+ self.add_handler(handler, group)
+
+ return handler, group
+
+ return decorator
diff --git a/pyrogram/client/methods/decorators/on_message.py b/pyrogram/client/methods/decorators/on_message.py
index c2f35a19..e6563893 100644
--- a/pyrogram/client/methods/decorators/on_message.py
+++ b/pyrogram/client/methods/decorators/on_message.py
@@ -25,19 +25,13 @@ from ...ext import BaseClient
class OnMessage(BaseClient):
- def on_message(self=None,
- filters=None,
- group: int = 0) -> callable:
- """Use this decorator to automatically register a function for handling
- messages. This does the same thing as :meth:`add_handler` using the
- :class:`MessageHandler`.
-
- .. note::
- This decorator will wrap your defined function in a tuple consisting of *(Handler, group)*.
-
- To reference your own function after it has been decorated, you need to access
- *my_function[0].callback*, that is, the *callback* field of Handler object which is the the
- first element in the tuple.
+ def on_message(
+ self=None,
+ filters=None,
+ group: int = 0
+ ) -> callable:
+ """Use this decorator to automatically register a function for handling messages.
+ This does the same thing as :meth:`add_handler` using the :class:`MessageHandler`.
Args:
filters (:obj:`Filters `):
diff --git a/pyrogram/client/methods/decorators/on_raw_update.py b/pyrogram/client/methods/decorators/on_raw_update.py
index 2deedb00..1494a319 100644
--- a/pyrogram/client/methods/decorators/on_raw_update.py
+++ b/pyrogram/client/methods/decorators/on_raw_update.py
@@ -24,18 +24,12 @@ from ...ext import BaseClient
class OnRawUpdate(BaseClient):
- def on_raw_update(self=None,
- group: int = 0) -> callable:
- """Use this decorator to automatically register a function for handling
- raw updates. This does the same thing as :meth:`add_handler` using the
- :class:`RawUpdateHandler`.
-
- .. note::
- This decorator will wrap your defined function in a tuple consisting of *(Handler, group)*.
-
- To reference your own function after it has been decorated, you need to access
- *my_function[0].callback*, that is, the *callback* field of Handler object which is the the
- first element in the tuple.
+ def on_raw_update(
+ self=None,
+ group: int = 0
+ ) -> callable:
+ """Use this decorator to automatically register a function for handling raw updates.
+ This does the same thing as :meth:`add_handler` using the :class:`RawUpdateHandler`.
Args:
group (``int``, *optional*):
diff --git a/pyrogram/client/methods/decorators/on_user_status.py b/pyrogram/client/methods/decorators/on_user_status.py
index 6198c9cd..4d8185b1 100644
--- a/pyrogram/client/methods/decorators/on_user_status.py
+++ b/pyrogram/client/methods/decorators/on_user_status.py
@@ -25,19 +25,13 @@ from ...ext import BaseClient
class OnUserStatus(BaseClient):
- def on_user_status(self=None,
- filters=None,
- group: int = 0) -> callable:
- """Use this decorator to automatically register a function for handling
- user status updates. This does the same thing as :meth:`add_handler` using the
- :class:`UserStatusHandler`.
-
- .. note::
- This decorator will wrap your defined function in a tuple consisting of *(Handler, group)*.
-
- To reference your own function after it has been decorated, you need to access
- *my_function[0].callback*, that is, the *callback* field of Handler object which is the the
- first element in the tuple.
+ def on_user_status(
+ self=None,
+ filters=None,
+ group: int = 0
+ ) -> callable:
+ """Use this decorator to automatically register a function for handling user status updates.
+ This does the same thing as :meth:`add_handler` using the :class:`UserStatusHandler`.
Args:
filters (:obj:`Filters `):
diff --git a/pyrogram/client/methods/messages/__init__.py b/pyrogram/client/methods/messages/__init__.py
index f76d0a22..dde50b7b 100644
--- a/pyrogram/client/methods/messages/__init__.py
+++ b/pyrogram/client/methods/messages/__init__.py
@@ -30,6 +30,7 @@ from .iter_history import IterHistory
from .retract_vote import RetractVote
from .send_animation import SendAnimation
from .send_audio import SendAudio
+from .send_cached_media import SendCachedMedia
from .send_chat_action import SendChatAction
from .send_contact import SendContact
from .send_document import SendDocument
@@ -74,6 +75,7 @@ class Messages(
ClosePoll,
RetractVote,
DownloadMedia,
- IterHistory
+ IterHistory,
+ SendCachedMedia
):
pass
diff --git a/pyrogram/client/methods/messages/close_poll.py b/pyrogram/client/methods/messages/close_poll.py
index c2d2706b..1b1164c2 100644
--- a/pyrogram/client/methods/messages/close_poll.py
+++ b/pyrogram/client/methods/messages/close_poll.py
@@ -23,9 +23,11 @@ from pyrogram.client.ext import BaseClient
class ClosePoll(BaseClient):
- def close_poll(self,
- chat_id: Union[int, str],
- message_id: id) -> bool:
+ def close_poll(
+ self,
+ chat_id: Union[int, str],
+ message_id: id
+ ) -> bool:
"""Use this method to close (stop) a poll.
Closed polls can't be reopened and nobody will be able to vote in it anymore.
@@ -43,7 +45,7 @@ class ClosePoll(BaseClient):
On success, True is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
poll = self.get_messages(chat_id, message_id).poll
diff --git a/pyrogram/client/methods/messages/delete_messages.py b/pyrogram/client/methods/messages/delete_messages.py
index 06acbb1f..bbd838ee 100644
--- a/pyrogram/client/methods/messages/delete_messages.py
+++ b/pyrogram/client/methods/messages/delete_messages.py
@@ -23,17 +23,13 @@ from pyrogram.client.ext import BaseClient
class DeleteMessages(BaseClient):
- def delete_messages(self,
- chat_id: Union[int, str],
- message_ids: Iterable[int],
- revoke: bool = True) -> bool:
- """Use this method to delete messages, including service messages, with the following limitations:
-
- - A message can only be deleted if it was sent less than 48 hours ago.
- - Users can delete outgoing messages in groups and supergroups.
- - Users granted *can_post_messages* permissions can delete outgoing messages in channels.
- - If the user is an administrator of a group, it can delete any message there.
- - If the user has *can_delete_messages* permission in a supergroup or a channel, it can delete any message there.
+ def delete_messages(
+ self,
+ chat_id: Union[int, str],
+ message_ids: Iterable[int],
+ revoke: bool = True
+ ) -> bool:
+ """Use this method to delete messages, including service messages.
Args:
chat_id (``int`` | ``str``):
@@ -55,7 +51,7 @@ class DeleteMessages(BaseClient):
True on success.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
peer = self.resolve_peer(chat_id)
message_ids = list(message_ids) if not isinstance(message_ids, int) else [message_ids]
diff --git a/pyrogram/client/methods/messages/download_media.py b/pyrogram/client/methods/messages/download_media.py
index 181daa14..35959d4a 100644
--- a/pyrogram/client/methods/messages/download_media.py
+++ b/pyrogram/client/methods/messages/download_media.py
@@ -24,13 +24,15 @@ from pyrogram.client.ext import BaseClient
class DownloadMedia(BaseClient):
- def download_media(self,
- message: Union["pyrogram.Message", str],
- file_name: str = "",
- block: bool = True,
- progress: callable = None,
- progress_args: tuple = ()) -> Union[str, None]:
- """Use this method to download the media from a Message.
+ def download_media(
+ self,
+ message: Union["pyrogram.Message", str],
+ file_name: str = "",
+ block: bool = True,
+ progress: callable = None,
+ progress_args: tuple = ()
+ ) -> Union[str, None]:
+ """Use this method to download the media from a message.
Args:
message (:obj:`Message ` | ``str``):
@@ -75,7 +77,7 @@ class DownloadMedia(BaseClient):
In case the download is deliberately stopped with :meth:`stop_transmission`, None is returned as well.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
``ValueError`` if the message doesn't contain any downloadable media
"""
error_message = "This message doesn't contain any downloadable media"
@@ -106,15 +108,15 @@ class DownloadMedia(BaseClient):
else:
raise ValueError(error_message)
elif isinstance(message, (
- pyrogram.Photo,
- pyrogram.PhotoSize,
- pyrogram.Audio,
- pyrogram.Document,
- pyrogram.Video,
- pyrogram.Voice,
- pyrogram.VideoNote,
- pyrogram.Sticker,
- pyrogram.Animation
+ pyrogram.Photo,
+ pyrogram.PhotoSize,
+ pyrogram.Audio,
+ pyrogram.Document,
+ pyrogram.Video,
+ pyrogram.Voice,
+ pyrogram.VideoNote,
+ pyrogram.Sticker,
+ pyrogram.Animation
)):
if isinstance(message, pyrogram.Photo):
media = pyrogram.Document(
diff --git a/pyrogram/client/methods/messages/edit_message_caption.py b/pyrogram/client/methods/messages/edit_message_caption.py
index fe704e41..c7bcbd70 100644
--- a/pyrogram/client/methods/messages/edit_message_caption.py
+++ b/pyrogram/client/methods/messages/edit_message_caption.py
@@ -24,12 +24,14 @@ from pyrogram.client.ext import BaseClient
class EditMessageCaption(BaseClient):
- def edit_message_caption(self,
- chat_id: Union[int, str],
- message_id: int,
- caption: str,
- parse_mode: str = "",
- reply_markup: "pyrogram.InlineKeyboardMarkup" = None) -> "pyrogram.Message":
+ def edit_message_caption(
+ self,
+ chat_id: Union[int, str],
+ message_id: int,
+ caption: str,
+ parse_mode: str = "",
+ reply_markup: "pyrogram.InlineKeyboardMarkup" = None
+ ) -> "pyrogram.Message":
"""Use this method to edit captions of messages.
Args:
@@ -56,7 +58,7 @@ class EditMessageCaption(BaseClient):
On success, the edited :obj:`Message ` is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
style = self.html if parse_mode.lower() == "html" else self.markdown
diff --git a/pyrogram/client/methods/messages/edit_message_media.py b/pyrogram/client/methods/messages/edit_message_media.py
index 9ad2f199..ea5870fc 100644
--- a/pyrogram/client/methods/messages/edit_message_media.py
+++ b/pyrogram/client/methods/messages/edit_message_media.py
@@ -23,7 +23,7 @@ from typing import Union
import pyrogram
from pyrogram.api import functions, types
-from pyrogram.api.errors import FileIdInvalid
+from pyrogram.errors import FileIdInvalid
from pyrogram.client.ext import BaseClient, utils
from pyrogram.client.types import (
InputMediaPhoto, InputMediaVideo, InputMediaAudio,
@@ -33,11 +33,13 @@ from pyrogram.client.types.input_media import InputMedia
class EditMessageMedia(BaseClient):
- def edit_message_media(self,
- chat_id: Union[int, str],
- message_id: int,
- media: InputMedia,
- reply_markup: "pyrogram.InlineKeyboardMarkup" = None) -> "pyrogram.Message":
+ def edit_message_media(
+ self,
+ chat_id: Union[int, str],
+ message_id: int,
+ media: InputMedia,
+ reply_markup: "pyrogram.InlineKeyboardMarkup" = None
+ ) -> "pyrogram.Message":
"""Use this method to edit audio, document, photo, or video messages.
If a message is a part of a message album, then it can be edited only to a photo or a video. Otherwise,
@@ -54,7 +56,7 @@ class EditMessageMedia(BaseClient):
message_id (``int``):
Message identifier in the chat specified in chat_id.
- media (:obj:`InputMediaAnimation` | :obj:`InputMediaAudio` | :obj:`InputMediaDocument` | :obj:`InputMediaPhoto` | :obj:`InputMediaVideo`)
+ media (:obj:`InputMedia`)
One of the InputMedia objects describing an animation, audio, document, photo or video.
reply_markup (:obj:`InlineKeyboardMarkup`, *optional*):
@@ -64,7 +66,7 @@ class EditMessageMedia(BaseClient):
On success, the edited :obj:`Message ` is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
style = self.html if media.parse_mode.lower() == "html" else self.markdown
caption = media.caption
@@ -131,7 +133,9 @@ class EditMessageMedia(BaseClient):
w=media.width,
h=media.height
),
- types.DocumentAttributeFilename(os.path.basename(media.media))
+ types.DocumentAttributeFilename(
+ file_name=os.path.basename(media.media)
+ )
]
)
)
@@ -187,7 +191,9 @@ class EditMessageMedia(BaseClient):
performer=media.performer,
title=media.title
),
- types.DocumentAttributeFilename(os.path.basename(media.media))
+ types.DocumentAttributeFilename(
+ file_name=os.path.basename(media.media)
+ )
]
)
)
@@ -244,7 +250,9 @@ class EditMessageMedia(BaseClient):
w=media.width,
h=media.height
),
- types.DocumentAttributeFilename(os.path.basename(media.media)),
+ types.DocumentAttributeFilename(
+ file_name=os.path.basename(media.media)
+ ),
types.DocumentAttributeAnimated()
]
)
@@ -296,7 +304,9 @@ class EditMessageMedia(BaseClient):
thumb=None if media.thumb is None else self.save_file(media.thumb),
file=self.save_file(media.media),
attributes=[
- types.DocumentAttributeFilename(os.path.basename(media.media))
+ types.DocumentAttributeFilename(
+ file_name=os.path.basename(media.media)
+ )
]
)
)
diff --git a/pyrogram/client/methods/messages/edit_message_reply_markup.py b/pyrogram/client/methods/messages/edit_message_reply_markup.py
index f8b5c0a5..e3495476 100644
--- a/pyrogram/client/methods/messages/edit_message_reply_markup.py
+++ b/pyrogram/client/methods/messages/edit_message_reply_markup.py
@@ -24,10 +24,12 @@ from pyrogram.client.ext import BaseClient
class EditMessageReplyMarkup(BaseClient):
- def edit_message_reply_markup(self,
- chat_id: Union[int, str],
- message_id: int,
- reply_markup: "pyrogram.InlineKeyboardMarkup" = None) -> "pyrogram.Message":
+ def edit_message_reply_markup(
+ self,
+ chat_id: Union[int, str],
+ message_id: int,
+ reply_markup: "pyrogram.InlineKeyboardMarkup" = None
+ ) -> "pyrogram.Message":
"""Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline bots).
Args:
@@ -47,7 +49,7 @@ class EditMessageReplyMarkup(BaseClient):
:obj:`Message ` is returned, otherwise True is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
r = self.send(
diff --git a/pyrogram/client/methods/messages/edit_message_text.py b/pyrogram/client/methods/messages/edit_message_text.py
index 1d2a065b..8e23b1de 100644
--- a/pyrogram/client/methods/messages/edit_message_text.py
+++ b/pyrogram/client/methods/messages/edit_message_text.py
@@ -24,13 +24,15 @@ from pyrogram.client.ext import BaseClient
class EditMessageText(BaseClient):
- def edit_message_text(self,
- chat_id: Union[int, str],
- message_id: int,
- text: str,
- parse_mode: str = "",
- disable_web_page_preview: bool = None,
- reply_markup: "pyrogram.InlineKeyboardMarkup" = None) -> "pyrogram.Message":
+ def edit_message_text(
+ self,
+ chat_id: Union[int, str],
+ message_id: int,
+ text: str,
+ parse_mode: str = "",
+ disable_web_page_preview: bool = None,
+ reply_markup: "pyrogram.InlineKeyboardMarkup" = None
+ ) -> "pyrogram.Message":
"""Use this method to edit text messages.
Args:
@@ -60,7 +62,7 @@ class EditMessageText(BaseClient):
On success, the edited :obj:`Message ` is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
style = self.html if parse_mode.lower() == "html" else self.markdown
diff --git a/pyrogram/client/methods/messages/forward_messages.py b/pyrogram/client/methods/messages/forward_messages.py
index 72e43e08..5540b38a 100644
--- a/pyrogram/client/methods/messages/forward_messages.py
+++ b/pyrogram/client/methods/messages/forward_messages.py
@@ -24,11 +24,15 @@ from ...ext import BaseClient
class ForwardMessages(BaseClient):
- def forward_messages(self,
- chat_id: Union[int, str],
- from_chat_id: Union[int, str],
- message_ids: Iterable[int],
- disable_notification: bool = None) -> "pyrogram.Messages":
+ def forward_messages(
+ self,
+ chat_id: Union[int, str],
+ from_chat_id: Union[int, str],
+ message_ids: Iterable[int],
+ disable_notification: bool = None,
+ as_copy: bool = False,
+ remove_caption: bool = False
+ ) -> "pyrogram.Messages":
"""Use this method to forward messages of any kind.
Args:
@@ -50,6 +54,15 @@ class ForwardMessages(BaseClient):
Sends the message silently.
Users will receive a notification with no sound.
+ as_copy (``bool``, *optional*):
+ Pass True to forward messages without the forward header (i.e.: send a copy of the message content).
+ Defaults to False.
+
+ remove_caption (``bool``, *optional*):
+ If set to True and *as_copy* is enabled as well, media captions are not preserved when copying the
+ message. Has no effect if *as_copy* is not enabled.
+ Defaults to False.
+
Returns:
On success and in case *message_ids* was an iterable, the returned value will be a list of the forwarded
:obj:`Messages ` even if a list contains just one element, otherwise if
@@ -57,37 +70,60 @@ class ForwardMessages(BaseClient):
is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
+
is_iterable = not isinstance(message_ids, int)
message_ids = list(message_ids) if is_iterable else [message_ids]
- r = self.send(
- functions.messages.ForwardMessages(
- to_peer=self.resolve_peer(chat_id),
- from_peer=self.resolve_peer(from_chat_id),
- id=message_ids,
- silent=disable_notification or None,
- random_id=[self.rnd_id() for _ in message_ids]
- )
- )
+ if as_copy:
+ forwarded_messages = []
- messages = []
+ for chunk in [message_ids[i:i + 200] for i in range(0, len(message_ids), 200)]:
+ messages = self.get_messages(chat_id=from_chat_id, message_ids=chunk) # type: pyrogram.Messages
- users = {i.id: i for i in r.users}
- chats = {i.id: i for i in r.chats}
-
- for i in r.updates:
- if isinstance(i, (types.UpdateNewMessage, types.UpdateNewChannelMessage)):
- messages.append(
- pyrogram.Message._parse(
- self, i.message,
- users, chats
+ for message in messages.messages:
+ forwarded_messages.append(
+ message.forward(
+ chat_id,
+ disable_notification=disable_notification,
+ as_copy=True,
+ remove_caption=remove_caption
+ )
)
- )
- return pyrogram.Messages(
- client=self,
- total_count=len(messages),
- messages=messages
- ) if is_iterable else messages[0]
+ return pyrogram.Messages(
+ client=self,
+ total_count=len(forwarded_messages),
+ messages=forwarded_messages
+ ) if is_iterable else forwarded_messages[0]
+ else:
+ r = self.send(
+ functions.messages.ForwardMessages(
+ to_peer=self.resolve_peer(chat_id),
+ from_peer=self.resolve_peer(from_chat_id),
+ id=message_ids,
+ silent=disable_notification or None,
+ random_id=[self.rnd_id() for _ in message_ids]
+ )
+ )
+
+ forwarded_messages = []
+
+ users = {i.id: i for i in r.users}
+ chats = {i.id: i for i in r.chats}
+
+ for i in r.updates:
+ if isinstance(i, (types.UpdateNewMessage, types.UpdateNewChannelMessage)):
+ forwarded_messages.append(
+ pyrogram.Message._parse(
+ self, i.message,
+ users, chats
+ )
+ )
+
+ return pyrogram.Messages(
+ client=self,
+ total_count=len(forwarded_messages),
+ messages=forwarded_messages
+ ) if is_iterable else forwarded_messages[0]
diff --git a/pyrogram/client/methods/messages/get_history.py b/pyrogram/client/methods/messages/get_history.py
index 73923b44..fda8f11f 100644
--- a/pyrogram/client/methods/messages/get_history.py
+++ b/pyrogram/client/methods/messages/get_history.py
@@ -22,20 +22,22 @@ from typing import Union
import pyrogram
from pyrogram.api import functions
-from pyrogram.api.errors import FloodWait
+from pyrogram.errors import FloodWait
from ...ext import BaseClient
log = logging.getLogger(__name__)
class GetHistory(BaseClient):
- def get_history(self,
- chat_id: Union[int, str],
- limit: int = 100,
- offset: int = 0,
- offset_id: int = 0,
- offset_date: int = 0,
- reverse: bool = False):
+ def get_history(
+ self,
+ chat_id: Union[int, str],
+ limit: int = 100,
+ offset: int = 0,
+ offset_id: int = 0,
+ offset_date: int = 0,
+ reverse: bool = False
+ ):
"""Use this method to retrieve a chunk of the history of a chat.
You can get up to 100 messages at once.
@@ -68,7 +70,7 @@ class GetHistory(BaseClient):
On success, a :obj:`Messages ` object is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
while True:
diff --git a/pyrogram/client/methods/messages/get_messages.py b/pyrogram/client/methods/messages/get_messages.py
index b1c90d10..c018a9eb 100644
--- a/pyrogram/client/methods/messages/get_messages.py
+++ b/pyrogram/client/methods/messages/get_messages.py
@@ -22,18 +22,20 @@ from typing import Union, Iterable
import pyrogram
from pyrogram.api import functions, types
-from pyrogram.api.errors import FloodWait
+from pyrogram.errors import FloodWait
from ...ext import BaseClient
log = logging.getLogger(__name__)
class GetMessages(BaseClient):
- def get_messages(self,
- chat_id: Union[int, str],
- message_ids: Union[int, Iterable[int]] = None,
- reply_to_message_ids: Union[int, Iterable[int]] = None,
- replies: int = 1) -> Union["pyrogram.Message", "pyrogram.Messages"]:
+ def get_messages(
+ self,
+ chat_id: Union[int, str],
+ message_ids: Union[int, Iterable[int]] = None,
+ reply_to_message_ids: Union[int, Iterable[int]] = None,
+ replies: int = 1
+ ) -> Union["pyrogram.Message", "pyrogram.Messages"]:
"""Use this method to get one or more messages that belong to a specific chat.
You can retrieve up to 200 messages at once.
@@ -61,7 +63,7 @@ class GetMessages(BaseClient):
*reply_to_message_ids* was an integer, the single requested :obj:`Message ` is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
ids, ids_type = (
(message_ids, types.InputMessageID) if message_ids
@@ -76,7 +78,7 @@ class GetMessages(BaseClient):
is_iterable = not isinstance(ids, int)
ids = list(ids) if is_iterable else [ids]
- ids = [ids_type(i) for i in ids]
+ ids = [ids_type(id=i) for i in ids]
if isinstance(peer, types.InputPeerChannel):
rpc = functions.channels.GetMessages(channel=peer, id=ids)
diff --git a/pyrogram/client/methods/messages/iter_history.py b/pyrogram/client/methods/messages/iter_history.py
index ab587988..f7a8a74e 100644
--- a/pyrogram/client/methods/messages/iter_history.py
+++ b/pyrogram/client/methods/messages/iter_history.py
@@ -23,13 +23,15 @@ from ...ext import BaseClient
class IterHistory(BaseClient):
- def iter_history(self,
- chat_id: Union[int, str],
- limit: int = 0,
- offset: int = 0,
- offset_id: int = 0,
- offset_date: int = 0,
- reverse: bool = False) -> Generator["pyrogram.Message", None, None]:
+ def iter_history(
+ self,
+ chat_id: Union[int, str],
+ limit: int = 0,
+ offset: int = 0,
+ offset_id: int = 0,
+ offset_date: int = 0,
+ reverse: bool = False
+ ) -> Generator["pyrogram.Message", None, None]:
"""Use this method to iterate through a chat history sequentially.
This convenience method does the same as repeatedly calling :meth:`get_history` in a loop, thus saving you from
@@ -62,7 +64,7 @@ class IterHistory(BaseClient):
A generator yielding :obj:`Message ` objects.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
offset_id = offset_id or (1 if reverse else 0)
current = 0
diff --git a/pyrogram/client/methods/messages/retract_vote.py b/pyrogram/client/methods/messages/retract_vote.py
index 7893f768..8fa8996c 100644
--- a/pyrogram/client/methods/messages/retract_vote.py
+++ b/pyrogram/client/methods/messages/retract_vote.py
@@ -23,9 +23,11 @@ from pyrogram.client.ext import BaseClient
class RetractVote(BaseClient):
- def retract_vote(self,
- chat_id: Union[int, str],
- message_id: id) -> bool:
+ def retract_vote(
+ self,
+ chat_id: Union[int, str],
+ message_id: id
+ ) -> bool:
"""Use this method to retract your vote in a poll.
Args:
@@ -41,7 +43,7 @@ class RetractVote(BaseClient):
On success, True is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
self.send(
functions.messages.SendVote(
diff --git a/pyrogram/client/methods/messages/send_animation.py b/pyrogram/client/methods/messages/send_animation.py
index 8fc31e08..798d236d 100644
--- a/pyrogram/client/methods/messages/send_animation.py
+++ b/pyrogram/client/methods/messages/send_animation.py
@@ -23,28 +23,32 @@ from typing import Union
import pyrogram
from pyrogram.api import functions, types
-from pyrogram.api.errors import FileIdInvalid, FilePartMissing
+from pyrogram.errors import FileIdInvalid, FilePartMissing
from pyrogram.client.ext import BaseClient, utils
class SendAnimation(BaseClient):
- def send_animation(self,
- chat_id: Union[int, str],
- animation: str,
- caption: str = "",
- parse_mode: str = "",
- duration: int = 0,
- width: int = 0,
- height: int = 0,
- thumb: str = None,
- disable_notification: bool = None,
- reply_to_message_id: int = None,
- reply_markup: Union["pyrogram.InlineKeyboardMarkup",
- "pyrogram.ReplyKeyboardMarkup",
- "pyrogram.ReplyKeyboardRemove",
- "pyrogram.ForceReply"] = None,
- progress: callable = None,
- progress_args: tuple = ()) -> Union["pyrogram.Message", None]:
+ def send_animation(
+ self,
+ chat_id: Union[int, str],
+ animation: str,
+ caption: str = "",
+ parse_mode: str = "",
+ duration: int = 0,
+ width: int = 0,
+ height: int = 0,
+ thumb: str = None,
+ disable_notification: bool = None,
+ reply_to_message_id: int = None,
+ reply_markup: Union[
+ "pyrogram.InlineKeyboardMarkup",
+ "pyrogram.ReplyKeyboardMarkup",
+ "pyrogram.ReplyKeyboardRemove",
+ "pyrogram.ForceReply"
+ ] = None,
+ progress: callable = None,
+ progress_args: tuple = ()
+ ) -> Union["pyrogram.Message", None]:
"""Use this method to send animation files (animation or H.264/MPEG-4 AVC video without sound).
Args:
@@ -121,7 +125,7 @@ class SendAnimation(BaseClient):
In case the upload is deliberately stopped with :meth:`stop_transmission`, None is returned instead.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
file = None
style = self.html if parse_mode.lower() == "html" else self.markdown
@@ -141,7 +145,7 @@ class SendAnimation(BaseClient):
w=width,
h=height
),
- types.DocumentAttributeFilename(os.path.basename(animation)),
+ types.DocumentAttributeFilename(file_name=os.path.basename(animation)),
types.DocumentAttributeAnimated()
]
)
diff --git a/pyrogram/client/methods/messages/send_audio.py b/pyrogram/client/methods/messages/send_audio.py
index a956ba85..d514b737 100644
--- a/pyrogram/client/methods/messages/send_audio.py
+++ b/pyrogram/client/methods/messages/send_audio.py
@@ -23,28 +23,32 @@ from typing import Union
import pyrogram
from pyrogram.api import functions, types
-from pyrogram.api.errors import FileIdInvalid, FilePartMissing
+from pyrogram.errors import FileIdInvalid, FilePartMissing
from pyrogram.client.ext import BaseClient, utils
class SendAudio(BaseClient):
- def send_audio(self,
- chat_id: Union[int, str],
- audio: str,
- caption: str = "",
- parse_mode: str = "",
- duration: int = 0,
- performer: str = None,
- title: str = None,
- thumb: str = None,
- disable_notification: bool = None,
- reply_to_message_id: int = None,
- reply_markup: Union["pyrogram.InlineKeyboardMarkup",
- "pyrogram.ReplyKeyboardMarkup",
- "pyrogram.ReplyKeyboardRemove",
- "pyrogram.ForceReply"] = None,
- progress: callable = None,
- progress_args: tuple = ()) -> Union["pyrogram.Message", None]:
+ def send_audio(
+ self,
+ chat_id: Union[int, str],
+ audio: str,
+ caption: str = "",
+ parse_mode: str = "",
+ duration: int = 0,
+ performer: str = None,
+ title: str = None,
+ thumb: str = None,
+ disable_notification: bool = None,
+ reply_to_message_id: int = None,
+ reply_markup: Union[
+ "pyrogram.InlineKeyboardMarkup",
+ "pyrogram.ReplyKeyboardMarkup",
+ "pyrogram.ReplyKeyboardRemove",
+ "pyrogram.ForceReply"
+ ] = None,
+ progress: callable = None,
+ progress_args: tuple = ()
+ ) -> Union["pyrogram.Message", None]:
"""Use this method to send audio files.
For sending voice messages, use the :obj:`send_voice()` method instead.
@@ -123,7 +127,7 @@ class SendAudio(BaseClient):
In case the upload is deliberately stopped with :meth:`stop_transmission`, None is returned instead.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
file = None
style = self.html if parse_mode.lower() == "html" else self.markdown
@@ -142,7 +146,7 @@ class SendAudio(BaseClient):
performer=performer,
title=title
),
- types.DocumentAttributeFilename(os.path.basename(audio))
+ types.DocumentAttributeFilename(file_name=os.path.basename(audio))
]
)
elif audio.startswith("http"):
diff --git a/pyrogram/client/methods/messages/send_cached_media.py b/pyrogram/client/methods/messages/send_cached_media.py
new file mode 100644
index 00000000..f0c690d9
--- /dev/null
+++ b/pyrogram/client/methods/messages/send_cached_media.py
@@ -0,0 +1,135 @@
+# Pyrogram - Telegram MTProto API Client Library for Python
+# Copyright (C) 2017-2019 Dan Tès
+#
+# This file is part of Pyrogram.
+#
+# Pyrogram is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Pyrogram is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Pyrogram. If not, see .
+
+import binascii
+import struct
+from typing import Union
+
+import pyrogram
+from pyrogram.api import functions, types
+from pyrogram.errors import FileIdInvalid
+from pyrogram.client.ext import BaseClient, utils
+
+
+class SendCachedMedia(BaseClient):
+ def send_cached_media(
+ self,
+ chat_id: Union[int, str],
+ file_id: str,
+ caption: str = "",
+ parse_mode: str = "",
+ disable_notification: bool = None,
+ reply_to_message_id: int = None,
+ reply_markup: Union[
+ "pyrogram.InlineKeyboardMarkup",
+ "pyrogram.ReplyKeyboardMarkup",
+ "pyrogram.ReplyKeyboardRemove",
+ "pyrogram.ForceReply"
+ ] = None
+ ) -> Union["pyrogram.Message", None]:
+ """Use this method to send any media stored on the Telegram servers using a file_id.
+
+ This convenience method works with any valid file_id only.
+ It does the same as calling the relevant method for sending media using a file_id, thus saving you from the
+ hassle of using the correct method for the media the file_id is pointing to.
+
+ Args:
+ chat_id (``int`` | ``str``):
+ Unique identifier (int) or username (str) of the target chat.
+ For your personal cloud (Saved Messages) you can simply use "me" or "self".
+ For a contact that exists in your Telegram address book you can use his phone number (str).
+
+ file_id (``str``):
+ Media to send.
+ Pass a file_id as string to send a media that exists on the Telegram servers.
+
+ caption (``bool``, *optional*):
+ Media caption, 0-1024 characters.
+
+ parse_mode (``str``, *optional*):
+ Use :obj:`MARKDOWN ` or :obj:`HTML `
+ if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your caption.
+ Defaults to Markdown.
+
+ disable_notification (``bool``, *optional*):
+ Sends the message silently.
+ Users will receive a notification with no sound.
+
+ reply_to_message_id (``int``, *optional*):
+ If the message is a reply, ID of the original message.
+
+ reply_markup (:obj:`InlineKeyboardMarkup` | :obj:`ReplyKeyboardMarkup` | :obj:`ReplyKeyboardRemove` | :obj:`ForceReply`, *optional*):
+ Additional interface options. An object for an inline keyboard, custom reply keyboard,
+ instructions to remove reply keyboard or to force a reply from the user.
+
+ Returns:
+ On success, the sent :obj:`Message ` is returned.
+
+ Raises:
+ :class:`RPCError ` in case of a Telegram RPC error.
+ """
+ style = self.html if parse_mode.lower() == "html" else self.markdown
+
+ try:
+ decoded = utils.decode(file_id)
+ fmt = " 24 else "` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
``ValueError`` if the provided string is not a valid ChatAction.
"""
@@ -60,7 +62,7 @@ class SendChatAction(BaseClient):
action = action.value
if "Upload" in action.__name__:
- action = action(progress)
+ action = action(progress=progress)
else:
action = action()
diff --git a/pyrogram/client/methods/messages/send_contact.py b/pyrogram/client/methods/messages/send_contact.py
index 96b23a9b..9143440e 100644
--- a/pyrogram/client/methods/messages/send_contact.py
+++ b/pyrogram/client/methods/messages/send_contact.py
@@ -24,18 +24,22 @@ from pyrogram.client.ext import BaseClient
class SendContact(BaseClient):
- def send_contact(self,
- chat_id: Union[int, str],
- phone_number: str,
- first_name: str,
- last_name: str = "",
- vcard: str = "",
- disable_notification: bool = None,
- reply_to_message_id: int = None,
- reply_markup: Union["pyrogram.InlineKeyboardMarkup",
- "pyrogram.ReplyKeyboardMarkup",
- "pyrogram.ReplyKeyboardRemove",
- "pyrogram.ForceReply"] = None) -> "pyrogram.Message":
+ def send_contact(
+ self,
+ chat_id: Union[int, str],
+ phone_number: str,
+ first_name: str,
+ last_name: str = None,
+ vcard: str = None,
+ disable_notification: bool = None,
+ reply_to_message_id: int = None,
+ reply_markup: Union[
+ "pyrogram.InlineKeyboardMarkup",
+ "pyrogram.ReplyKeyboardMarkup",
+ "pyrogram.ReplyKeyboardRemove",
+ "pyrogram.ForceReply"
+ ] = None
+ ) -> "pyrogram.Message":
"""Use this method to send phone contacts.
Args:
@@ -71,7 +75,7 @@ class SendContact(BaseClient):
On success, the sent :obj:`Message ` is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
r = self.send(
functions.messages.SendMedia(
@@ -79,8 +83,8 @@ class SendContact(BaseClient):
media=types.InputMediaContact(
phone_number=phone_number,
first_name=first_name,
- last_name=last_name,
- vcard=vcard
+ last_name=last_name or "",
+ vcard=vcard or ""
),
message="",
silent=disable_notification or None,
diff --git a/pyrogram/client/methods/messages/send_document.py b/pyrogram/client/methods/messages/send_document.py
index 35fe8c0e..a36a0fbb 100644
--- a/pyrogram/client/methods/messages/send_document.py
+++ b/pyrogram/client/methods/messages/send_document.py
@@ -23,25 +23,29 @@ from typing import Union
import pyrogram
from pyrogram.api import functions, types
-from pyrogram.api.errors import FileIdInvalid, FilePartMissing
+from pyrogram.errors import FileIdInvalid, FilePartMissing
from pyrogram.client.ext import BaseClient, utils
class SendDocument(BaseClient):
- def send_document(self,
- chat_id: Union[int, str],
- document: str,
- thumb: str = None,
- caption: str = "",
- parse_mode: str = "",
- disable_notification: bool = None,
- reply_to_message_id: int = None,
- reply_markup: Union["pyrogram.InlineKeyboardMarkup",
- "pyrogram.ReplyKeyboardMarkup",
- "pyrogram.ReplyKeyboardRemove",
- "pyrogram.ForceReply"] = None,
- progress: callable = None,
- progress_args: tuple = ()) -> Union["pyrogram.Message", None]:
+ def send_document(
+ self,
+ chat_id: Union[int, str],
+ document: str,
+ thumb: str = None,
+ caption: str = "",
+ parse_mode: str = "",
+ disable_notification: bool = None,
+ reply_to_message_id: int = None,
+ reply_markup: Union[
+ "pyrogram.InlineKeyboardMarkup",
+ "pyrogram.ReplyKeyboardMarkup",
+ "pyrogram.ReplyKeyboardRemove",
+ "pyrogram.ForceReply"
+ ] = None,
+ progress: callable = None,
+ progress_args: tuple = ()
+ ) -> Union["pyrogram.Message", None]:
"""Use this method to send general files.
Args:
@@ -56,7 +60,7 @@ class SendDocument(BaseClient):
pass an HTTP URL as a string for Telegram to get a file from the Internet, or
pass a file path as string to upload a new file that exists on your local machine.
- thumb (``str``):
+ thumb (``str``, *optional*):
Thumbnail of the file sent.
The thumbnail should be in JPEG format and less than 200 KB in size.
A thumbnail's width and height should not exceed 90 pixels.
@@ -109,7 +113,7 @@ class SendDocument(BaseClient):
In case the upload is deliberately stopped with :meth:`stop_transmission`, None is returned instead.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
file = None
style = self.html if parse_mode.lower() == "html" else self.markdown
@@ -123,7 +127,7 @@ class SendDocument(BaseClient):
file=file,
thumb=thumb,
attributes=[
- types.DocumentAttributeFilename(os.path.basename(document))
+ types.DocumentAttributeFilename(file_name=os.path.basename(document))
]
)
elif document.startswith("http"):
diff --git a/pyrogram/client/methods/messages/send_location.py b/pyrogram/client/methods/messages/send_location.py
index b899a938..f3ed81df 100644
--- a/pyrogram/client/methods/messages/send_location.py
+++ b/pyrogram/client/methods/messages/send_location.py
@@ -24,16 +24,20 @@ from pyrogram.client.ext import BaseClient
class SendLocation(BaseClient):
- def send_location(self,
- chat_id: Union[int, str],
- latitude: float,
- longitude: float,
- disable_notification: bool = None,
- reply_to_message_id: int = None,
- reply_markup: Union["pyrogram.InlineKeyboardMarkup",
- "pyrogram.ReplyKeyboardMarkup",
- "pyrogram.ReplyKeyboardRemove",
- "pyrogram.ForceReply"] = None) -> "pyrogram.Message":
+ def send_location(
+ self,
+ chat_id: Union[int, str],
+ latitude: float,
+ longitude: float,
+ disable_notification: bool = None,
+ reply_to_message_id: int = None,
+ reply_markup: Union[
+ "pyrogram.InlineKeyboardMarkup",
+ "pyrogram.ReplyKeyboardMarkup",
+ "pyrogram.ReplyKeyboardRemove",
+ "pyrogram.ForceReply"
+ ] = None
+ ) -> "pyrogram.Message":
"""Use this method to send points on the map.
Args:
@@ -63,15 +67,15 @@ class SendLocation(BaseClient):
On success, the sent :obj:`Message ` is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
r = self.send(
functions.messages.SendMedia(
peer=self.resolve_peer(chat_id),
media=types.InputMediaGeoPoint(
- types.InputGeoPoint(
- latitude,
- longitude
+ geo_point=types.InputGeoPoint(
+ lat=latitude,
+ long=longitude
)
),
message="",
diff --git a/pyrogram/client/methods/messages/send_media_group.py b/pyrogram/client/methods/messages/send_media_group.py
index 0df273bc..4fdc1132 100644
--- a/pyrogram/client/methods/messages/send_media_group.py
+++ b/pyrogram/client/methods/messages/send_media_group.py
@@ -25,7 +25,7 @@ from typing import Union, List
import pyrogram
from pyrogram.api import functions, types
-from pyrogram.api.errors import FileIdInvalid, FloodWait
+from pyrogram.errors import FileIdInvalid, FloodWait
from pyrogram.client.ext import BaseClient, utils
log = logging.getLogger(__name__)
@@ -34,11 +34,13 @@ log = logging.getLogger(__name__)
class SendMediaGroup(BaseClient):
# TODO: Add progress parameter
# TODO: Figure out how to send albums using URLs
- def send_media_group(self,
- chat_id: Union[int, str],
- media: List[Union["pyrogram.InputMediaPhoto", "pyrogram.InputMediaVideo"]],
- disable_notification: bool = None,
- reply_to_message_id: int = None):
+ def send_media_group(
+ self,
+ chat_id: Union[int, str],
+ media: List[Union["pyrogram.InputMediaPhoto", "pyrogram.InputMediaVideo"]],
+ disable_notification: bool = None,
+ reply_to_message_id: int = None
+ ):
"""Use this method to send a group of photos or videos as an album.
Args:
@@ -47,10 +49,8 @@ class SendMediaGroup(BaseClient):
For your personal cloud (Saved Messages) you can simply use "me" or "self".
For a contact that exists in your Telegram address book you can use his phone number (str).
- media (``list``):
- A list containing either :obj:`InputMediaPhoto ` or
- :obj:`InputMediaVideo ` objects
- describing photos and videos to be sent, must include 2–10 items.
+ media (List of :obj:`InputMediaPhoto` and :obj:`InputMediaVideo`):
+ A list describing photos and videos to be sent, must include 2–10 items.
disable_notification (``bool``, *optional*):
Sends the message silently.
@@ -64,7 +64,7 @@ class SendMediaGroup(BaseClient):
single messages sent.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
multi_media = []
@@ -137,7 +137,7 @@ class SendMediaGroup(BaseClient):
w=i.width,
h=i.height
),
- types.DocumentAttributeFilename(os.path.basename(i.media))
+ types.DocumentAttributeFilename(file_name=os.path.basename(i.media))
]
)
)
diff --git a/pyrogram/client/methods/messages/send_message.py b/pyrogram/client/methods/messages/send_message.py
index 6589fcd6..b45b7192 100644
--- a/pyrogram/client/methods/messages/send_message.py
+++ b/pyrogram/client/methods/messages/send_message.py
@@ -24,17 +24,21 @@ from ...ext import BaseClient
class SendMessage(BaseClient):
- def send_message(self,
- chat_id: Union[int, str],
- text: str,
- parse_mode: str = "",
- disable_web_page_preview: bool = None,
- disable_notification: bool = None,
- reply_to_message_id: int = None,
- reply_markup: Union["pyrogram.InlineKeyboardMarkup",
- "pyrogram.ReplyKeyboardMarkup",
- "pyrogram.ReplyKeyboardRemove",
- "pyrogram.ForceReply"] = None) -> "pyrogram.Message":
+ def send_message(
+ self,
+ chat_id: Union[int, str],
+ text: str,
+ parse_mode: str = "",
+ disable_web_page_preview: bool = None,
+ disable_notification: bool = None,
+ reply_to_message_id: int = None,
+ reply_markup: Union[
+ "pyrogram.InlineKeyboardMarkup",
+ "pyrogram.ReplyKeyboardMarkup",
+ "pyrogram.ReplyKeyboardRemove",
+ "pyrogram.ForceReply"
+ ] = None
+ ) -> "pyrogram.Message":
"""Use this method to send text messages.
Args:
@@ -69,7 +73,7 @@ class SendMessage(BaseClient):
On success, the sent :obj:`Message` is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
style = self.html if parse_mode.lower() == "html" else self.markdown
message, entities = style.parse(text).values()
diff --git a/pyrogram/client/methods/messages/send_photo.py b/pyrogram/client/methods/messages/send_photo.py
index 84647245..7e327cbd 100644
--- a/pyrogram/client/methods/messages/send_photo.py
+++ b/pyrogram/client/methods/messages/send_photo.py
@@ -23,25 +23,29 @@ from typing import Union
import pyrogram
from pyrogram.api import functions, types
-from pyrogram.api.errors import FileIdInvalid, FilePartMissing
+from pyrogram.errors import FileIdInvalid, FilePartMissing
from pyrogram.client.ext import BaseClient, utils
class SendPhoto(BaseClient):
- def send_photo(self,
- chat_id: Union[int, str],
- photo: str,
- caption: str = "",
- parse_mode: str = "",
- ttl_seconds: int = None,
- disable_notification: bool = None,
- reply_to_message_id: int = None,
- reply_markup: Union["pyrogram.InlineKeyboardMarkup",
- "pyrogram.ReplyKeyboardMarkup",
- "pyrogram.ReplyKeyboardRemove",
- "pyrogram.ForceReply"] = None,
- progress: callable = None,
- progress_args: tuple = ()) -> Union["pyrogram.Message", None]:
+ def send_photo(
+ self,
+ chat_id: Union[int, str],
+ photo: str,
+ caption: str = "",
+ parse_mode: str = "",
+ ttl_seconds: int = None,
+ disable_notification: bool = None,
+ reply_to_message_id: int = None,
+ reply_markup: Union[
+ "pyrogram.InlineKeyboardMarkup",
+ "pyrogram.ReplyKeyboardMarkup",
+ "pyrogram.ReplyKeyboardRemove",
+ "pyrogram.ForceReply"
+ ] = None,
+ progress: callable = None,
+ progress_args: tuple = ()
+ ) -> Union["pyrogram.Message", None]:
"""Use this method to send photos.
Args:
@@ -108,7 +112,7 @@ class SendPhoto(BaseClient):
In case the upload is deliberately stopped with :meth:`stop_transmission`, None is returned instead.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
file = None
style = self.html if parse_mode.lower() == "html" else self.markdown
diff --git a/pyrogram/client/methods/messages/send_poll.py b/pyrogram/client/methods/messages/send_poll.py
index 8e938a1a..13e55b08 100644
--- a/pyrogram/client/methods/messages/send_poll.py
+++ b/pyrogram/client/methods/messages/send_poll.py
@@ -24,16 +24,20 @@ from pyrogram.client.ext import BaseClient
class SendPoll(BaseClient):
- def send_poll(self,
- chat_id: Union[int, str],
- question: str,
- options: List[str],
- disable_notification: bool = None,
- reply_to_message_id: int = None,
- reply_markup: Union["pyrogram.InlineKeyboardMarkup",
- "pyrogram.ReplyKeyboardMarkup",
- "pyrogram.ReplyKeyboardRemove",
- "pyrogram.ForceReply"] = None) -> "pyrogram.Message":
+ def send_poll(
+ self,
+ chat_id: Union[int, str],
+ question: str,
+ options: List[str],
+ disable_notification: bool = None,
+ reply_to_message_id: int = None,
+ reply_markup: Union[
+ "pyrogram.InlineKeyboardMarkup",
+ "pyrogram.ReplyKeyboardMarkup",
+ "pyrogram.ReplyKeyboardRemove",
+ "pyrogram.ForceReply"
+ ] = None
+ ) -> "pyrogram.Message":
"""Use this method to send a new poll.
Args:
@@ -63,7 +67,7 @@ class SendPoll(BaseClient):
On success, the sent :obj:`Message ` is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
r = self.send(
functions.messages.SendMedia(
diff --git a/pyrogram/client/methods/messages/send_sticker.py b/pyrogram/client/methods/messages/send_sticker.py
index e41c074e..e556aae3 100644
--- a/pyrogram/client/methods/messages/send_sticker.py
+++ b/pyrogram/client/methods/messages/send_sticker.py
@@ -23,22 +23,26 @@ from typing import Union
import pyrogram
from pyrogram.api import functions, types
-from pyrogram.api.errors import FileIdInvalid, FilePartMissing
+from pyrogram.errors import FileIdInvalid, FilePartMissing
from pyrogram.client.ext import BaseClient, utils
class SendSticker(BaseClient):
- def send_sticker(self,
- chat_id: Union[int, str],
- sticker: str,
- disable_notification: bool = None,
- reply_to_message_id: int = None,
- reply_markup: Union["pyrogram.InlineKeyboardMarkup",
- "pyrogram.ReplyKeyboardMarkup",
- "pyrogram.ReplyKeyboardRemove",
- "pyrogram.ForceReply"] = None,
- progress: callable = None,
- progress_args: tuple = ()) -> Union["pyrogram.Message", None]:
+ def send_sticker(
+ self,
+ chat_id: Union[int, str],
+ sticker: str,
+ disable_notification: bool = None,
+ reply_to_message_id: int = None,
+ reply_markup: Union[
+ "pyrogram.InlineKeyboardMarkup",
+ "pyrogram.ReplyKeyboardMarkup",
+ "pyrogram.ReplyKeyboardRemove",
+ "pyrogram.ForceReply"
+ ] = None,
+ progress: callable = None,
+ progress_args: tuple = ()
+ ) -> Union["pyrogram.Message", None]:
"""Use this method to send .webp stickers.
Args:
@@ -92,7 +96,7 @@ class SendSticker(BaseClient):
In case the upload is deliberately stopped with :meth:`stop_transmission`, None is returned instead.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
file = None
@@ -103,7 +107,7 @@ class SendSticker(BaseClient):
mime_type="image/webp",
file=file,
attributes=[
- types.DocumentAttributeFilename(os.path.basename(sticker))
+ types.DocumentAttributeFilename(file_name=os.path.basename(sticker))
]
)
elif sticker.startswith("http"):
diff --git a/pyrogram/client/methods/messages/send_venue.py b/pyrogram/client/methods/messages/send_venue.py
index 163be38e..1c9ca630 100644
--- a/pyrogram/client/methods/messages/send_venue.py
+++ b/pyrogram/client/methods/messages/send_venue.py
@@ -24,20 +24,24 @@ from pyrogram.client.ext import BaseClient
class SendVenue(BaseClient):
- def send_venue(self,
- chat_id: Union[int, str],
- latitude: float,
- longitude: float,
- title: str,
- address: str,
- foursquare_id: str = "",
- foursquare_type: str = "",
- disable_notification: bool = None,
- reply_to_message_id: int = None,
- reply_markup: Union["pyrogram.InlineKeyboardMarkup",
- "pyrogram.ReplyKeyboardMarkup",
- "pyrogram.ReplyKeyboardRemove",
- "pyrogram.ForceReply"] = None) -> "pyrogram.Message":
+ def send_venue(
+ self,
+ chat_id: Union[int, str],
+ latitude: float,
+ longitude: float,
+ title: str,
+ address: str,
+ foursquare_id: str = "",
+ foursquare_type: str = "",
+ disable_notification: bool = None,
+ reply_to_message_id: int = None,
+ reply_markup: Union[
+ "pyrogram.InlineKeyboardMarkup",
+ "pyrogram.ReplyKeyboardMarkup",
+ "pyrogram.ReplyKeyboardRemove",
+ "pyrogram.ForceReply"
+ ] = None
+ ) -> "pyrogram.Message":
"""Use this method to send information about a venue.
Args:
@@ -80,7 +84,7 @@ class SendVenue(BaseClient):
On success, the sent :obj:`Message ` is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
r = self.send(
functions.messages.SendMedia(
diff --git a/pyrogram/client/methods/messages/send_video.py b/pyrogram/client/methods/messages/send_video.py
index b69b2185..08d8b7ab 100644
--- a/pyrogram/client/methods/messages/send_video.py
+++ b/pyrogram/client/methods/messages/send_video.py
@@ -23,29 +23,33 @@ from typing import Union
import pyrogram
from pyrogram.api import functions, types
-from pyrogram.api.errors import FileIdInvalid, FilePartMissing
+from pyrogram.errors import FileIdInvalid, FilePartMissing
from pyrogram.client.ext import BaseClient, utils
class SendVideo(BaseClient):
- def send_video(self,
- chat_id: Union[int, str],
- video: str,
- caption: str = "",
- parse_mode: str = "",
- duration: int = 0,
- width: int = 0,
- height: int = 0,
- thumb: str = None,
- supports_streaming: bool = True,
- disable_notification: bool = None,
- reply_to_message_id: int = None,
- reply_markup: Union["pyrogram.InlineKeyboardMarkup",
- "pyrogram.ReplyKeyboardMarkup",
- "pyrogram.ReplyKeyboardRemove",
- "pyrogram.ForceReply"] = None,
- progress: callable = None,
- progress_args: tuple = ()) -> Union["pyrogram.Message", None]:
+ def send_video(
+ self,
+ chat_id: Union[int, str],
+ video: str,
+ caption: str = "",
+ parse_mode: str = "",
+ duration: int = 0,
+ width: int = 0,
+ height: int = 0,
+ thumb: str = None,
+ supports_streaming: bool = True,
+ disable_notification: bool = None,
+ reply_to_message_id: int = None,
+ reply_markup: Union[
+ "pyrogram.InlineKeyboardMarkup",
+ "pyrogram.ReplyKeyboardMarkup",
+ "pyrogram.ReplyKeyboardRemove",
+ "pyrogram.ForceReply"
+ ] = None,
+ progress: callable = None,
+ progress_args: tuple = ()
+ ) -> Union["pyrogram.Message", None]:
"""Use this method to send video files.
Args:
@@ -125,7 +129,7 @@ class SendVideo(BaseClient):
In case the upload is deliberately stopped with :meth:`stop_transmission`, None is returned instead.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
file = None
style = self.html if parse_mode.lower() == "html" else self.markdown
@@ -145,7 +149,7 @@ class SendVideo(BaseClient):
w=width,
h=height
),
- types.DocumentAttributeFilename(os.path.basename(video))
+ types.DocumentAttributeFilename(file_name=os.path.basename(video))
]
)
elif video.startswith("http"):
diff --git a/pyrogram/client/methods/messages/send_video_note.py b/pyrogram/client/methods/messages/send_video_note.py
index b35dbea6..4844dd65 100644
--- a/pyrogram/client/methods/messages/send_video_note.py
+++ b/pyrogram/client/methods/messages/send_video_note.py
@@ -23,25 +23,29 @@ from typing import Union
import pyrogram
from pyrogram.api import functions, types
-from pyrogram.api.errors import FileIdInvalid, FilePartMissing
+from pyrogram.errors import FileIdInvalid, FilePartMissing
from pyrogram.client.ext import BaseClient, utils
class SendVideoNote(BaseClient):
- def send_video_note(self,
- chat_id: Union[int, str],
- video_note: str,
- duration: int = 0,
- length: int = 1,
- thumb: str = None,
- disable_notification: bool = None,
- reply_to_message_id: int = None,
- reply_markup: Union["pyrogram.InlineKeyboardMarkup",
- "pyrogram.ReplyKeyboardMarkup",
- "pyrogram.ReplyKeyboardRemove",
- "pyrogram.ForceReply"] = None,
- progress: callable = None,
- progress_args: tuple = ()) -> Union["pyrogram.Message", None]:
+ def send_video_note(
+ self,
+ chat_id: Union[int, str],
+ video_note: str,
+ duration: int = 0,
+ length: int = 1,
+ thumb: str = None,
+ disable_notification: bool = None,
+ reply_to_message_id: int = None,
+ reply_markup: Union[
+ "pyrogram.InlineKeyboardMarkup",
+ "pyrogram.ReplyKeyboardMarkup",
+ "pyrogram.ReplyKeyboardRemove",
+ "pyrogram.ForceReply"
+ ] = None,
+ progress: callable = None,
+ progress_args: tuple = ()
+ ) -> Union["pyrogram.Message", None]:
"""Use this method to send video messages.
Args:
@@ -107,7 +111,7 @@ class SendVideoNote(BaseClient):
In case the upload is deliberately stopped with :meth:`stop_transmission`, None is returned instead.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
file = None
diff --git a/pyrogram/client/methods/messages/send_voice.py b/pyrogram/client/methods/messages/send_voice.py
index 33261db6..110b0704 100644
--- a/pyrogram/client/methods/messages/send_voice.py
+++ b/pyrogram/client/methods/messages/send_voice.py
@@ -23,25 +23,29 @@ from typing import Union
import pyrogram
from pyrogram.api import functions, types
-from pyrogram.api.errors import FileIdInvalid, FilePartMissing
+from pyrogram.errors import FileIdInvalid, FilePartMissing
from pyrogram.client.ext import BaseClient, utils
class SendVoice(BaseClient):
- def send_voice(self,
- chat_id: Union[int, str],
- voice: str,
- caption: str = "",
- parse_mode: str = "",
- duration: int = 0,
- disable_notification: bool = None,
- reply_to_message_id: int = None,
- reply_markup: Union["pyrogram.InlineKeyboardMarkup",
- "pyrogram.ReplyKeyboardMarkup",
- "pyrogram.ReplyKeyboardRemove",
- "pyrogram.ForceReply"] = None,
- progress: callable = None,
- progress_args: tuple = ()) -> Union["pyrogram.Message", None]:
+ def send_voice(
+ self,
+ chat_id: Union[int, str],
+ voice: str,
+ caption: str = "",
+ parse_mode: str = "",
+ duration: int = 0,
+ disable_notification: bool = None,
+ reply_to_message_id: int = None,
+ reply_markup: Union[
+ "pyrogram.InlineKeyboardMarkup",
+ "pyrogram.ReplyKeyboardMarkup",
+ "pyrogram.ReplyKeyboardRemove",
+ "pyrogram.ForceReply"
+ ] = None,
+ progress: callable = None,
+ progress_args: tuple = ()
+ ) -> Union["pyrogram.Message", None]:
"""Use this method to send audio files.
Args:
@@ -106,7 +110,7 @@ class SendVoice(BaseClient):
In case the upload is deliberately stopped with :meth:`stop_transmission`, None is returned instead.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
file = None
style = self.html if parse_mode.lower() == "html" else self.markdown
diff --git a/pyrogram/client/methods/messages/vote_poll.py b/pyrogram/client/methods/messages/vote_poll.py
index 9e400e62..2a9de874 100644
--- a/pyrogram/client/methods/messages/vote_poll.py
+++ b/pyrogram/client/methods/messages/vote_poll.py
@@ -23,10 +23,12 @@ from pyrogram.client.ext import BaseClient
class VotePoll(BaseClient):
- def vote_poll(self,
- chat_id: Union[int, str],
- message_id: id,
- option: int) -> bool:
+ def vote_poll(
+ self,
+ chat_id: Union[int, str],
+ message_id: id,
+ option: int
+ ) -> bool:
"""Use this method to vote a poll.
Args:
@@ -45,7 +47,7 @@ class VotePoll(BaseClient):
On success, True is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
poll = self.get_messages(chat_id, message_id).poll
diff --git a/pyrogram/client/methods/password/change_cloud_password.py b/pyrogram/client/methods/password/change_cloud_password.py
index 3504dab1..2f8cfbd6 100644
--- a/pyrogram/client/methods/password/change_cloud_password.py
+++ b/pyrogram/client/methods/password/change_cloud_password.py
@@ -24,10 +24,12 @@ from ...ext import BaseClient
class ChangeCloudPassword(BaseClient):
- def change_cloud_password(self,
- current_password: str,
- new_password: str,
- new_hint: str = "") -> bool:
+ def change_cloud_password(
+ self,
+ current_password: str,
+ new_password: str,
+ new_hint: str = ""
+ ) -> bool:
"""Use this method to change your Two-Step Verification password (Cloud Password) with a new one.
Args:
@@ -44,7 +46,7 @@ class ChangeCloudPassword(BaseClient):
True on success.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
``ValueError`` in case there is no cloud password to change.
"""
r = self.send(functions.account.GetPassword())
diff --git a/pyrogram/client/methods/password/enable_cloud_password.py b/pyrogram/client/methods/password/enable_cloud_password.py
index 980f50fd..b29dcfd3 100644
--- a/pyrogram/client/methods/password/enable_cloud_password.py
+++ b/pyrogram/client/methods/password/enable_cloud_password.py
@@ -24,10 +24,12 @@ from ...ext import BaseClient
class EnableCloudPassword(BaseClient):
- def enable_cloud_password(self,
- password: str,
- hint: str = "",
- email: str = None) -> bool:
+ def enable_cloud_password(
+ self,
+ password: str,
+ hint: str = "",
+ email: str = None
+ ) -> bool:
"""Use this method to enable the Two-Step Verification security feature (Cloud Password) on your account.
This password will be asked when you log-in on a new device in addition to the SMS code.
@@ -46,7 +48,7 @@ class EnableCloudPassword(BaseClient):
True on success.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
``ValueError`` in case there is already a cloud password enabled.
"""
r = self.send(functions.account.GetPassword())
diff --git a/pyrogram/client/methods/password/remove_cloud_password.py b/pyrogram/client/methods/password/remove_cloud_password.py
index 6817ab12..6e9a0ab4 100644
--- a/pyrogram/client/methods/password/remove_cloud_password.py
+++ b/pyrogram/client/methods/password/remove_cloud_password.py
@@ -22,8 +22,10 @@ from ...ext import BaseClient
class RemoveCloudPassword(BaseClient):
- def remove_cloud_password(self,
- password: str) -> bool:
+ def remove_cloud_password(
+ self,
+ password: str
+ ) -> bool:
"""Use this method to turn off the Two-Step Verification security feature (Cloud Password) on your account.
Args:
@@ -34,7 +36,7 @@ class RemoveCloudPassword(BaseClient):
True on success.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
``ValueError`` in case there is no cloud password to remove.
"""
r = self.send(functions.account.GetPassword())
diff --git a/pyrogram/client/methods/password/utils.py b/pyrogram/client/methods/password/utils.py
index 24c4dd28..3a29976a 100644
--- a/pyrogram/client/methods/password/utils.py
+++ b/pyrogram/client/methods/password/utils.py
@@ -101,4 +101,4 @@ def compute_check(r: types.account.Password, password: str) -> types.InputCheckP
+ K_bytes
)
- return types.InputCheckPasswordSRP(srp_id, A_bytes, M1_bytes)
+ return types.InputCheckPasswordSRP(srp_id=srp_id, A=A_bytes, M1=M1_bytes)
diff --git a/pyrogram/client/methods/users/__init__.py b/pyrogram/client/methods/users/__init__.py
index db5e5869..f8c39650 100644
--- a/pyrogram/client/methods/users/__init__.py
+++ b/pyrogram/client/methods/users/__init__.py
@@ -21,6 +21,7 @@ from .get_me import GetMe
from .get_user_profile_photos import GetUserProfilePhotos
from .get_users import GetUsers
from .set_user_profile_photo import SetUserProfilePhoto
+from .update_username import UpdateUsername
class Users(
@@ -28,6 +29,7 @@ class Users(
SetUserProfilePhoto,
DeleteUserProfilePhotos,
GetUsers,
- GetMe
+ GetMe,
+ UpdateUsername
):
pass
diff --git a/pyrogram/client/methods/users/delete_user_profile_photos.py b/pyrogram/client/methods/users/delete_user_profile_photos.py
index 025a5e95..bd9fc98e 100644
--- a/pyrogram/client/methods/users/delete_user_profile_photos.py
+++ b/pyrogram/client/methods/users/delete_user_profile_photos.py
@@ -25,9 +25,11 @@ from ...ext import BaseClient
class DeleteUserProfilePhotos(BaseClient):
- def delete_user_profile_photos(self,
- id: Union[str, List[str]]) -> bool:
- """Use this method to delete your own profile photos
+ def delete_user_profile_photos(
+ self,
+ id: Union[str, List[str]]
+ ) -> bool:
+ """Use this method to delete your own profile photos.
Args:
id (``str`` | ``list``):
@@ -38,7 +40,7 @@ class DeleteUserProfilePhotos(BaseClient):
True on success.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
id = id if isinstance(id, list) else [id]
input_photos = []
diff --git a/pyrogram/client/methods/users/get_me.py b/pyrogram/client/methods/users/get_me.py
index beea1243..c8b6c1f1 100644
--- a/pyrogram/client/methods/users/get_me.py
+++ b/pyrogram/client/methods/users/get_me.py
@@ -29,13 +29,13 @@ class GetMe(BaseClient):
Basic information about the user or bot in form of a :obj:`User` object
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
return pyrogram.User._parse(
self,
self.send(
functions.users.GetFullUser(
- types.InputPeerSelf()
+ id=types.InputPeerSelf()
)
).user
)
diff --git a/pyrogram/client/methods/users/get_user_profile_photos.py b/pyrogram/client/methods/users/get_user_profile_photos.py
index 2129dba3..ac7a872e 100644
--- a/pyrogram/client/methods/users/get_user_profile_photos.py
+++ b/pyrogram/client/methods/users/get_user_profile_photos.py
@@ -24,10 +24,12 @@ from ...ext import BaseClient
class GetUserProfilePhotos(BaseClient):
- def get_user_profile_photos(self,
- user_id: Union[int, str],
- offset: int = 0,
- limit: int = 100) -> "pyrogram.UserProfilePhotos":
+ def get_user_profile_photos(
+ self,
+ user_id: Union[int, str],
+ offset: int = 0,
+ limit: int = 100
+ ) -> "pyrogram.UserProfilePhotos":
"""Use this method to get a list of profile pictures for a user.
Args:
@@ -48,7 +50,7 @@ class GetUserProfilePhotos(BaseClient):
On success, a :obj:`UserProfilePhotos` object is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
return pyrogram.UserProfilePhotos._parse(
self,
diff --git a/pyrogram/client/methods/users/get_users.py b/pyrogram/client/methods/users/get_users.py
index 6c340ffa..7e6ebd6b 100644
--- a/pyrogram/client/methods/users/get_users.py
+++ b/pyrogram/client/methods/users/get_users.py
@@ -24,8 +24,10 @@ from ...ext import BaseClient
class GetUsers(BaseClient):
- def get_users(self,
- user_ids: Iterable[Union[int, str]]) -> Union["pyrogram.User", List["pyrogram.User"]]:
+ def get_users(
+ self,
+ user_ids: Iterable[Union[int, str]]
+ ) -> Union["pyrogram.User", List["pyrogram.User"]]:
"""Use this method to get information about a user.
You can retrieve up to 200 users at once.
@@ -41,7 +43,7 @@ class GetUsers(BaseClient):
*user_ids* was an integer or string, the single requested :obj:`User` is returned.
Raises:
- :class:`Error ` in case of a Telegram RPC error.
+ :class:`RPCError ` in case of a Telegram RPC error.
"""
is_iterable = not isinstance(user_ids, (int, str))
user_ids = list(user_ids) if is_iterable else [user_ids]
diff --git a/pyrogram/client/methods/users/set_user_profile_photo.py b/pyrogram/client/methods/users/set_user_profile_photo.py
index 0863c695..af02a12d 100644
--- a/pyrogram/client/methods/users/set_user_profile_photo.py
+++ b/pyrogram/client/methods/users/set_user_profile_photo.py
@@ -21,8 +21,10 @@ from ...ext import BaseClient
class SetUserProfilePhoto(BaseClient):
- def set_user_profile_photo(self,
- photo: str) -> bool:
+ def set_user_profile_photo(
+ self,
+ photo: str
+ ) -> bool:
"""Use this method to set a new profile photo.
This method only works for Users.
@@ -37,13 +39,13 @@ class SetUserProfilePhoto(BaseClient):
True on success.
Raises:
- :class:`Error