From ea0ecbcd50414748bfcbf8951c3731924bf1fdf4 Mon Sep 17 00:00:00 2001 From: Alex Root Junior Date: Mon, 17 Jul 2023 23:02:10 +0300 Subject: [PATCH] Render changelog --- CHANGES.rst | 130 +++++++++++++++++++++++++++++++++++++++ CHANGES/1133.doc.rst | 1 - CHANGES/1139.misc.rst | 7 --- CHANGES/1142.misc.rst | 2 - CHANGES/1144.misc.rst | 1 - CHANGES/1146.bugfix.rst | 4 -- CHANGES/1147.feature.rst | 1 - CHANGES/1155.bugfix.rst | 1 - CHANGES/1160.bugfix.rst | 1 - CHANGES/1161.feature.rst | 17 ----- CHANGES/1162.bugfix.rst | 1 - CHANGES/1163.feature.rst | 4 -- CHANGES/1168.misc.rst | 6 -- CHANGES/1170.removal.rst | 3 - CHANGES/1172.feature.rst | 2 - CHANGES/1173.feature.rst | 1 - CHANGES/1176.bugfix.rst | 1 - CHANGES/1178.feature | 1 - CHANGES/1191.feature.rst | 1 - CHANGES/1196.bugfix.rst | 1 - CHANGES/1202.misc.rst | 6 -- CHANGES/1210.misc.rst | 6 -- CHANGES/1213.bugfix.rst | 7 --- CHANGES/1221.misc.rst | 4 -- 24 files changed, 130 insertions(+), 79 deletions(-) delete mode 100644 CHANGES/1133.doc.rst delete mode 100644 CHANGES/1139.misc.rst delete mode 100644 CHANGES/1142.misc.rst delete mode 100644 CHANGES/1144.misc.rst delete mode 100644 CHANGES/1146.bugfix.rst delete mode 100644 CHANGES/1147.feature.rst delete mode 100644 CHANGES/1155.bugfix.rst delete mode 100644 CHANGES/1160.bugfix.rst delete mode 100644 CHANGES/1161.feature.rst delete mode 100644 CHANGES/1162.bugfix.rst delete mode 100644 CHANGES/1163.feature.rst delete mode 100644 CHANGES/1168.misc.rst delete mode 100644 CHANGES/1170.removal.rst delete mode 100644 CHANGES/1172.feature.rst delete mode 100644 CHANGES/1173.feature.rst delete mode 100644 CHANGES/1176.bugfix.rst delete mode 100644 CHANGES/1178.feature delete mode 100644 CHANGES/1191.feature.rst delete mode 100644 CHANGES/1196.bugfix.rst delete mode 100644 CHANGES/1202.misc.rst delete mode 100644 CHANGES/1210.misc.rst delete mode 100644 CHANGES/1213.bugfix.rst delete mode 100644 CHANGES/1221.misc.rst diff --git a/CHANGES.rst b/CHANGES.rst index afbb2d4a..a778b4b5 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -16,6 +16,136 @@ Changelog .. towncrier release notes start +3.0.0b8 (2023-07-17) +===================== + +Features +-------- + +- Added possibility to use custom events in routers (If router does not support custom event it does not break and passes it to included routers). + `#1147 `_ +- Added support for FSM in Forum topics. + + The strategy can be changed in dispatcher: + + .. code-block:: python + + from aiogram.fsm.strategy import FSMStrategy + ... + dispatcher = Dispatcher( + fsm_strategy=FSMStrategy.USER_IN_TOPIC, + storage=..., # Any persistent storage + ) + + .. note:: + + If you have implemented you own storages you should extend record key generation + with new one attribute - :code:`thread_id` + `#1161 `_ +- Improved CallbackData serialization. + + - Minimized UUID (hex without dashes) + - Replaced bool values with int (true=1, false=0) + `#1163 `_ +- Added a tool to make text formatting flexible and easy. + More details on the :ref:`corresponding documentation page ` + `#1172 `_ +- Added :code:`X-Telegram-Bot-Api-Secret-Token` header check + `#1173 `_ +- Made :code:`allowed_updates` list to revolve automatically in start_polling method if not set explicitly. + `#1178 `_ +- Added possibility to pass custom headers to :class:`URLInputFile` object + `#1191 `_ + + +Bugfixes +-------- + +- Change type of result in InlineQueryResult enum for :code:`InlineQueryResultCachedMpeg4Gif` + and :code:`InlineQueryResultMpeg4Gif` to more correct according to documentation. + + Change regexp for entities parsing to more correct (:code:`InlineQueryResultType.yml`). + `#1146 `_ +- Fixed signature of startup/shutdown events to include the :code:`**dispatcher.workflow_data` as the handler arguments. + `#1155 `_ +- Added missing :code:`FORUM_TOPIC_EDITED` value to content_type property + `#1160 `_ +- Fixed compatibility with Python 3.8-3.9 (from previous release) + `#1162 `_ +- Fixed the markdown spoiler parser. + `#1176 `_ +- Fixed workflow data propagation + `#1196 `_ +- Fixed the serialization error associated with nested subtypes + like InputMedia, ChatMember, etc. + + The previously generated code resulted in an invalid schema under pydantic v2, + which has stricter type parsing. + Hence, subtypes without the specification of all subtype unions were generating + an empty object. This has been rectified now. + `#1213 `_ + + +Improved Documentation +---------------------- + +- Changed small grammar typos for :code:`upload_file` + `#1133 `_ + + +Deprecations and Removals +------------------------- + +- Removed text filter in due to is planned to remove this filter few versions ago. + + Use :code:`F.text` instead + `#1170 `_ + + +Misc +---- + +- Added full support of `Bot API 6.6 `_ + + .. danger:: + + Note that this issue has breaking changes described in in the Bot API changelog, + this changes is not breaking in the API but breaking inside aiogram because + Beta stage is not finished. + `#1139 `_ +- Added full support of `Bot API 6.7 `_ + + .. warning:: + + Note that arguments *switch_pm_parameter* and *switch_pm_text* was deprecated + and should be changed to *button* argument as described in API docs. + `#1168 `_ +- Updated `Pydantic to V2 `_ + + .. warning:: + + Be careful, not all libraries is already updated to using V2 + `#1202 `_ +- Added global defaults :code:`disable_web_page_preview` and :code:`protect_content` in addition to :code:`parse_mode` to the Bot instance, + reworked internal request builder mechanism. + `#1142 `_ +- Removed bot parameters from storages + `#1144 `_ + +- Replaced ContextVar's with a new feature called `Validation Context `_ + in Pydantic to improve the clarity, usability, and versatility of handling the Bot instance within method shortcuts. + + .. danger:: + + **Breaking**: The 'bot' argument now is required in `URLInputFile` + `#1210 `_ +- Updated magic-filter with new features + + - Added hint for :code:`len(F)` error + - Added not in operation + `#1221 `_ + + 3.0.0b7 (2023-02-18) ===================== diff --git a/CHANGES/1133.doc.rst b/CHANGES/1133.doc.rst deleted file mode 100644 index 247f0c66..00000000 --- a/CHANGES/1133.doc.rst +++ /dev/null @@ -1 +0,0 @@ -Changed small grammar typos for :code:`upload_file` diff --git a/CHANGES/1139.misc.rst b/CHANGES/1139.misc.rst deleted file mode 100644 index 432607e0..00000000 --- a/CHANGES/1139.misc.rst +++ /dev/null @@ -1,7 +0,0 @@ -Added full support of `Bot API 6.6 `_ - -.. danger:: - - Note that this issue has breaking changes described in in the Bot API changelog, - this changes is not breaking in the API but breaking inside aiogram because - Beta stage is not finished. diff --git a/CHANGES/1142.misc.rst b/CHANGES/1142.misc.rst deleted file mode 100644 index 01e3ee72..00000000 --- a/CHANGES/1142.misc.rst +++ /dev/null @@ -1,2 +0,0 @@ -Added global defaults :code:`disable_web_page_preview` and :code:`protect_content` in addition to :code:`parse_mode` to the Bot instance, -reworked internal request builder mechanism. diff --git a/CHANGES/1144.misc.rst b/CHANGES/1144.misc.rst deleted file mode 100644 index 8b3109f0..00000000 --- a/CHANGES/1144.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Removed bot parameters from storages diff --git a/CHANGES/1146.bugfix.rst b/CHANGES/1146.bugfix.rst deleted file mode 100644 index 736df86d..00000000 --- a/CHANGES/1146.bugfix.rst +++ /dev/null @@ -1,4 +0,0 @@ -Change type of result in InlineQueryResult enum for :code:`InlineQueryResultCachedMpeg4Gif` -and :code:`InlineQueryResultMpeg4Gif` to more correct according to documentation. - -Change regexp for entities parsing to more correct (:code:`InlineQueryResultType.yml`). diff --git a/CHANGES/1147.feature.rst b/CHANGES/1147.feature.rst deleted file mode 100644 index 81cf8173..00000000 --- a/CHANGES/1147.feature.rst +++ /dev/null @@ -1 +0,0 @@ -If router does not support custom event it does not break and passes it to included routers diff --git a/CHANGES/1155.bugfix.rst b/CHANGES/1155.bugfix.rst deleted file mode 100644 index 8d264dcf..00000000 --- a/CHANGES/1155.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Fixed signature of startup/shutdown events to include the :code:`**dispatcher.workflow_data` as the handler arguments. diff --git a/CHANGES/1160.bugfix.rst b/CHANGES/1160.bugfix.rst deleted file mode 100644 index 6c5fa45b..00000000 --- a/CHANGES/1160.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Added missing :code:`FORUM_TOPIC_EDITED` value to content_type property diff --git a/CHANGES/1161.feature.rst b/CHANGES/1161.feature.rst deleted file mode 100644 index e19a1125..00000000 --- a/CHANGES/1161.feature.rst +++ /dev/null @@ -1,17 +0,0 @@ -Added support for FSM in Forum topics. - -The strategy can be changed in dispatcher: - -.. code-block:: python - - from aiogram.fsm.strategy import FSMStrategy - ... - dispatcher = Dispatcher( - fsm_strategy=FSMStrategy.USER_IN_TOPIC, - storage=..., # Any persistent storage - ) - -.. note:: - - If you have implemented you own storages you should extend record key generation - with new one attribute - :code:`thread_id` diff --git a/CHANGES/1162.bugfix.rst b/CHANGES/1162.bugfix.rst deleted file mode 100644 index 16d5be16..00000000 --- a/CHANGES/1162.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Fixed compatibility with Python 3.8-3.9 diff --git a/CHANGES/1163.feature.rst b/CHANGES/1163.feature.rst deleted file mode 100644 index 06e97c3d..00000000 --- a/CHANGES/1163.feature.rst +++ /dev/null @@ -1,4 +0,0 @@ -Improved CallbackData serialization. - -- Minimized UUID (hex without dashes) -- Replaced bool values with int (true=1, false=0) diff --git a/CHANGES/1168.misc.rst b/CHANGES/1168.misc.rst deleted file mode 100644 index 0bce876f..00000000 --- a/CHANGES/1168.misc.rst +++ /dev/null @@ -1,6 +0,0 @@ -Added full support of `Bot API 6.7 `_ - -.. warning:: - - Note that arguments *switch_pm_parameter* and *switch_pm_text* was deprecated - and should be changed to *button* argument as described in API docs. diff --git a/CHANGES/1170.removal.rst b/CHANGES/1170.removal.rst deleted file mode 100644 index c2a06444..00000000 --- a/CHANGES/1170.removal.rst +++ /dev/null @@ -1,3 +0,0 @@ -Removed text filter in due to is planned to remove this filter few versions ago. - -Use :code:`F.text` instead diff --git a/CHANGES/1172.feature.rst b/CHANGES/1172.feature.rst deleted file mode 100644 index 5a1005da..00000000 --- a/CHANGES/1172.feature.rst +++ /dev/null @@ -1,2 +0,0 @@ -Added a tool to make text formatting flexible and easy. -More details on the :ref:`corresponding documentation page ` diff --git a/CHANGES/1173.feature.rst b/CHANGES/1173.feature.rst deleted file mode 100644 index 03ee7422..00000000 --- a/CHANGES/1173.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Added :code:`X-Telegram-Bot-Api-Secret-Token` header check diff --git a/CHANGES/1176.bugfix.rst b/CHANGES/1176.bugfix.rst deleted file mode 100644 index 57f67202..00000000 --- a/CHANGES/1176.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Fixed the markdown spoiler parser. diff --git a/CHANGES/1178.feature b/CHANGES/1178.feature deleted file mode 100644 index 654e78ae..00000000 --- a/CHANGES/1178.feature +++ /dev/null @@ -1 +0,0 @@ -Made allowed_updates list to revolve automatically in start_polling method if not set explicitly. diff --git a/CHANGES/1191.feature.rst b/CHANGES/1191.feature.rst deleted file mode 100644 index 2fb3bb1f..00000000 --- a/CHANGES/1191.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Added possibility to pass custom headers to :class:`URLInputFile` object diff --git a/CHANGES/1196.bugfix.rst b/CHANGES/1196.bugfix.rst deleted file mode 100644 index db6594a6..00000000 --- a/CHANGES/1196.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Fixed workflow data propagation diff --git a/CHANGES/1202.misc.rst b/CHANGES/1202.misc.rst deleted file mode 100644 index 9aeb4099..00000000 --- a/CHANGES/1202.misc.rst +++ /dev/null @@ -1,6 +0,0 @@ -Updated `Pydantic to V2 `_ - -.. warning:: - - Be careful, not all libraries is already updated to using V2 - (for example at the time, when this warning was added FastAPI still not support V2) diff --git a/CHANGES/1210.misc.rst b/CHANGES/1210.misc.rst deleted file mode 100644 index e4d3589c..00000000 --- a/CHANGES/1210.misc.rst +++ /dev/null @@ -1,6 +0,0 @@ -Replaced ContextVar's with a new feature called `Validation Context `_ -in Pydantic to improve the clarity, usability, and versatility of handling the Bot instance within method shortcuts. - -.. danger:: - - **Breaking**: The 'bot' argument now is required in `URLInputFile` diff --git a/CHANGES/1213.bugfix.rst b/CHANGES/1213.bugfix.rst deleted file mode 100644 index a9787889..00000000 --- a/CHANGES/1213.bugfix.rst +++ /dev/null @@ -1,7 +0,0 @@ -Fixed the serialization error associated with nested subtypes -like InputMedia, ChatMember, etc. - -The previously generated code resulted in an invalid schema under pydantic v2, -which has stricter type parsing. -Hence, subtypes without the specification of all subtype unions were generating -an empty object. This has been rectified now. diff --git a/CHANGES/1221.misc.rst b/CHANGES/1221.misc.rst deleted file mode 100644 index 583ae46a..00000000 --- a/CHANGES/1221.misc.rst +++ /dev/null @@ -1,4 +0,0 @@ -Updated magic-filter with new features - -- Added hint for :code:`len(F)` error -- Added not in operation