From 1b9e6665572684591545241d07c507fa462364c1 Mon Sep 17 00:00:00 2001 From: Alex Root Junior Date: Sun, 14 Aug 2022 18:54:43 +0300 Subject: [PATCH] Update docs --- CHANGES.rst | 70 +++++++++++++++++++++++++++++++++++++++++ CHANGES/803.feature.rst | 3 -- CHANGES/894.feature.rst | 7 ----- CHANGES/896.misc.rst | 1 - CHANGES/901.bugfix.rst | 1 - CHANGES/906.bugfix.rst | 5 --- CHANGES/907.misc.rst | 1 - CHANGES/922.feature.rst | 1 - CHANGES/927.bugfix.rst | 1 - CHANGES/929.feature.rst | 1 - CHANGES/936.misc.rst | 1 - CHANGES/938.misc.rst | 9 ------ CHANGES/941.misc.rst | 1 - CHANGES/942.misc.rst | 1 - CHANGES/944.misc.rst | 1 - CHANGES/972.bugfix.rst | 1 - CHANGES/975.misc.rst | 1 - 17 files changed, 70 insertions(+), 36 deletions(-) delete mode 100644 CHANGES/803.feature.rst delete mode 100644 CHANGES/894.feature.rst delete mode 100644 CHANGES/896.misc.rst delete mode 100644 CHANGES/901.bugfix.rst delete mode 100644 CHANGES/906.bugfix.rst delete mode 100644 CHANGES/907.misc.rst delete mode 100644 CHANGES/922.feature.rst delete mode 100644 CHANGES/927.bugfix.rst delete mode 100644 CHANGES/929.feature.rst delete mode 100644 CHANGES/936.misc.rst delete mode 100644 CHANGES/938.misc.rst delete mode 100644 CHANGES/941.misc.rst delete mode 100644 CHANGES/942.misc.rst delete mode 100644 CHANGES/944.misc.rst delete mode 100644 CHANGES/972.bugfix.rst delete mode 100644 CHANGES/975.misc.rst diff --git a/CHANGES.rst b/CHANGES.rst index 1b08ff61..ab8c2e01 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -14,6 +14,76 @@ Changelog .. towncrier release notes start +3.0.0b4 (2022-08-14) +===================== + +Features +-------- + +- Add class helper ChatAction for constants that Telegram BotAPI uses in sendChatAction request. + In my opinion, this will help users and will also improve compatibility with 2.x version + where similar class was called "ChatActions". + `#803 `_ +- Added possibility to combine filters or invert result + + Example: + .. code-block:: python + Text(text="demo") | Command(commands=["demo"]) + MyFilter() & AnotherFilter() + ~StateFilter(state='my-state') + `#894 `_ +- Fixed type hints for redis TTL params. + `#922 `_ +- Added `full_name` shortcut for `Chat` object + `#929 `_ + + +Bugfixes +-------- + +- Fixed false-positive coercing of Union types in API methods + `#901 `_ +- Added 3 missing content types: + + * proximity_alert_triggered + * supergroup_chat_created + * channel_chat_created + `#906 `_ +- Fixed the ability to compare the state, now comparison to copy of the state will return `True`. + `#927 `_ +- Fixed default lock kwargs in RedisEventIsolation. + `#972 `_ + + +Misc +---- + +- Restrict including routers with strings + `#896 `_ +- Changed CommandPatterType to CommandPatternType in `aiogram/dispatcher/filters/command.py` + `#907 `_ +- Added full support of `Bot API 6.1 `_ + `#936 `_ +- **Breaking!** More flat project structure + + These packages was moved, imports in your code should be fixed: + + - :code:`aiogram.dispatcher.filters` -> :code:`aiogram.filters` + - :code:`aiogram.dispatcher.fsm` -> :code:`aiogram.fsm` + - :code:`aiogram.dispatcher.handler` -> :code:`aiogram.handler` + - :code:`aiogram.dispatcher.webhook` -> :code:`aiogram.webhook` + - :code:`aiogram.dispatcher.flags/*` -> :code:`aiogram.dispatcher.flags` (single module instead of package) + `#938 `_ +- Removed deprecated :code:`router._handler` and :code:`router.register__handler` methods. + `#941 `_ +- Deprecated filters factory. It will be removed in next Beta (3.0b5) + `#942 `_ +- `MessageEntity` method `get_text` was removed and `extract` was renamed to `extract_from` + `#944 `_ +- Added full support of `Bot API 6.2 `_ + `#975 `_ + + 3.0.0b3 (2022-04-19) ===================== diff --git a/CHANGES/803.feature.rst b/CHANGES/803.feature.rst deleted file mode 100644 index 59ee6725..00000000 --- a/CHANGES/803.feature.rst +++ /dev/null @@ -1,3 +0,0 @@ -Add class helper ChatAction for constants that Telegram BotAPI uses in sendChatAction request. -In my opinion, this will help users and will also improve compatibility with 2.x version -where similar class was called "ChatActions". diff --git a/CHANGES/894.feature.rst b/CHANGES/894.feature.rst deleted file mode 100644 index f89f4e07..00000000 --- a/CHANGES/894.feature.rst +++ /dev/null @@ -1,7 +0,0 @@ -Added possibility to combine filters or invert result - -Example: -.. code-block:: python - Text(text="demo") | Command(commands=["demo"]) - MyFilter() & AnotherFilter() - ~StateFilter(state='my-state') diff --git a/CHANGES/896.misc.rst b/CHANGES/896.misc.rst deleted file mode 100644 index 9dbd6db4..00000000 --- a/CHANGES/896.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Restrict including routers with strings diff --git a/CHANGES/901.bugfix.rst b/CHANGES/901.bugfix.rst deleted file mode 100644 index e920c152..00000000 --- a/CHANGES/901.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Fixed false-positive coercing of Union types in API methods diff --git a/CHANGES/906.bugfix.rst b/CHANGES/906.bugfix.rst deleted file mode 100644 index 1e727535..00000000 --- a/CHANGES/906.bugfix.rst +++ /dev/null @@ -1,5 +0,0 @@ -Added 3 missing content types: - -* proximity_alert_triggered -* supergroup_chat_created -* channel_chat_created diff --git a/CHANGES/907.misc.rst b/CHANGES/907.misc.rst deleted file mode 100644 index 5c7608e4..00000000 --- a/CHANGES/907.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Changed CommandPatterType to CommandPatternType in `aiogram/dispatcher/filters/command.py` diff --git a/CHANGES/922.feature.rst b/CHANGES/922.feature.rst deleted file mode 100644 index 7ce5000c..00000000 --- a/CHANGES/922.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Fixed type hints for redis TTL params. diff --git a/CHANGES/927.bugfix.rst b/CHANGES/927.bugfix.rst deleted file mode 100644 index c16ae945..00000000 --- a/CHANGES/927.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Fixed the ability to compare the state, now comparison to copy of the state will return `True`. diff --git a/CHANGES/929.feature.rst b/CHANGES/929.feature.rst deleted file mode 100644 index 21764a59..00000000 --- a/CHANGES/929.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Added `full_name` shortcut for `Chat` object diff --git a/CHANGES/936.misc.rst b/CHANGES/936.misc.rst deleted file mode 100644 index 0d48256c..00000000 --- a/CHANGES/936.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Added full support of `Bot API 6.1 `_ diff --git a/CHANGES/938.misc.rst b/CHANGES/938.misc.rst deleted file mode 100644 index c1babc7f..00000000 --- a/CHANGES/938.misc.rst +++ /dev/null @@ -1,9 +0,0 @@ -**Breaking!** More flat project structure - -These packages was moved, imports in your code should be fixed: - -- :code:`aiogram.dispatcher.filters` -> :code:`aiogram.filters` -- :code:`aiogram.dispatcher.fsm` -> :code:`aiogram.fsm` -- :code:`aiogram.dispatcher.handler` -> :code:`aiogram.handler` -- :code:`aiogram.dispatcher.webhook` -> :code:`aiogram.webhook` -- :code:`aiogram.dispatcher.flags/*` -> :code:`aiogram.dispatcher.flags` (single module instead of package) diff --git a/CHANGES/941.misc.rst b/CHANGES/941.misc.rst deleted file mode 100644 index 9eb14085..00000000 --- a/CHANGES/941.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Removed deprecated :code:`router._handler` and :code:`router.register__handler` methods. diff --git a/CHANGES/942.misc.rst b/CHANGES/942.misc.rst deleted file mode 100644 index 09aa341c..00000000 --- a/CHANGES/942.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Deprecated filters factory. It will be removed in next Beta (3.0b5) diff --git a/CHANGES/944.misc.rst b/CHANGES/944.misc.rst deleted file mode 100644 index 1dc64aaa..00000000 --- a/CHANGES/944.misc.rst +++ /dev/null @@ -1 +0,0 @@ -`MessageEntity` method `get_text` was removed and `extract` was renamed to `extract_from` diff --git a/CHANGES/972.bugfix.rst b/CHANGES/972.bugfix.rst deleted file mode 100644 index c59dbbfc..00000000 --- a/CHANGES/972.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Fixed default lock kwargs in RedisEventIsolation. diff --git a/CHANGES/975.misc.rst b/CHANGES/975.misc.rst deleted file mode 100644 index daf4d5bc..00000000 --- a/CHANGES/975.misc.rst +++ /dev/null @@ -1 +0,0 @@ -Added full support of `Bot API 6.2 `_