upstream/ipython Files · IPython/nbformat/v2/tests/nbexamples.py

Reset the interactive namespace __warningregistry__ before executing code...

Reset the interactive namespace __warningregistry__ before executing code Fixes . Idea: Right now, people often don't see important warnings when running code in IPython, because (to a first approximation) any given warning will only issue once per session. Blink and you'll miss it! This is a very common contributor to confused emails to numpy-discussion. E.g.: In [5]: 1 / my_array_with_random_contents /home/njs/.user-python2.7-64bit-3/bin/ipython:1: RuntimeWarning: divide by zero encountered in divide #!/home/njs/.user-python2.7-64bit-3/bin/python Out[5]: array([ 1.77073316, -2.29765021, -2.01800811, ..., 1.13871243, -1.08302964, -8.6185091 ]) Oo, right, guess I gotta be careful of those zeros -- thanks, numpy, for giving me that warning! A few days later: In [592]: 1 / some_other_array Out[592]: array([ 3.07735763, 0.50769289, 0.83984078, ..., -0.67563917, -0.85736257, -1.36511271]) Oops, it turns out that this array had a zero in it too, and that's going to bite me later. But no warning this time! The effect of this commit is to make it so that warnings triggered by the code in cell 5 do *not* suppress warnings triggered by the code in cell 592. Note that this only applies to warnings triggered *directly* by code entered interactively -- if somepkg.foo() calls anotherpkg.bad_func() which issues a warning, then this warning will still only be displayed once, even if multiple cells call somepkg.foo(). But if cell 5 and cell 592 both call anotherpkg.bad_func() directly, then both will get warnings. (Important exception: if foo() is defined *interactively*, and calls anotherpkg.bad_func(), then every cell that calls foo() will display the warning again. This is unavoidable without fixes to CPython upstream.) Explanation: Python's warning system has some weird quirks. By default, it tries to suppress duplicate warnings, where "duplicate" means the same warning message triggered twice by the same line of code. This requires determining which line of code is responsible for triggering a warning, and this is controlled by the stacklevel= argument to warnings.warn. Basically, though, the idea is that if foo() calls bar() which calls baz() which calls some_deprecated_api(), then baz() will get counted as being "responsible", and the warning system will make a note that the usage of some_deprecated_api() inside baz() has already been warned about and doesn't need to be warned about again. So far so good. To accomplish this, obviously, there has to be a record of somewhere which line this was. You might think that this would be done by recording the filename:linenumber pair in a dict inside the warnings module, or something like that. You would be wrong. What actually happens is that the warnings module will use stack introspection to reach into baz()'s execution environment, create a global (module-level) variable there named __warningregistry__, and then, inside this dictionary, record just the line number. Basically, it assumes that any given module contains only one line 1, only one line 2, etc., so storing the filename is irrelevant. Obviously for interactive code this is totally wrong -- all cells share the same execution environment and global namespace, and they all contain a new line 1. Currently the warnings module treats these as if they were all the same line. In fact they are not the same line; once we have executed a given chunk of code, we will never see those particular lines again. As soon as a given chunk of code finishes executing, its line number labels become meaningless, and the corresponding warning registry entries become meaningless as well. Therefore, with this patch we delete the __warningregistry__ each time we execute a new block of code.

Thomas Kluyver - - Load All Authors

File last commit:

r5745:943a2321


                r18548:61431d7d

Download file

             nbexamples.py
        
                    109 lines
            
             | 2.2 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / nbformat / v2 / tests / nbexamples.py
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        MinRK
    
fix base64 code in nbformat.v2...

              r5175
            
      import os

      from base64 import encodestring

        Brian E. Granger
    
Full versioning added to nbformat.

              r4406
            
      from ..nbbase import (

        Brian E. Granger
    
Initial draft of more formal notebook format....

              r4401
            
          NotebookNode,

        Brian E. Granger
    
Implemented metadata for notebook format.

              r4637
            
          new_code_cell, new_text_cell, new_worksheet, new_notebook, new_output,

          new_metadata, new_author

        Brian E. Granger
    
Initial draft of more formal notebook format....

              r4401
            
      )

        MinRK
    
