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
74 lines
2.3 KiB
Python
74 lines
2.3 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 inspect import signature
|
|
from typing import Any
|
|
|
|
import wrapt
|
|
|
|
from debtcollector import _utils
|
|
|
|
_KWARG_UPDATED_POSTFIX_TPL = (
|
|
', please update the code to explicitly set %s as the value'
|
|
)
|
|
_KWARG_UPDATED_PREFIX_TPL = (
|
|
'The %s argument is changing its default value to %s'
|
|
)
|
|
|
|
|
|
# TODO(stephenfin): Figure out typing for return values
|
|
def updated_kwarg_default_value(
|
|
name: str,
|
|
old_value: str,
|
|
new_value: str,
|
|
message: str | None = None,
|
|
version: str | None = None,
|
|
stacklevel: int = 3,
|
|
category: type[Warning] = FutureWarning,
|
|
) -> Any:
|
|
"""Decorates a kwarg accepting function to change the default value"""
|
|
|
|
prefix = _KWARG_UPDATED_PREFIX_TPL % (name, new_value)
|
|
postfix = _KWARG_UPDATED_POSTFIX_TPL % old_value
|
|
out_message = _utils.generate_message(
|
|
prefix, postfix=postfix, message=message, version=version
|
|
)
|
|
|
|
def decorator(f: Callable[..., Any]) -> Callable[..., Any]:
|
|
sig = signature(f)
|
|
varnames = list(sig.parameters.keys())
|
|
|
|
@wrapt.decorator
|
|
def wrapper(
|
|
wrapped: Callable[..., Any],
|
|
instance: Any,
|
|
args: tuple[Any, ...],
|
|
kwargs: dict[str, Any],
|
|
) -> Any:
|
|
explicit_params = set(varnames[: len(args)] + list(kwargs.keys()))
|
|
allparams = set(varnames)
|
|
default_params = set(allparams - explicit_params)
|
|
if name in default_params:
|
|
_utils.deprecation(
|
|
out_message, stacklevel=stacklevel, category=category
|
|
)
|
|
return wrapped(*args, **kwargs)
|
|
|
|
return wrapper(f)
|
|
|
|
return decorator
|