Update docs

This commit is contained in:
Alex Root Junior 2022-11-25 05:25:26 +02:00
parent 3d38577bb0
commit e84b8b92e6
No known key found for this signature in database
GPG key ID: 074C1D455EBEA4AC
70 changed files with 203 additions and 264 deletions

View file

@ -1,5 +1,5 @@
#####
Types
Enums
#####
Here is list of all available enums:

View file

@ -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 %}

View file

@ -0,0 +1,2 @@
bases:
- _ErrorEvent

View file

@ -175,10 +175,6 @@ T = TypeVar("T")
class Bot(ContextInstanceMixin["Bot"]):
"""
Bot class
"""
def __init__(
self,
token: str,
@ -186,6 +182,8 @@ class Bot(ContextInstanceMixin["Bot"]):
parse_mode: Optional[str] = None,
) -> None:
"""
Bot class
:param token: Telegram Bot token `Obtained from @BotFather <https://t.me/BotFather>`_
:param session: HTTP Client session (For example AiohttpSession).
If not specified it will be automatically created.
@ -234,6 +232,11 @@ class Bot(ContextInstanceMixin["Bot"]):
self.reset_current(token)
async def me(self) -> User:
"""
Cached alias for getMe method
:return:
"""
if self._me is None: # pragma: no cover
self._me = await self.get_me()
return self._me

View file

@ -36,6 +36,7 @@ from .document import Document
from .downloadable import Downloadable
from .encrypted_credentials import EncryptedCredentials
from .encrypted_passport_element import EncryptedPassportElement
from .error_event import ErrorEvent
from .file import File
from .force_reply import ForceReply
from .forum_topic import ForumTopic
@ -141,150 +142,151 @@ from .web_app_info import WebAppInfo
from .webhook_info import WebhookInfo
__all__ = (
"TelegramObject",
"Downloadable",
"UNSET",
"BufferedInputFile",
"FSInputFile",
"URLInputFile",
"Update",
"WebhookInfo",
"User",
"Chat",
"Message",
"ContentType",
"MessageId",
"MessageEntity",
"PhotoSize",
"Animation",
"Audio",
"Document",
"Video",
"VideoNote",
"Voice",
"Contact",
"Dice",
"PollOption",
"PollAnswer",
"Poll",
"Location",
"Venue",
"WebAppData",
"ProximityAlertTriggered",
"MessageAutoDeleteTimerChanged",
"ForumTopicCreated",
"ForumTopicClosed",
"ForumTopicReopened",
"VideoChatScheduled",
"VideoChatStarted",
"VideoChatEnded",
"VideoChatParticipantsInvited",
"UserProfilePhotos",
"File",
"WebAppInfo",
"ReplyKeyboardMarkup",
"KeyboardButton",
"KeyboardButtonPollType",
"ReplyKeyboardRemove",
"InlineKeyboardMarkup",
"InlineKeyboardButton",
"LoginUrl",
"CallbackQuery",
"ForceReply",
"ChatPhoto",
"ChatInviteLink",
"ChatAdministratorRights",
"ChatMember",
"ChatMemberOwner",
"ChatMemberAdministrator",
"ChatMemberMember",
"ChatMemberRestricted",
"ChatMemberLeft",
"ChatMemberBanned",
"ChatMemberUpdated",
"ChatJoinRequest",
"ChatPermissions",
"ChatLocation",
"ForumTopic",
"BotCommand",
"BotCommandScope",
"BotCommandScopeDefault",
"BotCommandScopeAllPrivateChats",
"BotCommandScopeAllGroupChats",
"BotCommandScopeAllChatAdministrators",
"BotCommandScopeAllGroupChats",
"BotCommandScopeAllPrivateChats",
"BotCommandScopeChat",
"BotCommandScopeChatAdministrators",
"BotCommandScopeChatMember",
"MenuButton",
"MenuButtonCommands",
"MenuButtonWebApp",
"MenuButtonDefault",
"ResponseParameters",
"InputMedia",
"InputMediaPhoto",
"InputMediaVideo",
"InputMediaAnimation",
"InputMediaAudio",
"InputMediaDocument",
"InputFile",
"Sticker",
"StickerSet",
"MaskPosition",
"BotCommandScopeDefault",
"BufferedInputFile",
"CallbackGame",
"CallbackQuery",
"Chat",
"ChatAdministratorRights",
"ChatInviteLink",
"ChatJoinRequest",
"ChatLocation",
"ChatMember",
"ChatMemberAdministrator",
"ChatMemberBanned",
"ChatMemberLeft",
"ChatMemberMember",
"ChatMemberOwner",
"ChatMemberRestricted",
"ChatMemberUpdated",
"ChatPermissions",
"ChatPhoto",
"ChosenInlineResult",
"Contact",
"ContentType",
"Dice",
"Document",
"Downloadable",
"EncryptedCredentials",
"EncryptedPassportElement",
"ErrorEvent",
"FSInputFile",
"File",
"ForceReply",
"ForumTopic",
"ForumTopicClosed",
"ForumTopicCreated",
"ForumTopicReopened",
"Game",
"GameHighScore",
"InlineKeyboardButton",
"InlineKeyboardMarkup",
"InlineQuery",
"InlineQueryResult",
"InlineQueryResultArticle",
"InlineQueryResultPhoto",
"InlineQueryResultGif",
"InlineQueryResultMpeg4Gif",
"InlineQueryResultVideo",
"InlineQueryResultAudio",
"InlineQueryResultVoice",
"InlineQueryResultDocument",
"InlineQueryResultLocation",
"InlineQueryResultVenue",
"InlineQueryResultContact",
"InlineQueryResultGame",
"InlineQueryResultCachedPhoto",
"InlineQueryResultCachedAudio",
"InlineQueryResultCachedDocument",
"InlineQueryResultCachedGif",
"InlineQueryResultCachedMpeg4Gif",
"InlineQueryResultCachedPhoto",
"InlineQueryResultCachedSticker",
"InlineQueryResultCachedDocument",
"InlineQueryResultCachedVideo",
"InlineQueryResultCachedVoice",
"InlineQueryResultCachedAudio",
"InlineQueryResultContact",
"InlineQueryResultDocument",
"InlineQueryResultGame",
"InlineQueryResultGif",
"InlineQueryResultLocation",
"InlineQueryResultMpeg4Gif",
"InlineQueryResultPhoto",
"InlineQueryResultVenue",
"InlineQueryResultVideo",
"InlineQueryResultVoice",
"InputContactMessageContent",
"InputFile",
"InputInvoiceMessageContent",
"InputLocationMessageContent",
"InputMedia",
"InputMediaAnimation",
"InputMediaAudio",
"InputMediaDocument",
"InputMediaPhoto",
"InputMediaVideo",
"InputMessageContent",
"InputTextMessageContent",
"InputLocationMessageContent",
"InputVenueMessageContent",
"InputContactMessageContent",
"InputInvoiceMessageContent",
"ChosenInlineResult",
"SentWebAppMessage",
"LabeledPrice",
"Invoice",
"ShippingAddress",
"KeyboardButton",
"KeyboardButtonPollType",
"LabeledPrice",
"Location",
"LoginUrl",
"MaskPosition",
"MenuButton",
"MenuButtonCommands",
"MenuButtonDefault",
"MenuButtonWebApp",
"Message",
"MessageAutoDeleteTimerChanged",
"MessageEntity",
"MessageId",
"OrderInfo",
"ShippingOption",
"SuccessfulPayment",
"ShippingQuery",
"PreCheckoutQuery",
"PassportData",
"PassportFile",
"EncryptedPassportElement",
"EncryptedCredentials",
"PassportElementError",
"PassportElementErrorDataField",
"PassportElementErrorFile",
"PassportElementErrorFiles",
"PassportElementErrorFrontSide",
"PassportElementErrorReverseSide",
"PassportElementErrorSelfie",
"PassportElementErrorFile",
"PassportElementErrorFiles",
"PassportElementErrorTranslationFile",
"PassportElementErrorTranslationFiles",
"PassportElementErrorUnspecified",
"Game",
"CallbackGame",
"GameHighScore",
"PassportFile",
"PhotoSize",
"Poll",
"PollAnswer",
"PollOption",
"PreCheckoutQuery",
"ProximityAlertTriggered",
"ReplyKeyboardMarkup",
"ReplyKeyboardRemove",
"ResponseParameters",
"SentWebAppMessage",
"ShippingAddress",
"ShippingOption",
"ShippingQuery",
"Sticker",
"StickerSet",
"SuccessfulPayment",
"TelegramObject",
"UNSET",
"URLInputFile",
"Update",
"User",
"UserProfilePhotos",
"Venue",
"Video",
"VideoChatEnded",
"VideoChatParticipantsInvited",
"VideoChatScheduled",
"VideoChatStarted",
"VideoNote",
"Voice",
"WebAppData",
"WebAppInfo",
"WebhookInfo",
)
# Load typing forward refs for every TelegramObject

View file

@ -2,15 +2,19 @@ from aiogram.types import Update
from aiogram.types.base import MutableTelegramObject
class ErrorEvent(MutableTelegramObject):
class _ErrorEvent(MutableTelegramObject):
class Config:
arbitrary_types_allowed = True
class ErrorEvent(_ErrorEvent):
"""
Internal event, should be used to receive errors while processing Updates from Telegram
Source: https://core.telegram.org/bots/api#error-event
"""
update: Update
"""Received update"""
exception: Exception
"""Exception"""
class Config:
arbitrary_types_allowed = True

View file

@ -15,3 +15,4 @@ For example :code:`sendMessage` named :code:`send_message` and has the same spec
:member-order: bysource
:special-members: __init__
:undoc-members: True
:noindex:

View file

@ -1,5 +1,5 @@
#####
Types
Enums
#####
Here is list of all available enums:

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.callback_query.CallbackQuery.answer`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.inline_query.InlineQuery.answer`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat_join_request.ChatJoinRequest.approve`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat.Chat.ban`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat.Chat.ban_sender_chat`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.copy_to`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat.Chat.create_invite_link`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat_join_request.ChatJoinRequest.decline`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat.Chat.delete_photo`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat.Chat.delete_sticker_set`

View file

@ -45,7 +45,7 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.delete`
- :meth:`aiogram.types.chat.Chat.delete_message`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.sticker.Sticker.delete_from_set`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat.Chat.edit_invite_link`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.edit_caption`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.edit_live_location`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.edit_media`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.edit_reply_markup`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.edit_text`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat.Chat.export_invite_link`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.forward`

View file

@ -40,6 +40,6 @@ With specific bot
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat.Chat.get_administrators`

View file

@ -40,6 +40,6 @@ With specific bot
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat.Chat.get_member`

View file

@ -40,6 +40,6 @@ With specific bot
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

@ -40,6 +40,6 @@ With specific bot
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

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat.Chat.leave`

View file

@ -45,7 +45,7 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.pin`
- :meth:`aiogram.types.chat.Chat.pin_message`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat.Chat.promote`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat.Chat.restrict`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat.Chat.revoke_invite_link`

View file

@ -45,7 +45,7 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.answer_animation`
- :meth:`aiogram.types.message.Message.reply_animation`

View file

@ -45,7 +45,7 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.answer_audio`
- :meth:`aiogram.types.message.Message.reply_audio`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat.Chat.do`

View file

@ -45,7 +45,7 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.answer_contact`
- :meth:`aiogram.types.message.Message.reply_contact`

View file

@ -45,7 +45,7 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.answer_dice`
- :meth:`aiogram.types.message.Message.reply_dice`

View file

@ -45,7 +45,7 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.answer_document`
- :meth:`aiogram.types.message.Message.reply_document`

View file

@ -45,7 +45,7 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.answer_game`
- :meth:`aiogram.types.message.Message.reply_game`

View file

@ -45,7 +45,7 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.answer_invoice`
- :meth:`aiogram.types.message.Message.reply_invoice`

View file

@ -45,7 +45,7 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.answer_location`
- :meth:`aiogram.types.message.Message.reply_location`

View file

@ -45,7 +45,7 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.answer_media_group`
- :meth:`aiogram.types.message.Message.reply_media_group`

View file

@ -45,7 +45,7 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.answer`
- :meth:`aiogram.types.message.Message.reply`

View file

@ -45,7 +45,7 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.answer_photo`
- :meth:`aiogram.types.message.Message.reply_photo`

View file

@ -45,7 +45,7 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.answer_poll`
- :meth:`aiogram.types.message.Message.reply_poll`

View file

@ -45,7 +45,7 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.answer_sticker`
- :meth:`aiogram.types.message.Message.reply_sticker`

View file

@ -45,7 +45,7 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.answer_venue`
- :meth:`aiogram.types.message.Message.reply_venue`

View file

@ -45,7 +45,7 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.answer_video`
- :meth:`aiogram.types.message.Message.reply_video`

View file

@ -45,7 +45,7 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.answer_video_note`
- :meth:`aiogram.types.message.Message.reply_video_note`

View file

@ -45,7 +45,7 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.answer_voice`
- :meth:`aiogram.types.message.Message.reply_voice`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat.Chat.set_administrator_custom_title`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat.Chat.set_description`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat.Chat.set_permissions`

View file

@ -40,6 +40,6 @@ With specific bot
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat.Chat.set_photo`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat.Chat.set_sticker_set`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat.Chat.set_title`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.sticker.Sticker.set_position_in_set`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.stop_live_location`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat.Chat.unban`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat.Chat.unban_sender_chat`

View file

@ -45,6 +45,6 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.chat.Chat.unpin_all_messages`

View file

@ -45,7 +45,7 @@ As reply into Webhook in handler
As shortcut from received object
-------------------
--------------------------------
- :meth:`aiogram.types.message.Message.unpin`
- :meth:`aiogram.types.chat.Chat.unpin_message`

View file

@ -190,3 +190,11 @@ Games
callback_game
game
game_high_score
Internals
=========
.. toctree::
:maxdepth: 1
error_event