fix base64 code in nbformat.v2...

              r5175
            
      # some random base64-encoded *bytes*

      png = encodestring(os.urandom(5))

      jpeg = encodestring(os.urandom(6))

        Brian E. Granger
    
Initial draft of more formal notebook format....

              r4401
            
      ws = new_worksheet(name='worksheet1')

        Brian E. Granger
    
Markdown cells are now saved and restored in notebooks.

              r4511
            
      ws.cells.append(new_text_cell(

          u'html',

          source='Some NumPy Examples',

          rendered='Some NumPy Examples'

        Brian E. Granger
    
Initial draft of more formal notebook format....

              r4401
            
      ))

      ws.cells.append(new_code_cell(

        Brian E. Granger
    
Updates to basic notebook format....

              r4402
            
          input='import numpy',

        Brian E. Granger
    
Added collapsed field to the code cell.

              r4533
            
          prompt_number=1,

          collapsed=False

        Brian E. Granger
    
Initial draft of more formal notebook format....

              r4401
            
      ))

        Brian E. Granger
    
Markdown cells are now saved and restored in notebooks.

              r4511
            
      ws.cells.append(new_text_cell(

          u'markdown',

        Brian E. Granger
    
New .py notebook format implemented.

              r4536
            
          source='A random array',

          rendered='A random array'

        Brian E. Granger
    
Markdown cells are now saved and restored in notebooks.

              r4511
            
      ))

        Brian E. Granger
    
Initial draft of more formal notebook format....

              r4401
            
      ws.cells.append(new_code_cell(

        Brian E. Granger
    
Updates to basic notebook format....

              r4402
            
          input='a = numpy.random.rand(100)',

        Brian E. Granger
    
Added collapsed field to the code cell.

              r4533
            
          prompt_number=2,

          collapsed=True

        Brian E. Granger
    
Initial draft of more formal notebook format....

              r4401
            
      ))

      ws.cells.append(new_code_cell(

          input='print a',

        Brian E. Granger
    
Updates to basic notebook format....

              r4402
            
          prompt_number=3,

        Brian E. Granger
    
Added collapsed field to the code cell.

              r4533
            
          collapsed=False,

        Brian E. Granger
    
Updates to basic notebook format....

              r4402
            
          outputs=[new_output(

              output_type=u'pyout',

              output_text=u'<array a>',

              output_html=u'The HTML rep',

              output_latex=u'$a$',

        MinRK
    
fix base64 code in nbformat.v2...

              r5175
            
              output_png=png,

              output_jpeg=jpeg,

        Brian E. Granger
    
Updates to basic notebook format....

              r4402
            
              output_svg=u'<svg>',

              output_json=u'json data',

        Brian E. Granger
    
Starting to rename text cell to html cell.

              r4498
            
              output_javascript=u'var i=0;',

              prompt_number=3

        Brian E. Granger
    
Updates to basic notebook format....

              r4402
            
          ),new_output(

              output_type=u'display_data',

              output_text=u'<array a>',

              output_html=u'The HTML rep',

              output_latex=u'$a$',

        MinRK
    
fix base64 code in nbformat.v2...

              r5175
            
              output_png=png,

              output_jpeg=jpeg,

        Brian E. Granger
    
Updates to basic notebook format....

              r4402
            
              output_svg=u'<svg>',

              output_json=u'json data',

        Brian E. Granger
    
Adding tracebacks, evalue and etype to the nbformat and notebook.

              r4540
            
              output_javascript=u'var i=0;'

          ),new_output(

              output_type=u'pyerr',

              etype=u'NameError',

              evalue=u'NameError was here',

              traceback=[u'frame 0', u'frame 1', u'frame 2']

        Brian E. Granger
    
Updates to basic notebook format....

              r4402
            
          )]

        Brian E. Granger
    
Initial draft of more formal notebook format....

              r4401
            
      ))

        Brian E. Granger
    
