__init__で初期化されると、新しい属性を受け入れないが、既存の属性の変更を受け入れるクラスを（Pythonで）作成できるようにしたいと思います。これを行うには、ハックっぽい方法がいくつかあります。たとえば、次の__setattr__ような方法があります。
def __setattr__(self, attribute, value):
if not attribute in self.__dict__:
print "Cannot set %s" % attribute
else:
self.__dict__[attribute] = value
__dict__次に、内部で直接編集します__init__が、これを行うための「適切な」方法があるかどうか疑問に思いました。
直接使用することはありません__dict__が、インスタンスを明示的に「フリーズ」する関数を追加できます。
class FrozenClass(object):
__isfrozen = False
def __setattr__(self, key, value):
if self.__isfrozen and not hasattr(self, key):
raise TypeError( "%r is a frozen class" % self )
object.__setattr__(self, key, value)
def _freeze(self):
self.__isfrozen = True
class Test(FrozenClass):
def __init__(self):
self.x = 42#
self.y = 2**3
self._freeze() # no new attributes after this point.
a,b = Test(), Test()
a.x = 10
b.z = 10 # fails
pythonicの方法は、で遊ぶ代わりにスロットを使用すること__setter__です。問題は解決するかもしれませんが、パフォーマンスは向上しません。オブジェクトの属性はディクショナリ" __dict__"に格納されます。これが、これまでに作成したクラスのオブジェクトに属性を動的に追加できる理由です。属性ストレージにディクショナリを使用することは非常に便利ですが、インスタンス変数が少量しかないオブジェクトのスペースを浪費することを意味する場合があります。
スロットは、このスペース消費の問題を回避するための優れた方法です。スロットは、オブジェクトに属性を動的に追加できる動的なdictを使用する代わりに、インスタンスの作成後に追加を禁止する静的な構造を提供します。
クラスを設計するとき、スロットを使用して属性が動的に作成されないようにすることができます。スロットを定義するには、という名前のリストを定義する必要があります__slots__。リストには、使用するすべての属性が含まれている必要があります。これを次のクラスで示します。このクラスでは、スロットリストに属性「val」の名前のみが含まれています。
class S(object):
__slots__ = ['val']
def __init__(self, v):
self.val = v
x = S(42)
print(x.val)
x.new = "not possible"
=>属性「new」の作成に失敗しました：
42
Traceback (most recent call last):
File "slots_ex.py", line 12, in <module>
x.new = "not possible"
AttributeError: 'S' object has no attribute 'new'
ノート：
- Python 3.3以降、スペース消費を最適化する利点はそれほど印象的ではなくなりました。Python 3.3では、オブジェクトの保存にキー共有辞書が使用されます。インスタンスの属性は、内部ストレージの一部、つまりキーとそれに対応するハッシュを格納する部分を相互に共有できます。これは、組み込みタイプ以外の多くのインスタンスを作成するプログラムのメモリ消費を削減するのに役立ちます。しかし、それでも動的に作成された属性を回避する方法です。
- スロットの使用には、それ自体のコストも伴います。シリアル化が壊れます（例：ピクルス）。また、多重継承を壊します。クラスは、スロットを定義するか、Cコードで定義されたインスタンスレイアウト（list、tuple、intなど）を持つ複数のクラスから継承することはできません。
誰かがデコレータでそれを行うことに興味があるなら、ここに実用的な解決策があります：
from functools import wraps
def froze_it(cls):
cls.__frozen = False
def frozensetattr(self, key, value):
if self.__frozen and not hasattr(self, key):
print("Class {} is frozen. Cannot set {} = {}"
.format(cls.__name__, key, value))
else:
object.__setattr__(self, key, value)
def init_decorator(func):
@wraps(func)
def wrapper(self, *args, **kwargs):
func(self, *args, **kwargs)
self.__frozen = True
return wrapper
cls.__setattr__ = frozensetattr
cls.__init__ = init_decorator(cls.__init__)
return cls
使用するのは非常に簡単です：
@froze_it
class Foo(object):
def __init__(self):
self.bar = 10
foo = Foo()
foo.bar = 42
foo.foobar = "no way"
結果：
>>> Class Foo is frozen. Cannot set foobar = no way
実際には、あなたは望んでいません__setattr__、あなたは望んでいます__slots__。クラス本体に追加__slots__ = ('foo', 'bar', 'baz')すると、Pythonは、どのインスタンスにもfoo、bar、bazのみが存在することを確認します。ただし、ドキュメントリストの注意事項をお読みください。
適切な方法は、をオーバーライドすること__setattr__です。それがその目的です。
デコレータを使用するソリューションは、プロジェクト全体の多くのクラスで簡単に使用でき、クラスごとに最小限の追加で使用できるため、非常に気に入っています。ただし、継承ではうまく機能しません。これが私のバージョンです。__setattr__関数のみをオーバーライドします。属性が存在せず、呼び出し元の関数が__init __でない場合、エラーメッセージが出力されます。
import inspect
def froze_it(cls):
def frozensetattr(self, key, value):
if not hasattr(self, key) and inspect.stack()[1][3] != "__init__":
print("Class {} is frozen. Cannot set {} = {}"
.format(cls.__name__, key, value))
else:
self.__dict__[key] = value
cls.__setattr__ = frozensetattr
return cls
@froze_it
class A:
def __init__(self):
self._a = 0
a = A()
a._a = 1
a._b = 2 # error
これはどうですか：
class A():
__allowed_attr=('_x', '_y')
def __init__(self,x=0,y=0):
self._x=x
self._y=y
def __setattr__(self,attribute,value):
if not attribute in self.__class__.__allowed_attr:
raise AttributeError
else:
super().__setattr__(attribute,value)
pystrictは、クラスでフリーズするために使用できるこのstackoverflowの質問に触発されたpypiインストール可能なデコレータです。プロジェクトでmypyとpylintを実行している場合でも、このようなデコレータが必要な理由を示すREADMEの例があります。
pip install pystrict
次に、@strictデコレータを使用します。
from pystrict import strict
@strict
class Blah
def __init__(self):
self.attr = 1
これが私が思いついたアプローチで、initでfreeze（）するための_frozen属性やメソッドを必要としません。
init中に、すべてのクラス属性をインスタンスに追加するだけです。
_frozen、freeze（）がなく、_frozenもvars（instance）出力に表示されないため、これが気に入っています。
class MetaModel(type):
def __setattr__(self, name, value):
raise AttributeError("Model classes do not accept arbitrary attributes")
class Model(object):
__metaclass__ = MetaModel
# init will take all CLASS attributes, and add them as SELF/INSTANCE attributes
def __init__(self):
for k, v in self.__class__.__dict__.iteritems():
if not k.startswith("_"):
self.__setattr__(k, v)
# setattr, won't allow any attributes to be set on the SELF/INSTANCE that don't already exist
def __setattr__(self, name, value):
if not hasattr(self, name):
raise AttributeError("Model instances do not accept arbitrary attributes")
else:
object.__setattr__(self, name, value)
# Example using
class Dog(Model):
name = ''
kind = 'canine'
d, e = Dog(), Dog()
print vars(d)
print vars(e)
e.junk = 'stuff' # fails
JochenRitzelの「Frozen」が好きです。不便なのは、Classを出力するときにisfrozen変数が表示されることです。__dict この問題を回避するには、許可された属性のリストを作成します（スロットと同様）。
class Frozen(object):
__List = []
def __setattr__(self, key, value):
setIsOK = False
for item in self.__List:
if key == item:
setIsOK = True
if setIsOK == True:
object.__setattr__(self, key, value)
else:
raise TypeError( "%r has no attributes %r" % (self, key) )
class Test(Frozen):
_Frozen__List = ["attr1","attr2"]
def __init__(self):
self.attr1 = 1
self.attr2 = 1
FrozenClassby Jochen Ritzelはかっこいいですが、毎回クラスを初期化するときに呼び出すの_frozen()はそれほどかっこいいわけではありません（そして、それを忘れるリスクを冒す必要があります）。関数を追加しました__init_slots__：
class FrozenClass(object):
__isfrozen = False
def _freeze(self):
self.__isfrozen = True
def __init_slots__(self, slots):
for key in slots:
object.__setattr__(self, key, None)
self._freeze()
def __setattr__(self, key, value):
if self.__isfrozen and not hasattr(self, key):
raise TypeError( "%r is a frozen class" % self )
object.__setattr__(self, key, value)
class Test(FrozenClass):
def __init__(self):
self.__init_slots__(["x", "y"])
self.x = 42#
self.y = 2**3
a,b = Test(), Test()
a.x = 10
b.z = 10 # fails
オーバーライドのパフォーマンスへの影響については__setattr__、どの回答にも言及されていません。これは、多くの小さなオブジェクトを作成するときに問題になる可能性があります。（そして__slots__、パフォーマンスの高いソリューションになりますが、ピクルス/継承を制限します）。
だから私はinitの後に遅いsettatrをインストールするこのバリアントを思いついた：
class FrozenClass:
def freeze(self):
def frozen_setattr(self, key, value):
if not hasattr(self, key):
raise TypeError("Cannot set {}: {} is a frozen class".format(key, self))
object.__setattr__(self, key, value)
self.__setattr__ = frozen_setattr
class Foo(FrozenClass): ...
freezeの最後に呼び出したくない__init__場合、継承が問題である場合、または継承を望まない場合は、それを適応させることもできます。たとえば、次の回答vars()に基づくデコレータバージョンです。pystrict
import functools
def strict(cls):
cls._x_setter = getattr(cls, "__setattr__", object.__setattr__)
cls._x_init = cls.__init__
@functools.wraps(cls.__init__)
def wrapper(self, *args, **kwargs):
cls._x_init(self, *args, **kwargs)
def frozen_setattr(self, key, value):
if not hasattr(self, key):
raise TypeError("Class %s is frozen. Cannot set '%s'." % (cls.__name__, key))
cls._x_setter(self, key, value)
cls.__setattr__ = frozen_setattr
cls.__init__ = wrapper
return cls
@strict
class Foo: ...