upstream/ipython Files · IPython/core/tests/test_hooks.py

Refuse to install event loop hooks when not using `prompt_toolkit` (#14132)...

Refuse to install event loop hooks when not using `prompt_toolkit` (#14132) Without this, `%gui` is effectively a no-op but the user thinks it works. For example. If running `ipython`: ``` In [1]: import matplotlib; matplotlib.use('QtAgg'); from matplotlib import pyplot; pyplot.ion(); pyplot.plot([1, 2, 3, 4]) Installed qt6 event loop hook. Out[1]: [<matplotlib.lines.Line2D at 0x1ba2f59d2a0>] ``` The window appears and responds as expected. If running `ipython --simple-prompt`, the user would see the same output, when in fact no event loop hook was installed since it's not supported without `prompt_toolkit`. The resulting Qt window is unresponsive because the event loop is not running, i.e. with `--simple-prompt`, Qt windows should block (but `pyplot` doesn't/can't know to do that) With this PR, the user will see: ``` In [1]: import matplotlib; matplotlib.use('QtAgg'); from matplotlib import pyplot; pyplot.ion(); pyplot.plot([1, 2, 3, 4]) Cannot install event loop hook for "qt" when running with `--simple-prompt`. NOTE: Tk is supported natively; use Tk apps and Tk backends with `--simple-prompt`. Out[1]: [<matplotlib.lines.Line2D at 0x170be0c0310>] ``` They'll still get an unresponsive Qt window, but they'll at least be told this can't work (while anything using Tk will work just fine).

Nikita Kniazev - - Load All Authors

File last commit:

r27087:0e59ae55


                r28368:22fc5ab5

Download file

             test_hooks.py
        
                    76 lines
            
             | 2.3 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / core / tests / test_hooks.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # -*- coding: utf-8 -*-

      """Tests for CommandChainDispatcher."""

      #-----------------------------------------------------------------------------

      # Imports

      #-----------------------------------------------------------------------------

      import pytest

      from IPython.core.error import TryNext

      from IPython.core.hooks import CommandChainDispatcher

      #-----------------------------------------------------------------------------

      # Local utilities

      #-----------------------------------------------------------------------------

      # Define two classes, one which succeeds and one which raises TryNext. Each

      # sets the attribute `called` to True when it is called.

      class Okay(object):

          def __init__(self, message):

              self.message = message

              self.called = False

          def __call__(self):

              self.called = True

              return self.message

      class Fail(object):

          def __init__(self, message):

              self.message = message

              self.called = False

          def __call__(self):

              self.called = True

              raise TryNext(self.message)

      #-----------------------------------------------------------------------------

      # Test functions

      #-----------------------------------------------------------------------------

      def test_command_chain_dispatcher_ff():

          """Test two failing hooks"""

          fail1 = Fail("fail1")

          fail2 = Fail("fail2")

          dp = CommandChainDispatcher([(0, fail1), (10, fail2)])

          with pytest.raises(TryNext) as e:

              dp()

          assert str(e.value) == "fail2"

          assert fail1.called is True

          assert fail2.called is True

      def test_command_chain_dispatcher_fofo():

          """Test a mixture of failing and succeeding hooks."""

          fail1 = Fail("fail1")

          fail2 = Fail("fail2")

          okay1 = Okay("okay1")

          okay2 = Okay("okay2")

          dp = CommandChainDispatcher([(0, fail1),

                                       # (5, okay1), # add this later

                                       (10, fail2),

                                       (15, okay2)])

          dp.add(okay1, 5)

          assert dp() == "okay1"

          assert fail1.called is True

          assert okay1.called is True

          assert fail2.called is False

          assert okay2.called is False

      def test_command_chain_dispatcher_eq_priority():

          okay1 = Okay(u'okay1')

          okay2 = Okay(u'okay2')

          dp = CommandChainDispatcher([(1, okay1)])

          dp.add(okay2, 1)

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				# -- coding: utf-8 --
				"""Tests for CommandChainDispatcher."""


				#-----------------------------------------------------------------------------
				# Imports
				#-----------------------------------------------------------------------------

				import pytest
				from IPython.core.error import TryNext
				from IPython.core.hooks import CommandChainDispatcher

				#-----------------------------------------------------------------------------
				# Local utilities
				#-----------------------------------------------------------------------------

				# Define two classes, one which succeeds and one which raises TryNext. Each
				# sets the attribute `called` to True when it is called.
				class Okay(object):
				def __init__(self, message):
				self.message = message
				self.called = False
				def __call__(self):
				self.called = True
				return self.message

				class Fail(object):
				def __init__(self, message):
				self.message = message
				self.called = False
				def __call__(self):
				self.called = True
				raise TryNext(self.message)

				#-----------------------------------------------------------------------------
				# Test functions
				#-----------------------------------------------------------------------------

				def test_command_chain_dispatcher_ff():
				"""Test two failing hooks"""
				fail1 = Fail("fail1")
				fail2 = Fail("fail2")
				dp = CommandChainDispatcher([(0, fail1), (10, fail2)])

				with pytest.raises(TryNext) as e:
				dp()
				assert str(e.value) == "fail2"

				assert fail1.called is True
				assert fail2.called is True

				def test_command_chain_dispatcher_fofo():
				"""Test a mixture of failing and succeeding hooks."""
				fail1 = Fail("fail1")
				fail2 = Fail("fail2")
				okay1 = Okay("okay1")
				okay2 = Okay("okay2")

				dp = CommandChainDispatcher([(0, fail1),
				# (5, okay1), # add this later
				(10, fail2),
				(15, okay2)])
				dp.add(okay1, 5)

				assert dp() == "okay1"

				assert fail1.called is True
				assert okay1.called is True
				assert fail2.called is False
				assert okay2.called is False

				def test_command_chain_dispatcher_eq_priority():
				okay1 = Okay(u'okay1')
				okay2 = Okay(u'okay2')
				dp = CommandChainDispatcher([(1, okay1)])
				dp.add(okay2, 1)