How to Create Singleton Class with a Decorator in Python
A singleton is a pattern that restricts the instantiation of a class to one instance/object. Using a decorator, we can define a class as a singleton by forcing the class to either return an existing instance of the class or create a new instance (if it doesn't exist).
def singleton(cls): instance = [None] def wrapper(*args, **kwargs): if instance is None: instance = cls(*args, **kwargs) return instance return wrapper
This decorator can be added to any class declaration and will make sure that at most one instance of the class is created. Any subsequent calls will return the already existing class instance.
@singleton class SomeSingletonClass: x = 2 def __init__(self): print("Created!") instance = SomeSingletonClass() # prints: Created! instance = SomeSingletonClass() # doesn't print anything print(instance.x) # 2 instance.x = 3 print(SomeSingletonClass().x) # 3
So it doesn't matter whether you refer to the class instance via your local variable or whether you create another "instance", you always get the same object.