Skip to content

Commit

Permalink
Add missing shortcuts, new enums, reworked old stuff (#1070)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
JrooTJunior committed Dec 4, 2022
1 parent 3438d24 commit 3ea73fb
Show file tree
Hide file tree
Showing 370 changed files with 18,326 additions and 6,971 deletions.
16 changes: 16 additions & 0 deletions .butcher/enums/BotCommandScopeType.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: BotCommandScopeType
description: |
This object represents the scope to which bot commands are applied.
Source: https://core.telegram.org/bots/api#botcommandscope
multi_parse:
attribute: type
regexp: "must be ([a-z_]+)"
entities:
- BotCommandScopeDefault
- BotCommandScopeAllPrivateChats
- BotCommandScopeAllGroupChats
- BotCommandScopeAllChatAdministrators
- BotCommandScopeChat
- BotCommandScopeChatAdministrators
- BotCommandScopeChatMember
22 changes: 22 additions & 0 deletions .butcher/enums/ChatActions.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: ChatAction
description: |
This object represents bot actions.
Choose one, depending on what the user is about to receive:
- typing for text messages,
- upload_photo for photos,
- record_video or upload_video for videos,
- record_voice or upload_voice for voice notes,
- upload_document for general files,
- choose_sticker for stickers,
- find_location for location data,
- record_video_note or upload_video_note for video notes.
Source: https://core.telegram.org/bots/api#sendchataction
parse:
format: rst
entity: sendChatAction
category: methods
attribute: action
regexp: '\*([a-z_]+)\*'
15 changes: 15 additions & 0 deletions .butcher/enums/ChatMemberStatus.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: ChatMemberStatus
description: |
This object represents chat member status.
Source: https://core.telegram.org/bots/api#chatmember
multi_parse:
attribute: status
regexp: "'([a-z_]+)'"
entities:
- ChatMemberOwner
- ChatMemberAdministrator
- ChatMemberMember
- ChatMemberRestricted
- ChatMemberLeft
- ChatMemberBanned
11 changes: 11 additions & 0 deletions .butcher/enums/ChatType.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: ChatType
description: |
This object represents a chat type
Source: https://core.telegram.org/bots/api#chat
parse:
entity: Chat
attribute: type
regexp: "'([a-z]+)'"
static:
SENDER: sender
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
name: ContentType
description: "Message content type"
description:
This object represents a type of content in message
static:
UNKNOWN: unknown
ANY: any
Expand Down
5 changes: 4 additions & 1 deletion .butcher/enums/dice.yml → .butcher/enums/DiceEmoji.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
name: DiceEmoji
description: "Emoji on which the dice throw animation is based"
description: |
Emoji on which the dice throw animation is based
Source: https://core.telegram.org/bots/api#dice
static:
DICE: 🎲
DART: 🎯
Expand Down
29 changes: 29 additions & 0 deletions .butcher/enums/InlineQueryResultType.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: InlineQueryResultType
description: |
The part of the face relative to which the mask should be placed.
Source: https://core.telegram.org/bots/api#maskposition
multi_parse:
attribute: type
regexp: "must be ([a-z_]+)"
entities:
- InlineQueryResultCachedAudio
- InlineQueryResultCachedDocument
- InlineQueryResultCachedGif
- InlineQueryResultCachedMpeg4Gif
- InlineQueryResultCachedPhoto
- InlineQueryResultCachedSticker
- InlineQueryResultCachedVideo
- InlineQueryResultCachedVoice
- InlineQueryResultArticle
- InlineQueryResultAudio
- InlineQueryResultContact
- InlineQueryResultGame
- InlineQueryResultDocument
- InlineQueryResultGif
- InlineQueryResultLocation
- InlineQueryResultMpeg4Gif
- InlineQueryResultPhoto
- InlineQueryResultVenue
- InlineQueryResultVideo
- InlineQueryResultVoice
14 changes: 14 additions & 0 deletions .butcher/enums/InputMediaType.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: InputMediaType
description: |
This object represents input media type
Source: https://core.telegram.org/bots/api#inputmedia
multi_parse:
attribute: type
regexp: 'must be ([a-z_]+)'
entities:
- InputMediaAnimation
- InputMediaAudio
- InputMediaDocument
- InputMediaPhoto
- InputMediaVideo
9 changes: 9 additions & 0 deletions .butcher/enums/MaskPositionPoint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name: MaskPositionPoint
description: |
The part of the face relative to which the mask should be placed.
Source: https://core.telegram.org/bots/api#maskposition
parse:
entity: MaskPosition
attribute: point
regexp: "'([a-z_]+)'"
13 changes: 13 additions & 0 deletions .butcher/enums/MenuButtonType.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: MenuButtonType
description: |
This object represents an type of Menu button
Source: https://core.telegram.org/bots/api#menubuttondefault
multi_parse:
format: rst
attribute: type
regexp: '\*([a-z_]+)\*'
entities:
- MenuButtonDefault
- MenuButtonCommands
- MenuButtonWebApp
10 changes: 10 additions & 0 deletions .butcher/enums/MessageEntityType.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: MessageEntityType
description: |
This object represents type of message entity
Source: https://core.telegram.org/bots/api#messageentity
parse:
entity: MessageEntity
category: types
attribute: type
regexp: "'([a-z_]+)'"
9 changes: 9 additions & 0 deletions .butcher/enums/ParseMode.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name: ParseMode
description: |
Formatting options
Source: https://core.telegram.org/bots/api#formatting-options
static:
MARKDOWN_V2: MarkdownV2
MARKDOWN: Markdown
HTML: HTML
9 changes: 9 additions & 0 deletions .butcher/enums/PollType.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name: PollType
description: |
This object represents poll type
Source: https://core.telegram.org/bots/api#poll
parse:
entity: Poll
attribute: type
regexp: "'([a-z]+)'"
9 changes: 9 additions & 0 deletions .butcher/enums/StickerType.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name: StickerType
description: |
The part of the face relative to which the mask should be placed.
Source: https://core.telegram.org/bots/api#maskposition
parse:
entity: Sticker
attribute: type
regexp: "'([a-z_]+)'"
File renamed without changes.
9 changes: 9 additions & 0 deletions .butcher/enums/UpdateType.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name: UpdateType
description: |
This object represents the complete list of allowed update types
Source: https://core.telegram.org/bots/api#update
extract:
entity: Update
exclude:
- update_id
6 changes: 0 additions & 6 deletions .butcher/enums/chat_type.yml

This file was deleted.

6 changes: 0 additions & 6 deletions .butcher/enums/update_type.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .butcher/templates/enums/index.rst.jinja2
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#####
Types
Enums
#####

Here is list of all available enums:
Expand Down
2 changes: 1 addition & 1 deletion .butcher/templates/methods/entity.rst.jinja2
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ As reply into Webhook in handler

{% if aliased %}
As shortcut from received object
-------------------
--------------------------------
{% for alias in aliased %}
- :meth:`aiogram.types.{{ alias.type|pythonize_name }}.{{ alias.type|pythonize_class_name }}.{{ alias.name }}`
{%- endfor %}
Expand Down
4 changes: 4 additions & 0 deletions .butcher/types/CallbackQuery/aliases.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
answer:
method: answerCallbackQuery
fill:
callback_query_id: self.id

0 comments on commit 3ea73fb

Please sign in to comment.