upstream/ipython Files · IPython/nbconvert/exporters/latex.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.

MinRK - - Load All Authors

File last commit:

r15346:31471a3b


                r18548:61431d7d

Download file

             latex.py
        
                    89 lines
            
             | 3.1 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / nbconvert / exporters / latex.py
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        MinRK
    
add raw_format to Exporter classes...

              r13664
            
      """LaTeX Exporter class"""

        Jonathan Frederic
    
Split exporter into base and latex.

              r10479
            
      #-----------------------------------------------------------------------------

      # Copyright (c) 2013, the IPython Development Team.

      #

      # Distributed under the terms of the Modified BSD License.

      #

      # The full license is in the file COPYING.txt, distributed with this software.

      #-----------------------------------------------------------------------------

      #-----------------------------------------------------------------------------

      # Imports

      #-----------------------------------------------------------------------------

        Jonathan Frederic
    
Added imports

              r10585
            
        damianavila
    
Fix missing import os in latex exporter.

              r11203
            
      # Stdlib imports

      import os

        Jonathan Frederic
    
Added imports

              r10585
            
      # IPython imports

        Thomas Kluyver
    
Drop unused traitlet imports

              r13933
            
      from IPython.utils.traitlets import Unicode

        Matthias BUSSONNIER
    
comit from home

              r10872
            
      from IPython.config import Config

        Jonathan Frederic
    
Added imports

              r10585
            
        Paul Ivanov
    
replace 'transformer' with 'preprocessor'

              r12219
            
      from IPython.nbconvert import filters, preprocessors

        Jonathan Frederic
    
Rebase changes made by hand

              r12505
            
      from .templateexporter import TemplateExporter

        Jonathan Frederic
    
Cleanup and refactor of API, almost complete....

              r10677
            
        Jonathan Frederic
    
Split exporter into base and latex.

              r10479
            
      #-----------------------------------------------------------------------------

      # Classes and functions

      #-----------------------------------------------------------------------------

        Jonathan Frederic
    
Rebase changes made by hand

              r12505
            
      class LatexExporter(TemplateExporter):

        Jonathan Frederic
    
Cleanup and refactor of API, almost complete....

              r10677
            
          """

          Exports to a Latex template.  Inherit from this class if your template is

          LaTeX based and you need custom tranformers/filters.  Inherit from it if 

          you are writing your own HTML template and need custom tranformers/filters.  

          If you don't need custom tranformers/filters, just change the 

          'template_file' config option.  Place your template in the special "/latex" 

          subfolder of the "../templates" folder.

          """

        Thomas Kluyver
    
Remove magic for loading templates from module names

              r13925
            
          def _file_extension_default(self):

              return 'tex'

          def _template_file_default(self):

              return 'article'

        Jonathan Frederic
    
Split exporter into base and latex.

              r10479
            
        Jonathan Frederic
    
Finished rename/refact on API namespace

              r10690
            
          #Latex constants

        Thomas Kluyver
    
Move html templates into separate folder

              r14047
            
          def _default_template_path_default(self):

              return os.path.join("..", "templates", "latex")

        Jonathan Frederic
    
Finished rename/refact on API namespace

              r10690
            
        Thomas Kluyver
    
Use _default method instead of redefining trait

              r14050
            
          def _template_skeleton_path_default(self):

              return os.path.join("..", "templates", "latex", "skeleton")

        Jonathan Frederic
    
Finished rename/refact on API namespace

              r10690
            
          #Special Jinja2 syntax that will not conflict when exporting latex.

          jinja_comment_block_start = Unicode("((=", config=True)

          jinja_comment_block_end = Unicode("=))", config=True)

          jinja_variable_block_start = Unicode("(((", config=True)

          jinja_variable_block_end = Unicode(")))", config=True)

          jinja_logic_block_start = Unicode("((*", config=True)

          jinja_logic_block_end = Unicode("*))", config=True)

          #Extension that the template files use.    

          template_extension = Unicode(".tplx", config=True)

        Matthias BUSSONNIER
    
