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

Update copyright/author statements....

Update copyright/author statements. - Updated copyright statements to use the new form: # Copyright (C) 2008-2009 The IPython Development Team I left the old notices in place (just updating the year in some cases), because as far as I know, old copyright statements are not meant to be retroactively modified. - Also, on most files, replaced __author__ marks with an 'Authors' section in the module docstring. This reduces top-level code in the module, while ensuring that the Author(s) get properly acknowledged in auto-generated API docs (sphinx doesn't read __author__ marks, but it will include the module docstring). I only left a few in place for very old files that we ship externally, and for those by Laurent: he had his authorship mark both in the docstring and in __author__ variables, so I think out of courtesy it would be better to ask him about it on the list. All the others were I found regular __author__ variables, I moved them to the main docstring.

fperez - - Load All Authors

File last commit:

r766:f858aa98


                r1875:bba7e571

Download file

             ipy_profile_doctest.py
        
                    46 lines
            
             | 1.4 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / Extensions / 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 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.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 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.IP.meta.doctest_mode = True

				main()