available_if#

sklearn.utils.metaestimators.available_if(check)#

一个只有在检查返回真值时才可用的属性。

Parameters:
checkcallable

当传递带有装饰方法的对象时,如果属性可用,则应返回真值,如果不可用,则返回False或引发AttributeError。

Returns:
callable

如果 check 返回真值,则使装饰方法可用,否则装饰方法不可用。

Examples

>>> from sklearn.utils.metaestimators import available_if
>>> class HelloIfEven:
...    def __init__(self, x):
...        self.x = x
...
...    def _x_is_even(self):
...        return self.x % 2 == 0
...
...    @available_if(_x_is_even)
...    def say_hello(self):
...        print("Hello")
...
>>> obj = HelloIfEven(1)
>>> hasattr(obj, "say_hello")
False
>>> obj.x = 2
>>> hasattr(obj, "say_hello")
True
>>> obj.say_hello()
Hello