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

Remove deprecated attributes from Bot class

Browse source 
The deprecated attributes `parse_mode`, `disable_web_page_preview`, and `protect_content` have been removed from the Bot class. Additionally, the associated warnings and test cases have been deleted. These attributes should now be passed using the `default=DefaultBotProperties(...)` syntax instead.
This commit is contained in:
JRoot Junior 2024-05-27 14:16:58 +03:00
parent 895f4f8dce
commit ce46fca81b
No known key found for this signature in database
GPG key ID: 738964250D5FF6E2
2 changed files with 33 additions and 82 deletions
Download patch file Download diff file Expand all files Collapse all files

72
aiogram/client/bot.py
View file

@ -3,7 +3,6 @@ from __future__ import annotations
import datetime
import io
import pathlib
import warnings
from contextlib import asynccontextmanager
from types import TracebackType
from typing import (
@ -251,10 +250,8 @@ class Bot:
self,
token: str,
session: Optional[BaseSession] = None,
parse_mode: Optional[str] = None,
disable_web_page_preview: Optional[bool] = None,
protect_content: Optional[bool] = None,
default: Optional[DefaultBotProperties] = None,
**kwargs: Any,
) -> None:
"""
Bot class
@ -262,12 +259,6 @@ class Bot:
: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.
:param parse_mode: Default parse mode.
If specified it will be propagated into the API methods at runtime.
:param disable_web_page_preview: Default disable_web_page_preview mode.
If specified it will be propagated into the API methods at runtime.
:param protect_content: Default protect_content mode.
If specified it will be propagated into the API methods at runtime.
:param default: Default bot properties.
If specified it will be propagated into the API methods at runtime.
:raise TokenValidationError: When token has invalid format this exception will be raised
@ -278,24 +269,33 @@ class Bot:
if session is None:
session = AiohttpSession()
if default is None:
default = DefaultBotProperties(
parse_mode=parse_mode,
link_preview_is_disabled=disable_web_page_preview,
protect_content=protect_content,
)
default = DefaultBotProperties()
self.session = session
# Few arguments are completely removed in 3.7.0 version
# Temporary solution to raise an error if user passed these arguments
# with explanation how to fix it
parse_mode = kwargs.get("parse_mode", None)
link_preview_is_disabled = kwargs.get("disable_web_page_preview", None)
protect_content = kwargs.get("protect_content", None)
if (
parse_mode is not None
or disable_web_page_preview is not None
or link_preview_is_disabled is not None
or protect_content is not None
):
warnings.warn(
example_kwargs = {
"parse_mode": parse_mode,
"link_preview_is_disabled": link_preview_is_disabled,
"protect_content": protect_content,
}
replacement_spec = ", ".join(
f"{k}={v!r}" for k, v in example_kwargs.items() if v is not None
)
raise TypeError(
"Passing `parse_mode`, `disable_web_page_preview` or `protect_content` "
"to Bot initializer is deprecated. This arguments will be removed in 3.7.0 version\n"
"Use `default=DefaultBotProperties(...)` instead.",
category=DeprecationWarning,
stacklevel=2,
"to Bot initializer is not supported anymore. These arguments have been removed "
f"in 3.7.0 version. Use `default=DefaultBotProperties({replacement_spec})` instead."
)
self.default = default
@ -314,36 +314,6 @@ class Bot:
) -> None:
await self.session.close()
@property
def parse_mode(self) -> Optional[str]:
warnings.warn(
"Accessing `parse_mode` from Bot instance is deprecated. This attribute will be removed in 3.5.0 version\n"
"Use `bot.default.parse_mode` instead.",
category=DeprecationWarning,
stacklevel=2,
)
return self.default.parse_mode
@property
def disable_web_page_preview(self) -> Optional[bool]:
warnings.warn(
"Accessing `disable_web_page_preview` from Bot instance is deprecated. This attribute will be removed in 3.5.0 version\n"
"Use `bot.default.link_preview_is_disabled` instead.",
category=DeprecationWarning,
stacklevel=2,
)
return self.default.link_preview_is_disabled
@property
def protect_content(self) -> Optional[bool]:
warnings.warn(
"Accessing `protect_content` from Bot instance is deprecated. This attribute will be removed in 3.5.0 version\n"
"Use `bot.default.protect_content` instead.",
category=DeprecationWarning,
stacklevel=2,
)
return self.default.protect_content
@property
def token(self) -> str:
return self.__token

43
tests/test_api/test_client/test_bot.py
View file

@ -12,7 +12,6 @@ from aiogram.client.session.aiohttp import AiohttpSession
from aiogram.client.telegram import TelegramAPIServer
from aiogram.methods import GetFile, GetMe
from aiogram.types import File, PhotoSize
from tests.deprecated import check_deprecated
from tests.mocked_bot import MockedBot
from tests.test_api.test_client.test_session.test_base_session import CustomSession
@ -55,36 +54,18 @@ class TestBot:
mocked_close.assert_awaited_once()
def test_init_default(self):
with check_deprecated(
max_version="3.7.0",
exception=TypeError,
):
bot = Bot(token="42:Test", parse_mode="HTML")
def test_deprecated_parse_mode(self):
with check_deprecated(
max_version="3.7.0",
exception=AttributeError,
):
bot = Bot(token="42:Test", parse_mode="HTML")
assert bot.parse_mode == "HTML"
def test_disable_web_page_preview(self):
with check_deprecated(
max_version="3.7.0",
exception=TypeError,
):
bot = Bot(token="42:Test", disable_web_page_preview=True)
assert bot.disable_web_page_preview is True
def test_deprecated_protect_content(self):
with check_deprecated(
max_version="3.7.0",
exception=AttributeError,
):
bot = Bot(token="42:Test", protect_content=True)
assert bot.protect_content is True
@pytest.mark.parametrize(
"kwargs",
[
{"parse_mode": "HTML"},
{"disable_web_page_preview": True},
{"protect_content": True},
{"parse_mode": True, "disable_web_page_preview": True},
],
)
def test_init_default(self, kwargs):
with pytest.raises(TypeError):
Bot(token="42:Test", **kwargs)
def test_hashable(self):
bot = Bot("42:TEST")