Есть ли простой, элегантный способ определения синглетонов?
Кажется, есть много способов определения синглетонов в Python. Есть ли общее мнение о переполнении стека?
22 ответа
Я на самом деле не вижу необходимости, так как модуль с функциями (а не классом) будет хорошо работать как одиночка. Все его переменные будут связаны с модулем, который в любом случае не может быть создан повторно.
Если вы действительно хотите использовать класс, в 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 - это шаблон Борга Алекса Мартелли (сотрудник Google и гений Python).
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
Посмотрите эту реализацию из 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
"""
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")]
...
Я очень не уверен в этом, но мой проект использует "условные синглтоны" (не обязательные синглтоны), то есть, если у меня есть класс с именем DataControllerЯ определяю это в том же модуле:
_data_controller = None
def GetDataController():
global _data_controller
if _data_controller is None:
_data_controller = DataController()
return _data_controller
Это не элегантно, так как это целых шесть строк. Но все мои синглтоны используют этот паттерн, и он, по крайней мере, очень явный (питонический).
Как говорится в принятом ответе, самый идиоматический способ - просто использовать модуль.
Имея это в виду, вот подтверждение концепции:
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, я использовал класс, в котором все функции-члены имели декоратор метода класса.
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()
Таким образом, вы можете писать тесты для свежих экземпляров без побочных эффектов, и нет необходимости добавлять модуль в глобальные операторы, а при необходимости вы можете получить варианты в будущем.
Вот пример из Питера Норвига из Python IAQ. Как мне сделать Singleton Pattern в Python? (Вы должны использовать функцию поиска вашего браузера, чтобы найти этот вопрос, прямой ссылки нет, извините)
Также у Брюса Экеля есть другой пример в его книге " Размышление на Python" (опять же, нет прямой ссылки на код)
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))
Будучи относительно новым для Python, я не уверен, какова самая распространенная идиома, но самое простое, что я могу придумать, это просто использовать модуль вместо класса. То, что было бы методами экземпляра в вашем классе, стало просто функциями в модуле, а любые данные просто стали переменными в модуле, а не членами класса. Я подозреваю, что это питонический подход к решению проблемы, для которой люди используют синглтоны.
Если вы действительно хотите одноэлементный класс, есть разумная реализация, описанная в первом обращении к Google для "Python singleton", а именно:
class Singleton:
__single = None
def __init__( self ):
if Singleton.__single:
raise Singleton.__single
Singleton.__single = self
Это, кажется, делает трюк.
Шаблон Singleton, реализованный с помощью Python, предоставлен ActiveState.
Похоже, хитрость заключается в том, чтобы поместить класс, который должен иметь только один экземпляр, внутри другого класса.
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
Хорошо, синглтон может быть хорошим или злым, я знаю. Это моя реализация, и я просто расширяю классический подход, чтобы ввести кэш внутри и создать много экземпляров другого типа или много экземпляров одного типа, но с разными аргументами.
Я назвал его 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>}
Каждый объект несет в себе одноэлементный кеш... Это может быть зло, но для некоторых оно прекрасно работает:)
Мое простое решение, основанное на значении параметров функции по умолчанию.
def getSystemContext(contextObjList=[]):
if len( contextObjList ) == 0:
contextObjList.append( Context() )
pass
return contextObjList[0]
class Context(object):
# Anything you want here
Сводный брат Синглтона
Я полностью согласен с Staale и оставляю здесь пример создания сводного брата-одиночки:
class void:pass
a = void();
a.__class__ = Singleton
a теперь будет сообщать, что он того же класса, что и синглтон, даже если он не похож на него. Таким образом, одиночные игры, использующие сложные классы, заканчиваются тем, что мы мало с ними связываемся
Таким образом, мы можем иметь тот же эффект и использовать более простые вещи, такие как переменная или модуль. Тем не менее, если мы хотим использовать классы для ясности и потому, что в Python класс является объектом, поэтому у нас уже есть объект (не экземпляр и не экземпляр, но он будет работать так же, как и он).
class Singleton:
def __new__(cls): raise AssertionError # Singletons can't have instances
Там у нас есть хорошая ошибка утверждения, если мы пытаемся создать экземпляр, и мы можем хранить на деривациях статические члены и вносить в них изменения во время выполнения (я люблю Python). Этот объект так же хорош, как и другие его сводные братья (вы все равно можете создавать их, если хотите), однако из-за простоты он будет работать быстрее.
В тех случаях, когда вам не нужно решение на основе метакласса, описанное выше, и вам не нравится простой подход, основанный на декораторе функций (например, потому что в этом случае статические методы в классе singleton не будут работать), этот компромисс работает:
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)