Implemented metadata for notebook format.

              r4637
            
      authors = [new_author(name='Bart Simpson',email='bsimpson@fox.com',

                 affiliation=u'Fox',url=u'http://www.fox.com')]

      md = new_metadata(name=u'My Notebook',license=u'BSD',created=u'8601_goes_here',

          modified=u'8601_goes_here',gistid=u'21341231',authors=authors)

        Brian E. Granger
    
Initial draft of more formal notebook format....

              r4401
            
      nb0 = new_notebook(

        Brian E. Granger
    
New .py notebook format implemented.

              r4536
            
          worksheets=[ws, new_worksheet(name='worksheet2')],

        Brian E. Granger
    
Implemented metadata for notebook format.

              r4637
            
          metadata=md

        Brian E. Granger
    
Initial draft of more formal notebook format....

              r4401
            
      )

        Thomas Kluyver
    
Use emacs-recognised encoding declaration.

              r5745
            
      nb0_py = """# -*- coding: utf-8 -*-

        Thomas Kluyver
    
Add encoding declaration to test for notebook -> .py export.

              r5740
            
      # <nbformat>2</nbformat>

        Brian E. Granger
    
Full versioning added to nbformat.

              r4406
            
        Brian E. Granger
    
New .py notebook format implemented.

              r4536
            
      # <htmlcell>

      # Some NumPy Examples

        Brian E. Granger
    
Full versioning added to nbformat.

              r4406
            
      # <codecell>

        Brian E. Granger
    
Initial draft of more formal notebook format....

              r4401
            
      import numpy

        Brian E. Granger
    
New .py notebook format implemented.

              r4536
            
      # <markdowncell>

      # A random array

        Brian E. Granger
    
Initial draft of more formal notebook format....

              r4401
            
      # <codecell>

      a = numpy.random.rand(100)

      # <codecell>

      print a

        Brian E. Granger
    
Full versioning added to nbformat.

              r4406
            
        Brian E. Granger
    
Initial draft of more formal notebook format....

              r4401
            
      """

	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

MinRK fix base64 code in nbformat.v2...	r5175	import os
		from base64 import encodestring

Brian E. Granger Full versioning added to nbformat.	r4406	from ..nbbase import (
Brian E. Granger Initial draft of more formal notebook format....	r4401	NotebookNode,
Brian E. Granger Implemented metadata for notebook format.	r4637	new_code_cell, new_text_cell, new_worksheet, new_notebook, new_output,
		new_metadata, new_author
Brian E. Granger Initial draft of more formal notebook format....	r4401	)

MinRK fix base64 code in nbformat.v2...	r5175	# some random base64-encoded bytes
		png = encodestring(os.urandom(5))
		jpeg = encodestring(os.urandom(6))
Brian E. Granger Initial draft of more formal notebook format....	r4401
		ws = new_worksheet(name='worksheet1')

Brian E. Granger Markdown cells are now saved and restored in notebooks.	r4511	ws.cells.append(new_text_cell(
		u'html',
		source='Some NumPy Examples',
		rendered='Some NumPy Examples'
Brian E. Granger Initial draft of more formal notebook format....	r4401	))


		ws.cells.append(new_code_cell(
Brian E. Granger Updates to basic notebook format....	r4402	input='import numpy',
Brian E. Granger Added collapsed field to the code cell.	r4533	prompt_number=1,
		collapsed=False
Brian E. Granger Initial draft of more formal notebook format....	r4401	))

Brian E. Granger Markdown cells are now saved and restored in notebooks.	r4511	ws.cells.append(new_text_cell(
		u'markdown',
Brian E. Granger New .py notebook format implemented.	r4536	source='A random array',
		rendered='A random array'
Brian E. Granger Markdown cells are now saved and restored in notebooks.	r4511	))

