upstream/ipython Files · IPython/qt.py

Fix example usage of BaseFormatter.for_type_by_name....

Fix example usage of BaseFormatter.for_type_by_name. I propose a small documentation fix for this excellent feature of IPython. The current example doesn't work because the type module and type name are lumped into one string. They must be given as separate strings. See docstring: ``` Signature: BaseFormatter.for_type_by_name(self, type_module, type_name, func=None) ``` For extra clarity, I have added a submodule to this made-up example module so that the pattern is clear.

Matthias Bussonnier - - Load All Authors

File last commit:

r23398:f33ca742


                r25165:5da2c265

Download file

             qt.py
        
                    24 lines
            
             | 762 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / qt.py
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Thomas Kluyver
    
Add shim to preserve IPython.qt imports

              r20851
            
      """

      Shim to maintain backwards compatibility with old IPython.qt imports.

      """

      # Copyright (c) IPython Development Team.

      # Distributed under the terms of the Modified BSD License.

      import sys

      from warnings import warn

        Min RK
    
add ShimWarning for shimmed imports...

              r21515
            
      from IPython.utils.shimmodule import ShimModule, ShimWarning

        Thomas Kluyver
    
Add shim to preserve IPython.qt imports

              r20851
            
        Matthias Bussonnier
    
Update shim warnings to include IPython version....

              r23398
            
      warn("The `IPython.qt` package has been deprecated since IPython 4.0. "

        Min RK
    
add ShimWarning for shimmed imports...

              r21515
            
           "You should import from qtconsole instead.", ShimWarning)

        Thomas Kluyver
    
Add shim to preserve IPython.qt imports

              r20851
            
      # Unconditionally insert the shim into sys.modules so that further import calls

      # trigger the custom attribute access above

        Sylvain Corlay
    
Fix qtconsole shims

              r21448
            
      _console = sys.modules['IPython.qt.console'] = ShimModule(

          src='IPython.qt.console', mirror='qtconsole')

      _qt = ShimModule(src='IPython.qt', mirror='qtconsole')

        Min RK
    
qtconsole package has been flattened....

              r21362
            
      _qt.console = _console

        Sylvain Corlay
    
Fix qtconsole shims

              r21448
            
      sys.modules['IPython.qt'] = _qt

	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

Thomas Kluyver Add shim to preserve IPython.qt imports	r20851	"""
		Shim to maintain backwards compatibility with old IPython.qt imports.
		"""
		# Copyright (c) IPython Development Team.
		# Distributed under the terms of the Modified BSD License.

		import sys
		from warnings import warn

Min RK add ShimWarning for shimmed imports...	r21515	from IPython.utils.shimmodule import ShimModule, ShimWarning
Thomas Kluyver Add shim to preserve IPython.qt imports	r20851
Matthias Bussonnier Update shim warnings to include IPython version....	r23398	warn("The `IPython.qt` package has been deprecated since IPython 4.0. "
Min RK add ShimWarning for shimmed imports...	r21515	"You should import from qtconsole instead.", ShimWarning)
Thomas Kluyver Add shim to preserve IPython.qt imports	r20851
		# Unconditionally insert the shim into sys.modules so that further import calls
		# trigger the custom attribute access above

Sylvain Corlay Fix qtconsole shims	r21448	_console = sys.modules['IPython.qt.console'] = ShimModule(
		src='IPython.qt.console', mirror='qtconsole')

		_qt = ShimModule(src='IPython.qt', mirror='qtconsole')

Min RK qtconsole package has been flattened....	r21362	_qt.console = _console
Sylvain Corlay Fix qtconsole shims	r21448	sys.modules['IPython.qt'] = _qt