python/aiogram
1
0
Fork 0
mirror of https://github.com/aiogram/aiogram.git synced 2026-04-08 16:37:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Write docs and small fixes.

Browse source
This commit is contained in:
Alex Root Junior 2018-09-07 21:24:13 +03:00
parent 23fba99d93
commit 7a55c040ee
31 changed files with 306 additions and 458 deletions
Download patch file Download diff file Expand all files Collapse all files

6
aiogram/bot/api.py
View file

@ -44,9 +44,9 @@ async def check_result(method_name: str, content_type: str, status_code: int, bo
"""
Checks whether `result` is a valid API response.
A result is considered invalid if:
- The server returned an HTTP response code other than 200
- The content of the result is invalid JSON.
- The method call was unsuccessful (The JSON 'ok' field equals False)
- The server returned an HTTP response code other than 200
- The content of the result is invalid JSON.
- The method call was unsuccessful (The JSON 'ok' field equals False)
:param method_name: The name of the method called
:param status_code: status code

6
aiogram/bot/bot.py
View file

@ -29,6 +29,12 @@ class Bot(BaseBot):
def me(self):
"""
Reset `me`
.. code-block:: python3
await bot.me
:return: :obj:`aiogram.types.User`
"""
if hasattr(self, '_me'):
delattr(self, '_me')

6
aiogram/types/auth_widget_data.py
View file

@ -1,3 +1,5 @@
from __future__ import annotations
from aiohttp import web
from . import base
@ -14,13 +16,13 @@ class AuthWidgetData(base.TelegramObject):
hash: base.String = fields.Field()
@classmethod
def parse(cls, request: web.Request) -> 'AuthWidgetData':
def parse(cls, request: web.Request) -> AuthWidgetData:
"""
Parse request as Telegram auth widget data.
:param request:
:return: :obj:`AuthWidgetData`
:raise :obj:`aiohttp.web.HTTPBadRequest`
:raise: :obj:`aiohttp.web.HTTPBadRequest`
"""
try:
query = dict(request.query)

2
aiogram/types/chat.py
View file

@ -511,7 +511,7 @@ class ChatActions(helper.Helper):
@classmethod
async def _do(cls, action: str, sleep=None):
from aiogram import Bot
await Bot.current().send_chat_action(Chat.current(), action)
await Bot.current().send_chat_action(Chat.current().id, action)
if sleep:
await asyncio.sleep(sleep)

31
aiogram/types/message.py
View file

@ -13,6 +13,7 @@ from .chat import Chat
from .contact import Contact
from .document import Document
from .game import Game
from .input_media import MediaGroup
from .invoice import Invoice
from .location import Location
from .message_entity import MessageEntity
@ -263,7 +264,7 @@ class Message(base.TelegramObject):
async def reply_photo(self, photo: typing.Union[base.InputFile, base.String],
caption: typing.Union[base.String, None] = None,
disable_notification: typing.Union[base.Boolean, None] = None,
reply_markup=None, reply=True) -> 'Message':
reply_markup=None, reply=True) -> Message:
"""
Use this method to send photos.
@ -294,7 +295,7 @@ class Message(base.TelegramObject):
title: typing.Union[base.String, None] = None,
disable_notification: typing.Union[base.Boolean, None] = None,
reply_markup=None,
reply=True) -> 'Message':
reply=True) -> Message:
"""
Use this method to send audio files, if you want Telegram clients to display them in the music player.
Your audio must be in the .mp3 format.
@ -336,7 +337,7 @@ class Message(base.TelegramObject):
caption: typing.Union[base.String, None] = None,
disable_notification: typing.Union[base.Boolean, None] = None,
reply_markup=None,
reply=True) -> 'Message':
reply=True) -> Message:
"""
Use this method to send general files.
@ -371,7 +372,7 @@ class Message(base.TelegramObject):
caption: typing.Union[base.String, None] = None,
disable_notification: typing.Union[base.Boolean, None] = None,
reply_markup=None,
reply=True) -> 'Message':
reply=True) -> Message:
"""
Use this method to send video files, Telegram clients support mp4 videos
(other formats may be sent as Document).
@ -412,7 +413,7 @@ class Message(base.TelegramObject):
duration: typing.Union[base.Integer, None] = None,
disable_notification: typing.Union[base.Boolean, None] = None,
reply_markup=None,
reply=True) -> 'Message':
reply=True) -> Message:
"""
Use this method to send audio files, if you want Telegram clients to display the file
as a playable voice message.
@ -450,7 +451,7 @@ class Message(base.TelegramObject):
length: typing.Union[base.Integer, None] = None,
disable_notification: typing.Union[base.Boolean, None] = None,
reply_markup=None,
reply=True) -> 'Message':
reply=True) -> Message:
"""
As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long.
Use this method to send video messages.
@ -480,9 +481,9 @@ class Message(base.TelegramObject):
reply_to_message_id=self.message_id if reply else None,
reply_markup=reply_markup)
async def reply_media_group(self, media: typing.Union['MediaGroup', typing.List],
async def reply_media_group(self, media: typing.Union[MediaGroup, typing.List],
disable_notification: typing.Union[base.Boolean, None] = None,
reply=True) -> typing.List['Message']:
reply=True) -> typing.List[Message]:
"""
Use this method to send a group of photos or videos as an album.
@ -505,7 +506,7 @@ class Message(base.TelegramObject):
longitude: base.Float, live_period: typing.Union[base.Integer, None] = None,
disable_notification: typing.Union[base.Boolean, None] = None,
reply_markup=None,
reply=True) -> 'Message':
reply=True) -> Message:
"""
Use this method to send point on the map.
@ -535,7 +536,7 @@ class Message(base.TelegramObject):
reply_markup=reply_markup)
async def edit_live_location(self, latitude: base.Float, longitude: base.Float,
reply_markup=None) -> 'Message' or base.Boolean:
reply_markup=None) -> typing.Union[Message, base.Boolean]:
"""
Use this method to edit live location messages sent by the bot or via the bot (for inline bots).
A location can be edited until its live_period expires or editing is explicitly disabled by a call
@ -557,7 +558,7 @@ class Message(base.TelegramObject):
chat_id=self.chat.id, message_id=self.message_id,
reply_markup=reply_markup)
async def stop_live_location(self, reply_markup=None) -> 'Message' or base.Boolean:
async def stop_live_location(self, reply_markup=None) -> typing.Union[Message, base.Boolean]:
"""
Use this method to stop updating a live location message sent by the bot or via the bot
(for inline bots) before live_period expires.
@ -577,7 +578,7 @@ class Message(base.TelegramObject):
foursquare_id: typing.Union[base.String, None] = None,
disable_notification: typing.Union[base.Boolean, None] = None,
reply_markup=None,
reply=True) -> 'Message':
reply=True) -> Message:
"""
Use this method to send information about a venue.
@ -616,7 +617,7 @@ class Message(base.TelegramObject):
first_name: base.String, last_name: typing.Union[base.String, None] = None,
disable_notification: typing.Union[base.Boolean, None] = None,
reply_markup=None,
reply=True) -> 'Message':
reply=True) -> Message:
"""
Use this method to send phone contacts.
@ -644,7 +645,7 @@ class Message(base.TelegramObject):
reply_to_message_id=self.message_id if reply else None,
reply_markup=reply_markup)
async def forward(self, chat_id, disable_notification=None) -> 'Message':
async def forward(self, chat_id, disable_notification=None) -> Message:
"""
Forward this message
@ -692,7 +693,7 @@ class Message(base.TelegramObject):
async def reply_sticker(self, sticker: typing.Union[base.InputFile, base.String],
disable_notification: typing.Union[base.Boolean, None] = None,
reply_markup=None, reply=True) -> 'Message':
reply_markup=None, reply=True) -> Message:
"""
Use this method to send .webp stickers.