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

Improve API documentation around configuration of embedded IPython (#13989)...

Improve API documentation around configuration of embedded IPython (#13989) This PR tries to improve the API documentation of `embed()`, `embed_kernel()`, `start_ipython()` and `start_kernel()` with respect to the configuration of IPython by adding links to other sections of the documentation. It also reorganizes the API docs so that `embed()` is listed under `IPython`, just as it's presented in the narrative documentation.

Matthias Bussonnier - - Load All Authors

File last commit:

r26716:4142eaaf


                r28197:ad452c1d

Download file

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

      """Test installing editor hooks"""

      import sys

      from unittest import mock

      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,

              })

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

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

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

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

          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"]

          else:

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

          cmd = args[0]

          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

				"""Test installing editor hooks"""
				import sys
				from unittest import mock

				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,
				})
				return mock.MagicMock(**{'wait.return_value': 0})
				editorhooks.install_editor('foo -l {line} -f {filename}', wait=False)

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

				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"]
				else:
				expected = "foo -l 64 -f 'the file'"
				cmd = args[0]
				assert cmd == expected