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

add support of stacklevel parameter in renamed_argument decorator

Browse source
This commit is contained in:
birdi 2019-08-11 00:07:30 +03:00
parent 05bfb37e18
commit cc601a7e0d
1 changed files with 18 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

29
aiogram/utils/deprecated.py
View file

@ -76,24 +76,27 @@ def warn_deprecated(message, warning=DeprecationWarning, stacklevel=2):
warnings.simplefilter('default', warning)
def renamed_argument(old_name: str, new_name: str, until_version: str):
def renamed_argument(old_name: str, new_name: str, until_version: str, stacklevel: int = 3):
"""
A meta-decorator to mark some arguments in function as deprecated.
.. code-block:: python3
@renamed_argument("user", "user_id", "3.0")
def some_function(user_id):
print(f"user_id={user_id}")
@renamed_argument("chat", "chat_id", "3.0") # stacklevel=3 by default
@renamed_argument("user", "user_id", "3.0", stacklevel=4)
def some_function(user_id, chat_id=None):
print(f"user_id={user_id}, chat_id={chat_id}")
some_function(user=123) # prints 'user_id=123' with warning
some_function(123) # prints 'user_id=123' without warning
some_function(user_id=123) # prints 'user_id=123' without warning
some_function(user=123) # prints 'user_id=123, chat_id=None' with warning
some_function(123) # prints 'user_id=123, chat_id=None' without warning
some_function(user_id=123) # prints 'user_id=123, chat_id=None' without warning
:param old_name:
:param new_name:
:param until_version: the version in which the argument is scheduled to be removed
:param stacklevel: leave it to default if it's the first decorator used.
Increment with any new decorator used.
:return: decorator
"""
@ -102,8 +105,10 @@ def renamed_argument(old_name: str, new_name: str, until_version: str):
@functools.wraps(func)
async def wrapped(*args, **kwargs):
if old_name in kwargs:
warn_deprecated(f"In coroutine '{func.__name__}' argument '{old_name}' is renamed to '{new_name}' "
f"and will be removed in aiogram {until_version}", stacklevel=3)
warn_deprecated(f"In coroutine '{func.__name__}' argument '{old_name}' "
f"is renamed to '{new_name}' "
f"and will be removed in aiogram {until_version}",
stacklevel=stacklevel)
kwargs.update(
{
new_name: kwargs[old_name],
@ -115,8 +120,10 @@ def renamed_argument(old_name: str, new_name: str, until_version: str):
@functools.wraps(func)
def wrapped(*args, **kwargs):
if old_name in kwargs:
warn_deprecated(f"In function '{func.__name__}' argument '{old_name}' is renamed to '{new_name}' "
f"and will be removed in aiogram {until_version}", stacklevel=3)
warn_deprecated(f"In function '{func.__name__}' argument '{old_name}' "
f"is renamed to '{new_name}' "
f"and will be removed in aiogram {until_version}",
stacklevel=stacklevel)
kwargs.update(
{
new_name: kwargs[old_name],