Domanda Cosa sono le metaclassi in Python?


Cosa sono le metaclassi e per cosa le usiamo?


4571
2017-09-19 06:10


origine


risposte:


Una metaclasse è la classe di una classe. Come una classe definisce come si comporta un'istanza della classe, una metaclasse definisce come si comporta una classe. Una classe è un'istanza di un metaclasse.

metaclass diagram

Mentre in Python puoi usare arbitrati callables per metaclassi (come Ierub  mostra), l'approccio più utile è in realtà per renderlo una vera e propria classe. type è il solito metaclasse in Python. Nel caso ti stia chiedendo, sì, type è di per sé una classe, ed è un suo tipo. Non sarai in grado di ricreare qualcosa del genere type puramente in Python, ma Python imbroglia un po '. Per creare il tuo metaclasse in Python vuoi davvero creare una sottoclasse type.

Un metaclasse è più comunemente usato come una fabbrica di classi. Come si crea un'istanza della classe chiamando la classe, Python crea una nuova classe (quando esegue l'istruzione 'classe') chiamando il metaclasse. Combinato con il normale __init__ e __new__ i metodi, le metaclassi ti permettono quindi di fare 'cose extra' quando crei una classe, come registrare la nuova classe con qualche registro, o addirittura sostituire la classe con qualcos'altro.

Quando il class istruzione è eseguita, Python prima esegue il corpo del class dichiarazione come un normale blocco di codice. Lo spazio dei nomi risultante (un dict) contiene gli attributi della futura classe. La metaclasse viene determinata osservando i baseclass della classe-to-be (i metaclassi sono ereditati), al __metaclass__ attributo della classe in attesa (se presente) o il __metaclass__ variabile globale. Il metaclasse viene quindi chiamato con il nome, le basi e gli attributi della classe per istanziarlo.

Tuttavia, le metaclassi effettivamente definiscono il genere  di una classe, non solo una fabbrica per questo, quindi puoi fare molto di più con loro. Ad esempio, puoi definire i metodi normali sul metaclass. Questi metodi metaclass sono come i metodi di classe, in quanto possono essere chiamati sulla classe senza un'istanza, ma non sono come i metodi di classe in quanto non possono essere chiamati su un'istanza della classe. type.__subclasses__() è un esempio di un metodo su type metaclasse. Puoi anche definire i normali metodi "magici", come __add__, __iter__ e __getattr__, per implementare o modificare il comportamento della classe.

Ecco un esempio aggregato di bit e pezzi:

def make_hook(f):
    """Decorator to turn 'foo' method into '__foo__'"""
    f.is_hook = 1
    return f

class MyType(type):
    def __new__(mcls, name, bases, attrs):

        if name.startswith('None'):
            return None

        # Go over attributes and see if they should be renamed.
        newattrs = {}
        for attrname, attrvalue in attrs.iteritems():
            if getattr(attrvalue, 'is_hook', 0):
                newattrs['__%s__' % attrname] = attrvalue
            else:
                newattrs[attrname] = attrvalue

        return super(MyType, mcls).__new__(mcls, name, bases, newattrs)

    def __init__(self, name, bases, attrs):
        super(MyType, self).__init__(name, bases, attrs)

        # classregistry.register(self, self.interfaces)
        print "Would register class %s now." % self

    def __add__(self, other):
        class AutoClass(self, other):
            pass
        return AutoClass
        # Alternatively, to autogenerate the classname as well as the class:
        # return type(self.__name__ + other.__name__, (self, other), {})

    def unregister(self):
        # classregistry.unregister(self)
        print "Would unregister class %s now." % self

class MyObject:
    __metaclass__ = MyType


class NoneSample(MyObject):
    pass

# Will print "NoneType None"
print type(NoneSample), repr(NoneSample)

class Example(MyObject):
    def __init__(self, value):
        self.value = value
    @make_hook
    def add(self, other):
        return self.__class__(self.value + other.value)

# Will unregister the class
Example.unregister()

inst = Example(10)
# Will fail with an AttributeError
#inst.unregister()

print inst + inst
class Sibling(MyObject):
    pass

ExampleSibling = Example + Sibling
# ExampleSibling is now a subclass of both Example and Sibling (with no
# content of its own) although it will believe it's called 'AutoClass'
print ExampleSibling
print ExampleSibling.__mro__

2078
2017-09-19 07:01



Classi come oggetti

Prima di capire le metaclassi, è necessario padroneggiare le classi in Python. E Python ha un'idea molto particolare di quali sono le classi, prese in prestito dal linguaggio Smalltalk.

Nella maggior parte delle lingue, le classi sono solo parti di codice che descrivono come produrre un oggetto. Questo è abbastanza vero anche in Python:

>>> class ObjectCreator(object):
...       pass
...

>>> my_object = ObjectCreator()
>>> print(my_object)
<__main__.ObjectCreator object at 0x8974f2c>

Ma le classi sono più di questo in Python. Anche le classi sono oggetti.

Sì, oggetti.

Non appena usi la parola chiave class, Python lo esegue e crea un oggetto. Le istruzioni

>>> class ObjectCreator(object):
...       pass
...

crea in memoria un oggetto con il nome "ObjectCreator".

Questo oggetto (la classe) è esso stesso in grado di creare oggetti (le istanze), e questo è il motivo per cui è una classe .

Ma ancora, è un oggetto, e quindi:

  • puoi assegnarlo a una variabile
  • puoi copiarlo
  • è possibile aggiungere attributi ad esso
  • puoi passarlo come parametro di funzione

per esempio.:

