class documentation

Base class for worker plugins that can intercept and modify worker behavior.

Plugins allow customization of worker creation and execution processes through a chain of responsibility pattern. Each plugin can modify the worker configuration or intercept worker execution.

Method configure_worker Hook called when creating a worker to allow modification of configuration.
Method init_worker_plugin Initialize this plugin in the plugin chain.
Method name Get the qualified name of this plugin. Can be overridden if desired to provide a more appropriate name.
Async Method run_worker Hook called when running a worker to allow interception of execution.
Instance Variable next_worker_plugin Undocumented
def configure_worker(self, config: WorkerConfig) -> WorkerConfig: (source)

Hook called when creating a worker to allow modification of configuration.

This method is called during worker creation and allows plugins to modify the worker configuration before the worker is fully initialized. Plugins can modify task queue names, adjust concurrency settings, add interceptors, or change other worker settings.

Parameters
config:WorkerConfigThe worker configuration dictionary to potentially modify.
Returns
WorkerConfigThe modified worker configuration.
def init_worker_plugin(self, next: Plugin) -> Plugin: (source)

Initialize this plugin in the plugin chain.

This method sets up the chain of responsibility pattern by storing a reference to the next plugin in the chain. It is called during worker creation to build the plugin chain.

Parameters
next:PluginThe next plugin in the chain to delegate to.
Returns
PluginThis plugin instance for method chaining.
def name(self) -> str: (source)

Get the qualified name of this plugin. Can be overridden if desired to provide a more appropriate name.

Returns
strThe fully qualified name of the plugin class (module.classname).
async def run_worker(self, worker: Worker): (source)

Hook called when running a worker to allow interception of execution.

This method is called when the worker is started and allows plugins to intercept or wrap the worker execution. Plugins can add monitoring, custom lifecycle management, or other execution-time behavior.

Parameters
worker:WorkerThe worker instance to run.
next_worker_plugin = (source)

Undocumented