allow to overwrite LaTexTransformer options

              r10869
            
        Thomas Kluyver
    
Make output_mimetype accessible from the class....

              r13834
            
          output_mimetype = 'text/latex'

        MinRK
    
add raw_format to Exporter classes...

              r13664
            
        Jonathan Frederic
    
Part way through adding 'flavor' support

              r11733
            
        Matthias BUSSONNIER
    
fix config inheriting

              r10963
            
          @property

          def default_config(self):

              c = Config({

        Jonathan Frederic
    
Rename GlobalConfigurable to NbConvertBase

              r11419
            
                  'NbConvertBase': {

        MinRK
    
handle 'application/pdf' in nbconvert...

              r15346
            
                      'display_data_priority' : ['latex', 'application/pdf', 'png', 'jpg', 'svg', 'jpeg', 'text']

        Matthias BUSSONNIER
    
correct depth for configurable

              r10965
            
                      },

        Paul Ivanov
    
replace 'transformer' with 'preprocessor'

              r12219
            
                   'ExtractOutputPreprocessor': {

        Jonathan Frederic
    
Added writers and supporting code.

              r11367
            
                          'enabled':True

        Jonathan Frederic
    
Transformers in traitlet lists now, new _init_ methods,...

              r11383
            
                       },

        Paul Ivanov
    
replace 'transformer' with 'preprocessor'

              r12219
            
                   'SVG2PDFPreprocessor': {

        Jonathan Frederic
    
Transformers in traitlet lists now, new _init_ methods,...

              r11383
            
                          'enabled':True

                       },

        Paul Ivanov
    
replace 'transformer' with 'preprocessor'

              r12219
            
                   'LatexPreprocessor': {

        Jonathan Frederic
    
Transformers in traitlet lists now, new _init_ methods,...

              r11383
            
                          'enabled':True

        Jonathan Frederic
    
Small bugfixes

              r11736
            
                       },

        Paul Ivanov
    
replace 'transformer' with 'preprocessor'

              r12219
            
                   'SphinxPreprocessor': {

        Jonathan Frederic
    
Part way through adding 'flavor' support

              r11733
            
                          'enabled':True

        Pablo de Oliveira
    
Add HighlightMagicsPreprocessor...

              r12573
            
                       },

                   'HighlightMagicsPreprocessor': {

                          'enabled':True

        Jonathan Frederic
    
Part way through adding 'flavor' support

              r11733
            
                       }

        Matthias BUSSONNIER
    
fix config inheriting

              r10963
            
               })

              c.merge(super(LatexExporter,self).default_config)

              return c

	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 add raw_format to Exporter classes...	r13664	"""LaTeX Exporter class"""

Jonathan Frederic Split exporter into base and latex.	r10479	#-----------------------------------------------------------------------------
		# Copyright (c) 2013, the IPython Development Team.
		#
		# Distributed under the terms of the Modified BSD License.
		#
		# The full license is in the file COPYING.txt, distributed with this software.
		#-----------------------------------------------------------------------------

		#-----------------------------------------------------------------------------
		# Imports
		#-----------------------------------------------------------------------------
Jonathan Frederic Added imports	r10585
damianavila Fix missing import os in latex exporter.	r11203	# Stdlib imports
		import os

Jonathan Frederic Added imports	r10585	# IPython imports
Thomas Kluyver Drop unused traitlet imports	r13933	from IPython.utils.traitlets import Unicode
Matthias BUSSONNIER comit from home	r10872	from IPython.config import Config
Jonathan Frederic Added imports	r10585
Paul Ivanov replace 'transformer' with 'preprocessor'	r12219	from IPython.nbconvert import filters, preprocessors
Jonathan Frederic Rebase changes made by hand	r12505	from .templateexporter import TemplateExporter
Jonathan Frederic Cleanup and refactor of API, almost complete....	r10677
Jonathan Frederic Split exporter into base and latex.	r10479	#-----------------------------------------------------------------------------
		# Classes and functions
		#-----------------------------------------------------------------------------

