mirror of
https://github.com/aiogram/aiogram.git
synced 2025-12-12 18:19:34 +00:00
3d63bf3b99
* Base implementation
* Small refactoring + added possibility to specify post-action on handlers
* Move scene properties to config object
* Revise aiogram/scenes with wizard-based design pattern
Modified files in aiogram/scenes to incorporate the Wizard design pattern. Files affected are _marker.py, _registry.py, _wizard.py and __init__.py. The changes introduced a SceneWizard Class and ScenesManager, both of which aid in controlling navigation between different scenes or states. This helps clarifying the codebase, streamline scene transitions and offer more control over the app flow.
* Added example
* Small optimizations
* Replace ValueError with SceneException in scenes. Added error safety in scene resolver.
* str
* Added possibility to reset context on scene entered and to handle callback query in any state
* Remove inline markup in example
* Small changes
* Docs + example
* Small refactoring
* Remove scene inclusion methods from router
The methods for including scenes as sub-routers have been removed from the router.py file. Instead, the SceneRegistry class is now set to register scenes by default upon initializing. This streamlines the scene management process by removing redundant routers and making registration automatic.
* Init tests
* Small fix in tests
* Add support for State instance in the scene
The aiogram FSM scene now allows the use of State instance as an argument, enabling more customization. Modified the 'as_handler' method to receive **kwargs arguments, allowing passing of attributes to the handler. An additional type check has been also added to ensure the 'scene' is either a subclass of Scene or a string.
* Fixed test
* Expand test coverage for test_fsm module
The commit enhances tests for the test_fsm module to improve code reliability. It includes additional unit tests for the ObserverDecorator and ActionContainer classes and introduces new tests for the SceneHandlerWrapper class. This ensures the correct functionality of the decorator methods, the action container execution, and the handler wrapper.
* Reformat code
* Fixed long line in the example
* Skip some tests on PyPy
* Change mock return_value
* Compatibility...
* Compatibility...
* Compatibility...
* Added base changes description
* Scenes Tests (#1369)
* ADD tests for `SceneRegistry`
* ADD tests for `ScenesManager`
* ADD Changelog
* Revert "ADD Changelog"
This reverts commit 6dd9301252.
* Remove `@pytest.mark.asyncio`, Reformat code
* Scenes Tests. Part 2 (#1371)
* ADD tests for `SceneWizard`
* ADD tests for `Scene`
* Refactor ObserverDecorator to use on.message syntax in test_scene.py
Cover `Scene::__init_subclass__::if isinstance(value, ObserverDecorator):`
* Refactor `HistoryManager` in `aiogram/fsm/scene.py`
Removed condition that checked if 'history' is empty before calling 'update_data' in 'Scene'.
* ADD tests for `HistoryManager`
* Small changes in the documentation
* Small changes in the documentation
* Small changes in the documentation
---------
Co-authored-by: Andrew <11490628+andrew000@users.noreply.github.com>
94 lines
2.7 KiB
ReStructuredText
94 lines
2.7 KiB
ReStructuredText
#####################
|
|
How to download file?
|
|
#####################
|
|
|
|
Download file manually
|
|
======================
|
|
|
|
First, you must get the `file_id` of the file you want to download.
|
|
Information about files sent to the bot is contained in `Message <types/message.html>`__.
|
|
|
|
For example, download the document that came to the bot.
|
|
|
|
.. code-block::
|
|
|
|
file_id = message.document.file_id
|
|
|
|
Then use the `getFile <methods/get_file.html>`__ method to get `file_path`.
|
|
|
|
.. code-block::
|
|
|
|
file = await bot.get_file(file_id)
|
|
file_path = file.file_path
|
|
|
|
After that, use the `download_file <#download-file>`__ method from the bot object.
|
|
|
|
download_file(...)
|
|
------------------
|
|
|
|
Download file by `file_path` to destination.
|
|
|
|
If you want to automatically create destination (:obj:`io.BytesIO`) use default
|
|
value of destination and handle result of this method.
|
|
|
|
.. automethod:: aiogram.client.bot.Bot.download_file
|
|
|
|
There are two options where you can download the file: to **disk** or to **binary I/O object**.
|
|
|
|
Download file to disk
|
|
---------------------
|
|
|
|
To download file to disk, you must specify the file name or path where to download the file.
|
|
In this case, the function will return nothing.
|
|
|
|
.. code-block::
|
|
|
|
await bot.download_file(file_path, "text.txt")
|
|
|
|
Download file to binary I/O object
|
|
----------------------------------
|
|
|
|
To download file to binary I/O object, you must specify an object with the
|
|
:obj:`typing.BinaryIO` type or use the default (:obj:`None`) value.
|
|
|
|
In the first case, the function will return your object:
|
|
|
|
.. code-block::
|
|
|
|
my_object = MyBinaryIO()
|
|
result: MyBinaryIO = await bot.download_file(file_path, my_object)
|
|
# print(result is my_object) # True
|
|
|
|
If you leave the default value, an :obj:`io.BytesIO` object will be created and returned.
|
|
|
|
.. code-block::
|
|
|
|
result: io.BytesIO = await bot.download_file(file_path)
|
|
|
|
|
|
Download file in short way
|
|
==========================
|
|
|
|
Getting `file_path` manually every time is boring, so you should use the `download <#download>`__ method.
|
|
|
|
download(...)
|
|
-------------
|
|
|
|
Download file by `file_id` or `Downloadable` object to destination.
|
|
|
|
If you want to automatically create destination (:obj:`io.BytesIO`) use default
|
|
value of destination and handle result of this method.
|
|
|
|
.. automethod:: aiogram.client.bot.Bot.download
|
|
|
|
It differs from `download_file <#download-file>`__ **only** in that it accepts `file_id`
|
|
or an `Downloadable` object (object that contains the `file_id` attribute) instead of `file_path`.
|
|
|
|
You can download a file to `disk <#download-file-to-disk>`__ or to a `binary I/O <#download-file-to-binary-io-object>`__ object in the same way.
|
|
|
|
Example:
|
|
|
|
.. code-block::
|
|
|
|
document = message.document
|
|
await bot.download(document)
|