deprecated_attribute¶

astropy.utils.decorators.deprecated_attribute(name, since, message=None, alternative=None, pending=False, warning_type=<class 'astropy.utils.exceptions.AstropyDeprecationWarning'>)[ソース]¶

公共属性を破棄されたと表記するために用いられる.これは、所与の属性名にアクセスする際に警告を発する属性を作成する。警告(すなわち内部コード)を防ぐためには，属性の専用名を用いて，下線を付加する方法である(すなわち. self._name ）。

パラメータ

name応力.応力: 使用する属性の名前は推奨されない.
since応力.応力: このAPIが使用されていないバージョン。これは必要です。
message文字列、オプション: デフォルトの廃棄メッセージをカバーする。書式説明子 name 属性の名前に用いることができ、 alternative 廃棄関数の代替名を挿入するために、廃棄メッセージで使用されてもよい。
alternative文字列、オプション: ユーザは、古い属性の予備属性を代替するために使用することができる。この代替オプションが提供された場合、破棄警告は、このオプションをユーザに通知する。
pendingブル値、オプション: Trueであれば，AstropyPendingDeproationWarningではなくAstropyPendingDeproationWarningを使用する. warning_type それがそうです。
warning_type警告: 警告を発します。デフォルト値は AstropyDeprecationWarning それがそうです。

実例.

class MyClass:
    # Mark the old_name as deprecated
    old_name = misc.deprecated_attribute('old_name', '0.1')

    def method(self):
        self._old_name = 42

ナビゲーション

deprecated_attribute¶