python/aiogram
1
0
Fork 0
mirror of https://github.com/aiogram/aiogram.git synced 2025-12-12 18:19:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Remove MkDocs

Browse source
This commit is contained in:
Alex Root Junior 2021-05-13 00:13:09 +03:00
parent 7dd80d281f
commit e1cd7268a1
442 changed files with 4 additions and 9429 deletions
Download patch file Download diff file Expand all files Collapse all files

96
docs2/api/upload_file.rst
View file

@ -1,96 +0,0 @@
.. _sending-files:
###################
How to upload file?
###################
As says `official Telegram Bot API documentation <https://core.telegram.org/bots/api#sending-files>`_
there are three ways to send files (photos, stickers, audio, media, etc.):
If the file is already stored somewhere on the Telegram servers or file is available by the URL,
you don't need to reupload it.
But if you need to upload new file just use subclasses of `InputFile <types/input_file.md>`__.
Here is available three different builtin types of input file:
- :class:`aiogram.types.input_file.FSInputFile` - `uploading from file system <#upload-from-file-system>`__
- :class:`aiogram.types.input_file.BufferedInputFile` - `uploading from buffer <#upload-from-buffer>`__
- :class:`aiogram.types.input_file.URLInputFile` - `uploading from URL <#upload-from-url>`__
.. warning::
**Be respectful with Telegram**
Instances of `InputFile` is reusable.
That's mean you can create instance of InputFile and sent this file multiple times but Telegram
is not recommend to do that and when you upload file once just save their `file_id`
and use it in next times.
Upload from file system
=======================
By first step you will need to import InputFile wrapper:
.. code-block::
from aiogram.types import FSInputFile
Then you can use it:
.. code-block::
cat = FSInputFile("cat.png")
agenda = FSInputFile("my-document.pdf", filename="agenda-2019-11-19.pdf")
.. autoclass:: aiogram.types.input_file.FSInputFile
:members:
Upload from buffer
==================
Files can be also passed from buffer
(For example you generate image using `Pillow <https://pillow.readthedocs.io/en/stable/>`_
and the want's to sent it to the Telegram):
Import wrapper:
.. code-block::
from aiogram.types import BufferedInputFile
And then you can use it:
.. code-block::
text_file = BufferedInputFile(b"Hello, world!", filename="file.txt")
.. autoclass:: aiogram.types.input_file.BufferedInputFile
:members:
Upload from url
===============
If you need to upload a file from another server, but the direct link is bound to your server's IP,
or you want to bypass native `upload limits <https://core.telegram.org/bots/api#sending-files>`_
by URL, you can use :obj:`aiogram.types.input_file.URLInputFile`.
Import wrapper:
.. code-block::
from aiogram.types import URLInputFile
And then you can use it:
.. code-block::
image = URLInputFile(
"https://www.python.org/static/community_logos/python-powered-h-140x182.png",
filename="python-logo.png"
)
.. autoclass:: aiogram.types.input_file.URLInputFile
:members: