fiftyone.plugins.context.PluginContext

class documentation

class PluginContext(object): (source)

Constructor: PluginContext(plugin_definition)

View In Hierarchy

Context that represents a plugin and the Python objects it creates.

Parameters
plugin_definitionthe fiftyone.plugins.PluginDefinition for the plugin
Method __init__ Undocumented
Method can_register Determines whether the given operator can be registered.
Method dispose_all Disposes all operators from this context.
Method has_errors Determines whether the plugin has errors.
Method register Registers the given operator on the plugin.
Method register_all Registers all operators defined by the plugin on this context.
Instance Variable errors Undocumented
Instance Variable instances Undocumented
Instance Variable plugin_definition Undocumented
Property name The plugin name.
Property secrets List of keys for required secrets as specified in the plugin definition.
def __init__(self, plugin_definition): (source)

Undocumented

def can_register(self, instance): (source)

Determines whether the given operator can be registered.

Parameters
instancean fiftyone.operators.operator.Operator
Returns
True/False
def dispose_all(self): (source)

Disposes all operators from this context.

def has_errors(self): (source)

Determines whether the plugin has errors.

Returns
True/False
def register(self, cls): (source)

Registers the given operator on the plugin.

Note

Any errors are logged rather than being raised.

Parameters
clsan fiftyone.operators.operator.Operator or fiftyone.operators.panel.Panel class
def register_all(self): (source)

Registers all operators defined by the plugin on this context.

Note

Any errors are logged rather than being raised.

errors: list = (source)

Undocumented

instances: list = (source)

Undocumented

plugin_definition = (source)

Undocumented

@property
name = (source)

The plugin name.

@property
secrets = (source)

List of keys for required secrets as specified in the plugin definition.