dekoratory w standardzie Pythona lib (specjalnie @deprecated)

Muszę oznaczyć procedury jako przestarzałe, ale najwyraźniej nie ma standardowego dekoratora biblioteki, który mógłby zostać wycofany. Znam przepisy na to i moduł ostrzeżeń, ale moje pytanie brzmi: dlaczego nie ma standardowego dekoratora biblioteki dla tego (powszechnego) zadania?

Dodatkowe pytanie: czy w ogóle istnieją standardowe dekoratory w bibliotece standardowej?

Oto fragment, zmodyfikowany na podstawie cytowanych przez Leandro:

import warnings
import functools

def deprecated(func):
    """This is a decorator which can be used to mark functions
    as deprecated. It will result in a warning being emitted
    when the function is used."""
    @functools.wraps(func)
    def new_func(*args, **kwargs):
        warnings.simplefilter('always', DeprecationWarning)  # turn off filter
        warnings.warn("Call to deprecated function {}.".format(func.__name__),
                      category=DeprecationWarning,
                      stacklevel=2)
        warnings.simplefilter('default', DeprecationWarning)  # reset filter
        return func(*args, **kwargs)
    return new_func

# Examples

@deprecated
def some_old_function(x, y):
    return x + y

class SomeClass:
    @deprecated
    def some_old_method(self, x, y):
        return x + y

Ponieważ w niektórych tłumaczach pierwsze ujawnione rozwiązanie (bez obsługi filtra) może skutkować pominięciem ostrzeżenia.

Oto inne rozwiązanie:

Ten dekorator ( w rzeczywistości fabryka dekoratorów ) pozwala podać przyczynę . Bardziej przydatna jest również pomoc programiście w zdiagnozowaniu problemu, podając nazwę pliku źródłowego i numer wiersza .

EDYCJA : Ten kod używa zalecenia Zero: zastępuje warnings.warn_explicitwiersz przez warnings.warn(msg, category=DeprecationWarning, stacklevel=2), co powoduje wyświetlenie witryny wywołania funkcji, a nie witryny definicji funkcji. Ułatwia debugowanie.

EDIT2 : Ta wersja umożliwia programistom określenie opcjonalnego komunikatu „powód”.

import functools
import inspect
import warnings

string_types = (type(b''), type(u''))


def deprecated(reason):
    """
    This is a decorator which can be used to mark functions
    as deprecated. It will result in a warning being emitted
    when the function is used.
    """

    if isinstance(reason, string_types):

        # The @deprecated is used with a 'reason'.
        #
        # .. code-block:: python
        #
        #    @deprecated("please, use another function")
        #    def old_function(x, y):
        #      pass

        def decorator(func1):

            if inspect.isclass(func1):
                fmt1 = "Call to deprecated class {name} ({reason})."
            else:
                fmt1 = "Call to deprecated function {name} ({reason})."

            @functools.wraps(func1)
            def new_func1(*args, **kwargs):
                warnings.simplefilter('always', DeprecationWarning)
                warnings.warn(
                    fmt1.format(name=func1.__name__, reason=reason),
                    category=DeprecationWarning,
                    stacklevel=2
                )
                warnings.simplefilter('default', DeprecationWarning)
                return func1(*args, **kwargs)

            return new_func1

        return decorator

    elif inspect.isclass(reason) or inspect.isfunction(reason):

        # The @deprecated is used without any 'reason'.
        #
        # .. code-block:: python
        #
        #    @deprecated
        #    def old_function(x, y):
        #      pass

        func2 = reason

        if inspect.isclass(func2):
            fmt2 = "Call to deprecated class {name}."
        else:
            fmt2 = "Call to deprecated function {name}."

        @functools.wraps(func2)
        def new_func2(*args, **kwargs):
            warnings.simplefilter('always', DeprecationWarning)
            warnings.warn(
                fmt2.format(name=func2.__name__),
                category=DeprecationWarning,
                stacklevel=2
            )
            warnings.simplefilter('default', DeprecationWarning)
            return func2(*args, **kwargs)

        return new_func2

    else:
        raise TypeError(repr(type(reason)))

Możesz użyć tego dekoratora dla funkcji , metod i klas .

Oto prosty przykład:

@deprecated("use another function")
def some_old_function(x, y):
    return x + y


class SomeClass(object):
    @deprecated("use another method")
    def some_old_method(self, x, y):
        return x + y


@deprecated("use another class")
class SomeOldClass(object):
    pass


some_old_function(5, 3)
SomeClass().some_old_method(8, 9)
SomeOldClass()

Dostaniesz:

deprecated_example.py:59: DeprecationWarning: Call to deprecated function or method some_old_function (use another function).
  some_old_function(5, 3)
deprecated_example.py:60: DeprecationWarning: Call to deprecated function or method some_old_method (use another method).
  SomeClass().some_old_method(8, 9)
deprecated_example.py:61: DeprecationWarning: Call to deprecated class SomeOldClass (use another class).
  SomeOldClass()

EDIT3: ten dekorator jest teraz częścią przestarzałej biblioteki:

