upstream/ipython Files · IPython/html.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

             html.py
        
                    28 lines
            
             | 839 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / html.py
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Min RK
    
shim IPython.html

              r21209
            
      """

      Shim to maintain backwards compatibility with old IPython.html 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

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

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

        Thomas Kluyver
    
jupyter_notebook renamed to just notebook

              r21360
            
           "You should import from `notebook` instead. "

        Min RK
    
add ShimWarning for shimmed imports...

              r21515
            
           "`IPython.html.widgets` has moved to `ipywidgets`.", ShimWarning)

        Min RK
    
shim IPython.html

              r21209
            
        Min RK
    
assign widgets shim as attribute on html shim...

              r21312
            
      _widgets = sys.modules['IPython.html.widgets'] = ShimModule(

        Thomas Kluyver
    
And ipython_widgets became ipywidgets

              r21361
            
          src='IPython.html.widgets', mirror='ipywidgets')

        Min RK
    
move widget shim to html.py...

              r21302
            
        Min RK
    
assign widgets shim as attribute on html shim...

              r21312
            
      _html = ShimModule(

        Thomas Kluyver
    
jupyter_notebook renamed to just notebook

              r21360
            
          src='IPython.html', mirror='notebook')

        Min RK
    
shim widgets before shimming html...

              r21308
            
        Min RK
    
assign widgets shim as attribute on html shim...

              r21312
            
      # hook up widgets

      _html.widgets = _widgets

      sys.modules['IPython.html'] = _html

        Min RK
    
shim `python -m IPython.html`

              r21211
            
      if __name__ == '__main__':

        Thomas Kluyver
    
jupyter_notebook renamed to just notebook

              r21360
            
          from notebook import notebookapp as app

        Min RK
    
shim `python -m IPython.html`

              r21211
            
          app.launch_new_instance()

	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

Min RK shim IPython.html	r21209	"""
		Shim to maintain backwards compatibility with old IPython.html 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

Matthias Bussonnier Update shim warnings to include IPython version....	r23398	warn("The `IPython.html` package has been deprecated since IPython 4.0. "
Thomas Kluyver jupyter_notebook renamed to just notebook	r21360	"You should import from `notebook` instead. "
Min RK add ShimWarning for shimmed imports...	r21515	"`IPython.html.widgets` has moved to `ipywidgets`.", ShimWarning)
Min RK shim IPython.html	r21209
Min RK assign widgets shim as attribute on html shim...	r21312	_widgets = sys.modules['IPython.html.widgets'] = ShimModule(
Thomas Kluyver And ipython_widgets became ipywidgets	r21361	src='IPython.html.widgets', mirror='ipywidgets')
Min RK move widget shim to html.py...	r21302
Min RK assign widgets shim as attribute on html shim...	r21312	_html = ShimModule(
Thomas Kluyver jupyter_notebook renamed to just notebook	r21360	src='IPython.html', mirror='notebook')
Min RK shim widgets before shimming html...	r21308
Min RK assign widgets shim as attribute on html shim...	r21312	# hook up widgets
		_html.widgets = _widgets
		sys.modules['IPython.html'] = _html

Min RK shim `python -m IPython.html`	r21211	if __name__ == '__main__':
Thomas Kluyver jupyter_notebook renamed to just notebook	r21360	from notebook import notebookapp as app
Min RK shim `python -m IPython.html`	r21211	app.launch_new_instance()