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

Scott Sanderson - - Load All Authors

File last commit:

r17799:40708d45


                r25165:5da2c265

Download file

             error.py
        
                    60 lines
            
             | 1.7 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / core / error.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # encoding: utf-8

      """

      Global exception classes for IPython.core.

      Authors:

      * Brian Granger

      * Fernando Perez

      * Min Ragan-Kelley

      Notes

      -----

      """

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

      #  Copyright (C) 2008 The IPython Development Team

      #

      #  Distributed under the terms of the BSD License.  The full license is in

      #  the file COPYING, distributed as part of this software.

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

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

      # Imports

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

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

      # Exception classes

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

      class IPythonCoreError(Exception):

          pass

      class TryNext(IPythonCoreError):

          """Try next hook exception.

          Raise this in your hook function to indicate that the next hook handler

          should be used to handle the operation.

          """

      class UsageError(IPythonCoreError):

          """Error in magic function arguments, etc.

          Something that probably won't warrant a full traceback, but should

          nevertheless interrupt a macro / batch file.

          """

      class StdinNotImplementedError(IPythonCoreError, NotImplementedError):

          """raw_input was requested in a context where it is not supported

          For use in IPython kernels, where only some frontends may support

          stdin requests.

          """

      class InputRejected(Exception):

          """Input rejected by ast transformer.

          Raise this in your NodeTransformer to indicate that InteractiveShell should

          not execute the supplied input.

          """

	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

				# encoding: utf-8
				"""
				Global exception classes for IPython.core.

				Authors:

				* Brian Granger
				* Fernando Perez
				* Min Ragan-Kelley

				Notes
				-----
				"""

				#-----------------------------------------------------------------------------
				# Copyright (C) 2008 The IPython Development Team
				#
				# Distributed under the terms of the BSD License. The full license is in
				# the file COPYING, distributed as part of this software.
				#-----------------------------------------------------------------------------

				#-----------------------------------------------------------------------------
				# Imports
				#-----------------------------------------------------------------------------

				#-----------------------------------------------------------------------------
				# Exception classes
				#-----------------------------------------------------------------------------

				class IPythonCoreError(Exception):
				pass


				class TryNext(IPythonCoreError):
				"""Try next hook exception.

				Raise this in your hook function to indicate that the next hook handler
				should be used to handle the operation.
				"""

				class UsageError(IPythonCoreError):
				"""Error in magic function arguments, etc.

				Something that probably won't warrant a full traceback, but should
				nevertheless interrupt a macro / batch file.
				"""

				class StdinNotImplementedError(IPythonCoreError, NotImplementedError):
				"""raw_input was requested in a context where it is not supported

				For use in IPython kernels, where only some frontends may support
				stdin requests.
				"""

				class InputRejected(Exception):
				"""Input rejected by ast transformer.

				Raise this in your NodeTransformer to indicate that InteractiveShell should
				not execute the supplied input.
				"""