[Python] シングルトンを定義するシンプルでエレガントな方法はありますか?


Answers

ここに私自身のシングルトンの実装があります。 クラスを飾るだけです。 シングルトンを取得するには、 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)
Question

Pythonでシングルトンを定義する方法はたくさんあるようです。 に関するコンセンサスの意見はありますか?




私は、クラスやインスタンスを強制的にシングルトンにすることは過度のことだと思います。 個人的には、私は、通常のインスタンス化可能クラス、準プライベート参照、および単純なファクトリ関数を定義するのが好きです。

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()

そうすれば、副作用のない新鮮なインスタンスに対してテストを書くことができ、グローバルステートメントでモジュールを振りかざす必要はなく、必要に応じて将来的にバリアントを派生させることができます。




シングルトンデコレータ(別名アノテーション)を作成することは、クラスを前方に装飾(アノテーション)したい場合には、エレガントな方法です。 次に、クラス定義の前に@singletonを置くだけです。

def singleton(cls):
    instances = {}
    def getinstance():
        if cls not in instances:
            instances[cls] = cls()
        return instances[cls]
    return getinstance

@singleton
class MyClass:
    ...



上記のメタクラスベースのソリューションが欲しくなく、シンプルな関数デコレータベースのアプローチが嫌いな場合(例えば、シングルトンクラスの静的メソッドが機能しないため)、この妥協は機能します:

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)



私がPythonでシングルトンを書いたのは、すべてのメンバ関数がclassmethodデコレータを持つクラスを使用したときです。

class foo:
  x = 1

  @classmethod
  def increment(cls, y = 1):
    cls.x += y



シングルトンの兄弟

私は完全にstaaleに同意し、私はシングルトン半分の兄弟を作成するサンプルを残します:

class void:pass
a = void();
a.__class__ = Singleton

aは、今のように見えなくても、シングルトンと同じクラスでaと報告します。 したがって、複雑なクラスを使用するシングルトンは、私たちがそれらをあまり混乱させないようにすることによって終わります。

そうであれば、変数やモジュールのような簡単なものを使うこともできます。 それでも、明快にするためクラスを使用したい場合や、Pythonではクラスがオブジェクトであるため、既にオブジェクトを持っています(インスタンスではなくインスタンスも同様です)。

class Singleton:
    def __new__(cls): raise AssertionError # Singletons can't have instances

インスタンスを作成しようとすると、素敵なアサーションエラーが発生し、実行時に静的メンバーの派生物を保存して変更することができます(私はPythonが大好きです)。 このオブジェクトは他の約半分の兄弟ほど優れています(望むならまだ作成できます)が、シンプルさのために速く実行される傾向があります。




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
        """
        self = "__self__"
        if not hasattr(cls, self):
            instance = object.__new__(cls)
            instance.init(*args, **kwds)
            setattr(cls, self, instance)
        return getattr(cls, self)

    def init(self, *args, **kwds):
        pass

これを拡張するのは比較的クリーンでなければなりません:

class Bus(Singleton):
    def init(self, label=None, *args, **kwds):
        self.label = label
        self.channels = [Channel("system"), Channel("app")]
        ...



Pythonに比較的新しいことは、最も一般的なイディオムが何であるか分かりませんが、私が考えることのできる最も簡単なことは、クラスの代わりにモジュールを使用することだけです。 あなたのクラスのインスタンスメソッドは、モジュール内の単なる関数になり、データはクラスのメンバーではなくモジュール内の変数になります。 私はこれが、人々がシングルトンを使用する問題のタイプを解決するためのpythonicアプローチだと考えています。

シングルトンクラスが本当に必要な場合は、Googleの「Pythonシングルトン」の最初のヒットで説明した合理的な実装があります

class Singleton:
    __single = None
    def __init__( self ):
        if Singleton.__single:
            raise Singleton.__single
        Singleton.__single = self

それはトリックを行うようだ。




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



デコレータでシングルトンパターンを実装するPEP318からこの実装を見てください:

def singleton(cls):
    instances = {}
    def getinstance():
        if cls not in instances:
            instances[cls] = cls()
        return instances[cls]
    return getinstance

@singleton
class MyClass:
    ...



Pythonでシングルトンを実装するためのやや異なるアプローチはAlex Martelli(Googleの従業員とPythonの天才)のborgパターンです。

class Borg:
    __shared_state = {}
    def __init__(self):
        self.__dict__ = self.__shared_state

したがって、すべてのインスタンスが同じIDを持つように強制するのではなく、状態を共有します。