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

Fernando Perez - - Load All Authors

File last commit:

r2440:0caaf43a


                r25165:5da2c265

Download file

             simpleerr.py
        
                    32 lines
            
             | 584 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / core / tests / simpleerr.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """Error script. DO NOT EDIT FURTHER! It will break exception doctests!!!"""

      import sys

      def div0():

          "foo"

          x = 1

          y = 0

          x/y

      def sysexit(stat, mode):

          raise SystemExit(stat, 'Mode = %s' % mode)

      def bar(mode):

          "bar"

          if mode=='div':

              div0()

          elif mode=='exit':

              try:

                  stat = int(sys.argv[2])

              except:

                  stat = 1

              sysexit(stat, mode)

          else:

              raise ValueError('Unknown mode')

      if __name__ == '__main__':

          try:

              mode = sys.argv[1]

          except IndexError:

              mode = 'div'

          bar(mode)

	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

				"""Error script. DO NOT EDIT FURTHER! It will break exception doctests!!!"""
				import sys

				def div0():
				"foo"
				x = 1
				y = 0
				x/y

				def sysexit(stat, mode):
				raise SystemExit(stat, 'Mode = %s' % mode)

				def bar(mode):
				"bar"
				if mode=='div':
				div0()
				elif mode=='exit':
				try:
				stat = int(sys.argv[2])
				except:
				stat = 1
				sysexit(stat, mode)
				else:
				raise ValueError('Unknown mode')

				if __name__ == '__main__':
				try:
				mode = sys.argv[1]
				except IndexError:
				mode = 'div'

				bar(mode)