prompt-toolkit / prompt-toolkit/python-prompt-toolkit

Temporarily disable Event callback

Open
#1,187 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
10.6k
Forks
815
PR merge metrics
No merged PRs in 30d

Description

I have a Buffer and I want to change its text without any on_text_changed events being fired. Is this currently possible without too much hacking?

I've tried adding this simple context manager to the Event class and it seems to work well. Should I make a PR?

@property
def handlers_disabled(self):
    """
    Context manager that disables all event handlers in its `with` block
    """
    class contextmanager:
        def __enter__(self, event=self):
            self._handlers = event._handlers
            event._handlers = []

        def __exit__(self, *exc_, event=self):
            event._handlers = self._handlers

    return contextmanager()

BTW: This is an awesome project. It's one of those things I never knew I badly needed.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Event class and Buffer's on_text_changed path; the issue does not name files or tests. Check how handlers are stored and invoked, then add coverage for temporarily suppressing callbacks and verify normal callbacks resume afterward.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.