Jonathan Frederic Rebase changes made by hand	r12505	class LatexExporter(TemplateExporter):
Jonathan Frederic Cleanup and refactor of API, almost complete....	r10677	"""
		Exports to a Latex template. Inherit from this class if your template is
		LaTeX based and you need custom tranformers/filters. Inherit from it if
		you are writing your own HTML template and need custom tranformers/filters.
		If you don't need custom tranformers/filters, just change the
		'template_file' config option. Place your template in the special "/latex"
		subfolder of the "../templates" folder.
		"""
Thomas Kluyver Remove magic for loading templates from module names	r13925
		def _file_extension_default(self):
		return 'tex'

		def _template_file_default(self):
		return 'article'
Jonathan Frederic Split exporter into base and latex.	r10479
Jonathan Frederic Finished rename/refact on API namespace	r10690	#Latex constants
Thomas Kluyver Move html templates into separate folder	r14047	def _default_template_path_default(self):
		return os.path.join("..", "templates", "latex")
Jonathan Frederic Finished rename/refact on API namespace	r10690
Thomas Kluyver Use _default method instead of redefining trait	r14050	def _template_skeleton_path_default(self):
		return os.path.join("..", "templates", "latex", "skeleton")
Jonathan Frederic Finished rename/refact on API namespace	r10690
		#Special Jinja2 syntax that will not conflict when exporting latex.
		jinja_comment_block_start = Unicode("((=", config=True)
		jinja_comment_block_end = Unicode("=))", config=True)
		jinja_variable_block_start = Unicode("(((", config=True)
		jinja_variable_block_end = Unicode(")))", config=True)
		jinja_logic_block_start = Unicode("((*", config=True)
		jinja_logic_block_end = Unicode("*))", config=True)

		#Extension that the template files use.
		template_extension = Unicode(".tplx", config=True)
Matthias BUSSONNIER allow to overwrite LaTexTransformer options	r10869
Thomas Kluyver Make output_mimetype accessible from the class....	r13834	output_mimetype = 'text/latex'
MinRK add raw_format to Exporter classes...	r13664
Jonathan Frederic Part way through adding 'flavor' support	r11733
Matthias BUSSONNIER fix config inheriting	r10963	@property
		def default_config(self):
		c = Config({
Jonathan Frederic Rename GlobalConfigurable to NbConvertBase	r11419	'NbConvertBase': {
MinRK handle 'application/pdf' in nbconvert...	r15346	'display_data_priority' : ['latex', 'application/pdf', 'png', 'jpg', 'svg', 'jpeg', 'text']
Matthias BUSSONNIER correct depth for configurable	r10965	},
Paul Ivanov replace 'transformer' with 'preprocessor'	r12219	'ExtractOutputPreprocessor': {
Jonathan Frederic Added writers and supporting code.	r11367	'enabled':True
Jonathan Frederic Transformers in traitlet lists now, new _init_ methods,...	r11383	},
Paul Ivanov replace 'transformer' with 'preprocessor'	r12219	'SVG2PDFPreprocessor': {
Jonathan Frederic Transformers in traitlet lists now, new _init_ methods,...	r11383	'enabled':True
		},
Paul Ivanov replace 'transformer' with 'preprocessor'	r12219	'LatexPreprocessor': {
Jonathan Frederic Transformers in traitlet lists now, new _init_ methods,...	r11383	'enabled':True
Jonathan Frederic Small bugfixes	r11736	},
Paul Ivanov replace 'transformer' with 'preprocessor'	r12219	'SphinxPreprocessor': {
Jonathan Frederic Part way through adding 'flavor' support	r11733	'enabled':True
Pablo de Oliveira Add HighlightMagicsPreprocessor...	r12573	},
		'HighlightMagicsPreprocessor': {
		'enabled':True
Jonathan Frederic Part way through adding 'flavor' support	r11733	}
Matthias BUSSONNIER fix config inheriting	r10963	})
		c.merge(super(LatexExporter,self).default_config)
		return c