是否有一种简单,优雅的方式来定义单身人士?

时间:2008-08-28 09:03:10

标签: python design-patterns singleton

似乎有很多方法可以在Python中定义singletons。 Stack Overflow是否有共识?

22 个答案:

答案 0 :(得分:337)

我并不真正看到需要,因为具有函数(而不是类)的模块可以很好地用作单例。它的所有变量都将绑定到模块,无论如何都无法重复实例化。

如果您确实希望使用类,则无法在Python中创建私有类或私有构造函数,因此除了仅使用API​​的约定之外,您无法防止多个实例化。我仍然只是将方法放在一个模块中,并将模块视为单例。

答案 1 :(得分:285)

这是我自己实现的单身人士。你所要做的就是装饰课程;要获得单例,您必须使用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)

答案 2 :(得分:181)

您可以像这样覆盖__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"

答案 3 :(得分:106)

在Python中实现单例的略微不同的方法是Alex Martelli(Google员工和Python天才)的borg pattern

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

因此,它们不是强制所有实例具有相同的身份,而是共享状态。

答案 4 :(得分:79)

模块方法效果很好。如果我绝对需要单身人士,我更喜欢Metaclass方法。

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

答案 5 :(得分:42)

PEP318看这个实现,用装饰器实现单例模式:

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

@singleton
class MyClass:
    ...

答案 6 :(得分:26)

正如accepted answer所说,最惯用的方法是使用模块

考虑到这一点,这是一个概念证明:

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

有关__new__的详细信息,请参阅Python data model

示例:

@singleton
class Duck(object):
    pass

if Duck() is Duck():
    print "It works!"
else:
    print "It doesn't work!"

注意:

  1. 您必须使用新式类(从object派生)。

  2. 单例在定义时初始化,而不是第一次使用。

  3. 这只是一个玩具示例。我从来没有在生产代码中实际使用它,也不打算。

答案 7 :(得分:16)

我对此非常不确定,但我的项目使用'常规单例'(非强制单例),也就是说,如果我有一个名为DataController的类,我在同一个模块中定义它:

_data_controller = None
def GetDataController():
    global _data_controller
    if _data_controller is None:
        _data_controller = DataController()
    return _data_controller

它不优雅,因为它是完整的六行。但我所有的单身人士都使用这种模式,至少非常明确(这是pythonic)。

答案 8 :(得分:14)

有一次我在Python中编写了一个单例,我使用了一个类,其中所有成员函数都有classmethod装饰器。

class foo:
  x = 1

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

答案 9 :(得分:14)

Python documentation确实涵盖了这一点:

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")]
        ...

答案 10 :(得分:9)

谷歌测试博客上也有一些有趣的文章,讨论为什么单身人士/可能是坏人并且是反模式的:

答案 11 :(得分:9)

如果要进行装饰(注释)类,创建单例装饰器(也称为注释)是一种优雅的方法。然后你就把@singleton放在你的类定义之前。

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

@singleton
class MyClass:
    ...

答案 12 :(得分:7)

以下是Peter Norvig的Python IAQ How do I do the Singleton Pattern in Python?的示例(您应该使用浏览器的搜索功能来查找此问题,没有直接链接,抱歉)

Bruce Eckel在他的书Thinking in Python中还有另一个例子(同样没有直接链接到代码)

答案 13 :(得分:5)

我认为强制一个类或一个实例是一个单例是过度的。就个人而言,我喜欢定义一个普通的可实例化类,一个半私有引用和一个简单的工厂函数。

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

通过这种方式,您可以针对没有副作用的新实例编写测试,并且不需要在模块中添加全局语句,如果需要,您可以在将来派生变体。

答案 14 :(得分:3)

The Singleton Pattern implemented with Python由ActiveState提供。

看起来诀窍就是把那个应该只有一个实例的类放在另一个类中。

答案 15 :(得分:3)

相对较新的Python我不知道最常见的成语是什么,但我能想到的最简单的事情就是使用模块而不是类。你的类上的实例方法将成为模块中的函数,任何数据都只是模块中的变量而不是类的成员。我怀疑这是解决人们使用单身人士问题类型的pythonic方法。

如果你真的想要一个单例类,那么first hit on Google为“Python单例”描述了一个合理的实现,特别是:

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

这似乎可以解决问题。

答案 16 :(得分:3)

好吧,单身可能是善恶,我知道。这是我的实现,我只是扩展了一种经典方法,在内部引入了一个缓存,并生成了许多不同类型的实例,或者许多相同类型但具有不同参数的实例。

我称之为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>}

每个对象都带有单例缓存...这可能是邪恶的,但对某些人来说效果很好:)。

答案 17 :(得分:2)

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

答案 18 :(得分:2)

我的简单解决方案,它基于函数参数的默认值。

def getSystemContext(contextObjList=[]):
    if len( contextObjList ) == 0:
        contextObjList.append( Context() )
        pass
    return contextObjList[0]

class Context(object):
    # Anything you want here

答案 19 :(得分:2)

辛格尔顿的同父异母兄弟

我完全赞同staale,我在这里留下了一个创建单身兄弟的样本:

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

a现在将报告与单身人士属于同一类,即使它看起来不像。所以使用复杂类的单身人士最终取决于我们不会对他们造成太大的影响。

这样,我们可以产生相同的效果,并使用更简单的东西,如变量或模块。尽管如此,如果我们想要使用类来清晰起见,并且因为Python中的类是一个对象,那么我们已经有了对象(不是和实例,但它会像这样)。

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

如果我们尝试创建一个实例,那么我们就会有一个很好的断言错误,我们可以在派生上存储静态成员并在运行时对它们进行更改(我喜欢Python)。这个对象和其他半兄弟一样好(如果你愿意,你仍然可以创建它们),但是由于简单,它会更快地运行。

答案 20 :(得分:1)

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

答案 21 :(得分:0)

如果您不想使用上面基于元类的解决方案,并且您不喜欢基于简单函数装饰器的方法(例如,因为在这种情况下,单例类上的静态方法将不起作用),妥协工作:

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)