acme.helpers.PluginManager.PluginInfo

class documentation

class PluginInfo:

View In Hierarchy

Dataclass to hold runtime information, metadata about a plugin, and state management.

Method configure Configure the plugin.
Method finalize Finalize the plugin.
Method pause Pause the plugin.
Method resolve Set the state of the plugin to resolved.
Method restart Restart the plugin.
Method start Start the plugin.
Method stop Stop the plugin.
Method unpause Unpause the plugin.
Method unresolve Set the state of the plugin to unresolved.
Method validate Validate the plugin configuration.
Class Variable configureMethod The configure method of the plugin. This method, if set, is called during the plugin configuration phase.
Class Variable doc The docstring of the plugin module.
Class Variable fileName File name of the plugin module.
Class Variable finishMethod The finalization method of the plugin. This method, if set, is called during the plugin finalization phase.
Class Variable initMethod The initialization method of the plugin. This method, if set, is called during the plugin initialization phase.
Class Variable instance The instantiated plugin class.
Class Variable instanceAttributeName If this is set, the plugin instance is accessible as attribute of the PluginManager under this name.
Class Variable module The loaded plugin module.
Class Variable name Name of the plugin.
Class Variable noRestartWhilePaused Flag to indicate whether the plugin should not restart requests while paused.
Class Variable onResolvedMethod The onResolved method of the plugin. This method, if set, is called when the plugin is resolved.
Class Variable onUnresolvedMethod The onUnresolved method of the plugin. This method, if set, is called when the plugin is unresolved.
Class Variable pauseMethod The pause method of the plugin. This method, if set, is called when the plugin is paused.
Class Variable pluginClass A reference to the plugin class.
Class Variable priority Priority of the plugin. The priority determines the order in which plugins are started, etc. Lower values mean higher priority, but stopping and finalizing happen in reverse order.
Class Variable restartMethod The restart method of the plugin. This method, if set, is called when the plugin is restarted.
Class Variable startMethod The start method of the plugin. This method, if set, is called when the plugin is started.
Class Variable stopMethod The stop method of the plugin. This method, if set, is called when the plugin is stopped.
Class Variable tags Optional list of tags to attach to the plugin for easier identification and filtering.
Class Variable unpauseMethod The unpause method of the plugin. This method, if set, is called when the plugin is unpaused.
Class Variable validateMethod The validate method of the plugin. This method, if set, is called during the plugin validation phase, after the configuration phase.
Instance Variable state Internal state of the plugin.
def configure(self, *args: Any, **kwargs: Any):

Configure the plugin.

def finalize(self):

Finalize the plugin.

def pause(self):

Pause the plugin.

def resolve(self):

Set the state of the plugin to resolved.

def restart(self):

Restart the plugin.

def start(self):

Start the plugin.

def stop(self):

Stop the plugin.

def unpause(self):

Unpause the plugin.

def unresolve(self):

Set the state of the plugin to unresolved.

def validate(self, *args: Any, **kwargs: Any):

Validate the plugin configuration.

configureMethod: Callable | None =

The configure method of the plugin. This method, if set, is called during the plugin configuration phase.

doc: str =

The docstring of the plugin module.

fileName: str =

File name of the plugin module.

finishMethod: Callable | None =

The finalization method of the plugin. This method, if set, is called during the plugin finalization phase.

initMethod: Callable | None =

The initialization method of the plugin. This method, if set, is called during the plugin initialization phase.

instance: Any | None =

The instantiated plugin class.

instanceAttributeName: str | None =

If this is set, the plugin instance is accessible as attribute of the PluginManager under this name.

module: ModuleType | None =

The loaded plugin module.

name: str =

Name of the plugin.

noRestartWhilePaused: bool =

Flag to indicate whether the plugin should not restart requests while paused.

onResolvedMethod: Callable | None =

The onResolved method of the plugin. This method, if set, is called when the plugin is resolved.

onUnresolvedMethod: Callable | None =

The onUnresolved method of the plugin. This method, if set, is called when the plugin is unresolved.

pauseMethod: Callable | None =

The pause method of the plugin. This method, if set, is called when the plugin is paused.

pluginClass: Any | None =

A reference to the plugin class.

priority: int =

Priority of the plugin. The priority determines the order in which plugins are started, etc. Lower values mean higher priority, but stopping and finalizing happen in reverse order.

restartMethod: Callable | None =

The restart method of the plugin. This method, if set, is called when the plugin is restarted.

startMethod: Callable | None =

The start method of the plugin. This method, if set, is called when the plugin is started.

stopMethod: Callable | None =

The stop method of the plugin. This method, if set, is called when the plugin is stopped.

tags: list[str] =

Optional list of tags to attach to the plugin for easier identification and filtering.

unpauseMethod: Callable | None =

The unpause method of the plugin. This method, if set, is called when the plugin is unpaused.

validateMethod: Callable | None =

The validate method of the plugin. This method, if set, is called during the plugin validation phase, after the configuration phase.

state: PluginState =

Internal state of the plugin.