Python でシングルトンを定義する方法はたくさんあるようです。Stack Overflow についてコンセンサス意見はありますか?
21 に答える
関数を含むモジュール(クラスではない)はシングルトンとしてうまく機能するため、実際には必要性がわかりません。そのすべての変数はモジュールにバインドされ、繰り返しインスタンス化することはできませんでした。
クラスを使用したい場合、Python でプライベート クラスまたはプライベート コンストラクターを作成する方法がないため、API を使用する際の慣例以外に、複数のインスタンス化から保護することはできません。私はまだメソッドをモジュールに入れ、モジュールをシングルトンと見なします。
これが私自身のシングルトンの実装です。クラスを装飾するだけです。シングルトンを取得するには、Instance
メソッドを使用する必要があります。次に例を示します。
@Singleton
class Foo:
def __init__(self):
print 'Foo created'
f = Foo() # Error, this isn't how you get the instance of a singleton
f = Foo.instance() # Good. Being explicit is in line with the Python Zen
g = Foo.instance() # Returns already created instance
print f is g # True
コードは次のとおりです。
class Singleton:
"""
A non-thread-safe helper class to ease implementing singletons.
This should be used as a decorator -- not a metaclass -- to the
class that should be a singleton.
The decorated class can define one `__init__` function that
takes only the `self` argument. Also, the decorated class cannot be
inherited from. Other than that, there are no restrictions that apply
to the decorated class.
To get the singleton instance, use the `instance` method. Trying
to use `__call__` will result in a `TypeError` being raised.
"""
def __init__(self, decorated):
self._decorated = decorated
def instance(self):
"""
Returns the singleton instance. Upon its first call, it creates a
new instance of the decorated class and calls its `__init__` method.
On all subsequent calls, the already created instance is returned.
"""
try:
return self._instance
except AttributeError:
self._instance = self._decorated()
return self._instance
def __call__(self):
raise TypeError('Singletons must be accessed through `instance()`.')
def __instancecheck__(self, inst):
return isinstance(inst, self._decorated)
__new__
次のようにメソッドをオーバーライドできます。
class Singleton(object):
_instance = None
def __new__(cls, *args, **kwargs):
if not cls._instance:
cls._instance = super(Singleton, cls).__new__(
cls, *args, **kwargs)
return cls._instance
if __name__ == '__main__':
s1 = Singleton()
s2 = Singleton()
if (id(s1) == id(s2)):
print "Same"
else:
print "Different"
Python でシングルトンを実装するための少し異なるアプローチは、Alex Martelli (Google 社員で Python の天才) によるborg パターンです。
class Borg:
__shared_state = {}
def __init__(self):
self.__dict__ = self.__shared_state
したがって、すべてのインスタンスに同じ ID を強制する代わりに、状態を共有します。
モジュールアプローチはうまく機能します。シングルトンが絶対に必要な場合は、メタクラスのアプローチを好みます。
class Singleton(type):
def __init__(cls, name, bases, dict):
super(Singleton, cls).__init__(name, bases, dict)
cls.instance = None
def __call__(cls,*args,**kw):
if cls.instance is None:
cls.instance = super(Singleton, cls).__call__(*args, **kw)
return cls.instance
class MyClass(object):
__metaclass__ = Singleton
デコレータを使用してシングルトン パターンを実装するPEP318のこの実装を参照してください。
def singleton(cls):
instances = {}
def getinstance():
if cls not in instances:
instances[cls] = cls()
return instances[cls]
return getinstance
@singleton
class MyClass:
...
Pythonのドキュメントはこれをカバーしています:
class Singleton(object):
def __new__(cls, *args, **kwds):
it = cls.__dict__.get("__it__")
if it is not None:
return it
cls.__it__ = it = object.__new__(cls)
it.init(*args, **kwds)
return it
def init(self, *args, **kwds):
pass
おそらく次のように書き直します。
class Singleton(object):
"""Use to create a singleton"""
def __new__(cls, *args, **kwds):
"""
>>> s = Singleton()
>>> p = Singleton()
>>> id(s) == id(p)
True
"""
it_id = "__it__"
# getattr will dip into base classes, so __dict__ must be used
it = cls.__dict__.get(it_id, None)
if it is not None:
return it
it = object.__new__(cls)
setattr(cls, it_id, it)
it.init(*args, **kwds)
return it
def init(self, *args, **kwds):
pass
class A(Singleton):
pass
class B(Singleton):
pass
class C(A):
pass
assert A() is A()
assert B() is B()
assert C() is C()
assert A() is not B()
assert C() is not B()
assert C() is not A()
これを拡張するのは比較的きれいなはずです:
class Bus(Singleton):
def init(self, label=None, *args, **kwds):
self.label = label
self.channels = [Channel("system"), Channel("app")]
...
受け入れられた答えが言うように、最も慣用的な方法は、モジュールを使用することです。
これを念頭に置いて、概念実証を次に示します。
def singleton(cls):
obj = cls()
# Always return the same object
cls.__new__ = staticmethod(lambda cls: obj)
# Disable __init__
try:
del cls.__init__
except AttributeError:
pass
return cls
の詳細については、Pythonデータモデルを参照してください__new__
。
例:
@singleton
class Duck(object):
pass
if Duck() is Duck():
print "It works!"
else:
print "It doesn't work!"
ノート:
これには、新しいスタイルのクラス(から派生
object
)を使用する必要があります。シングルトンは、最初に使用されるときではなく、定義されたときに初期化されます。
これは単なるおもちゃの例です。私はこれを本番コードで実際に使用したことはなく、使用する予定もありません。
Python でシングルトンを書いたとき、すべてのメンバ関数が classmethod デコレータを持つクラスを使用しました。
class Foo:
x = 1
@classmethod
def increment(cls, y=1):
cls.x += y
今後クラスを装飾 (注釈) したい場合は、シングルトン デコレータ (別名、注釈) を作成するのがエレガントな方法です。次に、クラス定義の前に @singleton を置きます。
def singleton(cls):
instances = {}
def getinstance():
if cls not in instances:
instances[cls] = cls()
return instances[cls]
return getinstance
@singleton
class MyClass:
...
また、Google Testing ブログには興味深い記事がいくつかあり、シングルトンが悪い/悪い可能性があり、アンチパターンである理由について説明しています。
クラスまたはインスタンスをシングルトンにするのはやり過ぎだと思います。個人的には、通常のインスタンス化可能なクラス、セミプライベート参照、および単純なファクトリ関数を定義するのが好きです。
class NothingSpecial:
pass
_the_one_and_only = None
def TheOneAndOnly():
global _the_one_and_only
if not _the_one_and_only:
_the_one_and_only = NothingSpecial()
return _the_one_and_only
または、モジュールが最初にインポートされたときのインスタンス化に問題がない場合:
class NothingSpecial:
pass
THE_ONE_AND_ONLY = NothingSpecial()
そうすれば、副作用なしに新しいインスタンスに対してテストを作成でき、モジュールにグローバルステートメントを振りかける必要はなく、必要に応じて、将来的にバリアントを派生させることができます。
ActiveStateの厚意によりPythonで実装されたシングルトンパターン。
トリックは、1つのインスタンスのみを持つことになっているクラスを別のクラス内に配置することのようです。
わかりました、シングルトンは善にも悪にもなり得ます。これは私の実装であり、従来のアプローチを拡張して内部にキャッシュを導入し、異なる型のインスタンスを多数生成するか、同じ型の多数のインスタンスを異なる引数で生成します。
これを Singleton_group と呼びました。これは、同様のインスタンスをグループ化し、同じ引数を持つ同じクラスのオブジェクトが作成されるのを防ぐためです。
# Peppelinux's cached singleton
class Singleton_group(object):
__instances_args_dict = {}
def __new__(cls, *args, **kwargs):
if not cls.__instances_args_dict.get((cls.__name__, args, str(kwargs))):
cls.__instances_args_dict[(cls.__name__, args, str(kwargs))] = super(Singleton_group, cls).__new__(cls, *args, **kwargs)
return cls.__instances_args_dict.get((cls.__name__, args, str(kwargs)))
# It's a dummy real world use example:
class test(Singleton_group):
def __init__(self, salute):
self.salute = salute
a = test('bye')
b = test('hi')
c = test('bye')
d = test('hi')
e = test('goodbye')
f = test('goodbye')
id(a)
3070148780L
id(b)
3070148908L
id(c)
3070148780L
b == d
True
b._Singleton_group__instances_args_dict
{('test', ('bye',), '{}'): <__main__.test object at 0xb6fec0ac>,
('test', ('goodbye',), '{}'): <__main__.test object at 0xb6fec32c>,
('test', ('hi',), '{}'): <__main__.test object at 0xb6fec12c>}
すべてのオブジェクトはシングルトンキャッシュを持っています...これは悪いことかもしれませんが、一部の人にとってはうまく機能します:)
class Singleton(object[,...]):
staticVar1 = None
staticVar2 = None
def __init__(self):
if self.__class__.staticVar1==None :
# create class instance variable for instantiation of class
# assign class instance variable values to class static variables
else:
# assign class static variable values to class instance variables
シングルトンの異母兄弟
私はstaaleに完全に同意し、シングルトンのハーフブラザーを作成するサンプルをここに残します。
class void:pass
a = void();
a.__class__ = Singleton
a
シングルトンのように見えなくても、シングルトンと同じクラスであると報告されます。したがって、複雑なクラスを使用するシングルトンは、それらをあまり混乱させないことに依存することになります。
そうすることで、同じ効果を得ることができ、変数やモジュールなどのより単純なものを使用できます。それでも、わかりやすくするためにクラスを使用したい場合、およびPythonではクラスはオブジェクトであるため、すでにオブジェクトがあります(インスタンスではありませんが、同じように機能します)。
class Singleton:
def __new__(cls): raise AssertionError # Singletons can't have instances
インスタンスを作成しようとすると、素晴らしいアサーションエラーが発生します。派生静的メンバーに保存して、実行時に変更を加えることができます(Pythonが大好きです)。このオブジェクトは、他の約半兄弟と同じくらい優れています(必要に応じて作成できます)が、単純さのために実行速度が速くなる傾向があります。
関数パラメーターのデフォルト値に基づく私の単純な解決策。
def getSystemContext(contextObjList=[]):
if len( contextObjList ) == 0:
contextObjList.append( Context() )
pass
return contextObjList[0]
class Context(object):
# Anything you want here
Python には比較的慣れていないので、最も一般的な慣用句が何であるかはわかりませんが、私が考えることができる最も簡単なことは、クラスの代わりにモジュールを使用することです。クラスのインスタンス メソッドだったものはモジュール内の単なる関数になり、すべてのデータはクラスのメンバーではなくモジュール内の変数になります。これは、人々がシングルトンを使用するタイプの問題を解決するための Pythonic アプローチだと思います。
本当にシングルトン クラスが必要な場合は、「Python シングルトン」のGoogle での最初のヒットで説明されている合理的な実装があります。具体的には次のとおりです。
class Singleton:
__single = None
def __init__( self ):
if Singleton.__single:
raise Singleton.__single
Singleton.__single = self
それはトリックを行うようです。
class Singeltone(type):
instances = dict()
def __call__(cls, *args, **kwargs):
if cls.__name__ not in Singeltone.instances:
Singeltone.instances[cls.__name__] = type.__call__(cls, *args, **kwargs)
return Singeltone.instances[cls.__name__]
class Test(object):
__metaclass__ = Singeltone
inst0 = Test()
inst1 = Test()
print(id(inst1) == id(inst0))
上記のメタクラスベースのソリューションが不要で、単純な関数デコレータベースのアプローチが気に入らない場合(たとえば、シングルトンクラスの静的メソッドが機能しないため)、この妥協点は機能します。
class singleton(object):
"""Singleton decorator."""
def __init__(self, cls):
self.__dict__['cls'] = cls
instances = {}
def __call__(self):
if self.cls not in self.instances:
self.instances[self.cls] = self.cls()
return self.instances[self.cls]
def __getattr__(self, attr):
return getattr(self.__dict__['cls'], attr)
def __setattr__(self, attr, value):
return setattr(self.__dict__['cls'], attr, value)