以前書いてみたアクセサ をpropertyを使って改良してみる。
propertyというのはnew-styleクラスに対してのみ使える、メソッドで
1class C(object):
2 def __init__(self): self.__x = None
3 def getx(self): return self.__x
4 def setx(self, value): self.__x = value
5 def delx(self): del self.__x
6 x = property(getx, setx, delx, "I'm the 'x' property.")
こんな感じで使う。
Rubyを使った人なら分かると思うけど、プロパティ名でのアクセス＝アクセサ呼び出しになるのは結構便利。 ActiveRecordなんかでは、特に便利だと感じる。あ、このプロパティ、もういっそエンコードされた値を返したい、と思ったときにそのクラスにプロパティ名と同じメソッドを定義するだけでいいし。
前につくったアクセサは「get_hoge()」や「set_hoge()」といった感じで呼び出されたけど、これにpropertyを使うことによってRubyと同じような属性アクセスが可能になる。
とりあえずこんな感じ。
1#!/usr/bin/python
2# vim: fileencoding=utf-8
3from itertools import *
4
5def property_accessor(cls, *names):
6 _property(cls, names)
7
8def property_reader(cls, *names):
9 _property(cls, names, True)
10
11def property_writer(cls, *names):
12 _property(cls, names, False, True)
13
14def _property(cls, names, error_setter = False, error_getter = False):
15 for attr_name, doc in _name_and_docs(names):
16 real_name = _real_name(cls, attr_name)
17 setter = _add_setter(cls, attr_name, real_name, error_setter)
18 getter = _add_getter(cls, attr_name, real_name, error_getter)
19 deleter = _add_deleter(cls, attr_name, real_name)
20 setattr(cls, attr_name, property(getter, setter, deleter, doc))
21
22def _name_and_docs(name_or_tuples):
23 return imap(_name_and_doc ,name_or_tuples)
24
25def _name_and_doc(name_or_tupple):
26 if isinstance(name_or_tupple, ("".__class__, u"".__class__)) :
27 return (name_or_tupple, "")
28 else:
29 return name_or_tupple
30
31def _real_name(cls, name) :
32 return "_%s__%s"%(cls.__name__, name)
33
34def _add_method(cls, verb, name, method_to_add):
35 method_name = "%s_%s" % (verb, name)
36 method = cls.__dict__.get(method_name)
37 if not method :
38 method = method_to_add
39 setattr(cls, method_name, method)
40 return method
41
42def _add_setter(cls, name, real_name, error = False) :
43 if error:
44 def setter(self, v):
45 raise AttributeError, "class %s: %s is a read-only attribute." % (cls.__name__, name)
46 else:
47 setter = lambda self, v : setattr(self, real_name, v)
48 return _add_method(cls, "set", name, setter)
49
50def _add_getter(cls, name, real_name, error = False) :
51 if error:
52 def getter(self):
53 raise AttributeError, "class %s: %s is a write-only attribute." % (cls.__name__, name)
54 else:
55 getter = lambda self : getattr(self, real_name)
56 return _add_method(cls, "get", name, getter)
57
58def _add_deleter(cls, name, real_name) :
59 deleter = lambda self : delattr(self, real_name)
60 return _add_method(cls, "delete", name, deleter)
61
62class AccessorType(type):
63 def __new__(cls, class_name, class_bases, classdict):
64 cls = type.__new__(cls, class_name, class_bases, classdict)
65 list = ["__accessor__", "__reader__", "__writer__"]
66 methods = imap(lambda n: eval("property_%s"%n.strip("_")), list)
67 for accessor_type, method in izip(list, methods):
68 if classdict.has_key(accessor_type):
69 method(cls, *classdict[accessor_type])
70 return cls
71
72class Accessor(object):
73 __metaclass__ = AccessorType
74 def __init__(self, *args) :
75 list = ["__accessor__", "__reader__", "__writer__"]
76 for accessor_type in list:
77 if not self.__class__.__dict__.has_key(accessor_type) : continue
78 for name in self.__class__.__dict__.get(accessor_type):
79 attr_name, doc = _name_and_doc(name)
80 if not self.__dict__.get(attr_name):
81 exec("self._%s__%s = None" % (self.__class__.__name__, attr_name))
使い方は
1#!/usr/bin/python
2# vim: fenc=utf-8
3import accessor
4
5class Test(accessor.Accessor) :
6 __accessor__ = [("x", "This is x value"), "y", "z"]
7 __reader__ = ["r"]
8
9 def __init__(self):
10 accessor.Accessor.__init__(self)
11
12 def get_y(self) :
13 return "new y value"
14
15obj = Test()
16obj.x = "hoge"
17
18print obj.x
19# => hoge
20
21print Test.x.__doc__
22# => This is x value
23
24print obj.y
25# => new y value
26
27obj.r = "value"
28# => AttributeError: class Test: r is a read-only attribute.
こんな感じ。
get_* とか set_* を定義すれば、独自のアクセサを定義できる。 属性は全て private(__*) として保存されているので、 self.__x みたいな感じでクラス内ではアクセスできる。
これやっててはまったのはココ。
1exec("self._%s__%s = None" % (self.__class__.__name__, attr_name))
いや self.__dict__[attr_name] = None でいいんだけど、ふとexecを使うと予想外なことがおこったのであえて記事にのっけてみた。
なんとこれじゃだめなのだ！！ふつうPythonでは self.__x = hoge とすると自動的に内部で self.__dict__["_classname__x"] = "hoge" に変換される。
でもexecでやるとどうやらこの過程をぶっ飛ばしてしまうらしい。要はprivateになってくれない。なので自分で変換してやることで解決する。
ところでこういうアクセサ生成メタクラスってネットにいっぱい転がってるんだけど、そろそろ標準で組み込まれたりしないんだろうかねえ。