Praktische Anwendung von Metaklassen

Transkript

1 Praktische Anwendung von Metaklassen Mirko Dziadzka PyCon DE / 27

2 Wer bin ich Wer bin ich? Bewege mich mit Softwareentwicklung auf dem Gebiet Unix, Netzwerk, Security Benutze Python seit ca in Projekten mit > LOC Zur Zeit bei Riverbed Technology in Regensburg 2 / 27

3 Wer seid ihr? Wer seid ihr? Wer weiss, was Metaklassen sind? Wer schon mal welche benutzt? Wer benutzt Dekoratoren? Wer benutzt Klassen Dekoratoren? 3 / 27

4 Was sind Metaklassen? 4 / 27

5 Was sind Metaklassen Was sind Metaklassen? Metaclasses are deeper magic than 99% of users should ever worry about. If you wonder whether you need them, you don t (the people who actually need them know with certainty that they need them, and don t need an explanation about why). Python Guru Tim Peters 5 / 27

6 Was sind Metaklassen Was sind Metaklassen? Ich glaube, es ist nicht ganz so schlimm... 99% Prozent brauchen keine Metaklassen, sie können aber helfen, Probleme auf einfachere Art zu lösen 6 / 27

7 Was sind Metaklassen Also... was sind Metaklassen? Klassen in Python sind auch nur Objekte also Instanz einer Klasse Die Klasse von Klassen ist type 7 / 27

8 Was sind Metaklassen >>> class Foo(object):... pass >>> foo = Foo() >>> foo < main.foo object at 0x1005b5b90> >>> foo. class <class main.foo > >>> foo. class. class <type type > 8 / 27

9 Was sind Metaklassen Die Klasse einer Benutzerdefinierten Klasse ist also type Wenn eine Klasse auch nur die Instanz einer anderen (Meta-)Klasse ist, so kann ich auch die Metaklasse benutzen, um eine Klasse zu erzeugen. 9 / 27

10 # define a class the normal way class Foo: default = 42 def get_answer(self): return self.default # define a class as object from type type def _Bar_get_answer(self): return self.default Bar = type( Bar, (), { default : 42, get_answer : _Bar_get_answer, }) 10 / 27

11 Was sind Metaklassen uns das ist auch genau das, was intern passiert Python benutzt nach dem Parsen des class statements type um die Klasse zu erzeugen. Das lässt sich über das Attribute metaclass in der Klasse oder im Modul ändern Es reicht, wenn metaclass in einer Basis Klasse deklariert wird Hinweis: In grossen Projekten immer alles von einer (auch gerne leeren) Basisklasse ableiten 11 / 27

12 class Foo(object): answer = 42 # ist gleichwertig zu class Foo(object): metaclass = type answer = 42 # ist (fast) gleichwertig zu class MetaClass(type): pass class Foo(object): metaclass = MetaClass answer = / 27

13 Wie implementiert man eine Metaklasse Wie jede andere Klasse auch üblichwerweise definiert man die init oder die new Methode um seinen code unterzubringen. new scheint mir angebrachter, da es der frühest mögliche Zeitpunkt ist 13 / 27

14 class ExampleMetaClass(type): def new (cls, name, bases, attributes): res = type(name, bases, attributes) print class %s created: %s % (name, res) return res class Foo(object): metaclass = ExampleMetaClass def init (self): return class Foo created: <class main.foo > 14 / 27

15 Wie implementiert man eine Metaklasse In dieser new Methode kann man nun anfangen, die Klasse zu manipulieren... oder zu analysieren 15 / 27

16 Beispiele 16 / 27

17 Wo benutzt man Metaklassen Wo benutzt man Metaklassen? Typischerweise bei Implemenationen von Interfaces ORM Mapper (django) Sprachmodifikationen (schlechter Ruf?) Debugging, / 27

18 Debugging mit Metaklassen: trace Das Problem Software wird an Kunden ausgeliefert. Falls es Probleme geben sollte, wünscht sich der Entwickler ausgiebige trace Informationen. Standard Lösung logging.debug calls, überall wo es sinnvoll sein könnte Grenzen der Lösung Debug Aufrufe kosten Rechenzeit Es ist nicht immer vorher klar, was sinnvoll ist Der Code wird durch debug Informationen unterbrochen und ist dadurch nicht so flüssig zu lesen 18 / 27

19 Debugging mit Metaklassen: trace Wunschlösung bei Nichtbenutzung, keine Laufzeiteinflüsse selektives tracen von allen Methoden aufrufen und Ergebnissen im Programm Kunde kann Problem mit eingeschaltetem Debug reproduzieren und aussagekräftige Logs an die Entwickeler schicken 19 / 27

20 Debugging mit Metaklassen: trace Idee: mittels config file / environment variable können beim Programmstart interessante Klassen/Methoden-namen angegeben werden eine Metaklasse dekoriert alle diese Methoden mit einem trace Dekorator 20 / 27

21 Debugging mit Metaklassen: trace class BaseMetaClass(type): def init (self, clsname, bases, attr): for name, value in attr.items(): if name.startswith( ): continue fullname = "%s.%s.%s" % ( self. module, clsname, name) if not should_wrap(fullname): continue value = trace_decorator(fullname, value) setattr(self, name, value) class BaseClass(object): metaclass = BaseMetaClass 21 / 27

22 Debugging mit Metaklassen: trace import os import fnmatch DEBUG_TARGETS = os.environ.get( DEBUG_TARGETS, ) def should_wrap(fullname): for pattern in DEBUG_TARGETS.split(, ): if fnmatch.fnmatch(fullname, pattern): return True return False 22 / 27

23 Debugging mit Metaklassen: trace def log(message, *args): print message % args def trace_decorator(fullname, method): def wrapper(*args, **kwargs): log("%s CALL %s %s", fullname, args, kwargs) try: res = method(*args, **kwargs) log("%s RETURN %s", fullname, res) return res except Exception,e: log("%s EXCEPTION %s", fullname, str(e)) raise #... return wrapper 23 / 27

24 Debugging mit Metaklassen: trace Anwendung $ DEBUG_TARGETS= $./metaclass_debug_usage.py $ DEBUG_TARGETS=*.Question.* $./metaclass_debug_usage.py main.question.set_answer CALL (< main.question object at 0x102cb1ad0>, 23 main.question.set_answer RETURN None 24 / 27

25 Andere Anwendungen Andere Anwendungen von Metaklassen Dynamische Code Analyse Callgraph Von wo wird auf eine Variable lesend/schreibend zugegriffen Coding Style enforcement fault injection 25 / 27

26 Weiterführendes Hintergrundinformationen Beispielcode Folien als PDF 26 / 27

27 Danke für s zuhören Fragen? 27 / 27