Brian E. Granger Initial draft of more formal notebook format....	r4401	ws.cells.append(new_code_cell(
Brian E. Granger Updates to basic notebook format....	r4402	input='a = numpy.random.rand(100)',
Brian E. Granger Added collapsed field to the code cell.	r4533	prompt_number=2,
		collapsed=True
Brian E. Granger Initial draft of more formal notebook format....	r4401	))

		ws.cells.append(new_code_cell(
		input='print a',
Brian E. Granger Updates to basic notebook format....	r4402	prompt_number=3,
Brian E. Granger Added collapsed field to the code cell.	r4533	collapsed=False,
Brian E. Granger Updates to basic notebook format....	r4402	outputs=[new_output(
		output_type=u'pyout',
		output_text=u'<array a>',
		output_html=u'The HTML rep',
		output_latex=u'$a$',
MinRK fix base64 code in nbformat.v2...	r5175	output_png=png,
		output_jpeg=jpeg,
Brian E. Granger Updates to basic notebook format....	r4402	output_svg=u'<svg>',
		output_json=u'json data',
Brian E. Granger Starting to rename text cell to html cell.	r4498	output_javascript=u'var i=0;',
		prompt_number=3
Brian E. Granger Updates to basic notebook format....	r4402	),new_output(
		output_type=u'display_data',
		output_text=u'<array a>',
		output_html=u'The HTML rep',
		output_latex=u'$a$',
MinRK fix base64 code in nbformat.v2...	r5175	output_png=png,
		output_jpeg=jpeg,
Brian E. Granger Updates to basic notebook format....	r4402	output_svg=u'<svg>',
		output_json=u'json data',
Brian E. Granger Adding tracebacks, evalue and etype to the nbformat and notebook.	r4540	output_javascript=u'var i=0;'
		),new_output(
		output_type=u'pyerr',
		etype=u'NameError',
		evalue=u'NameError was here',
		traceback=[u'frame 0', u'frame 1', u'frame 2']
Brian E. Granger Updates to basic notebook format....	r4402	)]
Brian E. Granger Initial draft of more formal notebook format....	r4401	))

Brian E. Granger Implemented metadata for notebook format.	r4637	authors = [new_author(name='Bart Simpson',email='bsimpson@fox.com',
		affiliation=u'Fox',url=u'http://www.fox.com')]
		md = new_metadata(name=u'My Notebook',license=u'BSD',created=u'8601_goes_here',
		modified=u'8601_goes_here',gistid=u'21341231',authors=authors)

Brian E. Granger Initial draft of more formal notebook format....	r4401	nb0 = new_notebook(
Brian E. Granger New .py notebook format implemented.	r4536	worksheets=[ws, new_worksheet(name='worksheet2')],
Brian E. Granger Implemented metadata for notebook format.	r4637	metadata=md
Brian E. Granger Initial draft of more formal notebook format....	r4401	)

Thomas Kluyver Use emacs-recognised encoding declaration.	r5745	nb0_py = """# -- coding: utf-8 --
Thomas Kluyver Add encoding declaration to test for notebook -> .py export.	r5740	# <nbformat>2</nbformat>
Brian E. Granger Full versioning added to nbformat.	r4406
Brian E. Granger New .py notebook format implemented.	r4536	# <htmlcell>

		# Some NumPy Examples

Brian E. Granger Full versioning added to nbformat.	r4406	# <codecell>
Brian E. Granger Initial draft of more formal notebook format....	r4401
		import numpy

Brian E. Granger New .py notebook format implemented.	r4536	# <markdowncell>

		# A random array

Brian E. Granger Initial draft of more formal notebook format....	r4401	# <codecell>

		a = numpy.random.rand(100)

		# <codecell>

		print a
Brian E. Granger Full versioning added to nbformat.	r4406
Brian E. Granger Initial draft of more formal notebook format....	r4401	"""