• Indeks pakietów Python (PyPi)
• Witryna GitHub
• Przeczytaj The Docs
• Świergot

Nowa stabilna wersja 1.2.10 🎉

Jak zasugerował muon , możesz w tym celu zainstalować deprecationpakiet.

deprecationBiblioteka zapewnia deprecateddekorator i fail_if_not_removeddekorator dla swoich badań.

Instalacja

pip install deprecation

Przykładowe użycie

import deprecation

@deprecation.deprecated(deprecated_in="1.0", removed_in="2.0",
                        current_version=__version__,
                        details="Use the bar function instead")
def foo():
    """Do some stuff"""
    return 1

Zobacz http://deprecation.readthedocs.io/, aby uzyskać pełną dokumentację.

Wydaje mi się, że powodem jest to, że kod Pythona nie może być przetwarzany statycznie (jak to miało miejsce w przypadku kompilatorów C ++), nie można uzyskać ostrzeżenia o używaniu niektórych rzeczy przed ich faktycznym użyciem. Nie sądzę, że dobrym pomysłem jest spamowanie użytkownika twojego skryptu za pomocą kilku wiadomości „Ostrzeżenie: ten programista tego skryptu używa wycofanego interfejsu API”.

Aktualizacja: ale możesz stworzyć dekorator, który przekształci oryginalną funkcję w inną. Nowa funkcja zaznaczy / sprawdzi przełącznik informujący, że ta funkcja została już wywołana i pokaże komunikat tylko po przełączeniu przełącznika w stan włączenia. I / lub przy wyjściu może wypisać listę wszystkich przestarzałych funkcji używanych w programie.

Możesz utworzyć plik utils

import warnings

def deprecated(message):
  def deprecated_decorator(func):
      def deprecated_func(*args, **kwargs):
          warnings.warn("{} is a deprecated function. {}".format(func.__name__, message),
                        category=DeprecationWarning,
                        stacklevel=2)
          warnings.simplefilter('default', DeprecationWarning)
          return func(*args, **kwargs)
      return deprecated_func
  return deprecated_decorator

Następnie zaimportuj dekorator wycofania w następujący sposób:

from .utils import deprecated

@deprecated("Use method yyy instead")
def some_method()"
 pass

AKTUALIZACJA: Myślę, że jest lepiej, gdy pokazujemy DeprecationWarning tylko za pierwszym razem dla każdej linii kodu i kiedy możemy wysłać wiadomość:

import inspect
import traceback
import warnings
import functools

import time


def deprecated(message: str = ''):
    """
    This is a decorator which can be used to mark functions
    as deprecated. It will result in a warning being emitted
    when the function is used first time and filter is set for show DeprecationWarning.
    """
    def decorator_wrapper(func):
        @functools.wraps(func)
        def function_wrapper(*args, **kwargs):
            current_call_source = '|'.join(traceback.format_stack(inspect.currentframe()))
            if current_call_source not in function_wrapper.last_call_source:
                warnings.warn("Function {} is now deprecated! {}".format(func.__name__, message),
                              category=DeprecationWarning, stacklevel=2)
                function_wrapper.last_call_source.add(current_call_source)

            return func(*args, **kwargs)

        function_wrapper.last_call_source = set()

        return function_wrapper
    return decorator_wrapper


@deprecated('You must use my_func2!')
def my_func():
    time.sleep(.1)
    print('aaa')
    time.sleep(.1)


def my_func2():
    print('bbb')


warnings.simplefilter('always', DeprecationWarning)  # turn off filter
print('before cycle')
for i in range(5):
    my_func()
print('after cycle')
my_func()
my_func()
my_func()

Wynik:

before cycle
C:/Users/adr-0/OneDrive/Projects/Python/test/unit1.py:45: DeprecationWarning: Function my_func is now deprecated! You must use my_func2!
aaa
aaa
aaa
aaa
aaa
after cycle
C:/Users/adr-0/OneDrive/Projects/Python/test/unit1.py:47: DeprecationWarning: Function my_func is now deprecated! You must use my_func2!
aaa
C:/Users/adr-0/OneDrive/Projects/Python/test/unit1.py:48: DeprecationWarning: Function my_func is now deprecated! You must use my_func2!
aaa
C:/Users/adr-0/OneDrive/Projects/Python/test/unit1.py:49: DeprecationWarning: Function my_func is now deprecated! You must use my_func2!
aaa

Process finished with exit code 0

Możemy po prostu kliknąć ścieżkę ostrzegawczą i przejść do linii w PyCharm.

Rozszerzając tę odpowiedź Stevena Vascellaro :

Jeśli używasz Anacondy, najpierw zainstaluj deprecationpakiet:

conda install -c conda-forge deprecation 

Następnie wklej poniższy fragment na górze pliku

import deprecation

@deprecation.deprecated(deprecated_in="1.0", removed_in="2.0",
                    current_version=__version__,
                    details="Use the bar function instead")
def foo():
    """Do some stuff"""
    return 1

Zobacz http://deprecation.readthedocs.io/, aby uzyskać pełną dokumentację.