88


16

Python標準ライブラリのデコレータ(@deprecated特に)

ルーチンを廃止予定としてマークする必要がありますが、廃止予定の標準ライブラリデコレータはありません。 私はそれのレシピと警告モジュールを知っていますが、私の質問は次のとおりです。

追加の質問:標準ライブラリには標準のデコレータがありますか?

7 Answer


44


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

インタープリターによっては、最初に公開されたソリューション(フィルター処理なし)で警告が抑制される場合があるためです。


26


これは別の解決策です:

このデコレーター(実際にはhttps://stackoverflow.com/questions/739654[decorator factory])を使用すると、*理由*メッセージを提供できます。 また、開発者がソース*ファイル名*と*行番号*を指定して問題を診断するのを支援することもより便利です。

編集:このコードはゼロの推奨事項を使用します:これは、 warnings.warn_explicit`行を warnings.warn(msg、category = DeprecationWarning、stacklevel = 2) `に置き換えます。これは、関数定義サイトではなく関数呼び出しサイトを出力します。 デバッグが簡単になります。

  • EDIT2 *:このバージョンでは、開発者がオプションの「理由」メッセージを指定できます。

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)))

このデコレータは、関数メソッド、*クラス*に使用できます。

これは簡単な例です:

@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()

あなたが得るでしょう:

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()

新しい安定版リリースv1.2.4


6


理由は、Pythonコードを静的に処理できないため(C ++コンパイラで行われているように)、実際に使用する前に何かを使用することについて警告を受け取ることができないためだと思います。 スクリプトのユーザーに「警告:このスクリプトのこの開発者は非推奨のAPIを使用しています」というメッセージを大量に送信することはお勧めできません。

*更新:*ただし、元の関数を別の関数に変換するデコレータを作成できます。 新しい関数は、この関数が既に呼び出されたことを示すスイッチをマーク/チェックし、スイッチをオン状態にしたときにのみメッセージを表示します。 および/または終了時に、プログラムで使用されているすべての非推奨関数のリストを出力します。


6


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

次に、非推奨のデコレータを次のようにインポートします。

from .utils import deprecated

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


4


muonが提案したとおり、https://pypi.org/project/deprecation/#description [このための deprecation]パッケージ。

_ deprecation`ライブラリは、テストのために deprecated`デコレータと `fail_if_not_removed`デコレータを提供します。 _

インストール

pip install deprecation

使用例

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

完全なドキュメントについては、http://deprecation.readthedocs.io/を参照してください。


1


更新:*各コード行*に対してDeprecationWarningを初めて表示したとき、およびメッセージを送信できるときは、より良いと思います:

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()

結果:

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

警告パスをクリックして、PyCharmの行に移動するだけです。


0


Anacondaを使用する場合、最初に `deprecation`パッケージをインストールしてください:

conda install -c conda-forge deprecation

次に、ファイルの先頭に次を貼り付けます

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

完全なドキュメントについては、http://deprecation.readthedocs.io/を参照してください。