upstream/ipython Files · IPython/quarantine/ipy_profile_doctest.py

Fix paste/cpaste bug and refactor/cleanup that code a lot....

Fix paste/cpaste bug and refactor/cleanup that code a lot. In fixing a pasting bug (mishandling of whitespace when input had prompts) it became clear the pasting code hadn't been updated when the new prefiltering machinery was added. Furthermore, the pasting magics are only for the terminal, but the code was in the base classes. This refactors and simplifies the pasting code, moving it to the terminal shell only, and removing unnecessary methods from the main class (using small utility functions instead). The tests were simplified because the previous regexp supported some odd edge cases that are not valid in the normal prefiltering code. We want to have a single location and set of rules for input prefiltering, so I changed some of the test cases to be consistent with what prefilter allows.

Brian Granger - - Load All Authors

File last commit:

r2267:928c921b


                r5435:8bb887c8

Download file

             ipy_profile_doctest.py
        
                    46 lines
            
             | 1.5 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / quarantine / ipy_profile_doctest.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """Config file for 'doctest' profile.

      This profile modifies the prompts to be the standard Python ones, so that you

      can generate easily doctests from an IPython session.

      But more importantly, it enables pasting of code with '>>>' prompts and

      arbitrary initial whitespace, as is typical of doctests in reST files and

      docstrings.  This allows you to easily re-run existing doctests and iteratively

      work on them as part of your development workflow.

      The exception mode is also set to 'plain' so the generated exceptions are as

      similar as possible to the default Python ones, for inclusion in doctests."""

      # get various stuff that are there for historical / familiarity reasons

      import ipy_legacy

      from IPython.core import ipapi

      from IPython.extensions import InterpreterPasteInput

      def main():    

          ip = ipapi.get()

          o = ip.options

          # Set the prompts similar to the defaults

          o.prompt_in1 = '>>> '

          o.prompt_in2 = '... '

          o.prompt_out = ''

          # Add a blank line before each new set of inputs.  This is needed by

          # doctest to distinguish each test from the next.

          o.separate_in = '\n'

          o.separate_out = ''

          o.separate_out2 = ''

          # Disable pprint, so that outputs are printed as similarly to standard

          # python as possible

          o.pprint = False

          # Use plain exceptions, to also resemble normal pyhton.

          o.xmode = 'plain'

          # Store the activity flag in the metadata bag from the running shell

          ip.meta.doctest_mode = True

      main()

	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

				"""Config file for 'doctest' profile.

				This profile modifies the prompts to be the standard Python ones, so that you
				can generate easily doctests from an IPython session.

				But more importantly, it enables pasting of code with '>>>' prompts and
				arbitrary initial whitespace, as is typical of doctests in reST files and
				docstrings. This allows you to easily re-run existing doctests and iteratively
				work on them as part of your development workflow.

				The exception mode is also set to 'plain' so the generated exceptions are as
				similar as possible to the default Python ones, for inclusion in doctests."""

				# get various stuff that are there for historical / familiarity reasons
				import ipy_legacy

				from IPython.core import ipapi

				from IPython.extensions import InterpreterPasteInput

				def main():
				ip = ipapi.get()
				o = ip.options

				# Set the prompts similar to the defaults
				o.prompt_in1 = '>>> '
				o.prompt_in2 = '... '
				o.prompt_out = ''

				# Add a blank line before each new set of inputs. This is needed by
				# doctest to distinguish each test from the next.
				o.separate_in = '\n'
				o.separate_out = ''
				o.separate_out2 = ''

				# Disable pprint, so that outputs are printed as similarly to standard
				# python as possible
				o.pprint = False

				# Use plain exceptions, to also resemble normal pyhton.
				o.xmode = 'plain'

				# Store the activity flag in the metadata bag from the running shell
				ip.meta.doctest_mode = True

				main()