fiftyone.core.singletons.DocumentSingleton

class documentation

class DocumentSingleton(type): (source)

Known subclasses: fiftyone.core.singletons.FrameSingleton, fiftyone.core.singletons.SampleSingleton

Singleton metaclass interface for fiftyone.core.document.Document subclasses.

The methods declared by this interface are used by the fiftyone.core.document.Document class to manage all instances of a class that implements this type.

Method	`_get_instance`	Retrieves the `fiftyone.core.document.Document` instance for the given document, if one exists.
Method	`_register_instance`	Registers the given instance in the weakref dictionary.
Method	`_reload_instance`	Reloads the backing document for the given instance (or view), if a reference exists to it.

def _get_instance(cls, doc): (source) ¶

overridden in fiftyone.core.singletons.FrameSingleton, fiftyone.core.singletons.SampleSingleton

Retrieves the fiftyone.core.document.Document instance for the given document, if one exists.

Parameters
cls	Undocumented
doc	a `fiftyone.core.odm.document.Document`
Returns
a `fiftyone.core.document.Document` instance, or None

def _register_instance(cls, obj): (source) ¶

overridden in fiftyone.core.singletons.FrameSingleton, fiftyone.core.singletons.SampleSingleton

Registers the given instance in the weakref dictionary.

Parameters
cls	Undocumented
obj	a `Document`

def _reload_instance(cls, obj): (source) ¶

overridden in fiftyone.core.singletons.FrameSingleton, fiftyone.core.singletons.SampleSingleton

Reloads the backing document for the given instance (or view), if a reference exists to it.

Parameters
cls	Undocumented
obj	a `Document` or `DocumentView`