temporalio.worker._worker._RootPlugin

class documentation

class _RootPlugin(Plugin): (source)

View In Hierarchy

Undocumented

Method configure_worker Hook called when creating a worker to allow modification of configuration.
Async Method run_worker Hook called when running a worker to allow interception of execution.

Inherited from Plugin:

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.
Instance Variable next_worker_plugin Undocumented
def configure_worker(self, config: WorkerConfig) -> WorkerConfig: (source)
overrides temporalio.worker.Plugin.configure_worker

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.
async def run_worker(self, worker: Worker): (source)
overrides temporalio.worker.Plugin.run_worker

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.