deephaven.plugin¶
- class Callback[source]¶
Bases:
ABCAn instance of Callback will be passed to Registration.register_into, to allow any number of plugins to be registered.
- abstractmethod register(plugin)[source]¶
Registers a given plugin type for use in the Deephaven server. Should be called from from a Registration’s register_into method, so that it is available when the server expects it. :type plugin:
Plugin|Type[Plugin] :param plugin: the plugin or plugin type to register on the server- Return type:
None- Returns:
- class Registration[source]¶
Bases:
ABCRegistration types should be set as the registration_cls for deephaven.plugin entrypoints for their package to ensure that they are all run on server startup.
- abstractmethod classmethod register_into(callback)[source]¶
Implement this method and reference this Registration type from the package’s entrypoint to ensure that any provided plugins are available at server startup. Invoke callback.register() once for each provided plugin. :type callback:
Callback:param callback: invoke this once per plugin to register them for use in the server.- Return type:
None- Returns: