如何创建类属性？

Question

在 python 中，我可以使用 @classmethod 装饰器向类添加方法。是否有类似的装饰器可以向类添加属性？我可以更好地展示我在说什么。

class Example(object):
   the_I = 10
   def __init__( self ):
      self.an_i = 20

   @property
   def i( self ):
      return self.an_i

   def inc_i( self ):
      self.an_i += 1

   # is this even possible?
   @classproperty
   def I( cls ):
      return cls.the_I

   @classmethod
   def inc_I( cls ):
      cls.the_I += 1

e = Example()
assert e.i == 20
e.inc_i()
assert e.i == 21

assert Example.I == 10
Example.inc_I()
assert Example.I == 11

我上面使用的语法是否可行，或者是否需要更多内容？

我想要类属性的原因是这样我可以延迟加载类属性，这似乎很合理。

Answer 1

我将这样做：

class ClassPropertyDescriptor(object):

    def __init__(self, fget, fset=None):
        self.fget = fget
        self.fset = fset

    def __get__(self, obj, klass=None):
        if klass is None:
            klass = type(obj)
        return self.fget.__get__(obj, klass)()

    def __set__(self, obj, value):
        if not self.fset:
            raise AttributeError("can't set attribute")
        type_ = type(obj)
        return self.fset.__get__(obj, type_)(value)

    def setter(self, func):
        if not isinstance(func, (classmethod, staticmethod)):
            func = classmethod(func)
        self.fset = func
        return self

def classproperty(func):
    if not isinstance(func, (classmethod, staticmethod)):
        func = classmethod(func)

    return ClassPropertyDescriptor(func)


class Bar(object):

    _bar = 1

    @classproperty
    def bar(cls):
        return cls._bar

    @bar.setter
    def bar(cls, value):
        cls._bar = value


# test instance instantiation
foo = Bar()
assert foo.bar == 1

baz = Bar()
assert baz.bar == 1

# test static variable
baz.bar = 5
assert foo.bar == 5

# test setting variable on the class
Bar.bar = 50
assert baz.bar == 50
assert foo.bar == 50

当我们调用 Bar.bar 时，setter 不起作用，因为我们正在调用
TypeOfBar.bar.__set__，它不是 Bar.bar.__set__。

添加元类定义可以解决这个问题：

class ClassPropertyMetaClass(type):
    def __setattr__(self, key, value):
        if key in self.__dict__:
            obj = self.__dict__.get(key)
        if obj and type(obj) is ClassPropertyDescriptor:
            return obj.__set__(self, value)

        return super(ClassPropertyMetaClass, self).__setattr__(key, value)

# and update class define:
#     class Bar(object):
#        __metaclass__ = ClassPropertyMetaClass
#        _bar = 1

# and update ClassPropertyDescriptor.__set__
#    def __set__(self, obj, value):
#       if not self.fset:
#           raise AttributeError("can't set attribute")
#       if inspect.isclass(obj):
#           type_ = obj
#           obj = None
#       else:
#           type_ = type(obj)
#       return self.fset.__get__(obj, type_)(value)

现在一切都会好起来的。

Answer 2

如果您按如下方式定义classproperty，那么您的示例将完全按照您的要求工作。

class classproperty(object):
    def __init__(self, f):
        self.f = f
    def __get__(self, obj, owner):
        return self.f(owner)

需要注意的是，您不能将其用于可写属性。 eI = 20 将引发 AttributeError，而 Example.I = 20 将覆盖属性对象本身。

Answer 3

[基于python 3.4编写的答案；元类语法与 2 不同，但我认为该技术仍然有效]

您可以使用元类来完成此操作......大多数情况下。 Dappawit 几乎可以工作，但我认为它有一个缺陷：

class MetaFoo(type):
    @property
    def thingy(cls):
        return cls._thingy

class Foo(object, metaclass=MetaFoo):
    _thingy = 23

这会为你提供 Foo 上的类属性，但有一个问题......

print("Foo.thingy is {}".format(Foo.thingy))
# Foo.thingy is 23
# Yay, the classmethod-property is working as intended!
foo = Foo()
if hasattr(foo, "thingy"):
    print("Foo().thingy is {}".format(foo.thingy))
else:
    print("Foo instance has no attribute 'thingy'")
# Foo instance has no attribute 'thingy'
# Wha....?

这里到底发生了什么？为什么我无法从实例访问类属性？

在找到我认为的答案之前，我为此苦苦思索了很长一段时间。 Python @properties 是描述符的子集，并且来自描述符文档（强调矿）：

属性访问的默认行为是获取、设置或删除
来自对象字典的属性。例如，ax 有一个查找链
从 a.__dict__['x'] 开始，然后 type(a).__dict__['x']，然后继续
通过type(a)的基类排除元类。

因此，方法解析顺序不包括我们的类属性（或元类中定义的任何其他内容）。 可以创建一个行为不同的内置属性装饰器的子类，但是（需要引用）我在谷歌上得到的印象是开发人员有一个很好的理由（我不明白）这样做。

这并不意味着我们运气不佳；我们可以很好地访问类本身的属性...并且我们可以从实例中的 type(self) 获取类，我们可以使用它来创建 @property 调度程序：

class Foo(object, metaclass=MetaFoo):
    _thingy = 23

    @property
    def thingy(self):
        return type(self).thingy

现在 Foo().thingy 按类和实例的预期工作！如果派生类替换其底层 _thingy （这是最初让我进行此搜索的用例），它也将继续做正确的事情。

