Class MyPlugin

distributed.diagnostics.tests.test_worker_plugin.MyPlugin

Declaration

class MyPlugin(WorkerPlugin)

source link

Methods

▷ def __init__(self, data, expected_notifications=None)
source link
▶ def release_dep(self, dep, state, report) override
inherited doc Called when the worker releases a dependency.
source link
This method overrides distributed.diagnostics.plugin.WorkerPlugin.release_dep.
Parameters
- dep : string
- state : string
```
State of the released dependency.
One of waiting, flight, memory.
```
- report : bool
```
Whether the worker should report the released dependency to the scheduler.
```
▶ def release_key(self, key, state, cause, reason, report) override
inherited doc Called when the worker releases a task.
source link
This method overrides distributed.diagnostics.plugin.WorkerPlugin.release_key.
Parameters
- key : string
- state : string
```
State of the released task.
One of waiting, ready, executing, long-running, memory, error.
```
- cause : string or None
```
Additional information on what triggered the release of the task.
```
- reason : None
```
Not used.
```
- report : bool
```
Whether the worker should report the released task to the scheduler.
```
▶ def setup(self, worker) override
inherited doc Run when the plugin is attached to a worker. This happens when the plugin is registered and attached to existing workers, or when a worker is created after the plugin has been registered.
source link
This method overrides distributed.diagnostics.plugin.WorkerPlugin.setup.
▶ def teardown(self, worker) override
inherited doc Run when the worker to which the plugin is attached to is closed
source link
This method overrides distributed.diagnostics.plugin.WorkerPlugin.teardown.

▶ def transition(self, key, start, finish, **kwargs) override

inherited doc Throughout the lifecycle of a task (see :doc:`Worker <worker>`), Workers are

source link

This method overrides distributed.diagnostics.plugin.WorkerPlugin.transition.

instructed by the scheduler to compute certain tasks, resulting in transitions
in the state of each task. The Worker owning the task is then notified of this
state transition.

Whenever a task changes its state, this method will be called.

Parameters

key : string

start : string

Start state of the transition.
One of waiting, ready, executing, long-running, memory, error.

finish : string
```
Final state of the transition.
```
kwargs : More options passed when transitioning

Distributed

Class MyPlugin

Declaration

Methods

Parameters

Parameters

Parameters