ipython / ipython/traitlets

Support observe as a decorator outside of classes

Open
#273 7 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
653
Forks
217
Avg merge
2d 21h
Merged PRs (30d)
2

Description

Please note that I have only used `traitlets` as a part of `ipywidgets`, and not sure how feasible are the suggestions below for its other uses - but for widgets they would be quite useful.

So, when one needs to `observe` a widget trait, it can't be done without separately defining the handler function and then subscribing:

``` python
def handler(*_):
# ... code ...

w.observe(handler, 'value')
```

Wouldn't it be better if you could just write like this:

``` python
@w.observe('value')
def _(*_):
# ... code ...
```

This way there is also no need to make a name for the handle function.

However, it's often useful to call the handler once after setting everything up, e.g. if you make some plots in the handler it makes sense to display them without forcing user to move a slider or something. So, I also suggest adding an argument to `observe`, like `run=True` (looking for a better name :) ) or a separate method `observe_and_run` which would also execute the handler (in addition to subscribing). This way we still wouldn't have to think of a name for the handler function.

So, instead of:

``` python
def handler(*_):
# ... code ...

w.observe(handler, 'value')
handler()
```

we would be able to write:

``` python
@w.observe('value', run=True)
def _(*_):
# ... code ...
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.