了解`np.ndarray`子类中的默认值

时间:2018-12-20 19:37:30

标签: python numpy subclass

我正在研究numpy documentation on subclassing ndarray,但是在设置默认值方面,我观察到的结果与所描述的略有不同。该文档似乎说应该使用一个位置来设置额外属性的默认值,但我发现有必要在两个位置保持正确的默认值。

考虑文档中描述的realistic example,此处转载(为简洁起见,注释已重新格式化):

import numpy as np

class RealisticInfoArray(np.ndarray):

    def __new__(cls, input_array, info=None):
        obj = np.asarray(input_array).view(cls)
        obj.info = info
        return obj

    def __array_finalize__(self, obj):
        # Note that it is here, rather than in the __new__ method,
        # that we set the default value for 'info', because this
        # method sees all creation of default objects - with the
        # InfoArray.__new__ constructor, but also with
        # arr.view(InfoArray).
        if obj is None: return
        self.info = getattr(obj, 'info', None)

描述默认值的生效位置的评论使我感到困惑。我替换了默认值以查看发生了什么,例如:info='michelangelo'中的__new__getattr(obj, 'info', 'donatello')中的__array_finalize__。我发现后者仅使用view创建方法设置,而前者用于显式构造函数调用和从模板创建:

>>> a = RealisticInfoArray(np.arange(10)); print(a.info)
michelangelo
>>> b = np.arange(10).view(RealisticInfoArray); print(b.info)
donatello
>>> c = a[1:]; print(c.info)
michelangelo

在这种情况下,根据我对文档的了解,看来a的默认设置为“错误”。据我所知,a.info__array_finalize__中已正确设置,但随后被__new__中的默认值覆盖。

首先,我是否犯了一个错误?如果不是,是否需要在两个地方都保持预期的默认设置,或者是否有办法将其减少到一个? (我在下面的回答中对此进行了尝试,感谢您提供任何反馈意见。)

1 个答案:

答案 0 :(得分:0)

我目前的解决方法(不维护两个默认值)是提供一个DEFAULT_INFO__new__都可以访问的类属性__array_finalize__

import numpy as np

class RealisticInfoArray(np.ndarray):

    DEFAULT_INFO = 'michelangelo'

    def __new__(cls, input_array, info=None):
        obj = np.asarray(input_array).view(cls)
        if info is None:
            info = obj.DEFAULT_INFO
        obj.info = info
        return obj

    def __array_finalize__(self, obj):
        if obj is None: return
        self.info = getattr(obj, 'info', self.DEFAULT_INFO)

可正确产生:

>>> a = RealisticInfoArray(np.arange(10)); print(a.info)
michelangelo
>>> b = np.arange(10).view(RealisticInfoArray); print(b.info)
michelangelo
>>> c = a[1:]; print(c.info)
michelangelo

这还具有一个额外的好处,即该类的用户可以修改默认值(例如RealisticInfoArray.DEFAULT_INFO = 'leonardo'),并使用自己认为合适的默认值。但是,我尚未测试此解决方案的意外副作用。