是否有简单、优雅的方法来定义单例对象?

在Python中似乎有很多方法来定义单例。对Stack Overflow是否有共识?

413994 次浏览

作为Python的新手,我不确定最常见的习语是什么,但我能想到的最简单的事情就是使用模块而不是类。类中的实例方法变成了模块中的函数,任何数据都变成了模块中的变量,而不是类的成员。我怀疑这是解决人们使用单例对象的问题的python方法。

如果你真的想要一个单例类,有一个合理的实现在第一次点击谷歌中描述了"Python singleton",具体来说:

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

这似乎奏效了。

我真的不认为有这个需要,因为一个带有函数(而不是类)的模块可以很好地作为一个单例。它的所有变量都将绑定到模块,无论如何都不能重复实例化。

如果你确实希望使用一个类,在Python中没有办法创建私有类或私有构造函数,所以你不能防止多个实例化,只能通过使用API中的约定。我仍然会将方法放在模块中,并将模块视为单例模块。

在Python中实现单例的稍微不同的方法是Alex Martelli(谷歌员工和Python天才)的borg模式

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

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

模块方法工作得很好。如果我绝对需要一个单例,我更喜欢元类方法。

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

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

class Foo:
x = 1
  

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

用Python实现的单例模式由ActiveState提供。

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

谷歌Testing博客上也有一些有趣的文章,讨论了为什么单例是/可能是不好的,并且是一种反模式:

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

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

它并不优雅,因为它足足有六行。但是我所有的单例都使用这个模式,而且它至少是非常显式的(这是python的)。

你可以像这样重写__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"
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:
...

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

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

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

这是我自己对单例对象的实现。你所要做的就是布置课堂;为了获得单例对象,你必须使用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)

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

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)

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

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


class Context(object):
# Anything you want here

如果你想继续装饰(注释)类,创建一个单例装饰器(又名注释)是一种优雅的方式。然后将@singleton放在类定义之前。

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


@singleton
class MyClass:
...

好吧,我知道,单胞胎可能是好的,也可能是坏的。这是我的实现,我只是扩展了一个经典的方法,在里面引入一个缓存,并产生许多不同类型的实例,或者许多相同类型的实例,但具有不同的参数。

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

每个对象都携带单例缓存…这可能是邪恶的,但对一些人来说很有用:)

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

正如接受的答案所说,最习惯的方法是使用模块

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

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数据模型

例子:

@singleton
class Duck(object):
pass


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

注:

  1. 为此你必须使用new-style类(派生自object)。

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

  3. 这只是一个简单的例子。我从未在产品代码中实际使用过它,也不打算这样做。

辛格尔顿同父异母的兄弟

我完全同意staale的观点,我在这里留下了一个创建单胎同父异母兄弟的例子:

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

a现在报告为与单例对象属于同一个类,即使它看起来不像单例对象。因此,使用复杂类的单例最终依赖于我们没有过多地干扰它们。

因此,我们可以使用更简单的东西,如变量或模块,以达到同样的效果。不过,如果我们想要使用类来明确,并且因为在Python中,类是一个对象,所以我们已经有了对象(不是和实例,但它会像)。

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

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