upstream/ipython Files · IPython/lib/tests/test_editorhooks.py

Swallow potential exceptions from showtraceback()...

Swallow potential exceptions from showtraceback() The nbgrader project is aware of a form of cheating where students disrupt `InteractiveShell.showtraceback` in hopes of hiding exceptions to avoid losing points. They have implemented a solution to prevent this cheating from working on the client side, and have some tests to demonstrate this technique: https://github.com/jupyter/nbgrader/blob/main/nbgrader/tests/apps/files/submitted-cheat-attempt.ipynb https://github.com/jupyter/nbgrader/blob/main/nbgrader/tests/apps/files/submitted-cheat-attempt-alternative.ipynb In essence, these attacks import the interactive shell and erase the traceback handler so that their failing tests won't report failures. import IPython.core.interactiveshell IPython.core.interactiveshell.InteractiveShell.showtraceback = None The problem is that this causes an exception inside the kernel, leading to a stalled execution. The kernel has stopped working, but the client continues to wait for messages. So far, nbgrader's solution to this is to require a timeout value so the client can eventually decide it is done. This prevents allowing a value of `None` for `Execute.timeout` because this would cause a test case to infinitely hang. This commit addresses the problem by making `InteractiveShell._run_cell` a little more protective around it's call to `showtraceback()`. There is already a try/except block around running the cell. This commit adds a finally clause so that the method will _always_ return an `ExecutionResult`, even if a new exception is thrown within the except clause. For the record, the exception thrown is: TypeError: 'NoneType' object is not callable Accepting this change will allow nbgrader to update `nbgrader.preprocessors.Execute` to support a type of `Integer(allow_none=True)` as the parent `NotebookClient` intended. Discussion about this is ongoing in jupyter/nbgrader#1690.

Matthias Bussonnier - - Load All Authors

File last commit:

r26716:4142eaaf


                r28094:fd34cf5f

Download file

             test_editorhooks.py
        
                    32 lines
            
             | 884 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / lib / tests / test_editorhooks.py
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Min RK
    
fix editorhooks typo...

              r18869
            
      """Test installing editor hooks"""

      import sys

        Srinivas Reddy Thatiparthy
    
import mock from unittest

              r23058
            
      from unittest import mock

        Min RK
    
fix editorhooks typo...

              r18869
            
      from IPython import get_ipython

      from IPython.lib import editorhooks

      def test_install_editor():

          called = []

          def fake_popen(*args, **kwargs):

              called.append({

                  'args': args,

                  'kwargs': kwargs,

              })

        Segev Finer
    
IPython/lib/editorhooks.py: wait for process even if wait=False...

              r23294
            
              return mock.MagicMock(**{'wait.return_value': 0})

        Min RK
    
fix editorhooks typo...

              r18869
            
          editorhooks.install_editor('foo -l {line} -f {filename}', wait=False)

          with mock.patch('subprocess.Popen', fake_popen):

              get_ipython().hooks.editor('the file', 64)

        Matthias Bussonnier
    
remove nose tools from test_editorhooks

              r26716
            
          assert len(called) == 1

          args = called[0]["args"]

          kwargs = called[0]["kwargs"]

          assert kwargs == {"shell": True}

          if sys.platform.startswith("win"):

              expected = ["foo", "-l", "64", "-f", "the file"]

        Min RK
    
fix editorhooks typo...

              r18869
            
          else:

              expected = "foo -l 64 -f 'the file'"

          cmd = args[0]

        Matthias Bussonnier
    
remove nose tools from test_editorhooks

              r26716
            
          assert cmd == expected

	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

Min RK fix editorhooks typo...	r18869	"""Test installing editor hooks"""
		import sys
Srinivas Reddy Thatiparthy import mock from unittest	r23058	from unittest import mock
Min RK fix editorhooks typo...	r18869
		from IPython import get_ipython
		from IPython.lib import editorhooks

		def test_install_editor():
		called = []
		def fake_popen(args, *kwargs):
		called.append({
		'args': args,
		'kwargs': kwargs,
		})
Segev Finer IPython/lib/editorhooks.py: wait for process even if wait=False...	r23294	return mock.MagicMock(**{'wait.return_value': 0})
Min RK fix editorhooks typo...	r18869	editorhooks.install_editor('foo -l {line} -f {filename}', wait=False)

		with mock.patch('subprocess.Popen', fake_popen):
		get_ipython().hooks.editor('the file', 64)

Matthias Bussonnier remove nose tools from test_editorhooks	r26716	assert len(called) == 1
		args = called[0]["args"]
		kwargs = called[0]["kwargs"]

		assert kwargs == {"shell": True}

		if sys.platform.startswith("win"):
		expected = ["foo", "-l", "64", "-f", "the file"]
Min RK fix editorhooks typo...	r18869	else:
		expected = "foo -l 64 -f 'the file'"
		cmd = args[0]
Matthias Bussonnier remove nose tools from test_editorhooks	r26716	assert cmd == expected