tempor.core.plugins.plugin_typing module

Typing definitions for plugin core functionality.

tempor.core.plugins.plugin_typing.PluginType

Type alias to indicate plugin type, such as 'method'.

tempor.core.plugins.plugin_typing.PluginTypeArgAll

Literal for argument options indicating all plugin types.

alias of Literal[all]

tempor.core.plugins.plugin_typing.PluginTypeArg

Plugin type argument type. May be PluginType (str), None, or PluginTypeArgAll ("all")

alias of Union[None, Literal[all], str]

tempor.core.plugins.plugin_typing.PluginName

Type alias to indicate plugin name, such as 'my_nn_classifier'.

tempor.core.plugins.plugin_typing.PluginFullName

Type alias to indicate plugin full name (with all [sub]categories), such as 'prediction.one_off.classification.my_nn_classifier'.

tempor.core.plugins.plugin_typing.PluginCategory

Type alias to indicate plugin category (including all [sub]categories), such as 'prediction.one_off.classification'.

tempor.core.plugins.plugin_typing.DEFAULT_PLUGIN_TYPE = 'method'

Default plugin type to which plugins will be assigned if no plugin type is specified (plugin type set to None).

tempor.core.plugins.plugin_typing.ALL_PLUGIN_TYPES_INDICATOR = 'all'

A string that indicates all plugins.