Skip to content

Deprecate worker plugin overwrite policy #5146

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
Aug 5, 2021
Merged

Deprecate worker plugin overwrite policy #5146

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
3 changes: 2 additions & 1 deletion distributed/diagnostics/tests/test_worker_plugin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,8 @@ def setup(self, worker):
assert list(responses.values()) == [{"status": "OK"}]

async with Worker(s.address, loop=s.loop):
responses = await c.register_worker_plugin(FooWorkerPlugin(), name="foo")
with pytest.warns(FutureWarning, match="worker plugin will be overwritten"):
responses = await c.register_worker_plugin(FooWorkerPlugin(), name="foo")
assert list(responses.values()) == [{"status": "repeat"}] * 2


Expand Down
7 changes: 7 additions & 0 deletions distributed/worker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2722,6 +2722,13 @@ async def plugin_add(self, comm=None, plugin=None, name=None):
assert name

if name in self.plugins:
warnings.warn(
"Attempting to add a worker plugin with the same name as an already registered "
f"plugin ({name}). Currently this results in no change and the previously registered "
"plugin is not overwritten. This behavior is deprecated and in a future release "
f"the previously registered {name} worker plugin will be overwritten.",
category=FutureWarning,
)
return {"status": "repeat"}
else:
self.plugins[name] = plugin
Expand Down