这对我来说并不是 100% 满意——必须在元类和对象类中进行设置，感觉违反了 DRY 原则。但后者只是一个单线调度程序；我基本上对它的存在感到满意，如果你真的想要的话，你可以将它压缩为 lambda 或其他东西。

Answer 4

如果您使用 Django，它有一个内置的 @classproperty 装饰器。

from django.utils.decorators import classproperty

对于 Django 4，请使用：

from django.utils.functional import classproperty

Answer 5

我认为您可以使用元类来做到这一点。因为元类可以像类的类一样（如果这有意义的话）。我知道您可以为元类分配一个 __call__() 方法来覆盖调用类 MyClass()。我想知道在元类上使用 property 装饰器的操作是否类似。

哇，它有效了：

class MetaClass(type):    
    def getfoo(self):
        return self._foo
    foo = property(getfoo)
    
    @property
    def bar(self):
        return self._bar
    
class MyClass(object):
    __metaclass__ = MetaClass
    _foo = 'abc'
    _bar = 'def'
    
print MyClass.foo
print MyClass.bar

注意：这是 Python 2.7 中的。 Python 3+ 使用不同的技术来声明元类。使用：class MyClass(metaclass=MetaClass):，去掉__metaclass__，其余相同。

Answer 6

据我所知，如果不创建新的元类，就无法为类属性编写 setter。

我发现以下方法有效。使用您想要的所有类属性和设置器定义一个元类。 IE，我想要一个带有 title 属性和 setter 的类。这是我写的：

class TitleMeta(type):
    @property
    def title(self):
        return getattr(self, '_title', 'Default Title')

    @title.setter
    def title(self, title):
        self._title = title
        # Do whatever else you want when the title is set...

现在像平常一样创建您想要的实际类，除了让它使用您上面创建的元类。

# Python 2 style:
class ClassWithTitle(object):
    __metaclass__ = TitleMeta
    # The rest of your class definition...

# Python 3 style:
class ClassWithTitle(object, metaclass = TitleMeta):
    # Your class definition...

如果我们只在单个类上使用它，像上面那样定义这个元类有点奇怪。在这种情况下，如果您使用 Python 2 样式，您实际上可以在类主体内定义元类。这样它就不会在模块范围中定义。

Answer 7

def _create_type(meta, name, attrs):
    type_name = f'{name}Type'
    type_attrs = {}
    for k, v in attrs.items():
        if type(v) is _ClassPropertyDescriptor:
            type_attrs[k] = v
    return type(type_name, (meta,), type_attrs)


class ClassPropertyType(type):
    def __new__(meta, name, bases, attrs):
        Type = _create_type(meta, name, attrs)
        cls = super().__new__(meta, name, bases, attrs)
        cls.__class__ = Type
        return cls


class _ClassPropertyDescriptor(object):
    def __init__(self, fget, fset=None):
        self.fget = fget
        self.fset = fset

    def __get__(self, obj, owner):
        if self in obj.__dict__.values():
            return self.fget(obj)
        return self.fget(owner)

    def __set__(self, obj, value):
        if not self.fset:
            raise AttributeError("can't set attribute")
        return self.fset(obj, value)

    def setter(self, func):
        self.fset = func
        return self


def classproperty(func):
    return _ClassPropertyDescriptor(func)



class Bar(metaclass=ClassPropertyType):
    __bar = 1

    @classproperty
    def bar(cls):
        return cls.__bar

    @bar.setter
    def bar(cls, value):
        cls.__bar = value

bar = Bar()
assert Bar.bar==1
Bar.bar=2
assert bar.bar==2
nbar = Bar()
assert nbar.bar==2

Answer 8

我碰巧想出了一个与@Andrew非常相似的解决方案，只有 DRY

class MetaFoo(type):

    def __new__(mc1, name, bases, nmspc):
        nmspc.update({'thingy': MetaFoo.thingy})
        return super(MetaFoo, mc1).__new__(mc1, name, bases, nmspc)

    @property
    def thingy(cls):
        if not inspect.isclass(cls):
            cls = type(cls)
        return cls._thingy

    @thingy.setter
    def thingy(cls, value):
        if not inspect.isclass(cls):
            cls = type(cls)
        cls._thingy = value

class Foo(metaclass=MetaFoo):
    _thingy = 23

class Bar(Foo)
    _thingy = 12

这具有最好的答案：

“元属性”被添加到类中，因此它仍然是实例的属性

1. 不需要在任何类中重新定义 thingy
2. 该属性对于实例和类都充当“类属性”
3. 您可以灵活地自定义 _thingy 的继承方式

在我的例子中，我实际上将 _thingy 自定义为不同的对于每个孩子，无需在每个类中定义它（并且没有默认值）：

   def __new__(mc1, name, bases, nmspc):
       nmspc.update({'thingy': MetaFoo.services, '_thingy': None})
       return super(MetaFoo, mc1).__new__(mc1, name, bases, nmspc)

Answer 9

如果您只需要延迟加载，那么您可以只使用类初始化方法。

EXAMPLE_SET = False
class Example(object):
   @classmethod 
   def initclass(cls):
       global EXAMPLE_SET 
       if EXAMPLE_SET: return
       cls.the_I = 'ok'
       EXAMPLE_SET = True

   def __init__( self ):
      Example.initclass()
      self.an_i = 20

try:
    print Example.the_I
except AttributeError:
    print 'ok class not "loaded"'
foo = Example()
print foo.the_I
print Example.the_I

但元类方法看起来更干净，并且行为更可预测。

也许您正在寻找的是 Singleton 设计模式。有一个很好的SO QA在 Python 中实现共享状态。