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

Paul Ivanov - - Load All Authors

File last commit:

r22963:2961b531


                r25165:5da2c265

Download file

             tclass.py
        
                    34 lines
            
             | 921 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / core / tests / tclass.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """Simple script to be run *twice*, to check reference counting bugs.

      See test_run for details."""

      import sys

      # We want to ensure that while objects remain available for immediate access,

      # objects from *previous* runs of the same script get collected, to avoid

      # accumulating massive amounts of old references.

      class C(object):

          def __init__(self,name):

              self.name = name

              self.p = print

              self.flush_stdout = sys.stdout.flush

          def __del__(self):

              self.p('tclass.py: deleting object:',self.name)

              self.flush_stdout()

      try:

          name = sys.argv[1]

      except IndexError:

          pass

      else:

          if name.startswith('C'):

              c = C(name)

      #print >> sys.stderr, "ARGV:", sys.argv  # dbg

      # This next print statement is NOT debugging, we're making the check on a

      # completely separate process so we verify by capturing stdout:

      print('ARGV 1-:', sys.argv[1:])

      sys.stdout.flush()

	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

				"""Simple script to be run twice, to check reference counting bugs.

				See test_run for details."""


				import sys

				# We want to ensure that while objects remain available for immediate access,
				# objects from previous runs of the same script get collected, to avoid
				# accumulating massive amounts of old references.
				class C(object):
				def __init__(self,name):
				self.name = name
				self.p = print
				self.flush_stdout = sys.stdout.flush

				def __del__(self):
				self.p('tclass.py: deleting object:',self.name)
				self.flush_stdout()

				try:
				name = sys.argv[1]
				except IndexError:
				pass
				else:
				if name.startswith('C'):
				c = C(name)

				#print >> sys.stderr, "ARGV:", sys.argv # dbg

				# This next print statement is NOT debugging, we're making the check on a
				# completely separate process so we verify by capturing stdout:
				print('ARGV 1-:', sys.argv[1:])
				sys.stdout.flush()