Add support for uploading from file pointers, fixes https://github.com/pyrogram/pyrogram/issues/261

This commit is contained in:
Octo 2019-07-20 10:22:12 +03:00 committed by Dan
parent 1e8c9812a1
commit c13392d2ce
10 changed files with 420 additions and 119 deletions

View File

@ -1715,7 +1715,7 @@ class Client(Methods, BaseClient):
def save_file(
self,
path: str,
path: Union[str, io.IOBase],
file_id: int = None,
file_part: int = 0,
progress: callable = None,
@ -1767,9 +1767,20 @@ class Client(Methods, BaseClient):
Raises:
RPCError: In case of a Telegram RPC error.
ValueError: if path is not str or file-like readable object
"""
part_size = 512 * 1024
file_size = os.path.getsize(path)
if isinstance(path, str):
fp = open(path, 'rb')
filename = os.path.basename(path)
elif hasattr(path, 'write'):
fp = path
filename = fp.name
else:
raise ValueError("Invalid path passed! Pass file pointer or path to file")
fp.seek(0, os.SEEK_END)
file_size = fp.tell()
fp.seek(0)
if file_size == 0:
raise ValueError("File size equals to 0 B")
@ -1787,11 +1798,10 @@ class Client(Methods, BaseClient):
session.start()
try:
with open(path, "rb") as f:
f.seek(part_size * file_part)
fp.seek(part_size * file_part)
while True:
chunk = f.read(part_size)
chunk = fp.read(part_size)
if not chunk:
if not is_big:
@ -1829,25 +1839,33 @@ class Client(Methods, BaseClient):
if progress:
progress(min(file_part * part_size, file_size), file_size, *progress_args)
except Client.StopTransmission:
if isinstance(path, str):
fp.close()
raise
except Exception as e:
if isinstance(path, str):
fp.close()
log.error(e, exc_info=True)
else:
if isinstance(path, str):
fp.close()
if is_big:
return types.InputFileBig(
id=file_id,
parts=file_total_parts,
name=os.path.basename(path),
name=filename,
)
else:
return types.InputFile(
id=file_id,
parts=file_total_parts,
name=os.path.basename(path),
name=filename,
md5_checksum=md5_sum
)
finally:
if isinstance(path, str):
fp.close()
session.stop()
def get_file(

View File

@ -0,0 +1,153 @@
# Pyrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-2019 Dan Tès <https://github.com/delivrance>
#
# 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 <http://www.gnu.org/licenses/>.
import io
import os
from typing import Union
import pyrogram
from pyrogram.api import functions, types
from pyrogram.client.ext import BaseClient, utils
from pyrogram.errors import FilePartMissing
class SendAnimatedSticker(BaseClient):
def send_animated_sticker(
self,
chat_id: Union[int, str],
animated_sticker: Union[str, io.IOBase],
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]:
"""Send .tgs animated stickers.
Parameters:
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).
animated_sticker (``str`` | file-like object):
Animated sticker to send.
Pass a file_id as string to send a animated sticker that exists on the Telegram servers,
pass an HTTP URL as a string for Telegram to get a .webp animated sticker file from the Internet, or
pass a file path as string to upload a new animated sticker that exists on your local machine.
pass a readable file-like object with .name
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.
progress (``callable``, *optional*):
Pass a callback function to view the upload progress.
The function must take *(client, current, total, \*args)* as positional arguments (look at the section
below for a detailed description).
progress_args (``tuple``, *optional*):
Extra custom arguments for the progress callback function. Useful, for example, if you want to pass
a chat_id and a message_id in order to edit a message with the updated progress.
Other Parameters:
client (:obj:`Client`):
The Client itself, useful when you want to call other API methods inside the callback function.
current (``int``):
The amount of bytes uploaded so far.
total (``int``):
The size of the file.
*args (``tuple``, *optional*):
Extra custom arguments as defined in the *progress_args* parameter.
You can either keep *\*args* or add every single extra argument in your function signature.
Returns:
:obj:`Message` | ``None``: On success, the sent animated sticker message is returned, otherwise, in case the
upload is deliberately stopped with :meth:`~Client.stop_transmission`, None is returned.
Raises:
RPCError: In case of a Telegram RPC error.
"""
file = None
try:
if isinstance(animated_sticker, str):
if os.path.exists(animated_sticker):
file = self.save_file(animated_sticker, progress=progress, progress_args=progress_args)
media = types.InputMediaUploadedDocument(
mime_type=self.guess_mime_type(animated_sticker) or "application/x-tgsticker",
file=file,
attributes=[
types.DocumentAttributeFilename(file_name=os.path.basename(animated_sticker))
]
)
elif animated_sticker.startswith("http"):
media = types.InputMediaDocumentExternal(
url=animated_sticker
)
else:
media = utils.get_input_media_from_file_id(animated_sticker, 5)
elif hasattr(animated_sticker, "read"):
file = self.save_file(animated_sticker, progress=progress, progress_args=progress_args)
media = types.InputMediaUploadedDocument(
mime_type=self.guess_mime_type(animated_sticker.name) or "application/x-tgsticker",
file=file,
attributes=[
types.DocumentAttributeFilename(file_name=animated_sticker.name)
]
)
while True:
try:
r = self.send(
functions.messages.SendMedia(
peer=self.resolve_peer(chat_id),
media=media,
silent=disable_notification or None,
reply_to_msg_id=reply_to_message_id,
random_id=self.rnd_id(),
reply_markup=reply_markup.write() if reply_markup else None,
message=""
)
)
except FilePartMissing as e:
self.save_file(animated_sticker, file_id=file.id, file_part=e.x)
else:
for i in r.updates:
if isinstance(i, (types.UpdateNewMessage, types.UpdateNewChannelMessage)):
return pyrogram.Message._parse(
self, i.message,
{i.id: i for i in r.users},
{i.id: i for i in r.chats}
)
except BaseClient.StopTransmission:
return None

View File

@ -15,7 +15,7 @@
#
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
import io
import os
from typing import Union
@ -29,6 +29,7 @@ class SendAnimation(BaseClient):
def send_animation(
self,
chat_id: Union[int, str],
animation: Union[str, io.IOBase],
animation: str,
file_ref: str = None,
caption: str = "",
@ -59,11 +60,13 @@ class SendAnimation(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).
animation (``str``):
animation (``str``| file-like object):
Animation to send.
Pass a file_id as string to send an animation that exists on the Telegram servers,
pass an HTTP URL as a string for Telegram to get an animation from the Internet, or
pass a file path as string to upload a new animation that exists on your local machine.
pass a readable file-like object with .name
file_ref (``str``, *optional*):
A valid file reference obtained by a recently fetched media message.
@ -163,6 +166,7 @@ class SendAnimation(BaseClient):
file = None
try:
if isinstance(animation, str):
if os.path.exists(animation):
thumb = None if thumb is None else self.save_file(thumb)
file = self.save_file(animation, progress=progress, progress_args=progress_args)
@ -187,7 +191,24 @@ class SendAnimation(BaseClient):
)
else:
media = utils.get_input_media_from_file_id(animation, file_ref, 10)
elif hasattr(animation, "read"):
thumb = None if thumb is None else self.save_file(thumb)
file = self.save_file(animation, progress=progress, progress_args=progress_args)
media = types.InputMediaUploadedDocument(
mime_type=self.guess_mime_type(animation.name) or "video/mp4",
file=file,
thumb=thumb,
attributes=[
types.DocumentAttributeVideo(
supports_streaming=True,
duration=duration,
w=width,
h=height
),
types.DocumentAttributeFilename(file_name=animation.name),
types.DocumentAttributeAnimated()
]
)
while True:
try:
r = self.send(

View File

@ -15,7 +15,7 @@
#
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
import io
import os
from typing import Union
@ -29,6 +29,7 @@ class SendAudio(BaseClient):
def send_audio(
self,
chat_id: Union[int, str],
audio: Union[str, io.IOBase],
audio: str,
file_ref: str = None,
caption: str = "",
@ -60,11 +61,12 @@ class SendAudio(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).
audio (``str``):
audio (``str``, file-like object):
Audio file to send.
Pass a file_id as string to send an audio file that exists on the Telegram servers,
pass an HTTP URL as a string for Telegram to get an audio file from the Internet, or
pass a file path as string to upload a new audio file that exists on your local machine.
pass a readable file-like object with .name
file_ref (``str``, *optional*):
A valid file reference obtained by a recently fetched media message.
@ -163,6 +165,7 @@ class SendAudio(BaseClient):
file = None
try:
if isinstance(audio, str):
if os.path.exists(audio):
thumb = None if thumb is None else self.save_file(thumb)
file = self.save_file(audio, progress=progress, progress_args=progress_args)
@ -185,6 +188,22 @@ class SendAudio(BaseClient):
)
else:
media = utils.get_input_media_from_file_id(audio, file_ref, 9)
elif hasattr(audio, "read"):
thumb = None if thumb is None else self.save_file(thumb)
file = self.save_file(audio, progress=progress, progress_args=progress_args)
media = types.InputMediaUploadedDocument(
mime_type=self.guess_mime_type(audio.name) or "audio/mpeg",
file=file,
thumb=thumb,
attributes=[
types.DocumentAttributeAudio(
duration=duration,
performer=performer,
title=title
),
types.DocumentAttributeFilename(file_name=os.path.basename(audio.name))
]
)
while True:
try:

View File

@ -15,7 +15,7 @@
#
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
import io
import os
from typing import Union
@ -29,6 +29,7 @@ class SendDocument(BaseClient):
def send_document(
self,
chat_id: Union[int, str],
document: Union[str, io.IOBase],
document: str,
file_ref: str = None,
thumb: str = None,
@ -60,6 +61,8 @@ class SendDocument(BaseClient):
Pass a file_id as string to send a file that exists on the Telegram servers,
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.
pass a readable file-like object with .name
file_ref (``str``, *optional*):
A valid file reference obtained by a recently fetched media message.
@ -143,6 +146,7 @@ class SendDocument(BaseClient):
file = None
try:
if isinstance(document, str):
if os.path.exists(document):
thumb = None if thumb is None else self.save_file(thumb)
file = self.save_file(document, progress=progress, progress_args=progress_args)
@ -160,6 +164,17 @@ class SendDocument(BaseClient):
)
else:
media = utils.get_input_media_from_file_id(document, file_ref, 5)
else:
thumb = None if thumb is None else self.save_file(thumb)
file = self.save_file(document, progress=progress, progress_args=progress_args)
media = types.InputMediaUploadedDocument(
mime_type=self.guess_mime_type(document.name) or "application/zip",
file=file,
thumb=thumb,
attributes=[
types.DocumentAttributeFilename(file_name=document.name)
]
)
while True:
try:

View File

@ -15,7 +15,7 @@
#
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
import io
import os
from typing import Union
@ -29,6 +29,7 @@ class SendPhoto(BaseClient):
def send_photo(
self,
chat_id: Union[int, str],
photo: Union[str, io.IOBase],
photo: str,
file_ref: str = None,
caption: str = "",
@ -54,11 +55,12 @@ class SendPhoto(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).
photo (``str``):
photo (``str`` | file-like object):
Photo to send.
Pass a file_id as string to send a photo that exists on the Telegram servers,
pass an HTTP URL as a string for Telegram to get a photo from the Internet, or
pass a file path as string to upload a new photo that exists on your local machine.
pass a readable file-like object with .name
file_ref (``str``, *optional*):
A valid file reference obtained by a recently fetched media message.
@ -137,6 +139,7 @@ class SendPhoto(BaseClient):
file = None
try:
if isinstance(photo, str):
if os.path.exists(photo):
file = self.save_file(photo, progress=progress, progress_args=progress_args)
media = types.InputMediaUploadedPhoto(
@ -150,6 +153,12 @@ class SendPhoto(BaseClient):
)
else:
media = utils.get_input_media_from_file_id(photo, file_ref, 2)
elif hasattr(photo, "read"):
file = self.save_file(photo, progress=progress, progress_args=progress_args)
media = types.InputMediaUploadedPhoto(
file=file,
ttl_seconds=ttl_seconds
)
while True:
try:

View File

@ -15,7 +15,7 @@
#
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
import io
import os
from typing import Union
@ -29,6 +29,7 @@ class SendSticker(BaseClient):
def send_sticker(
self,
chat_id: Union[int, str],
sticker: Union[str, io.IOBase],
sticker: str,
file_ref: str = None,
disable_notification: bool = None,
@ -56,6 +57,7 @@ class SendSticker(BaseClient):
Pass a file_id as string to send a sticker that exists on the Telegram servers,
pass an HTTP URL as a string for Telegram to get a .webp sticker file from the Internet, or
pass a file path as string to upload a new sticker that exists on your local machine.
pass a readable file-like object with .name
file_ref (``str``, *optional*):
A valid file reference obtained by a recently fetched media message.
@ -113,6 +115,7 @@ class SendSticker(BaseClient):
file = None
try:
if isinstance(sticker, str):
if os.path.exists(sticker):
file = self.save_file(sticker, progress=progress, progress_args=progress_args)
media = types.InputMediaUploadedDocument(
@ -128,6 +131,15 @@ class SendSticker(BaseClient):
)
else:
media = utils.get_input_media_from_file_id(sticker, file_ref, 8)
elif hasattr(sticker, "read"):
file = self.save_file(sticker, progress=progress, progress_args=progress_args)
media = types.InputMediaUploadedDocument(
mime_type=self.guess_mime_type(sticker) or "image/webp",
file=file,
attributes=[
types.DocumentAttributeFilename(file_name=sticker.name)
]
)
while True:
try:

View File

@ -15,7 +15,7 @@
#
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
import io
import os
from typing import Union
@ -29,6 +29,7 @@ class SendVideo(BaseClient):
def send_video(
self,
chat_id: Union[int, str],
video: Union[str, io.IOBase],
video: str,
file_ref: str = None,
caption: str = "",
@ -64,6 +65,7 @@ class SendVideo(BaseClient):
Pass a file_id as string to send a video that exists on the Telegram servers,
pass an HTTP URL as a string for Telegram to get a video from the Internet, or
pass a file path as string to upload a new video that exists on your local machine.
pass a readable file-like object with .name
file_ref (``str``, *optional*):
A valid file reference obtained by a recently fetched media message.
@ -160,6 +162,7 @@ class SendVideo(BaseClient):
file = None
try:
if isinstance(video, str):
if os.path.exists(video):
thumb = None if thumb is None else self.save_file(thumb)
file = self.save_file(video, progress=progress, progress_args=progress_args)
@ -183,6 +186,23 @@ class SendVideo(BaseClient):
)
else:
media = utils.get_input_media_from_file_id(video, file_ref, 4)
elif hasattr(video, "read"):
thumb = None if thumb is None else self.save_file(thumb)
file = self.save_file(video, progress=progress, progress_args=progress_args)
media = types.InputMediaUploadedDocument(
mime_type=self.guess_mime_type(video.name) or "video/mp4",
file=file,
thumb=thumb,
attributes=[
types.DocumentAttributeVideo(
supports_streaming=supports_streaming or None,
duration=duration,
w=width,
h=height
),
types.DocumentAttributeFilename(file_name=video.name)
]
)
while True:
try:

View File

@ -15,7 +15,7 @@
#
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
import io
import os
from typing import Union
@ -29,6 +29,7 @@ class SendVideoNote(BaseClient):
def send_video_note(
self,
chat_id: Union[int, str],
video_note: Union[str, io.IOBase],
video_note: str,
file_ref: str = None,
duration: int = 0,
@ -54,11 +55,12 @@ class SendVideoNote(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).
video_note (``str``):
video_note (``str``, file-like object):
Video note to send.
Pass a file_id as string to send a video note that exists on the Telegram servers, or
pass a file path as string to upload a new video note that exists on your local machine.
Sending video notes by a URL is currently unsupported.
pass a readable file-like object with .name
file_ref (``str``, *optional*):
A valid file reference obtained by a recently fetched media message.
@ -128,6 +130,7 @@ class SendVideoNote(BaseClient):
file = None
try:
if isinstance(video_note, str):
if os.path.exists(video_note):
thumb = None if thumb is None else self.save_file(thumb)
file = self.save_file(video_note, progress=progress, progress_args=progress_args)
@ -146,6 +149,22 @@ class SendVideoNote(BaseClient):
)
else:
media = utils.get_input_media_from_file_id(video_note, file_ref, 13)
elif hasattr(video_note, "read"):
thumb = None if thumb is None else self.save_file(thumb)
file = self.save_file(video_note, progress=progress, progress_args=progress_args)
media = types.InputMediaUploadedDocument(
mime_type=self.guess_mime_type(video_note.name) or "video/mp4",
file=file,
thumb=thumb,
attributes=[
types.DocumentAttributeVideo(
round_message=True,
duration=duration,
w=length,
h=length
)
]
)
while True:
try:

View File

@ -15,7 +15,7 @@
#
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
import io
import os
from typing import Union
@ -29,6 +29,7 @@ class SendVoice(BaseClient):
def send_voice(
self,
chat_id: Union[int, str],
voice: Union[str, io.IOBase],
voice: str,
file_ref=None,
caption: str = "",
@ -54,11 +55,12 @@ class SendVoice(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).
voice (``str``):
voice (``str``, file-like object):
Audio file to send.
Pass a file_id as string to send an audio that exists on the Telegram servers,
pass an HTTP URL as a string for Telegram to get an audio from the Internet, or
pass a file path as string to upload a new audio that exists on your local machine.
pass a readable file-like object with .name
file_ref (``str``, *optional*):
A valid file reference obtained by a recently fetched media message.
@ -132,6 +134,7 @@ class SendVoice(BaseClient):
file = None
try:
if isinstance(voice, str):
if os.path.exists(voice):
file = self.save_file(voice, progress=progress, progress_args=progress_args)
media = types.InputMediaUploadedDocument(
@ -150,6 +153,18 @@ class SendVoice(BaseClient):
)
else:
media = utils.get_input_media_from_file_id(voice, file_ref, 3)
elif hasattr(voice, "read"):
file = self.save_file(voice, progress=progress, progress_args=progress_args)
media = types.InputMediaUploadedDocument(
mime_type=self.guess_mime_type(voice.name) or "audio/mpeg",
file=file.name,
attributes=[
types.DocumentAttributeAudio(
voice=True,
duration=duration
)
]
)
while True:
try: