deephaven.plugin

• js
  • JsPlugin
    • JsPlugin.main
    • JsPlugin.name
    • JsPlugin.path()
    • JsPlugin.version
• object_type
  • BidirectionalObjectType
    • BidirectionalObjectType.create_client_connection()
    • BidirectionalObjectType.is_type()
    • BidirectionalObjectType.name
  • Exporter
    • Exporter.reference()
  • FetchOnlyObjectType
    • FetchOnlyObjectType.is_type()
    • FetchOnlyObjectType.name
    • FetchOnlyObjectType.to_bytes()
  • MessageStream
    • MessageStream.on_close()
    • MessageStream.on_data()
  • ObjectType
    • ObjectType.is_type()
    • ObjectType.name
  • Reference
    • Reference.index

class Callback

Bases: ABC

An instance of Callback will be passed to Registration.register_into, to allow any number of plugins to be registered.

abstract register(plugin)

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: Union[Plugin, Type[Plugin]] :param plugin: the plugin or plugin type to register on the server :rtype: None :return:

class Plugin

Bases: ABC

class Registration

Bases: ABC

Registration 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.

abstract classmethod register_into(callback)

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. :rtype: None :return:

list_plugins_console()

Entrypoint for the console script deephaven-plugin-list-plugins

list_registrations_console()

Entrypoint for the console script deephaven-plugin-list-registrations