7abbf7a443
This is not perfect as mypy at least doesn't consider e.g. subclasses of the property decorator class to behave the same way, but it's as good as we can get without introducing a mypy plugin. Signed-off-by: Stephen Finucane <stephenfin@redhat.com> Change-Id: Ia0c4110218ce8a48c3ec5e720f07e45fc2b831bf
67 lines
2.0 KiB
Python
67 lines
2.0 KiB
Python
# Copyright (C) 2015 Yahoo! Inc. All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
from __future__ import annotations
|
|
|
|
from collections.abc import Callable
|
|
from typing import Any
|
|
|
|
import wrapt
|
|
|
|
from debtcollector import _utils
|
|
|
|
_KWARG_RENAMED_POSTFIX_TPL = ", please use the '%s' argument instead"
|
|
_KWARG_RENAMED_PREFIX_TPL = "Using the '%s' argument is deprecated"
|
|
|
|
|
|
# TODO(stephenfin): Figure out typing for return values
|
|
def renamed_kwarg(
|
|
old_name: str,
|
|
new_name: str,
|
|
message: str | None = None,
|
|
version: str | None = None,
|
|
removal_version: str | None = None,
|
|
stacklevel: int = 3,
|
|
category: type[Warning] | None = None,
|
|
replace: bool = False,
|
|
) -> Any:
|
|
"""Decorates a kwarg accepting function to deprecate a renamed kwarg."""
|
|
|
|
prefix = _KWARG_RENAMED_PREFIX_TPL % old_name
|
|
postfix = _KWARG_RENAMED_POSTFIX_TPL % new_name
|
|
out_message = _utils.generate_message(
|
|
prefix,
|
|
postfix=postfix,
|
|
message=message,
|
|
version=version,
|
|
removal_version=removal_version,
|
|
)
|
|
|
|
@wrapt.decorator
|
|
def decorator(
|
|
wrapped: Callable[..., Any],
|
|
instance: Any,
|
|
args: tuple[Any, ...],
|
|
kwargs: dict[str, Any],
|
|
) -> Any:
|
|
if old_name in kwargs:
|
|
_utils.deprecation(
|
|
out_message, stacklevel=stacklevel, category=category
|
|
)
|
|
if replace:
|
|
kwargs.setdefault(new_name, kwargs.pop(old_name))
|
|
return wrapped(*args, **kwargs)
|
|
|
|
return decorator
|