bundles / traitlets 5.15.0 / traitlets / config / configurable / SingletonConfigurable / instance

classmethod

`traitlets.config.configurable:SingletonConfigurable.instance`

source: /traitlets/config/configurable.py :553

Summary

Returns a global instance of this class.

Extended Summary

This method create a new instance if none have previously been created and returns a previously created instance is one already exists.

The arguments and keyword arguments passed to this method are passed on to the __init__ method of the class upon instantiation.

Examples

Create a singleton class using instance, and retrieve it::

from traitlets.config.configurable import SingletonConfigurable
class Foo(SingletonConfigurable): pass
foo = Foo.instance()
foo == Foo.instance()

Create a subclass that is retrieved using the base class instance::

class Bar(SingletonConfigurable): pass
class Bam(Bar): pass
bam = Bam.instance()
bam == Bar.instance()

Aliases

traitlets.config.SingletonConfigurable.instance

Referenced by

This package