Add control to widget messages. #2490
Conversation
Adding these references to the sub-widgets that make up a markdown document is necessary in order for the blocks to be able to post messages with a reference to the original document, which in turn is needed for the Message.control property to work.
There was a problem hiding this comment.
This may look like an unrelated change, but I needed to update this documentation to add control.
But this was the source of the issue with #2486 so I just went ahead and took care of that as well.
Test now fully works, as of #2490.
* Add tests for #2484. * Implement @on extension. [skip ci] Related issues: #2484. * Changelog. * Add missing @on test. * Remove debug prints. * Document changes. * Update tests. Test now fully works, as of #2490. * Cache parsed selectors. * Streamline exit condition. * Fix typing. * More succint wording. * Document 'on' kwargs. * Update src/textual/_on.py Co-authored-by: Will McGugan <[email protected]> * Update docs/guide/events.md Co-authored-by: Will McGugan <[email protected]> * Change 'on' API. * Remove example code. * Address feedback. * Update src/textual/_on.py Co-authored-by: Will McGugan <[email protected]> * Address review feedback. * Fix #2499. * don't require control to be manually specified * update docstring * deleted words --------- Co-authored-by: Will McGugan <[email protected]>
| @@ -64,19 +64,32 @@ class FileSelected(Message, bubble=True): | |||
| `DirectoryTree` or in a parent widget in the DOM. | |||
| """ | |||
|
|
|||
| def __init__(self, node: TreeNode[DirEntry], path: Path) -> None: | |||
| def __init__( | |||
| self, tree: DirectoryTree, node: TreeNode[DirEntry], path: Path | |||
There was a problem hiding this comment.
I realise this is a bit late now, but this will have broken DirectoryTree as it didn't update the use of the message later on in the code.
There was a problem hiding this comment.
Is there an issue for this?
This means we need to add tests. 😬
There was a problem hiding this comment.
I believe it got fixed with 0.24.1 yesterday evening; I was just making a after-the-fact note. But I do think we may need to be careful as we go along with adding this sort of reference to all messages; sometimes the context might matter (in this case the message is a node-oriented message, so the node is the subject of the message and the node knows which tree it came from).
There was a problem hiding this comment.
Thanks. Sorry for the mess-up D:
| This is an alias for [`FileSelected.tree`][textual.widgets.DirectoryTree.FileSelected.tree] | ||
| which is used by the [`on`][textual.on] decorator. | ||
| """ | ||
| return self.tree |
There was a problem hiding this comment.
This could be done without the Tree reference by using:
return self.node.tree
This adds the property
controlto all the widget messages.Closes #2489.
Closes #2486.