Мне недавно задали тот же вопрос, и я получил несколько ответов. Я надеюсь, что все в порядке, чтобы возобновить эту тему, так как я хотел бы остановиться на нескольких из упомянутых вариантов использования и добавить несколько новых.
Большинство метаклассов, которые я видел, делают одну из двух вещей:
Регистрация (добавление класса в структуру данных):
models = {}
class ModelMetaclass(type):
def __new__(meta, name, bases, attrs):
models[name] = cls = type.__new__(meta, name, bases, attrs)
return cls
class Model(object):
__metaclass__ = ModelMetaclass
Всякий раз, когда вы подкласс Model
, ваш класс регистрируется в словаре models
:
>>> class A(Model):
... pass
...
>>> class B(A):
... pass
...
>>> models
{'A': <__main__.A class at 0x...>,
'B': <__main__.B class at 0x...>}
Это также можно сделать с помощью декораторов классов:
models = {}
def model(cls):
models[cls.__name__] = cls
return cls
@model
class A(object):
pass
Или с явной функцией регистрации:
models = {}
def register_model(cls):
models[cls.__name__] = cls
class A(object):
pass
register_model(A)
На самом деле, это почти то же самое: вы упоминаете декораторы классов неблагоприятно, но на самом деле это не более чем синтаксический сахар для вызова функции в классе, поэтому в этом нет ничего волшебного.
В любом случае, преимущество метаклассов в этом случае заключается в наследовании, поскольку они работают для любых подклассов, тогда как другие решения работают только для подклассов, явно оформленных или зарегистрированных.
>>> class B(A):
... pass
...
>>> models
{'A': <__main__.A class at 0x...> # No B :(
Рефакторинг (изменение атрибутов класса или добавление новых):
class ModelMetaclass(type):
def __new__(meta, name, bases, attrs):
fields = {}
for key, value in attrs.items():
if isinstance(value, Field):
value.name = '%s.%s' % (name, key)
fields[key] = value
for base in bases:
if hasattr(base, '_fields'):
fields.update(base._fields)
attrs['_fields'] = fields
return type.__new__(meta, name, bases, attrs)
class Model(object):
__metaclass__ = ModelMetaclass
Всякий раз, когда вы создаете подкласс Model
и определяете некоторые атрибуты Field
, они вводятся со своими именами (например, для более информативных сообщений об ошибках) и группируются в словарь _fields
(для простой итерации, без необходимости просматривать все атрибуты класса и все атрибуты его базовых классов каждый раз):
>>> class A(Model):
... foo = Integer()
...
>>> class B(A):
... bar = String()
...
>>> B._fields
{'foo': Integer('A.foo'), 'bar': String('B.bar')}
Опять же, это можно сделать (без наследования) с помощью декоратора классов:
def model(cls):
fields = {}
for key, value in vars(cls).items():
if isinstance(value, Field):
value.name = '%s.%s' % (cls.__name__, key)
fields[key] = value
for base in cls.__bases__:
if hasattr(base, '_fields'):
fields.update(base._fields)
cls._fields = fields
return cls
@model
class A(object):
foo = Integer()
class B(A):
bar = String()
# B.bar has no name :(
# B._fields is {'foo': Integer('A.foo')} :(
Или явно:
class A(object):
foo = Integer('A.foo')
_fields = {'foo': foo} # Don't forget all the base classes' fields, too!
Хотя, вопреки вашей пропаганде удобочитаемого и поддерживаемого неметапрограммирования, это гораздо более громоздко, избыточно и подвержено ошибкам:
class B(A):
bar = String()
# vs.
class B(A):
bar = String('bar')
_fields = {'B.bar': bar, 'A.foo': A.foo}
Рассмотрев наиболее распространенные и конкретные случаи использования, единственные случаи, когда вам абсолютно НЕОБХОДИМО использовать метаклассы, это когда вы хотите изменить имя класса или список базовых классов, поскольку после определения эти параметры запекаются в классе, и никакой декоратор или функция не могут их испечь.
class Metaclass(type):
def __new__(meta, name, bases, attrs):
return type.__new__(meta, 'foo', (int,), attrs)
class Baseclass(object):
__metaclass__ = Metaclass
class A(Baseclass):
pass
class B(A):
pass
print A.__name__ # foo
print B.__name__ # foo
print issubclass(B, A) # False
print issubclass(B, int) # True
Это может быть полезно в средах для выдачи предупреждений всякий раз, когда определены классы с похожими именами или неполными деревьями наследования, но я не могу придумать причину, кроме троллинга, для фактического изменения этих значений. Может быть, Дэвид Бизли может.
В любом случае, в Python 3 метаклассы также имеют метод __prepare__
, который позволяет вам преобразовывать тело класса в отображение, отличное от dict
, поддерживая, таким образом, упорядоченные атрибуты, перегруженные атрибуты и другие забавные интересные вещи:
import collections
class Metaclass(type):
@classmethod
def __prepare__(meta, name, bases, **kwds):
return collections.OrderedDict()
def __new__(meta, name, bases, attrs, **kwds):
print(list(attrs))
# Do more stuff...
class A(metaclass=Metaclass):
x = 1
y = 2
# prints ['x', 'y'] rather than ['y', 'x']
1058 *
class ListDict(dict):
def __setitem__(self, key, value):
self.setdefault(key, []).append(value)
class Metaclass(type):
@classmethod
def __prepare__(meta, name, bases, **kwds):
return ListDict()
def __new__(meta, name, bases, attrs, **kwds):
print(attrs['foo'])
# Do more stuff...
class A(metaclass=Metaclass):
def foo(self):
pass
def foo(self, x):
pass
# prints [<function foo at 0x...>, <function foo at 0x...>] rather than <function foo at 0x...>
Можно утверждать, что упорядоченные атрибуты могут быть достигнуты с помощью счетчиков создания, а перегрузка может быть смоделирована с аргументами по умолчанию:
import itertools
class Attribute(object):
_counter = itertools.count()
def __init__(self):
self._count = Attribute._counter.next()
class A(object):
x = Attribute()
y = Attribute()
A._order = sorted([(k, v) for k, v in vars(A).items() if isinstance(v, Attribute)],
key = lambda (k, v): v._count)
1064 *
class A(object):
def _foo0(self):
pass
def _foo1(self, x):
pass
def foo(self, x=None):
if x is None:
return self._foo0()
else:
return self._foo1(x)
Помимо того, что он намного более уродлив, он также менее гибок: что, если вам нужны упорядоченные литеральные атрибуты, такие как целые числа и строки? Что если None
является допустимым значением для x
?
Вот креативный способ решить первую проблему:
import sys
class Builder(object):
def __call__(self, cls):
cls._order = self.frame.f_code.co_names
return cls
def ordered():
builder = Builder()
def trace(frame, event, arg):
builder.frame = frame
sys.settrace(None)
sys.settrace(trace)
return builder
@ordered()
class A(object):
x = 1
y = 'foo'
print A._order # ['x', 'y']
А вот творческий способ решить второй:
_undefined = object()
class A(object):
def _foo0(self):
pass
def _foo1(self, x):
pass
def foo(self, x=_undefined):
if x is _undefined:
return self._foo0()
else:
return self._foo1(x)
Но это намного, намного вуду, чем простой метакласс (особенно первый, который действительно тает ваш мозг). Я хочу сказать, что метаклассы выглядят как незнакомые и не интуитивно понятные, но вы также можете рассматривать их как следующий шаг эволюции в языках программирования: вам просто нужно изменить свое мышление. В конце концов, вы, вероятно, могли бы делать все в C, включая определение структуры с помощью указателей на функции и передачу ее в качестве первого аргумента ее функциям. Человек, впервые увидевший C ++, может сказать: «Что это за магия? Почему компилятор неявно передает this
в методы, а не в обычные и статические функции? Лучше быть явным и подробным о своих аргументах». Но тогда объектно-ориентированное программирование становится гораздо более мощным, когда вы его получаете; и это тоже квази-аспектно-ориентированное программирование, я полагаю. И когда вы понимаете метаклассы, они на самом деле очень просты, так почему бы не использовать их, когда это удобно?
И, наконец, метаклассы радуются, и программирование должно быть веселым. Использование стандартных программных конструкций и шаблонов проектирования все время скучно и скучно и мешает вашему воображению. Живи немного! Вот метаметакласс, только для вас.
class MetaMetaclass(type):
def __new__(meta, name, bases, attrs):
def __new__(meta, name, bases, attrs):
cls = type.__new__(meta, name, bases, attrs)
cls._label = 'Made in %s' % meta.__name__
return cls
attrs['__new__'] = __new__
return type.__new__(meta, name, bases, attrs)
class China(type):
__metaclass__ = MetaMetaclass
class Taiwan(type):
__metaclass__ = MetaMetaclass
class A(object):
__metaclass__ = China
class B(object):
__metaclass__ = Taiwan
print A._label # Made in China
print B._label # Made in Taiwan