Skip to content

Update documentation for register_worker_plugin #5533

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jrbourbeau merged 1 commit into from
Nov 22, 2021
Merged

Update documentation for register_worker_plugin #5533

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion distributed/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4273,7 +4273,7 @@ def register_worker_plugin(self, plugin=None, name=None, nanny=None, **kwargs):

If the plugin has a ``name`` attribute, or if the ``name=`` keyword is
used then that will control idempotency. If a plugin with that name has
already been registered then any future plugins will not run.
already been registered, then it will be removed and replaced by the new one.

For alternatives to plugins, you may also wish to look into preload
scripts.
Expand Down
2 changes: 1 addition & 1 deletion distributed/scheduler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7206,7 +7206,7 @@ def stop_task_metadata(self, comm=None, name=None):
return {"metadata": plugin.metadata, "state": plugin.state}

async def register_worker_plugin(self, comm, plugin, name=None):
"""Registers a setup function, and call it on every worker"""
"""Registers a worker plugin on all running and future workers"""
self.worker_plugins[name] = plugin

responses = await self.broadcast(
Expand Down