在Python中创建单例

这个问题不是为了讨论单例设计模式是否可取、是否是一种反模式，或者是否用于任何宗教战争，而是为了讨论如何以最Python化的方式在Python中最好地实现这种模式。在这个例子中，我定义“最蟒蛇”是指它遵循“最少惊讶的原则”。

我有多个类将成为单类（我的用例是一个记录器，但这并不重要）。当我可以简单地继承或装饰时，我不希望在几个类中添加口香糖。

最佳方法：

方法1：装饰器

def singleton(class_):
    instances = {}
    def getinstance(*args, **kwargs):
        if class_ not in instances:
            instances[class_] = class_(*args, **kwargs)
        return instances[class_]
    return getinstance

@singleton
class MyClass(BaseClass):
    pass

Pros

装饰符的添加方式通常比多重继承更直观。

Cons

虽然使用MyClass（）创建的对象将是真正的单例对象，但MyClass本身是一个函数，而不是类，因此不能从中调用类方法x=MyClass（）；y=MyClass（）；t=类型（n）（）；

则x==y但x！=t&y！=吨

方法2：基类

class Singleton(object):
    _instance = None
    def __new__(class_, *args, **kwargs):
        if not isinstance(class_._instance, class_):
            class_._instance = object.__new__(class_, *args, **kwargs)
        return class_._instance

class MyClass(Singleton, BaseClass):
    pass

Pros

这是一门真正的课

Cons

多重继承-嗯__new__是否可以在从第二个基类继承期间被覆盖？一个人必须想得比必要的多。

方法3：元类

class Singleton(type):
    _instances = {}
    def __call__(cls, *args, **kwargs):
        if cls not in cls._instances:
            cls._instances[cls] = super(Singleton, cls).__call__(*args, **kwargs)
        return cls._instances[cls]

#Python2
class MyClass(BaseClass):
    __metaclass__ = Singleton

#Python3
class MyClass(BaseClass, metaclass=Singleton):
    pass

Pros

这是一门真正的课自动神奇地覆盖继承为正确的目的使用__metaclass__（并让我意识到）

Cons

有吗？

方法4：decorator返回同名类

def singleton(class_):
    class class_w(class_):
        _instance = None
        def __new__(class_, *args, **kwargs):
            if class_w._instance is None:
                class_w._instance = super(class_w,
                                    class_).__new__(class_,
                                                    *args,
                                                    **kwargs)
                class_w._instance._sealed = False
            return class_w._instance
        def __init__(self, *args, **kwargs):
            if self._sealed:
                return
            super(class_w, self).__init__(*args, **kwargs)
            self._sealed = True
    class_w.__name__ = class_.__name__
    return class_w

@singleton
class MyClass(BaseClass):
    pass

Pros

这是一门真正的课自动神奇地覆盖继承

Cons

创建每个新类是否没有开销？在这里，我们为每个希望成为单例的类创建两个类。虽然这对我来说很好，但我担心这可能无法扩展。当然，对于这种模式的规模是否太容易，还有争议。。。_seled属性的意义是什么无法使用super（）在基类上调用同名方法，因为它们将递归。这意味着您不能自定义__new__，也不能对需要调用__init__的类进行子类化。

方法5：模块

模块文件singleton.py

Pros

简单胜于复杂

Cons

未延迟实例化

当前回答

我将推荐一个使用元类的优雅解决方案

class Singleton(type): 
    # Inherit from "type" in order to gain access to method __call__
    def __init__(self, *args, **kwargs):
        self.__instance = None # Create a variable to store the object reference
        super().__init__(*args, **kwargs)

    def __call__(self, *args, **kwargs):
        if self.__instance is None:
            # if the object has not already been created
            self.__instance = super().__call__(*args, **kwargs) # Call the __init__ method of the subclass (Spam) and save the reference
            return self.__instance
        else:
            # if object (Spam) reference already exists; return it
            return self.__instance

class Spam(metaclass=Singleton):
    def __init__(self, x):
        print('Creating Spam')
        self.x = x


if __name__ == '__main__':
    spam = Spam(100)
    spam2 = Spam(200)

输出：

Creating Spam

从输出中可以看到，只有一个对象被实例化

2020-08-19 08:42:18

其他回答

您只需要一个装饰器，具体取决于python版本：

Python 3.2+

实施

from functools import lru_cache

@lru_cache(maxsize=None)
class CustomClass(object):

    def __init__(self, arg):
        print(f"CustomClass initialised with {arg}")
        self.arg = arg

用法

c1 = CustomClass("foo")
c2 = CustomClass("foo")
c3 = CustomClass("bar")

print(c1 == c2)
print(c1 == c3)

输出

>>> CustomClass initialised with foo
>>> CustomClass initialised with bar
>>> True
>>> False

注意foo只打印一次

Python 3.9+

实施：

from functools import cache

@cache
class CustomClass(object):
    ...

2022-10-07 14:31:02

我不记得我在哪里找到了这个解决方案，但从我的非Python专家的角度来看，我发现它是最“优雅”的：

class SomeSingleton(dict):
    __instance__ = None
    def __new__(cls, *args,**kwargs):
        if SomeSingleton.__instance__ is None:
            SomeSingleton.__instance__ = dict.__new__(cls)
        return SomeSingleton.__instance__

    def __init__(self):
        pass

    def some_func(self,arg):
        pass

我为什么喜欢这个？没有修饰符，没有元类，没有多重继承。。。如果你决定不再让它成为单身汉，就删除__new__方法。由于我刚接触Python（以及OOP），我希望有人能告诉我为什么这是一种可怕的方法？

2014-11-11 05:38:12

这是给你的一句话：

singleton = lambda c: c()

以下是您的使用方法：

@singleton
class wat(object):
    def __init__(self): self.x = 1
    def get_x(self): return self.x

assert wat.get_x() == 1

您的对象会被急切地实例化。这可能是你想要的，也可能不是你想要的。

2013-10-19 14:43:33

方法3看起来很整洁，但如果您希望程序同时在Python2和Python3中运行，它就不起作用了。即使使用Python版本的测试来保护单独的变体也失败了，因为Python 3版本在Python 2中给出了语法错误。

感谢Mike Watkins：http://mikewatkins.ca/2008/11/29/python-2-and-3-metaclasses/.如果您希望程序同时在Python 2和Python 3中运行，则需要执行以下操作：

class Singleton(type):
    _instances = {}
    def __call__(cls, *args, **kwargs):
        if cls not in cls._instances:
            cls._instances[cls] = super(Singleton, cls).__call__(*args, **kwargs)
        return cls._instances[cls]

MC = Singleton('MC', (object), {})

class MyClass(MC):
    pass    # Code for the class implementation

我假设赋值中的“object”需要替换为“BaseClass”，但我还没有尝试过（我已经尝试了如图所示的代码）。

2013-07-24 17:06:05

正如@Staale在这里提到的，在python中创建单例的最简单方法是使用带有全局变量的模块（作为“属性”，而全局函数作为“方法”）。但我想为这个已经令人惊叹的答案补充一点非常重要的东西：继承也在这里发挥作用！

要创建一个继承自另一个“singleton module”a.py的“singleton模块”B.py，只需使用以下行启动B.py：from a import*，这将尊重私有变量（默认情况下不导入它们）。

2022-05-30 20:00:36

在Python中创建单例

推荐文章

最新文章

标签