>>> print(ObjectCreator) # you can print a class because it's an object
<class '__main__.ObjectCreator'>
>>> def echo(o):
...       print(o)
...
>>> echo(ObjectCreator) # you can pass a class as a parameter
<class '__main__.ObjectCreator'>
>>> print(hasattr(ObjectCreator, 'new_attribute'))
False
>>> ObjectCreator.new_attribute = 'foo' # you can add attributes to a class
>>> print(hasattr(ObjectCreator, 'new_attribute'))
True
>>> print(ObjectCreator.new_attribute)
foo
>>> ObjectCreatorMirror = ObjectCreator # you can assign a class to a variable
>>> print(ObjectCreatorMirror.new_attribute)
foo
>>> print(ObjectCreatorMirror())
<__main__.ObjectCreator object at 0x8997b4c>

Creare classi dinamicamente

Poiché le classi sono oggetti, puoi crearle al volo, come qualsiasi oggetto.

Innanzitutto, puoi creare una classe in una funzione usando class:

>>> def choose_class(name):
...     if name == 'foo':
...         class Foo(object):
...             pass
...         return Foo # return the class, not an instance
...     else:
...         class Bar(object):
...             pass
...         return Bar
...
>>> MyClass = choose_class('foo')
>>> print(MyClass) # the function returns a class, not an instance
<class '__main__.Foo'>
>>> print(MyClass()) # you can create an object from this class
<__main__.Foo object at 0x89c6d4c>

Ma non è così dinamico, dal momento che devi ancora scrivere l'intera classe da solo.

Poiché le classi sono oggetti, devono essere generate da qualcosa.

Quando usi il class parola chiave, Python crea questo oggetto automaticamente. Ma come con la maggior parte delle cose in Python, ti dà un modo per farlo manualmente.

Ricorda la funzione type? La buona vecchia funzione che ti consente di sapere cosa digitare un oggetto è:

>>> print(type(1))
<type 'int'>
>>> print(type("1"))
<type 'str'>
>>> print(type(ObjectCreator))
<type 'type'>
>>> print(type(ObjectCreator()))
<class '__main__.ObjectCreator'>

Bene, type ha una capacità completamente diversa, può anche creare classi al volo. type può prendere la descrizione di una classe come parametri, e restituire una classe.

