Add missing shortcuts, new enums, reworked old stuff (#1070)

* Render shortcuts

* Render docs

* Added enumerations

* Added docs

* Use enums, removed Helper

* Bump butcher

* Added InputMediaType enum

* Added MaskPositionPoint, InlineQueryResultType enums

* Update texts

* Added StickerType enum

* Cover tests

* Update docs

* Fixed imports

* Re-enabled all pre-commit hooks
This commit is contained in:
Alex Root Junior 2022-12-04 03:05:49 +02:00 committed by GitHub
parent 3438d2446d
commit 3ea73fbbbd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
370 changed files with 19735 additions and 8380 deletions

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return AnswerCallbackQuery(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.callback_query.CallbackQuery.answer`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return AnswerInlineQuery(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.inline_query.InlineQuery.answer`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return ApproveChatJoinRequest(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat_join_request.ChatJoinRequest.approve`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return BanChatMember(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.ban`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return BanChatSenderChat(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.ban_sender_chat`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return CopyMessage(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.copy_to`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return CreateChatInviteLink(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.create_invite_link`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return DeclineChatJoinRequest(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat_join_request.ChatJoinRequest.decline`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return DeleteChatPhoto(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.delete_photo`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return DeleteChatStickerSet(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.delete_sticker_set`

View file

@ -42,3 +42,10 @@ As reply into Webhook in handler
.. code-block:: python
return DeleteMessage(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.delete`
- :meth:`aiogram.types.chat.Chat.delete_message`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return DeleteStickerFromSet(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.sticker.Sticker.delete_from_set`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return EditChatInviteLink(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.edit_invite_link`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return EditMessageCaption(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.edit_caption`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return EditMessageLiveLocation(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.edit_live_location`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return EditMessageMedia(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.edit_media`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return EditMessageReplyMarkup(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.edit_reply_markup`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return EditMessageText(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.edit_text`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return ExportChatInviteLink(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.export_invite_link`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return ForwardMessage(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.forward`

View file

@ -35,3 +35,11 @@ With specific bot
.. code-block:: python
result: List[Union[ChatMemberOwner, ChatMemberAdministrator, ChatMemberMember, ChatMemberRestricted, ChatMemberLeft, ChatMemberBanned]] = await bot(GetChatAdministrators(...))
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.get_administrators`

View file

@ -35,3 +35,11 @@ With specific bot
.. code-block:: python
result: Union[ChatMemberOwner, ChatMemberAdministrator, ChatMemberMember, ChatMemberRestricted, ChatMemberLeft, ChatMemberBanned] = await bot(GetChatMember(...))
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.get_member`

View file

@ -35,3 +35,11 @@ With specific bot
.. code-block:: python
result: int = await bot(GetChatMemberCount(...))
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.get_member_count`

View file

@ -1,37 +0,0 @@
###################
getChatMembersCount
###################
Returns: :obj:`int`
.. automodule:: aiogram.methods.get_chat_members_count
:members:
:member-order: bysource
:undoc-members: True
Usage
=====
As bot method
-------------
.. code-block::
result: int = await bot.get_chat_members_count(...)
Method as object
----------------
Imports:
- :code:`from aiogram.methods.get_chat_members_count import GetChatMembersCount`
- alias: :code:`from aiogram.methods import GetChatMembersCount`
With specific bot
~~~~~~~~~~~~~~~~~
.. code-block:: python
result: int = await bot(GetChatMembersCount(...))

View file

@ -35,3 +35,11 @@ With specific bot
.. code-block:: python
result: UserProfilePhotos = await bot(GetUserProfilePhotos(...))
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.user.User.get_profile_photos`

View file

@ -1,44 +0,0 @@
##############
kickChatMember
##############
Returns: :obj:`bool`
.. automodule:: aiogram.methods.kick_chat_member
:members:
:member-order: bysource
:undoc-members: True
Usage
=====
As bot method
-------------
.. code-block::
result: bool = await bot.kick_chat_member(...)
Method as object
----------------
Imports:
- :code:`from aiogram.methods.kick_chat_member import KickChatMember`
- alias: :code:`from aiogram.methods import KickChatMember`
With specific bot
~~~~~~~~~~~~~~~~~
.. code-block:: python
result: bool = await bot(KickChatMember(...))
As reply into Webhook in handler
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: python
return KickChatMember(...)

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return LeaveChat(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.leave`

View file

@ -42,3 +42,10 @@ As reply into Webhook in handler
.. code-block:: python
return PinChatMessage(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.pin`
- :meth:`aiogram.types.chat.Chat.pin_message`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return PromoteChatMember(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.promote`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return RestrictChatMember(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.restrict`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return RevokeChatInviteLink(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.revoke_invite_link`

View file

@ -42,3 +42,10 @@ As reply into Webhook in handler
.. code-block:: python
return SendAnimation(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.answer_animation`
- :meth:`aiogram.types.message.Message.reply_animation`

View file

@ -42,3 +42,10 @@ As reply into Webhook in handler
.. code-block:: python
return SendAudio(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.answer_audio`
- :meth:`aiogram.types.message.Message.reply_audio`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return SendChatAction(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.do`

View file

@ -42,3 +42,10 @@ As reply into Webhook in handler
.. code-block:: python
return SendContact(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.answer_contact`
- :meth:`aiogram.types.message.Message.reply_contact`

View file

@ -42,3 +42,10 @@ As reply into Webhook in handler
.. code-block:: python
return SendDice(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.answer_dice`
- :meth:`aiogram.types.message.Message.reply_dice`

View file

@ -42,3 +42,10 @@ As reply into Webhook in handler
.. code-block:: python
return SendDocument(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.answer_document`
- :meth:`aiogram.types.message.Message.reply_document`

View file

@ -42,3 +42,10 @@ As reply into Webhook in handler
.. code-block:: python
return SendGame(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.answer_game`
- :meth:`aiogram.types.message.Message.reply_game`

View file

@ -42,3 +42,10 @@ As reply into Webhook in handler
.. code-block:: python
return SendInvoice(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.answer_invoice`
- :meth:`aiogram.types.message.Message.reply_invoice`

View file

@ -42,3 +42,10 @@ As reply into Webhook in handler
.. code-block:: python
return SendLocation(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.answer_location`
- :meth:`aiogram.types.message.Message.reply_location`

View file

@ -42,3 +42,10 @@ As reply into Webhook in handler
.. code-block:: python
return SendMediaGroup(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.answer_media_group`
- :meth:`aiogram.types.message.Message.reply_media_group`

View file

@ -42,3 +42,10 @@ As reply into Webhook in handler
.. code-block:: python
return SendMessage(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.answer`
- :meth:`aiogram.types.message.Message.reply`

View file

@ -42,3 +42,10 @@ As reply into Webhook in handler
.. code-block:: python
return SendPhoto(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.answer_photo`
- :meth:`aiogram.types.message.Message.reply_photo`

View file

@ -42,3 +42,10 @@ As reply into Webhook in handler
.. code-block:: python
return SendPoll(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.answer_poll`
- :meth:`aiogram.types.message.Message.reply_poll`

View file

@ -42,3 +42,10 @@ As reply into Webhook in handler
.. code-block:: python
return SendSticker(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.answer_sticker`
- :meth:`aiogram.types.message.Message.reply_sticker`

View file

@ -42,3 +42,10 @@ As reply into Webhook in handler
.. code-block:: python
return SendVenue(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.answer_venue`
- :meth:`aiogram.types.message.Message.reply_venue`

View file

@ -42,3 +42,10 @@ As reply into Webhook in handler
.. code-block:: python
return SendVideo(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.answer_video`
- :meth:`aiogram.types.message.Message.reply_video`

View file

@ -42,3 +42,10 @@ As reply into Webhook in handler
.. code-block:: python
return SendVideoNote(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.answer_video_note`
- :meth:`aiogram.types.message.Message.reply_video_note`

View file

@ -42,3 +42,10 @@ As reply into Webhook in handler
.. code-block:: python
return SendVoice(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.answer_voice`
- :meth:`aiogram.types.message.Message.reply_voice`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return SetChatAdministratorCustomTitle(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.set_administrator_custom_title`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return SetChatDescription(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.set_description`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return SetChatPermissions(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.set_permissions`

View file

@ -35,3 +35,11 @@ With specific bot
.. code-block:: python
result: bool = await bot(SetChatPhoto(...))
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.set_photo`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return SetChatStickerSet(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.set_sticker_set`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return SetChatTitle(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.set_title`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return SetStickerPositionInSet(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.sticker.Sticker.set_position_in_set`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return StopMessageLiveLocation(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.stop_live_location`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return UnbanChatMember(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.unban`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return UnbanChatSenderChat(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.unban_sender_chat`

View file

@ -42,3 +42,9 @@ As reply into Webhook in handler
.. code-block:: python
return UnpinAllChatMessages(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.chat.Chat.unpin_all_messages`

View file

@ -42,3 +42,10 @@ As reply into Webhook in handler
.. code-block:: python
return UnpinChatMessage(...)
As shortcut from received object
--------------------------------
- :meth:`aiogram.types.message.Message.unpin`
- :meth:`aiogram.types.chat.Chat.unpin_message`