TeamPGM/pyrogram
2
0
Fork 0
mirror of https://github.com/TeamPGM/pyrogram.git synced 2024-11-16 12:51:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into docs

Browse Source
This commit is contained in:
Dan 2018-03-25 21:59:14 +02:00
commit e5c8bcfe14
1 changed files with 34 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
pyrogram/client/client.py
View File

@ -190,7 +190,7 @@ class Client:
Requires no parameters. Requires no parameters.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
if self.BOT_TOKEN_RE.match(self.session_name): if self.BOT_TOKEN_RE.match(self.session_name):
self.token = self.session_name self.token = self.session_name
@ -789,7 +789,7 @@ class Client:
The API Scheme function filled with proper arguments. The API Scheme function filled with proper arguments.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
if self.is_started: if self.is_started:
r = self.session.send(data) r = self.session.send(data)
@ -921,7 +921,7 @@ class Client:
:obj:`InputPeerChannel <pyrogram.api.types.InputPeerChannel>` depending on the *peer_id*. :obj:`InputPeerChannel <pyrogram.api.types.InputPeerChannel>` depending on the *peer_id*.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
if type(peer_id) is str: if type(peer_id) is str:
if peer_id in ("self", "me"): if peer_id in ("self", "me"):
@ -977,7 +977,7 @@ class Client:
Full information about the user in form of a :obj:`UserFull <pyrogram.api.types.UserFull>` object. Full information about the user in form of a :obj:`UserFull <pyrogram.api.types.UserFull>` object.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
return self.send( return self.send(
functions.users.GetFullUser( functions.users.GetFullUser(
@ -1023,7 +1023,7 @@ class Client:
On success, the sent Message is returned. On success, the sent Message is returned.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
style = self.html if parse_mode.lower() == "html" else self.markdown style = self.html if parse_mode.lower() == "html" else self.markdown
@ -1069,7 +1069,7 @@ class Client:
On success, the sent Message is returned. On success, the sent Message is returned.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
return self.send( return self.send(
functions.messages.ForwardMessages( functions.messages.ForwardMessages(
@ -1138,7 +1138,7 @@ class Client:
On success, the sent Message is returned. On success, the sent Message is returned.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
style = self.html if parse_mode.lower() == "html" else self.markdown style = self.html if parse_mode.lower() == "html" else self.markdown
file = self.save_file(photo, progress=progress) file = self.save_file(photo, progress=progress)
@ -1228,7 +1228,7 @@ class Client:
On success, the sent Message is returned. On success, the sent Message is returned.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
style = self.html if parse_mode.lower() == "html" else self.markdown style = self.html if parse_mode.lower() == "html" else self.markdown
file = self.save_file(audio, progress=progress) file = self.save_file(audio, progress=progress)
@ -1312,7 +1312,7 @@ class Client:
On success, the sent Message is returned. On success, the sent Message is returned.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
style = self.html if parse_mode.lower() == "html" else self.markdown style = self.html if parse_mode.lower() == "html" else self.markdown
file = self.save_file(document, progress=progress) file = self.save_file(document, progress=progress)
@ -1381,7 +1381,7 @@ class Client:
On success, the sent Message is returned. On success, the sent Message is returned.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
file = self.save_file(sticker, progress=progress) file = self.save_file(sticker, progress=progress)
@ -1481,7 +1481,7 @@ class Client:
On success, the sent Message is returned. On success, the sent Message is returned.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
style = self.html if parse_mode.lower() == "html" else self.markdown style = self.html if parse_mode.lower() == "html" else self.markdown
file = self.save_file(video, progress=progress) file = self.save_file(video, progress=progress)
@ -1572,7 +1572,7 @@ class Client:
On success, the sent Message is returned. On success, the sent Message is returned.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
style = self.html if parse_mode.lower() == "html" else self.markdown style = self.html if parse_mode.lower() == "html" else self.markdown
file = self.save_file(voice, progress=progress) file = self.save_file(voice, progress=progress)
@ -1652,7 +1652,7 @@ class Client:
On success, the sent Message is returned. On success, the sent Message is returned.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
file = self.save_file(video_note, progress=progress) file = self.save_file(video_note, progress=progress)
@ -1816,7 +1816,7 @@ class Client:
On success, the sent Message is returned. On success, the sent Message is returned.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
return self.send( return self.send(
functions.messages.SendMedia( functions.messages.SendMedia(
@ -1878,7 +1878,7 @@ class Client:
On success, the sent Message is returned. On success, the sent Message is returned.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
return self.send( return self.send(
functions.messages.SendMedia( functions.messages.SendMedia(
@ -1937,7 +1937,7 @@ class Client:
On success, the sent Message is returned. On success, the sent Message is returned.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
return self.send( return self.send(
functions.messages.SendMedia( functions.messages.SendMedia(
@ -1976,7 +1976,7 @@ class Client:
Progress of the upload process. Progress of the upload process.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
if "Upload" in action.__name__: if "Upload" in action.__name__:
action = action(progress) action = action(progress)
@ -2009,7 +2009,7 @@ class Client:
Values between 1—100 are accepted. Defaults to 100. Values between 1—100 are accepted. Defaults to 100.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
return self.send( return self.send(
functions.photos.GetUserPhotos( functions.photos.GetUserPhotos(
@ -2050,7 +2050,7 @@ class Client:
Disables link previews for links in this message. Disables link previews for links in this message.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
style = self.html if parse_mode.lower() == "html" else self.markdown style = self.html if parse_mode.lower() == "html" else self.markdown
@ -2089,7 +2089,7 @@ class Client:
Defaults to Markdown. Defaults to Markdown.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
style = self.html if parse_mode.lower() == "html" else self.markdown style = self.html if parse_mode.lower() == "html" else self.markdown
@ -2129,7 +2129,7 @@ class Client:
channels and supergroups are always revoked (i.e.: deleted for everyone). channels and supergroups are always revoked (i.e.: deleted for everyone).
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
peer = self.resolve_peer(chat_id) peer = self.resolve_peer(chat_id)
@ -2421,7 +2421,7 @@ class Client:
channel/supergroup (in the format @username). channel/supergroup (in the format @username).
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
match = self.INVITE_LINK_RE.match(chat_id) match = self.INVITE_LINK_RE.match(chat_id)
@ -2461,7 +2461,7 @@ class Client:
Deletes the group chat dialog after leaving (for simple group chats, not supergroups). Deletes the group chat dialog after leaving (for simple group chats, not supergroups).
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
peer = self.resolve_peer(chat_id) peer = self.resolve_peer(chat_id)
@ -2507,7 +2507,7 @@ class Client:
On success, the exported invite link as string is returned. On success, the exported invite link as string is returned.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
Note: Note:
If the returned link is a new one it may take a while for it to be activated. If the returned link is a new one it may take a while for it to be activated.
@ -2570,7 +2570,7 @@ class Client:
True on success, False otherwise. True on success, False otherwise.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
r = self.send(functions.account.GetPassword()) r = self.send(functions.account.GetPassword())
@ -2609,7 +2609,7 @@ class Client:
True on success, False otherwise. True on success, False otherwise.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
r = self.send(functions.account.GetPassword()) r = self.send(functions.account.GetPassword())
@ -2643,7 +2643,7 @@ class Client:
True on success, False otherwise. True on success, False otherwise.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
r = self.send(functions.account.GetPassword()) r = self.send(functions.account.GetPassword())
@ -2699,7 +2699,7 @@ class Client:
On success, the absolute path of the downloaded file as string is returned, None otherwise. On success, the absolute path of the downloaded file as string is returned, None otherwise.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
if isinstance(message, (types.Message, types.Photo)): if isinstance(message, (types.Message, types.Photo)):
done = Event() done = Event()
@ -2745,7 +2745,7 @@ class Client:
On success, the absolute path of the downloaded photo as string is returned, None otherwise. On success, the absolute path of the downloaded photo as string is returned, None otherwise.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
if isinstance(photo, (types.UserProfilePhoto, types.ChatPhoto)): if isinstance(photo, (types.UserProfilePhoto, types.ChatPhoto)):
photo = types.Photo( photo = types.Photo(
@ -2774,7 +2774,7 @@ class Client:
On success, the added contacts are returned. On success, the added contacts are returned.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
imported_contacts = self.send( imported_contacts = self.send(
functions.contacts.ImportContacts( functions.contacts.ImportContacts(
@ -2796,7 +2796,7 @@ class Client:
True on success. True on success.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
contacts = [] contacts = []
@ -2856,7 +2856,7 @@ class Client:
On Success, :obj:`BotResults <pyrogram.api.types.messages.BotResults>` is returned. On Success, :obj:`BotResults <pyrogram.api.types.messages.BotResults>` is returned.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
return self.send( return self.send(
functions.messages.GetInlineBotResults( functions.messages.GetInlineBotResults(
@ -2904,7 +2904,7 @@ class Client:
On success, the sent Message is returned. On success, the sent Message is returned.
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
return self.send( return self.send(
functions.messages.SendInlineBotResult( functions.messages.SendInlineBotResult(
@ -2937,7 +2937,7 @@ class Client:
List of the requested messages List of the requested messages
Raises: Raises:
:class:`pyrogram.Error` :class:`Error <pyrogram.Error>`
""" """
peer = self.resolve_peer(chat_id) peer = self.resolve_peer(chat_id)
message_ids = [types.InputMessageID(i) for i in message_ids] message_ids = [types.InputMessageID(i) for i in message_ids]