(Lo so, è sciocco che la stessa funzione possa avere due usi completamente diversi in base ai parametri che gli si passano. È un problema dovuto all'indietro compatibilità in Python)

type funziona in questo modo:

type(name of the class,
     tuple of the parent class (for inheritance, can be empty),
     dictionary containing attributes names and values)

per esempio.:

>>> class MyShinyClass(object):
...       pass

può essere creato manualmente in questo modo:

>>> MyShinyClass = type('MyShinyClass', (), {}) # returns a class object
>>> print(MyShinyClass)
<class '__main__.MyShinyClass'>
>>> print(MyShinyClass()) # create an instance with the class
<__main__.MyShinyClass object at 0x8997cec>

Noterai che usiamo "MyShinyClass" come nome della classe e come variabile per contenere il riferimento di classe. Possono essere diversi, ma non c'è motivo di complicare le cose.

type accetta un dizionario per definire gli attributi della classe. Così:

>>> class Foo(object):
...       bar = True

Può essere tradotto in:

>>> Foo = type('Foo', (), {'bar':True})

E usato come una classe normale:

>>> print(Foo)
<class '__main__.Foo'>
>>> print(Foo.bar)
True
>>> f = Foo()
>>> print(f)
<__main__.Foo object at 0x8a9b84c>
>>> print(f.bar)
True

E naturalmente, puoi ereditare da esso, quindi:

>>>   class FooChild(Foo):
...         pass

sarebbe:

>>> FooChild = type('FooChild', (Foo,), {})
>>> print(FooChild)
<class '__main__.FooChild'>
>>> print(FooChild.bar) # bar is inherited from Foo
True

Alla fine ti consigliamo di aggiungere metodi alla tua classe. Basta definire una funzione con la firma appropriata e assegnarlo come attributo.

>>> def echo_bar(self):
...       print(self.bar)
...
>>> FooChild = type('FooChild', (Foo,), {'echo_bar': echo_bar})
>>> hasattr(Foo, 'echo_bar')
False
>>> hasattr(FooChild, 'echo_bar')
True
>>> my_foo = FooChild()
>>> my_foo.echo_bar()
True

Ed è possibile aggiungere ancora più metodi dopo aver creato dinamicamente la classe, proprio come aggiungere metodi a un oggetto di classe creato normalmente.

>>> def echo_bar_more(self):
...       print('yet another method')
...
>>> FooChild.echo_bar_more = echo_bar_more
>>> hasattr(FooChild, 'echo_bar_more')
True

Vedi dove stiamo andando: in Python, le classi sono oggetti e puoi creare una classe al volo, in modo dinamico.

Questo è ciò che Python fa quando usi la parola chiave classe lo fa usando una metaclasse.

Cosa sono i metaclassi (finalmente)

I metaclassi sono le "cose" che creano classi.

Definisci le classi per creare oggetti, giusto?

Ma abbiamo imparato che le classi Python sono oggetti.

Bene, le metaclassi sono ciò che creano questi oggetti. Sono le classi delle classi, puoi immaginarli in questo modo:

MyClass = MetaClass()
my_object = MyClass()

L'hai visto type ti permette di fare qualcosa del genere:

MyClass = type('MyClass', (), {})

È perché la funzione type è in effetti un metaclass. type è il metaclea Python usa per creare tutte le classi dietro le quinte.

Ora ti chiedi perché diavolo è scritto in lettere minuscole, e non Type?

Beh, immagino sia una questione di coerenza str, la classe che crea oggetti di archi, e intla classe che crea oggetti interi. type è solo la classe che crea oggetti di classe.

Lo vedi controllando il __class__ attributo.

Tutto, e intendo tutto, è un oggetto in Python. Ciò include gli ints, archi, funzioni e classi. Tutti loro sono oggetti. E tutti loro hanno stato creato da una classe:

>>> age = 35
>>> age.__class__
<type 'int'>
>>> name = 'bob'
>>> name.__class__
<type 'str'>
>>> def foo(): pass
>>> foo.__class__
<type 'function'>
>>> class Bar(object): pass
>>> b = Bar()
>>> b.__class__
<class '__main__.Bar'>

Ora, qual è il __class__ di qualsiasi __class__ ?

>>> age.__class__.__class__
<type 'type'>
>>> name.__class__.__class__
<type 'type'>
>>> foo.__class__.__class__
<type 'type'>
>>> b.__class__.__class__
<type 'type'>

Quindi, un metaclasse è solo il materiale che crea oggetti di classe.

Puoi chiamarlo una "fabbrica di classe", se lo desideri.

type è la metaclora incorporata usata da Python, ma ovviamente è possibile creare la tua proprio metaclasse.

Il __metaclass__ attributo

Puoi aggiungere un __metaclass__ attributo quando scrivi una classe:

class Foo(object):
    __metaclass__ = something...
    [...]

In tal caso, Python utilizzerà la metaclasse per creare la classe Foo.

Attento, è difficile.

Scrivi class Foo(object) prima, ma l'oggetto di classe Foo non è stato creato ancora in memoria.

Python cercherà __metaclass__ nella definizione della classe. Se lo trova, lo userà per creare la classe dell'oggetto Foo. Se non lo fa, userà type per creare la classe.

Leggi più volte.

Quando lo fai:

class Foo(Bar):
    pass

Python fa quanto segue:

C'è un __metaclass__ attributo in Foo?

Se sì, crea in memoria un oggetto di classe (ho detto un oggetto di classe, rimani con me qui), con il nome Foo usando ciò che è dentro __metaclass__.

Se Python non riesce a trovare __metaclass__, cercherà a __metaclass__ a livello di MODULO, e prova a fare lo stesso (ma solo per le classi che non ereditano nulla, in pratica le classi vecchio stile).

Quindi se non riesce a trovarne __metaclass__ a tutti, userà il Baril primo (il primo genitore) possiede il metaclasse (che potrebbe essere l'impostazione predefinita) type) per creare l'oggetto di classe.

Stai attento qui che il __metaclass__ l'attributo non verrà ereditato, il metaclass del genitore ( Bar.__class__) sarà. Se Bar usato a __metaclass__ attributo che ha creato Bar con type() (e non type.__new__()), le sottoclassi non erediteranno tale comportamento.

Ora la grande domanda è, cosa puoi inserire __metaclass__ ?

La risposta è: qualcosa che può creare una classe.

E cosa può creare una classe? typeo qualsiasi cosa che sottoclassi o utilizzi.

Metaclassi personalizzati

Lo scopo principale di un metaclass è di cambiare automaticamente la classe, quando è stato creato.

Di solito lo fai per le API, in cui vuoi creare classi corrispondenti a contesto attuale.

Immagina un esempio stupido, in cui decidi che tutte le classi del tuo modulo dovrebbero avere i loro attributi scritti in maiuscolo. Ci sono diversi modi per fai questo, ma un modo è quello di impostare __metaclass__ a livello di modulo.

In questo modo, tutte le classi di questo modulo verranno create utilizzando questo metaclass, e dobbiamo solo dire al metaclass di trasformare tutti gli attributi in maiuscolo.

Fortunatamente, __metaclass__ può effettivamente essere qualsiasi chiamabile, non ha bisogno di essere un classe formale (lo so, qualcosa con "classe" nel suo nome non ha bisogno di essere una classe, vai a capire ... ma è utile).

Quindi inizieremo con un semplice esempio, utilizzando una funzione.

# the metaclass will automatically get passed the same argument
# that you usually pass to `type`
def upper_attr(future_class_name, future_class_parents, future_class_attr):
    """
      Return a class object, with the list of its attribute turned
      into uppercase.
    """

    # pick up any attribute that doesn't start with '__' and uppercase it
    uppercase_attr = {}
    for name, val in future_class_attr.items():
        if not name.startswith('__'):
            uppercase_attr[name.upper()] = val
        else:
            uppercase_attr[name] = val

    # let `type` do the class creation
    return type(future_class_name, future_class_parents, uppercase_attr)

__metaclass__ = upper_attr # this will affect all classes in the module

class Foo(): # global __metaclass__ won't work with "object" though
    # but we can define __metaclass__ here instead to affect only this class
    # and this will work with "object" children
    bar = 'bip'

print(hasattr(Foo, 'bar'))
# Out: False
print(hasattr(Foo, 'BAR'))
# Out: True

f = Foo()
print(f.BAR)
# Out: 'bip'

Ora, facciamo esattamente la stessa cosa, ma usando una vera classe per un metaclasse:

# remember that `type` is actually a class like `str` and `int`
# so you can inherit from it
class UpperAttrMetaclass(type):
    # __new__ is the method called before __init__
    # it's the method that creates the object and returns it
    # while __init__ just initializes the object passed as parameter
    # you rarely use __new__, except when you want to control how the object
    # is created.
    # here the created object is the class, and we want to customize it
    # so we override __new__
    # you can do some stuff in __init__ too if you wish
    # some advanced use involves overriding __call__ as well, but we won't
    # see this
    def __new__(upperattr_metaclass, future_class_name,
                future_class_parents, future_class_attr):

        uppercase_attr = {}
        for name, val in future_class_attr.items():
            if not name.startswith('__'):
                uppercase_attr[name.upper()] = val
            else:
                uppercase_attr[name] = val

        return type(future_class_name, future_class_parents, uppercase_attr)

Ma questo non è davvero OOP. Noi chiamiamo type direttamente e non escludiamo o chiama il genitore __new__. Facciamolo:

class UpperAttrMetaclass(type):

    def __new__(upperattr_metaclass, future_class_name,
                future_class_parents, future_class_attr):

        uppercase_attr = {}
        for name, val in future_class_attr.items():
            if not name.startswith('__'):
                uppercase_attr[name.upper()] = val
            else:
                uppercase_attr[name] = val

        # reuse the type.__new__ method
        # this is basic OOP, nothing magic in there
        return type.__new__(upperattr_metaclass, future_class_name,
                            future_class_parents, uppercase_attr)

Potresti aver notato l'argomento extra upperattr_metaclass. C'è niente di speciale a riguardo: __new__ riceve sempre la classe in cui è definita, come primo parametro. Proprio come te self per i metodi ordinari che ricevono l'istanza come primo parametro o la classe di definizione per i metodi di classe.

Naturalmente, i nomi che ho usato qui sono lunghi per motivi di chiarezza, ma come per self, tutti gli argomenti hanno nomi convenzionali. Quindi una vera produzione metaclass sarebbe simile a questo:

class UpperAttrMetaclass(type):

    def __new__(cls, clsname, bases, dct):

        uppercase_attr = {}
        for name, val in dct.items():
            if not name.startswith('__'):
                uppercase_attr[name.upper()] = val
            else:
                uppercase_attr[name] = val

        return type.__new__(cls, clsname, bases, uppercase_attr)

Possiamo renderlo ancora più pulito usando super, che faciliterà l'ereditarietà (perché sì, puoi avere metaclassi, che ereditano da metaclassi, che ereditano dal tipo):

class UpperAttrMetaclass(type):

    def __new__(cls, clsname, bases, dct):

        uppercase_attr = {}
        for name, val in dct.items():
            if not name.startswith('__'):
                uppercase_attr[name.upper()] = val
            else:
                uppercase_attr[name] = val

        return super(UpperAttrMetaclass, cls).__new__(cls, clsname, bases, uppercase_attr)

Questo è tutto. Non c'è davvero niente di più sulle metaclassi.

La ragione dietro la complessità del codice che utilizza metaclassi non è perché dei metaclassi, è perché di solito usi le metaclassi per fare cose contorte affidandosi all'introspezione, manipolando l'ereditarietà, vars come __dict__, eccetera.

In effetti, le metaclassi sono particolarmente utili per fare la magia nera, e quindi roba complicata. Ma da soli, sono semplici:

  • intercettare una creazione di classe
  • modificare la classe
  • restituire la classe modificata

Perché dovresti usare classi di metaclassi invece di funzioni?

Da __metaclass__ può accettare qualsiasi chiamabile, perché dovresti usare una classe poiché è ovviamente più complicato?

Ci sono diversi motivi per farlo:

  • L'intenzione è chiara. Quando leggi UpperAttrMetaclass(type), sai cosa seguirà
  • Puoi usare OOP. Metaclass può ereditare dal metaclasse, sovrascrivere i metodi padre. I metaclassi possono persino usare metaclassi.
  • Le sottoclassi di una classe saranno istanze del suo metamato se hai specificato una classe metaclasse, ma non con una metaclass.
  • Puoi strutturare meglio il tuo codice. Non usi mai le metaclassi per qualcosa come banale come nell'esempio sopra. Di solito è per qualcosa di complicato. Avere il la capacità di creare diversi metodi e raggrupparli in una classe è molto utile per rendere il codice più facile da leggere.
  • Puoi agganciare __new__, __init__ e __call__. Che permetterà tu a fare cose diverse. Anche se di solito puoi farcela tutta __new__, alcune persone sono solo più a loro agio nell'uso __init__.
  • Questi sono chiamati metaclassi, dannazione! Deve significare qualcosa!

Perché dovresti usare i metaclassi?

Ora la grande domanda. Perché dovresti utilizzare qualche oscura funzione soggetta a errori?

Beh, di solito non lo fai:

I metaclassi sono la magia più profonda che   Il 99% degli utenti non dovrebbe mai preoccuparsi.   Se ti chiedi se ne hai bisogno,   tu no (le persone che in realtà   bisogno di loro sapere con certezza che   ne hanno bisogno e non ne hanno bisogno   spiegazione sul perché).

Python Guru Tim Peters

Il caso d'uso principale per un metaclasse sta creando un'API. Un tipico esempio di questo è l'ORM Django.

Ti permette di definire qualcosa di simile a questo:

class Person(models.Model):
    name = models.CharField(max_length=30)
    age = models.IntegerField()

Ma se lo fai:

guy = Person(name='bob', age='35')
print(guy.age)

Non restituirà un IntegerField oggetto. Restituirà un inte può anche prenderlo direttamente dal database.

Questo è possibile perché models.Model definisce __metaclass__ e usa un po 'di magia che trasformerà il Person hai appena definito con semplici dichiarazioni in un gancio complesso a un campo di database.

Django rende semplice l'aspetto di qualcosa di complesso esponendo una semplice API e usando metaclassi, ricreando il codice da questa API per fare il vero lavoro dietro le quinte.

L'ultima parola

Innanzitutto, sai che le classi sono oggetti che possono creare istanze.

Beh, in effetti, le classi sono esse stesse istanze. Di metaclassi

>>> class Foo(object): pass
>>> id(Foo)
142630324

Tutto è un oggetto in Python e sono tutte o istanze di classi o istanze di metaclassi.

Eccetto per type.

type è in realtà il suo metaclasse. Questo non è qualcosa che potresti riproducibile in puro Python, e viene eseguito imbrogliando un po 'l'implementazione livello.

In secondo luogo, le metaclassi sono complicate. Potresti non volerne usare per alterazioni di classe molto semplici. Puoi cambiare classe usando due tecniche differenti:

Il 99% delle volte hai bisogno di un'alterazione di classe, stai meglio usando questi.

Ma il 98% delle volte non hai bisogno di alterazioni di classe.


5753
2017-09-19 06:26



Nota, questa risposta è per Python 2.x come è stato scritto nel 2008, le metaclature sono leggermente diverse in 3.x, vedi i commenti.

I metaclassi sono la salsa segreta che rende il lavoro 'di classe'. Il metaclasse predefinito per un nuovo oggetto stile è chiamato 'tipo'.

class type(object)
  |  type(object) -> the object's type
  |  type(name, bases, dict) -> a new type

I metaclassi richiedono 3 arg. ' nome ',' basi ' e ' dict '

Qui è dove inizia il segreto. Cerca da dove vengono il nome, le basi e il dict in questa definizione di classe di esempio.

class ThisIsTheName(Bases, Are, Here):
    All_the_code_here
    def doesIs(create, a):
        dict

Definiamo un metaclass che dimostrerà come classe: 'lo chiama.

def test_metaclass(name, bases, dict):
    print 'The Class Name is', name
    print 'The Class Bases are', bases
    print 'The dict has', len(dict), 'elems, the keys are', dict.keys()

    return "yellow"

class TestName(object, None, int, 1):
    __metaclass__ = test_metaclass
    foo = 1
    def baz(self, arr):
        pass

print 'TestName = ', repr(TestName)

# output => 
The Class Name is TestName
The Class Bases are (<type 'object'>, None, <type 'int'>, 1)
The dict has 4 elems, the keys are ['baz', '__module__', 'foo', '__metaclass__']
TestName =  'yellow'

E ora, un esempio che in realtà significa qualcosa, questo renderà automaticamente le variabili nella lista "attributi" impostate sulla classe e impostate su Nessuna.

def init_attributes(name, bases, dict):
    if 'attributes' in dict:
        for attr in dict['attributes']:
            dict[attr] = None

    return type(name, bases, dict)

class Initialised(object):
    __metaclass__ = init_attributes
    attributes = ['foo', 'bar', 'baz']

print 'foo =>', Initialised.foo
# output=>
foo => None

Nota che il comportamento magico che "Initalizzato" ottiene avendo il metaclasse init_attributes non è passato su una sottoclasse di Initalised.

Ecco un esempio ancora più concreto, che mostra come è possibile creare una sottoclasse di "tipo" per creare un metaclasse che esegue un'azione quando viene creata la classe. Questo è piuttosto difficile:

class MetaSingleton(type):
    instance = None
    def __call__(cls, *args, **kw):
        if cls.instance is None:
            cls.instance = super(MetaSingleton, cls).__call__(*args, **kw)
        return cls.instance

 class Foo(object):
     __metaclass__ = MetaSingleton

 a = Foo()
 b = Foo()
 assert a is b

311
2017-09-19 06:45



Un uso per i metaclassi è l'aggiunta automatica di nuove proprietà e metodi a un'istanza.

Ad esempio, se guardi Modelli di Django , la loro definizione sembra un po 'confusa. Sembra che tu stia solo definendo le proprietà della classe:

class Person(models.Model):
    first_name = models.CharField(max_length=30)
    last_name = models.CharField(max_length=30)

Tuttavia, durante il runtime gli oggetti Person sono riempiti con tutti i tipi di metodi utili. Vedere il fonte  per qualche stupefacente metaclasseria.


124
2018-06-21 16:30



Altri hanno spiegato come funzionano le metaclassi e come si adattano al sistema di tipo Python. Ecco un esempio di ciò per cui possono essere utilizzati. In un framework di test che ho scritto, volevo tenere traccia dell'ordine in cui sono state definite le classi, in modo da poterle successivamente istanziare in questo ordine. Ho trovato più facile farlo usando una metaclasse.

class MyMeta(type):

    counter = 0

    def __init__(cls, name, bases, dic):
        type.__init__(cls, name, bases, dic)
        cls._order = MyMeta.counter
        MyMeta.counter += 1

class MyType(object):              # Python 2
    __metaclass__ = MyMeta

class MyType(metaclass=MyMeta):    # Python 3
    pass

Tutto ciò che è una sottoclasse di MyType quindi ottiene un attributo di classe _order che registra l'ordine in cui sono state definite le classi.


117
2017-09-19 06:32



Penso che l'introduzione di ONLamp alla programmazione di metaclassi sia ben scritta e dia un'ottima introduzione all'argomento nonostante abbia già diversi anni.

http://www.onlamp.com/pub/a/python/2003/04/17/metaclasses.html

In breve: una classe è un progetto per la creazione di un'istanza, un metaclasse è un progetto per la creazione di una classe. Si può facilmente vedere che in Python le classi devono essere anche oggetti di prima classe per abilitare questo comportamento.

Non ne ho mai scritto uno anch'io, ma penso che uno degli usi più belli delle metaclassi possa essere visto nel Struttura di Django . Le classi modello utilizzano un approccio metaclass per abilitare uno stile dichiarativo di scrittura di nuovi modelli o classi di moduli. Mentre il metaclasse sta creando la classe, tutti i membri hanno la possibilità di personalizzare la classe stessa.

La cosa che rimane da dire è: se non sai quali sono le metaclassi, la probabilità che tu non ne avranno bisogno  è il 99%.


86
2017-08-10 23:28



Cosa sono le metaclassi? Per cosa li usi?

TLDR: un metaclasse crea un'istanza e definisce il comportamento di una classe esattamente come una classe crea un'istanza e definisce il comportamento di un'istanza.

pseudocodice:

>>> Class(...)
instance

Quanto sopra dovrebbe sembrare familiare. Bene, dove lo fa Class vieni? È un'istanza di un metaclasse (anche pseudocodice):

>>> Metaclass(...)
Class

Nel codice reale, possiamo passare il metaclass di default, type, tutto ciò di cui abbiamo bisogno per creare un'istanza di una classe e ottenere una classe:

>>> type('Foo', (object,), {}) # requires a name, bases, and a namespace
<class '__main__.Foo'>

Mettendolo diversamente

  • Una classe è un'istanza come metaclasse appartiene a una classe.

    Quando istanziamo un oggetto, otteniamo un'istanza:

    >>> object()                          # instantiation of class
    <object object at 0x7f9069b4e0b0>     # instance
    

    Allo stesso modo, quando definiamo una classe esplicitamente con il metaclass predefinito, type, lo istanziamo:

    >>> type('Object', (object,), {})     # instantiation of metaclass
    <class '__main__.Object'>             # instance
    
  • In altre parole, una classe è un'istanza di un metaclasse:

    >>> isinstance(object, type)
    True
    
  • Metti una terza via, una metaclasse è la classe di una classe.

    >>> type(object) == type
    True
    >>> object.__class__
    <class 'type'>
    

Quando si scrive una definizione di classe e Python lo esegue, utilizza una metaclasse per istanziare l'oggetto classe (che, a sua volta, sarà utilizzato per istanziare le istanze di quella classe).

Proprio come possiamo usare le definizioni di classe per cambiare il modo in cui si comportano le istanze di oggetti personalizzati, possiamo usare una definizione di classe metaclasse per cambiare il modo in cui un oggetto di classe si comporta.

Per cosa possono essere usati? Dal docs :

I potenziali usi per i metaclassi sono illimitati. Alcune idee che sono state esplorate includono la registrazione, il controllo dell'interfaccia, la delega automatica, la creazione automatica delle proprietà, i proxy, i framework e il blocco / sincronizzazione automatica delle risorse.

Tuttavia, di solito è incoraggiato gli utenti a evitare l'uso di metaclassi a meno che non sia assolutamente necessario.

Usi un metaclasse ogni volta che crei una classe:

Quando scrivi una definizione di classe, ad esempio, come questa,

class Foo(object): 
    'demo'

Si istanzia un oggetto di classe.

>>> Foo
<class '__main__.Foo'>
>>> isinstance(Foo, type), isinstance(Foo, object)
(True, True)

È lo stesso di chiamare funzionalmente type con gli argomenti appropriati e assegnando il risultato a una variabile di quel nome:

name = 'Foo'
bases = (object,)
namespace = {'__doc__': 'demo'}
Foo = type(name, bases, namespace)

Nota, alcune cose vengono automaticamente aggiunte al __dict__, cioè lo spazio dei nomi:

>>> Foo.__dict__
dict_proxy({'__dict__': <attribute '__dict__' of 'Foo' objects>, 
'__module__': '__main__', '__weakref__': <attribute '__weakref__' 
of 'Foo' objects>, '__doc__': 'demo'})

Il metaclasse  dell'oggetto che abbiamo creato, in entrambi i casi, lo è type.

(Una nota a margine sul contenuto della classe __dict__: __module__ è lì perché le classi devono sapere dove sono definite, e __dict__ e __weakref__ ci sono perché non lo definiamo __slots__ - Se noi definire __slots__ salveremo un po 'di spazio nelle istanze, poiché possiamo impedirlo __dict__ e __weakref__ escludendoli. Per esempio:

>>> Baz = type('Bar', (object,), {'__doc__': 'demo', '__slots__': ()})
>>> Baz.__dict__
mappingproxy({'__doc__': 'demo', '__slots__': (), '__module__': '__main__'})

... ma sto divagando.)

Possiamo estendere type proprio come qualsiasi altra definizione di classe:

Ecco l'impostazione predefinita __repr__ di classi:

>>> Foo
<class '__main__.Foo'>

Una delle cose più preziose che possiamo fare per impostazione predefinita nella scrittura di un oggetto Python è di fornirgli un bene __repr__. Quando chiamiamo help(repr) impariamo che c'è un buon test per a __repr__ ciò richiede anche un test per l'uguaglianza - obj == eval(repr(obj)). La seguente semplice implementazione di __repr__ e __eq__ per le istanze di classe della nostra classe di tipo ci fornisce una dimostrazione che potrebbe migliorare sul valore predefinito __repr__ di classi:

class Type(type):
    def __repr__(cls):
        """
        >>> Baz
        Type('Baz', (Foo, Bar,), {'__module__': '__main__', '__doc__': None})
        >>> eval(repr(Baz))
        Type('Baz', (Foo, Bar,), {'__module__': '__main__', '__doc__': None})
        """
        metaname = type(cls).__name__
        name = cls.__name__
        parents = ', '.join(b.__name__ for b in cls.__bases__)
        if parents:
            parents += ','
        namespace = ', '.join(': '.join(
          (repr(k), repr(v) if not isinstance(v, type) else v.__name__))
               for k, v in cls.__dict__.items())
        return '{0}(\'{1}\', ({2}), {{{3}}})'.format(metaname, name, parents, namespace)
    def __eq__(cls, other):
        """
        >>> Baz == eval(repr(Baz))
        True            
        """
        return (cls.__name__, cls.__bases__, cls.__dict__) == (
                other.__name__, other.__bases__, other.__dict__)

Così ora quando creiamo un oggetto con questo metaclasse, il __repr__ echo sulla riga di comando fornisce una vista molto meno brutta del default:

>>> class Bar(object): pass
>>> Baz = Type('Baz', (Foo, Bar,), {'__module__': '__main__', '__doc__': None})
>>> Baz
Type('Baz', (Foo, Bar,), {'__module__': '__main__', '__doc__': None})

Con un bel __repr__ definito per l'istanza di classe, abbiamo una maggiore capacità di eseguire il debug del nostro codice. Tuttavia, molto più controllo con eval(repr(Class)) è improbabile (in quanto le funzioni sarebbero piuttosto impossibili da valutare in base al loro valore predefinito __repr__'S).

Un utilizzo previsto: __prepare__ uno spazio dei nomi

Se, ad esempio, vogliamo sapere in quale ordine vengono creati i metodi di una classe, potremmo fornire un ditt ordinato come lo spazio dei nomi della classe. Lo faremmo con __prepare__ quale restituisce lo spazio dei nomi dict per la classe se è implementato in Python 3 :

from collections import OrderedDict

class OrderedType(Type):
    @classmethod
    def __prepare__(metacls, name, bases, **kwargs):
        return OrderedDict()
    def __new__(cls, name, bases, namespace, **kwargs):
        result = Type.__new__(cls, name, bases, dict(namespace))
        result.members = tuple(namespace)
        return result

E l'uso:

class OrderedMethodsObject(object, metaclass=OrderedType):
    def method1(self): pass
    def method2(self): pass
    def method3(self): pass
    def method4(self): pass

E ora abbiamo una registrazione dell'ordine in cui sono stati creati questi metodi (e altri attributi di classe):

>>> OrderedMethodsObject.members
('__module__', '__qualname__', 'method1', 'method2', 'method3', 'method4')

Nota, questo esempio è stato adattato dal documentazione  - il nuovo enum nella libreria standard  fa questo.

Quindi quello che abbiamo fatto è stato creare un'istanza di un metaclass creando una classe. Possiamo anche trattare il metaclass come faremmo con qualsiasi altra classe. Ha un ordine di risoluzione del metodo:

>>> inspect.getmro(OrderedType)
(<class '__main__.OrderedType'>, <class '__main__.Type'>, <class 'type'>, <class 'object'>)

E ha approssimativamente il corretto repr (che non possiamo più valutare a meno che non riusciamo a trovare un modo per rappresentare le nostre funzioni):

>>> OrderedMethodsObject
OrderedType('OrderedMethodsObject', (object,), {'method1': <function OrderedMethodsObject.method1 at 0x0000000002DB01E0>, 'members': ('__module__', '__qualname__', 'method1', 'method2', 'method3', 'method4'), 'method3': <function OrderedMet
hodsObject.method3 at 0x0000000002DB02F0>, 'method2': <function OrderedMethodsObject.method2 at 0x0000000002DB0268>, '__module__': '__main__', '__weakref__': <attribute '__weakref__' of 'OrderedMethodsObject' objects>, '__doc__': None, '__d
ict__': <attribute '__dict__' of 'OrderedMethodsObject' objects>, 'method4': <function OrderedMethodsObject.method4 at 0x0000000002DB0378>})

74
2018-03-01 19:48



Aggiornamento Python 3

Ci sono (a questo punto) due metodi chiave in un metaclass:

  • __prepare__, e
  • __new__

__prepare__ ti consente di fornire una mappatura personalizzata (come ad esempio un OrderedDict) da utilizzare come spazio dei nomi durante la creazione della classe. Devi restituire un'istanza di qualsiasi spazio dei nomi che scegli. Se non si implementa __prepare__un normale dict si usa.

__new__ è responsabile della creazione / modifica effettiva della classe finale.

Un metaclass a regola d'arte, niente da fare vorrebbe:

class Meta(type):

    def __prepare__(metaclass, cls, bases):
        return dict()

    def __new__(metacls, cls, bases, clsdict):
        return super().__new__(metacls, cls, bases, clsdict)

Un semplice esempio:

Supponiamo che tu voglia un semplice codice di convalida da eseguire sui tuoi attributi, come se dovesse sempre essere un int o a str. Senza una metaclasse, la tua classe assomiglierebbe a qualcosa:

class Person:
    weight = ValidateType('weight', int)
    age = ValidateType('age', int)
    name = ValidateType('name', str)

Come puoi vedere, devi ripetere due volte il nome dell'attributo. Ciò rende possibili errori di battitura insieme a bug irritanti.

Un metaclasse semplice può risolvere questo problema:

class Person(metaclass=Validator):
    weight = ValidateType(int)
    age = ValidateType(int)
    name = ValidateType(str)

Questo è ciò che sembrerebbe il metaclass (non usando __prepare__ dal momento che non è necessario):

class Validator(type):
    def __new__(metacls, cls, bases, clsdict):
        # search clsdict looking for ValidateType descriptors
        for name, attr in clsdict.items():
            if isinstance(attr, ValidateType):
                attr.name = name
                attr.attr = '_' + name
        # create final class and return it
        return super().__new__(metacls, cls, bases, clsdict)

Un esempio di:

p = Person()
p.weight = 9
print(p.weight)
p.weight = '9'

produce:

9
Traceback (most recent call last):
  File "simple_meta.py", line 36, in <module>
    p.weight = '9'
  File "simple_meta.py", line 24, in __set__
    (self.name, self.type, value))
TypeError: weight must be of type(s) <class 'int'> (got '9')

Nota : Questo esempio è abbastanza semplice potrebbe anche essere stato realizzato con un decoratore di classe, ma presumibilmente un vero metaclass avrebbe fatto molto di più.

La classe 'ValidateType' per riferimento:

class ValidateType:
    def __init__(self, type):
        self.name = None  # will be set by metaclass
        self.attr = None  # will be set by metaclass
        self.type = type
    def __get__(self, inst, cls):
        if inst is None:
            return self
        else:
            return inst.__dict__[self.attr]
    def __set__(self, inst, value):
        if not isinstance(value, self.type):
            raise TypeError('%s must be of type(s) %s (got %r)' %
                    (self.name, self.type, value))
        else:
            inst.__dict__[self.attr] = value

55
2017-10-13 09:21



Una metaclasse è una classe che indica come (qualche) altra classe dovrebbe essere creata.

Questo è un caso in cui ho visto il metaclasse come una soluzione al mio problema: Ho avuto un problema davvero complicato, che probabilmente avrebbe potuto essere risolto in modo diverso, ma ho scelto di risolverlo usando un metaclass. A causa della complessità, è uno dei pochi moduli che ho scritto dove i commenti nel modulo superano la quantità di codice che è stata scritta. Ecco qui...

#!/usr/bin/env python

# Copyright (C) 2013-2014 Craig Phillips.  All rights reserved.

# This requires some explaining.  The point of this metaclass excercise is to
# create a static abstract class that is in one way or another, dormant until
# queried.  I experimented with creating a singlton on import, but that did
# not quite behave how I wanted it to.  See now here, we are creating a class
# called GsyncOptions, that on import, will do nothing except state that its
# class creator is GsyncOptionsType.  This means, docopt doesn't parse any
# of the help document, nor does it start processing command line options.
# So importing this module becomes really efficient.  The complicated bit
# comes from requiring the GsyncOptions class to be static.  By that, I mean
# any property on it, may or may not exist, since they are not statically
# defined; so I can't simply just define the class with a whole bunch of
# properties that are @property @staticmethods.
#
# So here's how it works:
#
# Executing 'from libgsync.options import GsyncOptions' does nothing more
# than load up this module, define the Type and the Class and import them
# into the callers namespace.  Simple.
#
# Invoking 'GsyncOptions.debug' for the first time, or any other property
# causes the __metaclass__ __getattr__ method to be called, since the class
# is not instantiated as a class instance yet.  The __getattr__ method on
# the type then initialises the class (GsyncOptions) via the __initialiseClass
# method.  This is the first and only time the class will actually have its
# dictionary statically populated.  The docopt module is invoked to parse the
# usage document and generate command line options from it.  These are then
# paired with their defaults and what's in sys.argv.  After all that, we
# setup some dynamic properties that could not be defined by their name in
# the usage, before everything is then transplanted onto the actual class
# object (or static class GsyncOptions).
#
# Another piece of magic, is to allow command line options to be set in
# in their native form and be translated into argparse style properties.
#
# Finally, the GsyncListOptions class is actually where the options are
# stored.  This only acts as a mechanism for storing options as lists, to
# allow aggregation of duplicate options or options that can be specified
# multiple times.  The __getattr__ call hides this by default, returning the
# last item in a property's list.  However, if the entire list is required,
# calling the 'list()' method on the GsyncOptions class, returns a reference
# to the GsyncListOptions class, which contains all of the same properties
# but as lists and without the duplication of having them as both lists and
# static singlton values.
#
# So this actually means that GsyncOptions is actually a static proxy class...
#
# ...And all this is neatly hidden within a closure for safe keeping.
def GetGsyncOptionsType():
    class GsyncListOptions(object):
        __initialised = False

    class GsyncOptionsType(type):
        def __initialiseClass(cls):
            if GsyncListOptions._GsyncListOptions__initialised: return

            from docopt import docopt
            from libgsync.options import doc
            from libgsync import __version__

            options = docopt(
                doc.__doc__ % __version__,
                version = __version__,
                options_first = True
            )

            paths = options.pop('<path>', None)
            setattr(cls, "destination_path", paths.pop() if paths else None)
            setattr(cls, "source_paths", paths)
            setattr(cls, "options", options)

            for k, v in options.iteritems():
                setattr(cls, k, v)

            GsyncListOptions._GsyncListOptions__initialised = True

        def list(cls):
            return GsyncListOptions

        def __getattr__(cls, name):
            cls.__initialiseClass()
            return getattr(GsyncListOptions, name)[-1]

        def __setattr__(cls, name, value):
            # Substitut option names: --an-option-name for an_option_name
            import re
            name = re.sub(r'^__', "", re.sub(r'-', "_", name))
            listvalue = []

            # Ensure value is converted to a list type for GsyncListOptions
            if isinstance(value, list):
                if value:
                    listvalue = [] + value
                else:
                    listvalue = [ None ]
            else:
                listvalue = [ value ]

            type.__setattr__(GsyncListOptions, name, listvalue)

    # Cleanup this module to prevent tinkering.
    import sys
    module = sys.modules[__name__]
    del module.__dict__['GetGsyncOptionsType']

    return GsyncOptionsType

# Our singlton abstract proxy class.
class GsyncOptions(object):
    __metaclass__ = GetGsyncOptionsType()

41
2017-08-09 18:49